Ensure at least two spaces before inline comment.

flake 8 rule E261

Exceptions for modules sheduled for removal or with
3rd-party origin and for data collections.

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9021 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

26 files changed, 48 insertions, 52 deletions

diff --git a/docutils/test/DocutilsTestSupport.py b/docutils/test/DocutilsTestSupport.py
index 6a33207cd..404771cfe 100644
--- a/docutils/test/DocutilsTestSupport.py
+++ b/docutils/test/DocutilsTestSupport.py
@@ -142,7 +142,7 @@ class CustomTestCase(StandardTestCase):
 
     Note: the modified signature is incompatible with
     the "pytest" and "nose" frameworks.
-    """ # cf. feature-request #81
+    """  # cf. feature-request #81
 
     compare = difflib.Differ().compare
     """Comparison method shared by all subclasses."""
@@ -262,7 +262,7 @@ class CustomTestSuite(unittest.TestSuite):
             if not mydir:
                 mydir = os.curdir
             if callerpath.startswith(mydir):
-                self.id = callerpath[len(mydir) + 1:] # caller's module
+                self.id = callerpath[len(mydir) + 1:]  # caller's module
             else:
                 self.id = callerpath
         else:
@@ -662,7 +662,7 @@ class WriterPublishTestCase(CustomTestCase, docutils.SettingsSpec):
 
     settings_default_overrides = {'_disable_config': True,
                                   'strict_visitor': True}
-    writer_name = '' # set in subclasses or constructor
+    writer_name = ''  # set in subclasses or constructor
 
     def __init__(self, *args, writer_name='', **kwargs):
         if writer_name:
diff --git a/docutils/test/functional/tests/field_name_limit.py b/docutils/test/functional/tests/field_name_limit.py
index af66c4ddd..3a2611c5d 100644
--- a/docutils/test/functional/tests/field_name_limit.py
+++ b/docutils/test/functional/tests/field_name_limit.py
@@ -8,7 +8,7 @@ parser_name = "rst"
 writer_name = "html"
 
 # Settings
-settings_overrides['field_name_limit'] = 0 # no limit
+settings_overrides['field_name_limit'] = 0  # no limit
 settings_overrides['docinfo_xform'] = False
 # local copy of stylesheets:
 # (Test runs in ``docutils/test/``, we need relative path from there.)
diff --git a/docutils/test/test_command_line.py b/docutils/test/test_command_line.py
index 296e4075e..7453eaf22 100644
--- a/docutils/test/test_command_line.py
+++ b/docutils/test/test_command_line.py
@@ -12,7 +12,7 @@ import locale
 import sys
 import unittest
 
-import DocutilsTestSupport # must be imported before docutils
+import DocutilsTestSupport  # must be imported before docutils
 import docutils.core
 
 # determine/guess the encoding of the standard input:
@@ -31,16 +31,16 @@ except LookupError:
 class CommandLineEncodingTests(unittest.TestCase):
 
     def test_sys_argv_decoding(self):
-        if argv_encoding == 'ascii': # cannot test
+        if argv_encoding == 'ascii':  # cannot test
             return
-        sys.argv.append('--source-url=test.txt') # pure ASCII argument
+        sys.argv.append('--source-url=test.txt')  # pure ASCII argument
         sys.argv.append('--title=Dornröschen')
         publisher = docutils.core.Publisher()
         publisher.process_command_line()
         self.assertEqual(publisher.settings.source_url, 'test.txt')
         self.assertEqual(publisher.settings.title, 'Dornröschen')
-        sys.argv.pop() # --title
-        sys.argv.pop() # --source-url
+        sys.argv.pop()  # --title
+        sys.argv.pop()  # --source-url
 
 
 if __name__ == '__main__':
diff --git a/docutils/test/test_functional.py b/docutils/test/test_functional.py
index 66f02c3b6..a6135da14 100755
--- a/docutils/test/test_functional.py
+++ b/docutils/test/test_functional.py
@@ -98,7 +98,7 @@ expected output and check it in:
 
         Note: the modified signature is incompatible with
         the "pytest" and "nose" frameworks.
