Prepare switch from optparse to argparse.

New interface function: frontend.get_default_settings()
easy access to default settings for programmatic use.

Add deprecation warnings.
Catch them when accessing the deprecated functions from Docutils.

Make docstrings conform to the Documentation Policies
(first line: summary, next line empty).

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

5 files changed, 13 insertions, 19 deletions

diff --git a/docutils/test/DocutilsTestSupport.py b/docutils/test/DocutilsTestSupport.py
index 69b589aeb..b677129b9 100644
--- a/docutils/test/DocutilsTestSupport.py
+++ b/docutils/test/DocutilsTestSupport.py
@@ -311,8 +311,7 @@ class TransformTestCase(CustomTestCase):
     cases that have nothing to do with the input and output of the transform.
     """
 
-    option_parser = frontend.OptionParser(components=(rst.Parser,))
-    settings = option_parser.get_default_values()
+    settings = frontend.get_default_settings(rst.Parser)
     settings.report_level = 1
     settings.halt_level = 5
     settings.debug = package_unittest.debug
@@ -433,8 +432,7 @@ class ParserTestCase(CustomTestCase):
     parser = rst.Parser()
     """Parser shared by all ParserTestCases."""
 
-    option_parser = frontend.OptionParser(components=(rst.Parser,))
-    settings = option_parser.get_default_values()
+    settings = frontend.get_default_settings(rst.Parser)
     settings.report_level = 5
     settings.halt_level = 5
     settings.debug = package_unittest.debug
@@ -495,8 +493,7 @@ class PEPParserTestCase(ParserTestCase):
     parser = rst.Parser(rfc2822=True, inliner=rst.states.Inliner())
     """Parser shared by all PEPParserTestCases."""
 
-    option_parser = frontend.OptionParser(components=(rst.Parser, pep.Reader))
-    settings = option_parser.get_default_values()
+    settings = frontend.get_default_settings(rst.Parser, pep.Reader)
     settings.report_level = 5
     settings.halt_level = 5
     settings.debug = package_unittest.debug
@@ -536,8 +533,7 @@ class RecommonmarkParserTestCase(ParserTestCase):
 
     if md_parser_class:
         parser = md_parser_class()
-        option_parser = frontend.OptionParser(components=(md_parser_class,))
-        settings = option_parser.get_default_values()
+        settings = frontend.get_default_settings(md_parser_class)
         settings.report_level = 5
         settings.halt_level = 5
         settings.debug = package_unittest.debug
diff --git a/docutils/test/test_error_reporting.py b/docutils/test/test_error_reporting.py
index 03ee54e9a..16f1082c5 100644
--- a/docutils/test/test_error_reporting.py
+++ b/docutils/test/test_error_reporting.py
@@ -32,10 +32,9 @@ import warnings
 
 from docutils import frontend, utils
 import docutils.parsers.rst
-from docutils.utils.error_reporting import SafeString, ErrorString, ErrorOutput
-
 warnings.filterwarnings('ignore', category=DeprecationWarning,
-                        message=r'.*utils\.error_reporting')
+                        module='.*error_reporting')
+from docutils.utils.error_reporting import SafeString, ErrorString, ErrorOutput  # noqa: E402, E501
 
 
 class SafeStringTests(unittest.TestCase):
@@ -241,8 +240,7 @@ class ErrorReportingTests(unittest.TestCase):
     parser = docutils.parsers.rst.Parser()
     """Parser shared by all ParserTestCases."""
 
-    option_parser = frontend.OptionParser(components=(parser,))
-    settings = option_parser.get_default_values()
+    settings = frontend.get_default_settings(parser)
     settings.report_level = 1
     settings.halt_level = 1
     settings.warning_stream = ''
diff --git a/docutils/test/test_language.py b/docutils/test/test_language.py
index 6fc92c9a3..ac47d46c0 100755
--- a/docutils/test/test_language.py
+++ b/docutils/test/test_language.py
@@ -23,7 +23,7 @@ from docutils.parsers.rst import directives, roles
 import docutils.utils
 import docutils.frontend
 
-_settings = docutils.frontend.OptionParser().get_default_values()
+_settings = docutils.frontend.get_default_settings()
 _reporter = docutils.utils.new_reporter('', _settings)
 
 reference_language = 'en'
diff --git a/docutils/test/test_parsers/test_parser.py b/docutils/test/test_parsers/test_parser.py
index 4157bb712..7d76eaf49 100644
--- a/docutils/test/test_parsers/test_parser.py
+++ b/docutils/test/test_parsers/test_parser.py
@@ -17,8 +17,8 @@ class RstParserTests(unittest.TestCase):
     def test_inputrestrictions(self):
         parser_class = parsers.get_parser_class('rst')
         parser = parser_class()
-        document = utils.new_document('test data', frontend.OptionParser(
-                    components=(parser, )).get_default_values())
+        document = utils.new_document('test data',
+                                      frontend.get_default_settings(parser))
         # input must be unicode at all times
         self.assertRaises(TypeError, parser.parse, b'hol', document)
 
diff --git a/docutils/test/test_settings.py b/docutils/test/test_settings.py
index aed6f770b..94c116564 100755
--- a/docutils/test/test_settings.py
+++ b/docutils/test/test_settings.py
@@ -108,10 +108,9 @@ class ConfigFileTests(unittest.TestCase):
     """Comparison method shared by all tests."""
 
     def setUp(self):
-        warnings.filterwarnings(action='ignore',
+        warnings.filterwarnings('ignore',
                                 category=frontend.ConfigDeprecationWarning)
-        warnings.filterwarnings(action='ignore', module='docutils.frontend',
-                                category=PendingDeprecationWarning)
+        warnings.filterwarnings('ignore', category=DeprecationWarning)
         self.option_parser = frontend.OptionParser(
             components=(pep_html.Writer, rst.Parser), read_config_files=None)
 
@@ -357,5 +356,6 @@ class HelperFunctionsTests(unittest.TestCase):
             reporter.set_conditions('foo', 1, 4)  # trigger warning
 
 
+
 if __name__ == '__main__':
     unittest.main()