From b2939d23c2da001cf2322a72e730025e52ffcc55 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Sun, 5 Dec 2021 16:55:47 +0100 Subject: Cleanup: Remove deprecated stuff Remove deprecated "parser_kwargs" and "emitter_kwargs" --- README.creole | 1 + README.rst | 4 +- creole/__init__.py | 90 +++++++------------------------------ creole/rest_tools/clean_writer.py | 2 +- creole/setup_utils.py | 4 +- creole/tests/test_creole2html.py | 89 ++++++++++++++++-------------------- creole/tests/test_html2textile.py | 2 +- creole/tests/utils/base_unittest.py | 24 +++++----- 8 files changed, 73 insertions(+), 143 deletions(-) diff --git a/README.creole b/README.creole index 6d48583..c40a487 100644 --- a/README.creole +++ b/README.creole @@ -228,6 +228,7 @@ Note: In this case you must install **docutils**! See above. = history = * *dev* - [[https://github.com/jedie/python-creole/compare/v1.4.10...master|compare v1.4.10...master]] +** Remove deprecated "parser_kwargs" and "emitter_kwargs" ** TBC * v1.4.10 - 2021-05-11 - [[https://github.com/jedie/python-creole/compare/v1.4.9...v1.4.10|compare v1.4.9...v1.4.10]] ** Update some string formatting to f-strings diff --git a/README.rst b/README.rst index 34188bd..23086ef 100644 --- a/README.rst +++ b/README.rst @@ -297,6 +297,8 @@ history * *dev* - `compare v1.4.10...master `_ + * Remove deprecated "parser_kwargs" and "emitter_kwargs" + * TBC * v1.4.10 - 2021-05-11 - `compare v1.4.9...v1.4.10 `_ @@ -700,4 +702,4 @@ donation ------------ -``Note: this file is generated from README.creole 2021-05-11 16:58:01 with "python-creole"`` \ No newline at end of file +``Note: this file is generated from README.creole 2021-12-05 16:58:04 with "python-creole"`` \ No newline at end of file diff --git a/creole/__init__.py b/creole/__init__.py index 1ed7752..4c22c25 100644 --- a/creole/__init__.py +++ b/creole/__init__.py @@ -31,7 +31,6 @@ API_STRING = __api__ # remove in future def creole2html(markup_string, debug=False, - parser_kwargs=None, emitter_kwargs=None, block_rules=None, blog_line_breaks=True, macros=None, verbose=None, stderr=None, strict=False, @@ -46,36 +45,24 @@ def creole2html(markup_string, debug=False, """ assert isinstance(markup_string, str), "given markup_string must be unicode!" - parser_kwargs2 = { - "block_rules": block_rules, - "blog_line_breaks": blog_line_breaks, - "debug": debug, - } - if parser_kwargs is not None: - warnings.warn( - "parser_kwargs argument in creole2html would be removed in the future!", - PendingDeprecationWarning) - parser_kwargs2.update(parser_kwargs) - # Create document tree from creole markup - document = CreoleParser(markup_string, **parser_kwargs2).parse() + document = CreoleParser( + markup_string, + block_rules=block_rules, + blog_line_breaks=blog_line_breaks, + debug=debug + ).parse() if debug: document.debug() - emitter_kwargs2 = { - "macros": macros, - "verbose": verbose, - "stderr": stderr, - "strict": strict, - } - if emitter_kwargs is not None: - warnings.warn( - "emitter_kwargs argument in creole2html would be removed in the future!", - PendingDeprecationWarning) - emitter_kwargs2.update(emitter_kwargs) - # Build html code from document tree - return HtmlEmitter(document, **emitter_kwargs2).emit() + return HtmlEmitter( + document, + macros=macros, + verbose=verbose, + stderr=stderr, + strict=strict + ).emit() def parse_html(html_string, debug=False): @@ -92,8 +79,6 @@ def parse_html(html_string, debug=False): def html2creole( html_string, debug=False, - parser_kwargs=None, - emitter_kwargs=None, unknown_emit=None, strict=False, ): @@ -103,30 +88,14 @@ def html2creole( >>> html2creole('

This is creole markup!

') 'This is **creole //markup//**!' """ - if parser_kwargs is not None: - warnings.warn( - "parser_kwargs argument in html2creole would be removed in the future!", - PendingDeprecationWarning) - document_tree = parse_html(html_string, debug=debug) - emitter_kwargs2 = { - "unknown_emit": unknown_emit, - "strict": strict, - } - if emitter_kwargs is not None: - warnings.warn( - "emitter_kwargs argument in html2creole would be removed in the future!", - PendingDeprecationWarning) - emitter_kwargs2.update(emitter_kwargs) - # create creole markup from the document tree - emitter = CreoleEmitter(document_tree, debug=debug, **emitter_kwargs2) + emitter = CreoleEmitter(document_tree, debug=debug, unknown_emit=unknown_emit, strict=strict) return emitter.emit() def html2textile(html_string, debug=False, - parser_kwargs=None, emitter_kwargs=None, unknown_emit=None ): """ @@ -135,29 +104,14 @@ def html2textile(html_string, debug=False, >>> html2textile('

This is textile markup!

') 'This is *textile __markup__*!' """ - if parser_kwargs is not None: - warnings.warn( - "parser_kwargs argument in html2textile would be removed in the future!", - PendingDeprecationWarning) - document_tree = parse_html(html_string, debug=debug) - emitter_kwargs2 = { - "unknown_emit": unknown_emit, - } - if emitter_kwargs is not None: - warnings.warn( - "emitter_kwargs argument in html2textile would be removed in the future!", - PendingDeprecationWarning) - emitter_kwargs2.update(emitter_kwargs) - # create textile markup from the document tree - emitter = TextileEmitter(document_tree, debug=debug, **emitter_kwargs2) + emitter = TextileEmitter(document_tree, debug=debug, unknown_emit=unknown_emit) return emitter.emit() def html2rest(html_string, debug=False, - parser_kwargs=None, emitter_kwargs=None, unknown_emit=None ): """ @@ -166,20 +120,8 @@ def html2rest(html_string, debug=False, >>> html2rest('

This is ReStructuredText markup!

') 'This is **ReStructuredText** *markup*!' """ - if parser_kwargs is not None: - warnings.warn("parser_kwargs argument in html2rest would be removed in the future!", PendingDeprecationWarning) - document_tree = parse_html(html_string, debug=debug) - emitter_kwargs2 = { - "unknown_emit": unknown_emit, - } - if emitter_kwargs is not None: - warnings.warn( - "emitter_kwargs argument in html2rest would be removed in the future!", - PendingDeprecationWarning) - emitter_kwargs2.update(emitter_kwargs) - # create ReStructuredText markup from the document tree - emitter = ReStructuredTextEmitter(document_tree, debug=debug, **emitter_kwargs2) + emitter = ReStructuredTextEmitter(document_tree, debug=debug, unknown_emit=unknown_emit) return emitter.emit() diff --git a/creole/rest_tools/clean_writer.py b/creole/rest_tools/clean_writer.py index ca69f22..bb46a49 100644 --- a/creole/rest_tools/clean_writer.py +++ b/creole/rest_tools/clean_writer.py @@ -42,7 +42,7 @@ DEBUG = False #DEBUG = True IGNORE_ATTR = ( - "start", "class", "frame", "rules", + "start", "class", "classes", "frame", "rules", ) IGNORE_TAGS = ( "div", diff --git a/creole/setup_utils.py b/creole/setup_utils.py index 7beccfd..b2e4dbb 100644 --- a/creole/setup_utils.py +++ b/creole/setup_utils.py @@ -113,9 +113,7 @@ def _generate_rst_readme(*, creole_readme_path): # convert html to ReSt rest_readme = html2rest( html_readme, - emitter_kwargs={ - 'unknown_emit': raise_unknown_node # raise a error if a unknown node found - } + unknown_emit=raise_unknown_node # raise a error if a unknown node found ) # Check if generated ReSt is valid, see also: diff --git a/creole/tests/test_creole2html.py b/creole/tests/test_creole2html.py index 0c36170..7824742 100644 --- a/creole/tests/test_creole2html.py +++ b/creole/tests/test_creole2html.py @@ -48,10 +48,8 @@ class TestCreole2html(BaseCreoleTest): my_stderr = StringIO() creole2html( markup_string="<><><>", - emitter_kwargs={ - "verbose": 2, - "stderr": my_stderr, - } + verbose=2, + stderr=my_stderr, ) error_msg = my_stderr.getvalue() @@ -78,33 +76,27 @@ class TestCreole2html(BaseCreoleTest): """ html = creole2html( markup_string="<>

foo

<>", - emitter_kwargs={ - "verbose": 1, - "macros": example_macros, - "stderr": sys.stderr, - } + verbose=1, + macros=example_macros, + stderr=sys.stderr, ) self.assertEqual(html, '

foo

\n

<bar?>

') def test_example_macros2(self): html = creole2html( markup_string="<>{{{<nocode>}}}<>", - emitter_kwargs={ - "verbose": 1, - "macros": example_macros, - "stderr": sys.stderr, - } + verbose=1, + macros=example_macros, + stderr=sys.stderr, ) self.assertEqual(html, '{{{<nocode>}}}') def test_example_macros3(self): html = creole2html( markup_string="<>1<><>2<>", - emitter_kwargs={ - "verbose": 1, - "macros": example_macros, - "stderr": sys.stderr, - } + verbose=1, + macros=example_macros, + stderr=sys.stderr, ) self.assertEqual(html, '1\n2') @@ -117,11 +109,9 @@ class TestCreole2html(BaseCreoleTest): html = creole2html( markup_string="<>c<>", - emitter_kwargs={ - "verbose": 1, - "macros": {"test": test}, - "stderr": sys.stderr, - } + verbose=1, + macros={"test": test}, + stderr=sys.stderr, ) self.assertEqual(html, 'a|b|c') @@ -132,15 +122,14 @@ class TestCreole2html(BaseCreoleTest): def testmacro(): pass - self.assertRaises(TypeError, - creole2html, - markup_string="<>bar<>", - emitter_kwargs={ - "verbose": 1, - "macros": testmacro, - "stderr": sys.stderr, - } - ) + self.assertRaises( + TypeError, + creole2html, + markup_string="<>bar<>", + verbose=1, + macros=testmacro, + stderr=sys.stderr, + ) def test_macro_wrong_arguments_with_error_report(self): """ @@ -152,15 +141,14 @@ class TestCreole2html(BaseCreoleTest): html = creole2html( markup_string="<>c<>", - emitter_kwargs={ - "verbose": 2, - "macros": {"test": test}, - "stderr": my_stderr, - } + verbose=2, + macros={"test": test}, + stderr=my_stderr, + ) + self.assertEqual( + html, + "[Error: Macro 'test' error: test() got an unexpected keyword argument 'bar']" ) - self.assertEqual(html, - "[Error: Macro 'test' error: test() got an unexpected keyword argument 'bar']" - ) error_msg = my_stderr.getvalue() # Check traceback information into our stderr handler @@ -182,15 +170,14 @@ class TestCreole2html(BaseCreoleTest): html = creole2html( markup_string="<>c<>", - emitter_kwargs={ - "verbose": 1, - "macros": {"test": test}, - "stderr": my_stderr, - } + verbose=1, + macros={"test": test}, + stderr=my_stderr, + ) + self.assertEqual( + html, + "[Error: Macro 'test' error: test() got an unexpected keyword argument 'bar']" ) - self.assertEqual(html, - "[Error: Macro 'test' error: test() got an unexpected keyword argument 'bar']" - ) error_msg = my_stderr.getvalue() self.assertEqual(error_msg, "") @@ -210,8 +197,8 @@ class TestCreole2html(BaseCreoleTest): print('hello world')

""", - macros={'code': example_macros.code} - ) + macros={'code': example_macros.code} + ) def test_code_macro_fallback(self): # force to use fallback. Will be reset in self.setUp() diff --git a/creole/tests/test_html2textile.py b/creole/tests/test_html2textile.py index 3da6805..6377f01 100644 --- a/creole/tests/test_html2textile.py +++ b/creole/tests/test_html2textile.py @@ -51,7 +51,7 @@ class TextileTests(BaseCreoleTest):

555666

""", - emitter_kwargs={"unknown_emit": preformat_unknown_nodes} + unknown_emit=preformat_unknown_nodes ) def test_transparent_unknown_nodes(self): diff --git a/creole/tests/utils/base_unittest.py b/creole/tests/utils/base_unittest.py index f6a4ee3..e97fac5 100644 --- a/creole/tests/utils/base_unittest.py +++ b/creole/tests/utils/base_unittest.py @@ -192,7 +192,7 @@ class BaseCreoleTest(MarkupTest): ) def assert_html2textile(self, textile_string, html_string, - strip_lines=False, debug=False, parser_kwargs={}, emitter_kwargs={}): + strip_lines=False, debug=False, **kwargs): """ Check html2textile """ @@ -205,7 +205,7 @@ class BaseCreoleTest(MarkupTest): html_string = strip_html_lines(html_string, strip_lines) # compare html -> textile - textile_string2 = html2textile(html_string, debug, parser_kwargs, emitter_kwargs) + textile_string2 = html2textile(html_string, debug, **kwargs) if debug: print("-" * 79) print(textile_string2) @@ -216,7 +216,7 @@ class BaseCreoleTest(MarkupTest): return textile_string, html_string def cross_compare_textile(self, textile_string, html_string, - strip_lines=False, debug=False, parser_kwargs={}, emitter_kwargs={}): + strip_lines=False, debug=False, **kwargs): """ Checks: * html2textile @@ -229,7 +229,7 @@ class BaseCreoleTest(MarkupTest): # compare html -> textile textile_string, html_string = self.assert_html2textile( textile_string, html_string, - strip_lines, debug, parser_kwargs, emitter_kwargs + strip_lines, debug, **kwargs ) # compare textile -> html @@ -242,7 +242,7 @@ class BaseCreoleTest(MarkupTest): self.assertEqual(html_string, html, msg="textile2html") def assert_html2rest(self, rest_string, html_string, - strip_lines=False, debug=False, parser_kwargs={}, emitter_kwargs={}): + strip_lines=False, debug=False, **kwargs): """ Check html to reStructuredText converter """ @@ -258,7 +258,7 @@ class BaseCreoleTest(MarkupTest): print(html_string) # compare html -> reStructuredText - rest_string2 = html2rest(html_string, debug, parser_kwargs, emitter_kwargs) + rest_string2 = html2rest(html_string, debug, **kwargs) print("-" * 100) print(rest_string2) print("-" * 100) @@ -291,14 +291,14 @@ class BaseCreoleTest(MarkupTest): self.assertEqual(html, html_string, msg="rest2html") def cross_compare_rest(self, rest_string, html_string, - strip_lines=False, debug=False, parser_kwargs={}, emitter_kwargs={}): + strip_lines=False, debug=False, **kwargs): # assert isinstance(textile_string, str) # assert isinstance(html_string, str) self.assertNotEqual(rest_string, html_string) rest_string, html_string = self.assert_html2rest( rest_string, html_string, - strip_lines, debug, parser_kwargs, emitter_kwargs + strip_lines, debug, **kwargs ) # compare rest -> html @@ -313,7 +313,7 @@ class BaseCreoleTest(MarkupTest): creole_string=None, textile_string=None, rest_string=None, - strip_lines=False, debug=False, parser_kwargs={}, emitter_kwargs={}): + strip_lines=False, debug=False, **kwargs): """ Cross compare with: * creole2html @@ -323,17 +323,17 @@ class BaseCreoleTest(MarkupTest): """ if creole_string: self.cross_compare_creole( - creole_string, html_string, strip_lines, debug, parser_kwargs, emitter_kwargs + creole_string, html_string, strip_lines, debug, **kwargs ) if textile_string: self.cross_compare_textile( - textile_string, html_string, strip_lines, debug, parser_kwargs, emitter_kwargs + textile_string, html_string, strip_lines, debug, **kwargs ) if rest_string: self.cross_compare_rest( - rest_string, html_string, strip_lines, debug, parser_kwargs, emitter_kwargs + rest_string, html_string, strip_lines, debug, **kwargs ) -- cgit v1.2.1