fix github action to work with tox

README.rst

@@ -156,12 +156,7 @@ Creating Custom Converters
 
 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
-change.
-The function that handles a HTML tag named ``abc`` is called
-``convert_abc(self, el, text, convert_as_inline)`` and returns a string
-containing the converted HTML tag.
-The ``MarkdownConverter`` object will handle the conversion based on the
-function names:
+change:
 
 .. code:: python
 
@@ -178,24 +173,9 @@ function names:
     def md(html, **options):
         return ImageBlockConverter(**options).convert(html)
 
-.. code:: python
-
-    from markdownify import MarkdownConverter
-
-    class IgnoreParagraphsConverter(MarkdownConverter):
-        """
-        Create a custom MarkdownConverter that ignores paragraphs
-        """
-        def convert_p(self, el, text, convert_as_inline):
-            return ''
-
-    # Create shorthand method for conversion
-    def md(html, **options):
-        return IgnoreParagraphsConverter(**options).convert(html)
-
 
 Command Line Interface
-======================
+=====================
 
 Use ``markdownify example.html > example.md`` or pipe input from stdin
 (``cat example.html | markdownify > example.md``).

markdownify/__init__.py

@@ -152,12 +152,13 @@ class MarkdownConverter(object):
     def process_text(self, el):
         text = six.text_type(el) or ''
 
-        # normalize whitespace if we're not inside a preformatted element
-        if not el.find_parent('pre'):
+        # dont remove any whitespace when handling pre or code in pre
+        if not (el.parent.name == 'pre'
+                or (el.parent.name == 'code'
+                    and el.parent.parent.name == 'pre')):
             text = whitespace_re.sub(' ', text)
 
-        # escape special characters if we're not inside a preformatted or code element
-        if not el.find_parent(['pre', 'code', 'kbd', 'samp']):
+        if el.parent.name != 'code' and el.parent.name != 'pre':
             text = self.escape(text)
 
         # remove trailing whitespaces if any of the following condition is true:
@@ -237,7 +238,7 @@ class MarkdownConverter(object):
         if convert_as_inline:
             return text
 
-        return '\n' + (line_beginning_re.sub('> ', text.strip()) + '\n\n') if text else ''
+        return '\n' + (line_beginning_re.sub('> ', text) + '\n\n') if text else ''
 
     def convert_br(self, el, text, convert_as_inline):
         if convert_as_inline:
@@ -265,7 +266,7 @@ class MarkdownConverter(object):
             return text
 
         style = self.options['heading_style'].lower()
-        text = text.strip()
+        text = text.rstrip()
         if style == UNDERLINED and n <= 2:
             line = '=' if n == 1 else '-'
             return self.underline(text, line)
@@ -350,12 +351,6 @@ class MarkdownConverter(object):
 
         return '\n```%s\n%s\n```\n' % (code_language, text)
 
-    def convert_script(self, el, text, convert_as_inline):
-        return ''
-
-    def convert_style(self, el, text, convert_as_inline):
-        return ''
-
     convert_s = convert_del
 
     convert_strong = convert_b
@@ -369,42 +364,20 @@ class MarkdownConverter(object):
     def convert_table(self, el, text, convert_as_inline):
         return '\n\n' + text + '\n'
 
-    def convert_caption(self, el, text, convert_as_inline):
-        return text + '\n'
-
-    def convert_figcaption(self, el, text, convert_as_inline):
-        return '\n\n' + text + '\n\n'
-
     def convert_td(self, el, text, convert_as_inline):
-        colspan = 1
-        if 'colspan' in el.attrs:
-            colspan = int(el['colspan'])
-        return ' ' + text.strip().replace("\n", " ") + ' |' * colspan
+        return ' ' + text + ' |'
 
     def convert_th(self, el, text, convert_as_inline):
-        colspan = 1
-        if 'colspan' in el.attrs:
-            colspan = int(el['colspan'])
-        return ' ' + text.strip().replace("\n", " ") + ' |' * colspan
+        return ' ' + text + ' |'
 
     def convert_tr(self, el, text, convert_as_inline):
         cells = el.find_all(['td', 'th'])