-        """ # cf. feature-request #81
+        """  # cf. feature-request #81
 
         assert configfile is not None, 'required argument'
         self.configfile = configfile
diff --git a/docutils/test/test_io.py b/docutils/test/test_io.py
index 8798b9d78..7efbe5717 100755
--- a/docutils/test/test_io.py
+++ b/docutils/test/test_io.py
@@ -66,8 +66,8 @@ class HelperTests(unittest.TestCase):
         self.assertEqual(io.check_encoding(mock_stdout, 'UTF-9'), None)
 
     def test_error_string(self):
-        us = '\xfc'      # bytes(us) fails
-        bs = b'\xc3\xbc' # str(bs) returns repr(bs)
+        us = '\xfc'       # bytes(us) fails
+        bs = b'\xc3\xbc'  # str(bs) returns repr(bs)
 
         self.assertEqual('Exception: spam',
                          io.error_string(Exception('spam')))
@@ -224,7 +224,7 @@ class ErrorOutputTests(unittest.TestCase):
         self.assertEqual(e.destination, sys.stderr)
 
     def test_bbuf(self):
-        buf = BBuf() # buffer storing byte string
+        buf = BBuf()  # buffer storing byte string
         e = io.ErrorOutput(buf, encoding='ascii')
         # write byte-string as-is
         e.write(b'b\xfc')
@@ -242,11 +242,12 @@ class ErrorOutputTests(unittest.TestCase):
         self.assertEqual(buf.getvalue(), b'b\xfc u\\xfc e\\xfc u\xc3\xbc')
 
     def test_ubuf(self):
-        buf = UBuf() # buffer only accepting unicode string
+        buf = UBuf()  # buffer only accepting unicode string
         # decode of binary strings
         e = io.ErrorOutput(buf, encoding='ascii')
         e.write(b'b\xfc')
-        self.assertEqual(buf.getvalue(), 'b\ufffd') # use REPLACEMENT CHARACTER
+        # use REPLACEMENT CHARACTER
+        self.assertEqual(buf.getvalue(), 'b\ufffd')
         # write Unicode string and Exceptions with Unicode args
         e.write(' u\xfc')
         self.assertEqual(buf.getvalue(), 'b\ufffd u\xfc')
diff --git a/docutils/test/test_language.py b/docutils/test/test_language.py
index c3ca25f7d..4dbec4dfb 100755
--- a/docutils/test/test_language.py
+++ b/docutils/test/test_language.py
@@ -81,7 +81,7 @@ class LanguageTestCase(DocutilsTestSupport.CustomTestCase):
 
         Note: the modified signature is incompatible with
         the "pytest" and "nose" frameworks.
-        """ # cf. feature-request #81
+        """  # cf. feature-request #81
 
         self.ref = docutils.languages.get_language(reference_language,
                                                    _reporter)
diff --git a/docutils/test/test_nodes.py b/docutils/test/test_nodes.py
index d1c9e998f..3a8723d51 100755
--- a/docutils/test/test_nodes.py
+++ b/docutils/test/test_nodes.py
@@ -640,9 +640,9 @@ class SetIdTests(unittest.TestCase):
     def setUp(self):
         self.document = utils.new_document('test')
         self.elements = [nodes.Element(names=['test']),
-                         nodes.section(), # Name empty
-                         nodes.section(names=['Test']), # duplicate id
-                         nodes.footnote(names=['2019-10-30']), # id empty
+                         nodes.section(),  # Name empty
+                         nodes.section(names=['Test']),  # duplicate id
+                         nodes.footnote(names=['2019-10-30']),  # id empty
                          ]
 
     def test_set_id_default(self):
diff --git a/docutils/test/test_parsers/test_recommonmark/test_misc.py b/docutils/test/test_parsers/test_recommonmark/test_misc.py
index 02e7ba490..ef7ee69fb 100644
--- a/docutils/test/test_parsers/test_recommonmark/test_misc.py
+++ b/docutils/test/test_parsers/test_recommonmark/test_misc.py
@@ -17,7 +17,7 @@ import unittest
 
 if __name__ == '__main__':
     import __init__
