Compare commits
22 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9231704988 | ||
|
|
c8f7cf63e3 | ||
|
|
12a68a7d14 | ||
|
|
1613c302bc | ||
|
|
478b1c7e13 | ||
|
|
ffcf6cbcb2 | ||
|
|
0ab0452414 | ||
|
|
b62b067cbd | ||
|
|
cb2646cd93 | ||
|
|
9692b5e714 | ||
|
|
ac68c53a7d | ||
|
|
55c9e84f38 | ||
|
|
40dd30419c | ||
|
|
da56f7f56a | ||
|
|
8400b39dd9 | ||
|
|
5fc1441fe7 | ||
|
|
044615eff1 | ||
|
|
99875683ac | ||
|
|
dbd9f3f3d2 | ||
|
|
0fdeb1ff6e | ||
|
|
eaeb0603eb | ||
|
|
6a2f3a4b42 |
1
.gitignore
vendored
1
.gitignore
vendored
@@ -8,3 +8,4 @@
|
|||||||
/MANIFEST
|
/MANIFEST
|
||||||
/venv
|
/venv
|
||||||
build/
|
build/
|
||||||
|
.vscode/settings.json
|
||||||
|
|||||||
@@ -96,12 +96,18 @@ newline_style
|
|||||||
newline). While the latter convention is non-standard, it is commonly
|
newline). While the latter convention is non-standard, it is commonly
|
||||||
preferred and supported by a lot of interpreters.
|
preferred and supported by a lot of interpreters.
|
||||||
|
|
||||||
|
code_language
|
||||||
|
Defines the language that should be assumed for all ``<pre>`` sections.
|
||||||
|
Useful, if all code on a page is in the same programming language and
|
||||||
|
should be annotated with `````python`` or similar.
|
||||||
|
Defaults to ``''`` (empty string) and can be any string.
|
||||||
|
|
||||||
Options may be specified as kwargs to the ``markdownify`` function, or as a
|
Options may be specified as kwargs to the ``markdownify`` function, or as a
|
||||||
nested ``Options`` class in ``MarkdownConverter`` subclasses.
|
nested ``Options`` class in ``MarkdownConverter`` subclasses.
|
||||||
|
|
||||||
|
|
||||||
Creating Custom Converters
|
Creating Custom Converters
|
||||||
=========================
|
==========================
|
||||||
|
|
||||||
If you have a special usecase that calls for a special conversion, you can
|
If you have a special usecase that calls for a special conversion, you can
|
||||||
always inherit from ``MarkdownConverter`` and override the method you want to
|
always inherit from ``MarkdownConverter`` and override the method you want to
|
||||||
|
|||||||
@@ -76,6 +76,7 @@ class MarkdownConverter(object):
|
|||||||
strong_em_symbol = ASTERISK
|
strong_em_symbol = ASTERISK
|
||||||
sub_symbol = ''
|
sub_symbol = ''
|
||||||
sup_symbol = ''
|
sup_symbol = ''
|
||||||
|
code_language = ''
|
||||||
|
|
||||||
class Options(DefaultOptions):
|
class Options(DefaultOptions):
|
||||||
pass
|
pass
|
||||||
@@ -96,11 +97,14 @@ class MarkdownConverter(object):
|
|||||||
|
|
||||||
def process_tag(self, node, convert_as_inline, children_only=False):
|
def process_tag(self, node, convert_as_inline, children_only=False):
|
||||||
text = ''
|
text = ''
|
||||||
# markdown headings can't include block elements (elements w/newlines)
|
|
||||||
|
# markdown headings or cells can't include
|
||||||
|
# block elements (elements w/newlines)
|
||||||
isHeading = html_heading_re.match(node.name) is not None
|
isHeading = html_heading_re.match(node.name) is not None
|
||||||
|
isCell = node.name in ['td', 'th']
|
||||||
convert_children_as_inline = convert_as_inline
|
convert_children_as_inline = convert_as_inline
|
||||||
|
|
||||||
if not children_only and isHeading:
|
if not children_only and (isHeading or isCell):
|
||||||
convert_children_as_inline = True
|
convert_children_as_inline = True
|
||||||
|
|
||||||
# Remove whitespace-only textnodes in purely nested nodes
|
# Remove whitespace-only textnodes in purely nested nodes
|
||||||
@@ -200,8 +204,6 @@ class MarkdownConverter(object):
|
|||||||
prefix, suffix, text = chomp(text)
|
prefix, suffix, text = chomp(text)
|
||||||
if not text:
|
if not text:
|
||||||
return ''
|
return ''
|
||||||
if convert_as_inline:
|
|
||||||
return text
|
|
||||||
href = el.get('href')
|
href = el.get('href')
|
||||||
title = el.get('title')
|
title = el.get('title')
|
||||||
# For the replacement see #29: text nodes underscores are escaped
|
# For the replacement see #29: text nodes underscores are escaped
|
||||||
@@ -313,7 +315,7 @@ class MarkdownConverter(object):
|
|||||||
el = el.parent
|
el = el.parent
|
||||||
bullets = self.options['bullets']
|
bullets = self.options['bullets']
|
||||||
bullet = bullets[depth % len(bullets)]
|
bullet = bullets[depth % len(bullets)]
|
||||||
return '%s %s\n' % (bullet, text or '')
|
return '%s %s\n' % (bullet, (text or '').strip())
|
||||||
|
|
||||||
def convert_p(self, el, text, convert_as_inline):
|
def convert_p(self, el, text, convert_as_inline):
|
||||||
if convert_as_inline:
|
if convert_as_inline:
|
||||||
@@ -323,7 +325,7 @@ class MarkdownConverter(object):
|
|||||||
def convert_pre(self, el, text, convert_as_inline):
|
def convert_pre(self, el, text, convert_as_inline):
|
||||||
if not text:
|
if not text:
|
||||||
return ''
|
return ''
|
||||||
return '\n```\n%s\n```\n' % text
|
return '\n```%s\n%s\n```\n' % (self.options['code_language'], text)
|
||||||
|
|
||||||
convert_s = convert_del
|
convert_s = convert_del
|
||||||
|
|
||||||
|
|||||||
4
setup.py
4
setup.py
@@ -10,7 +10,7 @@ read = lambda filepath: codecs.open(filepath, 'r', 'utf-8').read()
|
|||||||
pkgmeta = {
|
pkgmeta = {
|
||||||
'__title__': 'markdownify',
|
'__title__': 'markdownify',
|
||||||
'__author__': 'Matthew Tretter',
|
'__author__': 'Matthew Tretter',
|
||||||
'__version__': '0.9.1',
|
'__version__': '0.10.1',
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@@ -70,7 +70,7 @@ setup(
|
|||||||
zip_safe=False,
|
zip_safe=False,
|
||||||
include_package_data=True,
|
include_package_data=True,
|
||||||
setup_requires=[
|
setup_requires=[
|
||||||
'flake8>=3.8,<4',
|
'flake8>=3.8,<5',
|
||||||
],
|
],
|
||||||
tests_require=[
|
tests_require=[
|
||||||
'pytest>=6.2,<7',
|
'pytest>=6.2,<7',
|
||||||
|
|||||||
@@ -210,3 +210,8 @@ def test_sub():
|
|||||||
def test_sup():
|
def test_sup():
|
||||||
assert md('<sup>foo</sup>') == 'foo'
|
assert md('<sup>foo</sup>') == 'foo'
|
||||||
assert md('<sup>foo</sup>', sup_symbol='^') == '^foo^'
|
assert md('<sup>foo</sup>', sup_symbol='^') == '^foo^'
|
||||||
|
|
||||||
|
|
||||||
|
def test_lang():
|
||||||
|
assert md('<pre>test\n foo\nbar</pre>', code_language='python') == '\n```python\ntest\n foo\nbar\n```\n'
|
||||||
|
assert md('<pre><code>test\n foo\nbar</code></pre>', code_language='javascript') == '\n```javascript\ntest\n foo\nbar\n```\n'
|
||||||
|
|||||||
@@ -51,6 +51,14 @@ def test_nested_ols():
|
|||||||
|
|
||||||
def test_ul():
|
def test_ul():
|
||||||
assert md('<ul><li>a</li><li>b</li></ul>') == '* a\n* b\n'
|
assert md('<ul><li>a</li><li>b</li></ul>') == '* a\n* b\n'
|
||||||
|
assert md("""<ul>
|
||||||
|
<li>
|
||||||
|
a
|
||||||
|
</li>
|
||||||
|
<li> b </li>
|
||||||
|
<li> c
|
||||||
|
</li>
|
||||||
|
</ul>""") == '* a\n* b\n* c\n'
|
||||||
|
|
||||||
|
|
||||||
def test_inline_ul():
|
def test_inline_ul():
|
||||||
|
|||||||
@@ -39,6 +39,25 @@ table_with_html_content = """<table>
|
|||||||
</table>"""
|
</table>"""
|
||||||
|
|
||||||
|
|
||||||
|
table_with_paragraphs = """<table>
|
||||||
|
<tr>
|
||||||
|
<th>Firstname</th>
|
||||||
|
<th><p>Lastname</p></th>
|
||||||
|
<th>Age</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><p>Jill</p></td>
|
||||||
|
<td><p>Smith</p></td>
|
||||||
|
<td><p>50</p></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>Eve</td>
|
||||||
|
<td>Jackson</td>
|
||||||
|
<td>94</td>
|
||||||
|
</tr>
|
||||||
|
</table>"""
|
||||||
|
|
||||||
|
|
||||||
table_with_header_column = """<table>
|
table_with_header_column = """<table>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Firstname</th>
|
<th>Firstname</th>
|
||||||
@@ -124,6 +143,7 @@ table_missing_head = """<table>
|
|||||||
def test_table():
|
def test_table():
|
||||||
assert md(table) == '\n\n| Firstname | Lastname | Age |\n| --- | --- | --- |\n| Jill | Smith | 50 |\n| Eve | Jackson | 94 |\n\n'
|
assert md(table) == '\n\n| Firstname | Lastname | Age |\n| --- | --- | --- |\n| Jill | Smith | 50 |\n| Eve | Jackson | 94 |\n\n'
|
||||||
assert md(table_with_html_content) == '\n\n| Firstname | Lastname | Age |\n| --- | --- | --- |\n| **Jill** | *Smith* | [50](#) |\n| Eve | Jackson | 94 |\n\n'
|
assert md(table_with_html_content) == '\n\n| Firstname | Lastname | Age |\n| --- | --- | --- |\n| **Jill** | *Smith* | [50](#) |\n| Eve | Jackson | 94 |\n\n'
|
||||||
|
assert md(table_with_paragraphs) == '\n\n| Firstname | Lastname | Age |\n| --- | --- | --- |\n| Jill | Smith | 50 |\n| Eve | Jackson | 94 |\n\n'
|
||||||
assert md(table_with_header_column) == '\n\n| Firstname | Lastname | Age |\n| --- | --- | --- |\n| Jill | Smith | 50 |\n| Eve | Jackson | 94 |\n\n'
|
assert md(table_with_header_column) == '\n\n| Firstname | Lastname | Age |\n| --- | --- | --- |\n| Jill | Smith | 50 |\n| Eve | Jackson | 94 |\n\n'
|
||||||
assert md(table_head_body) == '\n\n| Firstname | Lastname | Age |\n| --- | --- | --- |\n| Jill | Smith | 50 |\n| Eve | Jackson | 94 |\n\n'
|
assert md(table_head_body) == '\n\n| Firstname | Lastname | Age |\n| --- | --- | --- |\n| Jill | Smith | 50 |\n| Eve | Jackson | 94 |\n\n'
|
||||||
assert md(table_missing_text) == '\n\n| | Lastname | Age |\n| --- | --- | --- |\n| Jill | | 50 |\n| Eve | Jackson | 94 |\n\n'
|
assert md(table_missing_text) == '\n\n| | Lastname | Age |\n| --- | --- | --- |\n| Jill | | 50 |\n| Eve | Jackson | 94 |\n\n'
|
||||||
|
|||||||
Reference in New Issue
Block a user