-        is_headrow = (
-            all([cell.name == 'th' for cell in cells])
-            or (not el.previous_sibling and not el.parent.name == 'tbody')
-            or (not el.previous_sibling and el.parent.name == 'tbody' and len(el.parent.parent.find_all(['thead'])) < 1)
-        )
+        is_headrow = all([cell.name == 'th' for cell in cells])
         overline = ''
         underline = ''
         if is_headrow and not el.previous_sibling:
             # first row and is headline: print headline underline
-            full_colspan = 0
-            for cell in cells:
-                if "colspan" in cell.attrs:
-                    full_colspan += int(cell["colspan"])
-                else:
-                    full_colspan += 1
-            underline += '| ' + ' | '.join(['---'] * full_colspan) + ' |' + '\n'
+            underline += '| ' + ' | '.join(['---'] * len(cells)) + ' |' + '\n'
         elif (not el.previous_sibling
               and (el.parent.name == 'table'
                    or (el.parent.name == 'tbody'

markdownify/main.py

@@ -3,8 +3,7 @@
 import argparse
 import sys
 
-from markdownify import markdownify, ATX, ATX_CLOSED, UNDERLINED, \
-    SPACES, BACKSLASH, ASTERISK, UNDERSCORE
+from markdownify import markdownify
 
 
 def main(argv=sys.argv[1:]):
@@ -29,23 +28,16 @@ def main(argv=sys.argv[1:]):
     parser.add_argument('--default-title', action='store_false',
                         help="A boolean to enable setting the title of a link to its "
                         "href, if no title is given.")
-    parser.add_argument('--heading-style', default=UNDERLINED,
-                        choices=(ATX, ATX_CLOSED, UNDERLINED),
+    parser.add_argument('--heading-style',
+                        choices=('ATX', 'ATX_CLOSED', 'SETEXT', 'UNDERLINED'),
                         help="Defines how headings should be converted.")
     parser.add_argument('-b', '--bullets', default='*+-',
                         help="A string of bullet styles to use; the bullet will "
                         "alternate based on nesting level.")
-    parser.add_argument('--strong-em-symbol', default=ASTERISK,
-                        choices=(ASTERISK, UNDERSCORE),
-                        help="Use * or _ to convert strong and italics text"),
     parser.add_argument('--sub-symbol', default='',
                         help="Define the chars that surround '<sub>'.")
     parser.add_argument('--sup-symbol', default='',
                         help="Define the chars that surround '<sup>'.")
-    parser.add_argument('--newline-style', default=SPACES,
-                        choices=(SPACES, BACKSLASH),
-                        help="Defines the style of <br> conversions: two spaces "
-                        "or backslash at the and of the line thet should break.")
     parser.add_argument('--code-language', default='',
                         help="Defines the language that should be assumed for all "
                         "'<pre>' sections.")

setup.py

@@ -9,7 +9,7 @@ read = lambda filepath: codecs.open(filepath, 'r', 'utf-8').read()
 pkgmeta = {
     '__title__': 'markdownify',
     '__author__': 'Matthew Tretter',
-    '__version__': '0.12.1',
+    '__version__': '0.11.2',
 }
 
 read = lambda filepath: codecs.open(filepath, 'r', 'utf-8').read()

shell.nix

@@ -1,10 +0,0 @@
-{ pkgs ? import <nixpkgs> {} }:
-pkgs.mkShell {
-  name = "python-shell";
-  buildInputs = with pkgs; [
-    python38
-    python38Packages.tox
-    python38Packages.setuptools
-    python38Packages.virtualenv
-  ];
-}

tests/test_conversions.py

@@ -52,12 +52,6 @@ def test_b_spaces():
 
 def test_blockquote():
     assert md('<blockquote>Hello</blockquote>') == '\n> Hello\n\n'
-    assert md('<blockquote>\nHello\n</blockquote>') == '\n> Hello\n\n'
-
-
-def test_blockquote_with_nested_paragraph():
-    assert md('<blockquote><p>Hello</p></blockquote>') == '\n> Hello\n\n'
-    assert md('<blockquote><p>Hello</p><p>Hello again</p></blockquote>') == '\n> Hello\n> \n> Hello again\n\n'
 
 
 def test_blockquote_with_paragraph():
@@ -66,7 +60,7 @@ def test_blockquote_with_paragraph():
 
 def test_blockquote_nested():
     text = md('<blockquote>And she was like <blockquote>Hello</blockquote></blockquote>')
-    assert text == '\n> And she was like \n> > Hello\n\n'
+    assert text == '\n> And she was like \n> > Hello\n> \n> \n\n'
 
 
 def test_br():
@@ -74,19 +68,9 @@ def test_br():
     assert md('a<br />b<br />c', newline_style=BACKSLASH) == 'a\\\nb\\\nc'
 
 
-def test_caption():
-    assert md('TEXT<figure><figcaption>Caption</figcaption><span>SPAN</span></figure>') == 'TEXT\n\nCaption\n\nSPAN'
-    assert md('<figure><span>SPAN</span><figcaption>Caption</figcaption></figure>TEXT') == 'SPAN\n\nCaption\n\nTEXT'
-
-
 def test_code():
     inline_tests('code', '`')
-    assert md('<code>*this_should_not_escape*</code>') == '`*this_should_not_escape*`'
-    assert md('<kbd>*this_should_not_escape*</kbd>') == '`*this_should_not_escape*`'
-    assert md('<samp>*this_should_not_escape*</samp>') == '`*this_should_not_escape*`'
-    assert md('<code><span>*this_should_not_escape*</span></code>') == '`*this_should_not_escape*`'
-    assert md('<code>this  should\t\tnormalize</code>') == '`this should normalize`'
-    assert md('<code><span>this  should\t\tnormalize</span></code>') == '`this should normalize`'
+    assert md('<code>this_should_not_escape</code>') == '`this_should_not_escape`'
 
 
 def test_del():
@@ -101,14 +85,6 @@ def test_em():
     inline_tests('em', '*')
 
 
-def test_header_with_space():
-    assert md('<h3>\n\nHello</h3>') == '### Hello\n\n'
-    assert md('<h4>\n\nHello</h4>') == '#### Hello\n\n'
-    assert md('<h5>\n\nHello</h5>') == '##### Hello\n\n'
-    assert md('<h5>\n\nHello\n\n</h5>') == '##### Hello\n\n'
-    assert md('<h5>\n\nHello   \n\n</h5>') == '##### Hello\n\n'
-
-
 def test_h1():
     assert md('<h1>Hello</h1>') == 'Hello\n=====\n\n'
 
@@ -211,18 +187,7 @@ def test_p():
 def test_pre():
     assert md('<pre>test\n    foo\nbar</pre>') == '\n```\ntest\n    foo\nbar\n```\n'
     assert md('<pre><code>test\n    foo\nbar</code></pre>') == '\n```\ntest\n    foo\nbar\n```\n'
-    assert md('<pre>*this_should_not_escape*</pre>') == '\n```\n*this_should_not_escape*\n```\n'
-    assert md('<pre><span>*this_should_not_escape*</span></pre>') == '\n```\n*this_should_not_escape*\n```\n'
-    assert md('<pre>\t\tthis  should\t\tnot  normalize</pre>') == '\n```\n\t\tthis  should\t\tnot  normalize\n```\n'
-    assert md('<pre><span>\t\tthis  should\t\tnot  normalize</span></pre>') == '\n```\n\t\tthis  should\t\tnot  normalize\n```\n'
-
-
-def test_script():
-    assert md('foo <script>var foo=42;</script> bar') == 'foo  bar'
-
-
-def test_style():
-    assert md('foo <style>h1 { font-size: larger }</style> bar') == 'foo  bar'
+    assert md('<pre>this_should_not_escape</pre>') == '\n```\nthis_should_not_escape\n```\n'
 
 
 def test_s():

tests/test_tables.py

@@ -57,26 +57,6 @@ table_with_paragraphs = """<table>
     </tr>
 </table>"""
 
-table_with_linebreaks = """<table>
-    <tr>
-        <th>Firstname</th>
-        <th>Lastname</th>
-        <th>Age</th>
-    </tr>
-    <tr>
-        <td>Jill</td>
-        <td>Smith
-        Jackson</td>
-        <td>50</td>
-    </tr>
-    <tr>
-        <td>Eve</td>
-        <td>Jackson
-        Smith</td>
-        <td>94</td>
-    </tr>
-</table>"""
-
 
 table_with_header_column = """<table>
     <tr>
@@ -119,28 +99,6 @@ table_head_body = """<table>
     </tbody>
 </table>"""
 
-table_head_body_missing_head = """<table>
-    <thead>
-        <tr>
-            <td>Firstname</td>
-            <td>Lastname</td>
-            <td>Age</td>
-        </tr>
-    </thead>
-    <tbody>
-        <tr>
-            <td>Jill</td>
-            <td>Smith</td>
-            <td>50</td>
-        </tr>
-        <tr>
-            <td>Eve</td>
-            <td>Jackson</td>
-            <td>94</td>
-        </tr>
-    </tbody>
-</table>"""
-
 table_missing_text = """<table>
     <thead>
         <tr>
@@ -201,42 +159,13 @@ table_body = """<table>
     </tbody>
 </table>"""
 
-table_with_caption = """TEXT<table><caption>Caption</caption>
-    <tbody><tr><td>Firstname</td>
-            <td>Lastname</td>
-            <td>Age</td>
-        </tr>
-    </tbody>
-</table>"""
-
-table_with_colspan = """<table>
-    <tr>
-        <th colspan="2">Name</th>
-        <th>Age</th>
-    </tr>
-    <tr>
-        <td>Jill</td>
-        <td>Smith</td>
-        <td>50</td>
-    </tr>
-    <tr>
-        <td>Eve</td>
-        <td>Jackson</td>
-        <td>94</td>
-    </tr>
-</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_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_linebreaks) == '\n\n| Firstname | Lastname | Age |\n| --- | --- | --- |\n| Jill | Smith  Jackson | 50 |\n| Eve | Jackson  Smith | 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_missing_head) == '\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_head) == '\n\n| Firstname | Lastname | Age |\n| --- | --- | --- |\n| Jill | Smith | 50 |\n| Eve | Jackson | 94 |\n\n'
-    assert md(table_body) == '\n\n| Firstname | Lastname | Age |\n| --- | --- | --- |\n| Jill | Smith | 50 |\n| Eve | Jackson | 94 |\n\n'
-    assert md(table_with_caption) == 'TEXT\n\nCaption\n| Firstname | Lastname | Age |\n| --- | --- | --- |\n\n'
-    assert md(table_with_colspan) == '\n\n| Name | | Age |\n| --- | --- | --- |\n| Jill | Smith | 50 |\n| Eve | Jackson | 94 |\n\n'
+    assert md(table_missing_head) == '\n\n|  |  |  |\n| --- | --- | --- |\n| Firstname | Lastname | Age |\n| Jill | Smith | 50 |\n| Eve | Jackson | 94 |\n\n'
+    assert md(table_body) == '\n\n|  |  |  |\n| --- | --- | --- |\n| Firstname | Lastname | Age |\n| Jill | Smith | 50 |\n| Eve | Jackson | 94 |\n\n'

tox.ini

@@ -2,14 +2,9 @@
 envlist = py38
 
 [testenv]
-passenv = PYTHONPATH
 deps =
-	pytest
 	flake8
-	restructuredtext_lint
-	Pygments
-commands =
 	pytest
+commands =
 	flake8 --ignore=E501,W503 markdownify tests
-	restructuredtext-lint README.rst
-
+	pytest