summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2023-05-10 10:12:11 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2023-05-10 10:12:11 +0000
commit06113edd9fd4bd0998588aa33469de88b7e27acc (patch)
tree55bd08e1448b5216165f8c2c690fa1f85576b5be
parentb3287874799c9a605e59064669fdf95bde0aa191 (diff)
downloaddocutils-06113edd9fd4bd0998588aa33469de88b7e27acc.tar.gz
Fix some flake8 warnings in test scripts and remove flake8 exception rules.
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9378 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
-rw-r--r--.flake814
-rw-r--r--docutils/.flake814
-rwxr-xr-xdocutils/test/test_writers/test_latex2e.py9
-rw-r--r--docutils/test/test_writers/test_manpage.py18
4 files changed, 27 insertions, 28 deletions
diff --git a/.flake8 b/.flake8
index 0d6ffaa97..703d0c87d 100644
--- a/.flake8
+++ b/.flake8
@@ -55,16 +55,14 @@ per-file-ignores =
docutils/test/functional/tests/*:F821
# deprecated module, will be removed
docutils/test/test_error_reporting.py:E261
- # test output samples contain long lines
- # don't indent list delimiters in lists of test samples (multi-line strings)
- docutils/test/test_readers/test_pep/*:E122,E128,E501
+ # Lists with multi-line test output samples
+ # may contain long lines (E501)
+ # and are not indented (E122, E124, E128)
docutils/test/test_parsers/*:E122,E124,E128,E501
- docutils/test/test_writers/*:E122,E124,E128,E501
- docutils/test/test_transforms/*:E122,E124,E128,E501
docutils/test/test_publisher.py:E501
- # raw string test samples with trailing whitespace
- docutils/test/test_writers/test_manpage.py:E121,E128,E501,W291
- docutils/test/test_writers/test_latex2e.py:E122,E128,E501,W291,W293
+ docutils/test/test_readers/test_pep/*:E122,E128,E501
+ docutils/test/test_transforms/*:E122,E124,E128,E501
+ docutils/test/test_writers/*:E122,E124,E128,E501
# ignore long line in string templates
docutils/tools/dev/generate_punctuation_chars.py:E501
diff --git a/docutils/.flake8 b/docutils/.flake8
index c64281cdf..666f299c0 100644
--- a/docutils/.flake8
+++ b/docutils/.flake8
@@ -55,16 +55,14 @@ per-file-ignores =
test/functional/tests/*:F821
# deprecated module, will be removed
test/test_error_reporting.py:E261
- # test output samples contain long lines
- # don't indent list delimiters in lists of test samples (multi-line strings)
- test/test_readers/test_pep/*:E122,E128,E501
+ # Lists with multi-line test output samples
+ # may contain long lines (E501)
+ # and are not indented (E122, E124, E128)
test/test_parsers/*:E122,E124,E128,E501
- test/test_writers/*:E122,E124,E128,E501
- test/test_transforms/*:E122,E124,E128,E501
test/test_publisher.py:E501
- # raw string test samples with trailing whitespace
- test/test_writers/test_manpage.py:E121,E128,E501,W291
- test/test_writers/test_latex2e.py:E122,E128,E501,W291,W293
+ test/test_readers/test_pep/*:E122,E128,E501
+ test/test_transforms/*:E122,E124,E128,E501
+ test/test_writers/*:E122,E124,E128,E501
# ignore long line in string templates
tools/dev/generate_punctuation_chars.py:E501
diff --git a/docutils/test/test_writers/test_latex2e.py b/docutils/test/test_writers/test_latex2e.py
index d4ba94b3d..91c116b7e 100755
--- a/docutils/test/test_writers/test_latex2e.py
+++ b/docutils/test/test_writers/test_latex2e.py
@@ -53,7 +53,8 @@ class WriterPublishTestCase(unittest.TestCase):
settings['use_latex_toc'] = False
for name, cases in samples_docutils_toc.items():
for casenum, (rst_input, expected) in enumerate(cases):
- with self.subTest(id=f'samples_docutils_toc[{name!r}][{casenum}]'):
+ id = f'samples_docutils_toc[{name!r}][{casenum}]'
+ with self.subTest(id=id):
output = publish_string(source=rst_input,
writer_name=self.writer_name,
settings_overrides=settings)
@@ -129,7 +130,8 @@ class WriterPublishTestCase(unittest.TestCase):
settings['stylesheet_path'] = f'{spam},{ham}'
for name, cases in samples_stylesheet.items():
for casenum, (rst_input, expected) in enumerate(cases):
- with self.subTest(id=f'samples_link_stylesheet[{name!r}][{casenum}]'):
+ id = f'samples_link_stylesheet[{name!r}][{casenum}]'
+ with self.subTest(id=id):
output = publish_string(source=rst_input,
writer_name=self.writer_name,
settings_overrides=settings)
@@ -143,7 +145,8 @@ class WriterPublishTestCase(unittest.TestCase):
settings['warning_stream'] = ''
for name, cases in samples_stylesheet_embed.items():
for casenum, (rst_input, expected) in enumerate(cases):
- with self.subTest(id=f'samples_embed_stylesheet[{name!r}][{casenum}]'):
+ id = f'samples_embed_stylesheet[{name!r}][{casenum}]'
+ with self.subTest(id=id):
output = publish_string(source=rst_input,
writer_name=self.writer_name,
settings_overrides=settings)
diff --git a/docutils/test/test_writers/test_manpage.py b/docutils/test/test_writers/test_manpage.py
index 4cbb426e6..dc8dcfd8b 100644
--- a/docutils/test/test_writers/test_manpage.py
+++ b/docutils/test/test_writers/test_manpage.py
@@ -98,7 +98,7 @@ This broke docutils\\-sphinx.
.\\" Generated by docutils manpage writer.
.
"""],
- ]
+]
totest['simple'] = [
["""\
@@ -226,7 +226,7 @@ public domain
.\" Generated by docutils manpage writer.
.
"""],
- ]
+]
totest['table'] = [
["""\
@@ -329,7 +329,7 @@ bla bla bla
.\\" Generated by docutils manpage writer.
.
"""],
- ]
+]
totest['definitionlist'] = [
["""
@@ -373,7 +373,7 @@ Description of Term 1 Description of Term 1
.\\" Generated by docutils manpage writer.
.
'''],
- ]
+]
totest['cmdlineoptions'] = [
["""optional arguments:
@@ -404,7 +404,7 @@ input device
.\\" Generated by docutils manpage writer.
.
"""],
- ]
+]
totest['citation'] = [
[""".. [docutils] blah blah blah
@@ -421,7 +421,7 @@ blah blah blah
.\\" Generated by docutils manpage writer.
.
"""],
- ]
+]
totest['rubric'] = [
[""".. rubric:: some rubric
@@ -444,7 +444,7 @@ a list
.\\" Generated by docutils manpage writer.
.
"""],
- ]
+]
totest['double_quote'] = [
["""in "defintion list"
@@ -467,7 +467,7 @@ They are \\(dqescaped\\(dq anywhere.
.\\" Generated by docutils manpage writer.
.
"""],
- ]
+]
totest['man_header'] = [
["""
@@ -495,7 +495,7 @@ Test title, docinfo to man page header.
.\" Generated by docutils manpage writer.
.
"""],
- ]
+]
if __name__ == '__main__':