-from test_parsers import DocutilsTestSupport # must be imported before docutils
+from test_parsers import DocutilsTestSupport  # must be imported before docutils
 from docutils import core, utils, parsers
 from docutils.core import publish_string
 
diff --git a/docutils/test/test_parsers/test_recommonmark/test_transitions.py b/docutils/test/test_parsers/test_recommonmark/test_transitions.py
index 394f3f72f..5d0e3a388 100755
--- a/docutils/test/test_parsers/test_recommonmark/test_transitions.py
+++ b/docutils/test/test_parsers/test_recommonmark/test_transitions.py
@@ -203,7 +203,7 @@ A paragraph and two transitions.
 ----------
 
 ----------
-""", # the same:
+""",
 """\
 <document source="test data">
     <paragraph>
diff --git a/docutils/test/test_parsers/test_rst/test_directives/test_admonitions_dummy_lang.py b/docutils/test/test_parsers/test_rst/test_directives/test_admonitions_dummy_lang.py
index 005c95a48..825d18f47 100644
--- a/docutils/test/test_parsers/test_rst/test_directives/test_admonitions_dummy_lang.py
+++ b/docutils/test/test_parsers/test_rst/test_directives/test_admonitions_dummy_lang.py
@@ -14,7 +14,7 @@ from test_parsers import DocutilsTestSupport
 
 def suite():
     settings = {'language_code': 'local-dummy-lang',
-                'report_level': 2} # warning (has no effect on test output is run as __main__).
+                'report_level': 2}  # TODO: ignored when run as __main__
     s = DocutilsTestSupport.ParserTestSuite(suite_settings=settings)
     s.generateTests(totest)
     return s
diff --git a/docutils/test/test_parsers/test_rst/test_directives/test_code_parsing.py b/docutils/test/test_parsers/test_rst/test_directives/test_code_parsing.py
index 942ba56c4..7bb2ac922 100644
--- a/docutils/test/test_parsers/test_rst/test_directives/test_code_parsing.py
+++ b/docutils/test/test_parsers/test_rst/test_directives/test_code_parsing.py
@@ -17,7 +17,7 @@ import unittest
 
 if __name__ == '__main__':
     import __init__
-from test_parsers import DocutilsTestSupport # must be imported before docutils
+from test_parsers import DocutilsTestSupport  # must be imported before docutils
 from docutils import core, utils
 from docutils.core import publish_string
 from docutils.utils.code_analyzer import with_pygments
diff --git a/docutils/test/test_parsers/test_rst/test_source_line.py b/docutils/test/test_parsers/test_rst/test_source_line.py
index 4b6d95131..b1c0b8023 100644
--- a/docutils/test/test_parsers/test_rst/test_source_line.py
+++ b/docutils/test/test_parsers/test_rst/test_source_line.py
@@ -27,7 +27,7 @@ import os
 
 if __name__ == '__main__':
     import __init__
-from test_transforms import DocutilsTestSupport # before importing docutils!
+from test_transforms import DocutilsTestSupport  # before importing docutils!
 from docutils.transforms.universal import ExposeInternals
 from docutils.parsers.rst import Parser
 
diff --git a/docutils/test/test_parsers/test_rst/test_tables.py b/docutils/test/test_parsers/test_rst/test_tables.py
index c4c3ffdb2..cbd6b3790 100755
--- a/docutils/test/test_parsers/test_rst/test_tables.py
+++ b/docutils/test/test_parsers/test_rst/test_tables.py
@@ -571,7 +571,7 @@ No blank line after table.
 | (The first cell of this table may expand                                     |
 | to accommodate long filesystem paths.)                                       |
 +------------------------------------------------------------------------------+
-""") % ('\n'.join('|    %-70s    |' % include2[part * 70 : (part + 1) * 70] # noqa: E203
+""") % ('\n'.join('|    %-70s    |' % include2[part * 70 : (part + 1) * 70]  # noqa: E203
                   for part in range(len(include2) // 70 + 1))),
 """\
 <document source="test data">
@@ -606,7 +606,7 @@ Something before.
 Something afterwards.
 
 And more.
-""") % ('\n'.join('|    %-70s    |' % include2[part * 70 : (part + 1) * 70] # noqa: E203
+""") % ('\n'.join('|    %-70s    |' % include2[part * 70 : (part + 1) * 70]  # noqa: E203
                   for part in range(len(include2) // 70 + 1))),
 """\
 <document source="test data">
@@ -1274,7 +1274,7 @@ Inclusion  .. include::
 Note       The first row of this table may expand
            to accommodate long filesystem paths.
 =========  =====================================================================
-""" % ('\n'.join('              %-65s' % include2[part * 65 : (part + 1) * 65] # noqa: E203
+""" % ('\n'.join('              %-65s' % include2[part * 65 : (part + 1) * 65]  # noqa: E203
                  for part in range(len(include2) // 65 + 1))),
 """\
 <document source="test data">
diff --git a/docutils/test/test_parsers/test_rst/test_transitions.py b/docutils/test/test_parsers/test_rst/test_transitions.py
index ac95c7470..78a405fd4 100755
--- a/docutils/test/test_parsers/test_rst/test_transitions.py
+++ b/docutils/test/test_parsers/test_rst/test_transitions.py
@@ -205,7 +205,7 @@ A paragraph and two transitions.
 ----------
 
 ----------
-""", # the same:
+""",
 """\
 <document source="test data">
     <paragraph>
diff --git a/docutils/test/test_publisher.py b/docutils/test/test_publisher.py
index c3fa0cc43..582d1bdb1 100755
--- a/docutils/test/test_publisher.py
+++ b/docutils/test/test_publisher.py
@@ -14,8 +14,6 @@ import DocutilsTestSupport              # must be imported before docutils
 import docutils
 from docutils import core, nodes, io
 
-u_prefix = b''
-
 
 test_document = """\
 Test Document
@@ -38,11 +36,8 @@ pseudoxml_output = b"""\
             <paragraph>
                 Unknown target name: "nonexistent".
 """
-exposed_pseudoxml_output = (
-    b'<document ids="test-document" internal:refnames="{'
-    + u_prefix
-    + b"""\
-\'nonexistent\': [<reference: <#text: \'nonexistent\'>>]}" names="test\\ document" source="<string>" title="Test Document">
+exposed_pseudoxml_output = b"""\
+<document ids="test-document" internal:refnames="{'nonexistent': [<reference: <#text: 'nonexistent'>>]}" names="test\\ document" source="<string>" title="Test Document">
     <title>
         Test Document
     <paragraph>
@@ -55,7 +50,7 @@ exposed_pseudoxml_output = (
         <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="4" source="<string>" type="ERROR">
             <paragraph>
                 Unknown target name: "nonexistent".
-""") # % u_prefix # %-expansion not supported in bytes in 3.3 and 3.4
+"""
 
 
 class PublisherTests(DocutilsTestSupport.StandardTestCase):
diff --git a/docutils/test/test_settings.py b/docutils/test/test_settings.py
index bd104ca38..0630eece8 100755
--- a/docutils/test/test_settings.py
+++ b/docutils/test/test_settings.py
@@ -223,7 +223,7 @@ class ConfigEnvVarFileTests(ConfigFileTests):
     def tearDown(self):
         os.environ = self.orig_environ
 
-    def test_old(self): pass # don't repreat this test
+    def test_old(self): pass  # don't repreat this test
 
     @unittest.skipUnless(
         os.name == 'posix',
@@ -350,7 +350,7 @@ class HelperFunctionsTests(unittest.TestCase):
         reporter = utils.Reporter('test', 1, 4)
         with self.assertWarnsRegex(DeprecationWarning,
                                    'Set attributes via configuration settings'):
-            reporter.set_conditions('foo', 1, 4) # trigger warning
+            reporter.set_conditions('foo', 1, 4)  # trigger warning
 
 if __name__ == '__main__':
     unittest.main()
diff --git a/docutils/test/test_transforms/test___init__.py b/docutils/test/test_transforms/test___init__.py
index e216a1d33..ba07c0bbf 100755
--- a/docutils/test/test_transforms/test___init__.py
+++ b/docutils/test/test_transforms/test___init__.py
@@ -12,7 +12,7 @@ import unittest
 
 if __name__ == '__main__':
     import __init__
-from test_transforms import DocutilsTestSupport # before importing docutils!
+from test_transforms import DocutilsTestSupport  # before importing docutils!
 from docutils import transforms, utils
 
 
diff --git a/docutils/test/test_transforms/test_expose_internals.py b/docutils/test/test_transforms/test_expose_internals.py
index b4835efe9..079966d1a 100755
--- a/docutils/test/test_transforms/test_expose_internals.py
+++ b/docutils/test/test_transforms/test_expose_internals.py
@@ -10,7 +10,7 @@ Test module for universal.ExposeInternals transform.
 
 if __name__ == '__main__':
     import __init__
-from test_transforms import DocutilsTestSupport # before importing docutils!
+from test_transforms import DocutilsTestSupport  # before importing docutils!
 from docutils.transforms.universal import ExposeInternals
 from docutils.parsers.rst import Parser
 
diff --git a/docutils/test/test_transforms/test_filter_messages.py b/docutils/test/test_transforms/test_filter_messages.py
index db1250d43..3ac3744fe 100644
--- a/docutils/test/test_transforms/test_filter_messages.py
+++ b/docutils/test/test_transforms/test_filter_messages.py
@@ -26,7 +26,7 @@ from docutils.parsers.rst import Parser
 
 def suite():
     parser = Parser()
-    settings = {'report_level': 5} # filter all system messages
+    settings = {'report_level': 5}  # filter all system messages
     s = DocutilsTestSupport.TransformTestSuite(
         parser, suite_settings=settings)
     s.generateTests(totest)
diff --git a/docutils/test/test_transforms/test_smartquotes.py b/docutils/test/test_transforms/test_smartquotes.py
index 98477e341..cd40cbc63 100644
--- a/docutils/test/test_transforms/test_smartquotes.py
+++ b/docutils/test/test_transforms/test_smartquotes.py
@@ -26,7 +26,7 @@ def suite():
     parser = Parser()
     settings = {'smart_quotes': True,
                 'trim_footnote_ref_space': True,
-                'report': 2} # TODO: why is this ignored when running as main?
+                'report': 2}  # TODO why is this ignored when running as main?
     s = DocutilsTestSupport.TransformTestSuite(
         parser, suite_settings=settings)
     s.generateTests(totest)
diff --git a/docutils/test/test_transforms/test_transitions.py b/docutils/test/test_transforms/test_transitions.py
index c098e9e8e..05a347f78 100755
--- a/docutils/test/test_transforms/test_transitions.py
+++ b/docutils/test/test_transforms/test_transitions.py
@@ -10,7 +10,7 @@ Test module for misc.Transitions transform.
 
 if __name__ == '__main__':
     import __init__
-from test_transforms import DocutilsTestSupport # before importing docutils!
+from test_transforms import DocutilsTestSupport  # before importing docutils!
 from docutils.transforms.misc import Transitions
 from docutils.parsers.rst import Parser
 
@@ -174,7 +174,7 @@ A paragraph and two transitions.
 ----------
 
 ----------
-""", # the same:
+""",
 """\
 <document source="test data">
     <paragraph>
diff --git a/docutils/test/test_transforms/test_writer_aux.py b/docutils/test/test_transforms/test_writer_aux.py
index 2b8ba6e8c..f316c848f 100755
--- a/docutils/test/test_transforms/test_writer_aux.py
+++ b/docutils/test/test_transforms/test_writer_aux.py
@@ -10,7 +10,7 @@ Test module for writer_aux transforms.
 
 if __name__ == '__main__':
     import __init__
-from test_transforms import DocutilsTestSupport # before importing docutils!
+from test_transforms import DocutilsTestSupport  # before importing docutils!
 from docutils.transforms import writer_aux
 from docutils.parsers.rst import Parser
 
diff --git a/docutils/test/test_utils.py b/docutils/test/test_utils.py
index 5e95818eb..0d08be310 100755
--- a/docutils/test/test_utils.py
+++ b/docutils/test/test_utils.py
@@ -268,8 +268,8 @@ class HelperFunctionTests(unittest.TestCase):
 
     def test_column_width(self):
         self.assertEqual(utils.column_width('de'), 2)
-        self.assertEqual(utils.column_width('dâ'), 2) # pre-composed
-        self.assertEqual(utils.column_width('dâ'), 2) # combining
+        self.assertEqual(utils.column_width('dâ'), 2)  # pre-composed
+        self.assertEqual(utils.column_width('dâ'), 2)  # combining
 
     def test_decode_path(self):
         try:
@@ -279,7 +279,7 @@ class HelperFunctionTests(unittest.TestCase):
         bytespath = utils.decode_path(bytes_filename)
         unipath = utils.decode_path('späm')
         defaultpath = utils.decode_path(None)
-        if bytes_filename != b'spam': # skip if ä cannot be encoded
+        if bytes_filename != b'spam':  # skip if ä cannot be encoded
             self.assertEqual(bytespath, 'späm')
         self.assertEqual(unipath, 'späm')
         self.assertEqual(defaultpath, '')
diff --git a/docutils/test/test_viewlist.py b/docutils/test/test_viewlist.py
index 3c70f3a7e..5b59a8829 100755
--- a/docutils/test/test_viewlist.py
+++ b/docutils/test/test_viewlist.py
@@ -37,7 +37,7 @@ class ViewListTests(unittest.TestCase):
         self.assertEqual(self.b, self.b_list)
         self.assertEqual(self.c, self.c_list)
         self.assertEqual(len(self.a), len(self.a_list))
-        self.assertTrue('d' in self.a) # __contains__
+        self.assertTrue('d' in self.a)  # __contains__
         self.assertEqual([value for value in self.a], self.a_list)
         # get and set values
         self.assertEqual(self.a[2], self.a_list[2])
diff --git a/docutils/test/test_writers/test_docutils_xml.py b/docutils/test/test_writers/test_docutils_xml.py
index 0ee39a020..15713fa9b 100755
--- a/docutils/test/test_writers/test_docutils_xml.py
+++ b/docutils/test/test_writers/test_docutils_xml.py
@@ -17,7 +17,7 @@ Test for docutils XML writer.
 
 if __name__ == '__main__':
     import __init__
-from test_writers import DocutilsTestSupport # before importing docutils!
+from test_writers import DocutilsTestSupport  # before importing docutils!
 import docutils
 import docutils.core
 
@@ -194,7 +194,7 @@ class DocutilsXMLTestCase(DocutilsTestSupport.StandardTestCase):
              '<string>:10: '
              '(WARNING/2) Invalid raw XML in column 30, line offset 1:\n',
              '<test>inline raw XML&lt;/test>\n'])
-        settings['halt_level'] = 2 # convert info messages to exceptions
+        settings['halt_level'] = 2  # convert info messages to exceptions
         settings['warning_stream'] = ''
         with self.assertRaises(docutils.utils.SystemMessage):
             publish_xml(settings, invalid_raw_xml_source)
diff --git a/docutils/test/test_writers/test_pseudoxml.py b/docutils/test/test_writers/test_pseudoxml.py
index 3cc14329c..99111f5b1 100755
--- a/docutils/test/test_writers/test_pseudoxml.py
+++ b/docutils/test/test_writers/test_pseudoxml.py
@@ -15,7 +15,7 @@ from test_writers import DocutilsTestSupport
 
 def suite():
     # Settings dictionary must not be empty for later changes to work.
-    settings = {'expose_internals': []} # default
+    settings = {'expose_internals': []}  # default
     s = DocutilsTestSupport.PublishTestSuite('pseudoxml',
                                              suite_settings=settings)
     s.generateTests(totest)