From 954b32789e031834acca7e28bbb35f310051d095 Mon Sep 17 00:00:00 2001 From: milde Date: Tue, 20 Dec 2011 14:14:21 +0000 Subject: [PATCH] docutils.utils is now a package (providing a place for sub-modules) important:: docutils/math, docutils/error_reporting.py, and docutils/urischemes.py will move to the utils package in the next release, too. Code importing these modules needs to adapt. git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@7267 929543f6-e4f2-0310-98a6-ba3bd3dd1d04 --- HISTORY.txt | 17 ++++++++++++----- RELEASE-NOTES.txt | 13 +++++++++++++ docutils/__init__.py | 6 +++--- docutils/parsers/rst/directives/body.py | 2 +- docutils/parsers/rst/roles.py | 2 +- docutils/parsers/rst/states.py | 5 +++-- docutils/{utils.py => utils/__init__.py} | 0 docutils/{parsers => utils}/code_analyzer.py | 0 docutils/{parsers/rst => utils}/punctuation_chars.py | 0 setup.py | 15 ++++++++++++++- test/test_parsers/test_rst/test_directives/test_code.py | 2 +- .../test_rst/test_directives/test_code_long.py | 2 +- .../test_rst/test_directives/test_include.py | 2 +- test/test_parsers/test_rst/test_interpreted.py | 2 +- test/test_utils.py | 2 +- 15 files changed, 52 insertions(+), 18 deletions(-) rename docutils/{utils.py => utils/__init__.py} (100%) rename docutils/{parsers => utils}/code_analyzer.py (100%) rename docutils/{parsers/rst => utils}/punctuation_chars.py (100%) diff --git a/HISTORY.txt b/HISTORY.txt index 6ba0dd3ac..19baff2b9 100644 --- a/HISTORY.txt +++ b/HISTORY.txt @@ -30,7 +30,14 @@ Changes Since 0.8.1 - Fix [ 3395948 ] (Work around encoding problems in Py3k). -* docutils/utils.py +* docutils/utils.py -> docutils/utils/__init__.py + + - docutils.utils is now a package (providing a place for sub-modules) + + .. important:: docutils/math, docutils/error_reporting.py, and + docutils/urischemes.py will move to the utils package in the next + release, too. Code importing these modules needs to adapt + (``import docutils.math`` -> ``import docutils.utils.math``, etc.). - DependencyList uses io.FileOutput and 'utf8' encoding to prevent errors recording non-ASCII filenames (fixes [ 3434355 ]. @@ -60,11 +67,11 @@ Release 0.8.1 (2011-08-30) * General: - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause) - and [ 3395920 ] (correct copyright info for rst.el). - + and [ 3395920 ] (correct copyright info for rst.el). + * docutils/test/ - - Apply [ 3303733 ] and [ 3365041 ] to fix tests under py3k. + - Apply [ 3303733 ] and [ 3365041 ] to fix tests under py3k. * docutils/writers/latex2e/__init__.py @@ -95,7 +102,7 @@ Release 0.8 (2011-07-07) - Most directives now support a "name" option that attaches a reference name. - + - Directive content may start on the first line also when the directive type accepts options. diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt index 6e231b50b..8eea662cd 100644 --- a/RELEASE-NOTES.txt +++ b/RELEASE-NOTES.txt @@ -28,10 +28,23 @@ Release 0.9 (unpublished) .. _Pygments: http://pygments.org/ +* docutils/utils.py -> docutils/utils/__init__.py + + - docutils.utils is now a package (providing a place for sub-modules) + + .. important:: docutils/math, docutils/error_reporting.py, and + docutils/urischemes.py will move to the utils package in the next + release, too. Code importing these modules needs to adapt + (``import docutils.math`` -> ``import docutils.utils.math``, etc.). + * docutils/writers/html4css1/__init__.py - change default for `math-output` setting to MathJax +* docutils/writers/latex2e/__init__.py + + - Record only files required to generate the LaTeX source as dependencies. + Release 0.8.1 (2011-08-30) ========================== diff --git a/docutils/__init__.py b/docutils/__init__.py index 3c3843ff0..482edf456 100644 --- a/docutils/__init__.py +++ b/docutils/__init__.py @@ -29,9 +29,6 @@ Modules: - urischemes.py: Contains a complete mapping of known URI addressing scheme names to descriptions. -- utils.py: Contains the ``Reporter`` system warning class and miscellaneous - utilities. - Subpackages: - languages: Language-specific mappings of terms. @@ -44,6 +41,9 @@ Subpackages: - transforms: Modules used by readers and writers to modify DPS doctrees. +- utils: Contains the ``Reporter`` system warning class and miscellaneous + utilities used by readers, writers, and transforms. + - writers: Format-specific output translators. """ diff --git a/docutils/parsers/rst/directives/body.py b/docutils/parsers/rst/directives/body.py index 8f6d4360c..4ff9fdc05 100644 --- a/docutils/parsers/rst/directives/body.py +++ b/docutils/parsers/rst/directives/body.py @@ -16,7 +16,7 @@ from docutils import nodes from docutils.parsers.rst import Directive from docutils.parsers.rst import directives from docutils.parsers.rst.roles import set_classes -from docutils.parsers.code_analyzer import Lexer, LexerError, NumberLines +from docutils.utils.code_analyzer import Lexer, LexerError, NumberLines class BasePseudoSection(Directive): diff --git a/docutils/parsers/rst/roles.py b/docutils/parsers/rst/roles.py index 1a8b0bf75..9b510fd30 100644 --- a/docutils/parsers/rst/roles.py +++ b/docutils/parsers/rst/roles.py @@ -75,7 +75,7 @@ __docformat__ = 'reStructuredText' from docutils import nodes, utils from docutils.parsers.rst import directives from docutils.parsers.rst.languages import en as _fallback_language_module -from docutils.parsers.code_analyzer import Lexer, LexerError +from docutils.utils.code_analyzer import Lexer, LexerError DEFAULT_INTERPRETED_ROLE = 'title-reference' """ diff --git a/docutils/parsers/rst/states.py b/docutils/parsers/rst/states.py index 556fac783..8bb1558f1 100644 --- a/docutils/parsers/rst/states.py +++ b/docutils/parsers/rst/states.py @@ -107,16 +107,17 @@ import sys import re import roman from types import FunctionType, MethodType + from docutils import nodes, statemachine, utils, urischemes from docutils import ApplicationError, DataError from docutils.statemachine import StateMachineWS, StateWS from docutils.nodes import fully_normalize_name as normalize_name from docutils.nodes import whitespace_normalize_name -from docutils.utils import escape2null, unescape, column_width import docutils.parsers.rst from docutils.parsers.rst import directives, languages, tableparser, roles from docutils.parsers.rst.languages import en as _fallback_language_module -from docutils.parsers.rst import punctuation_chars +from docutils.utils import escape2null, unescape, column_width +from docutils.utils import punctuation_chars class MarkupError(DataError): pass class UnknownInterpretedRoleError(DataError): pass diff --git a/docutils/utils.py b/docutils/utils/__init__.py similarity index 100% rename from docutils/utils.py rename to docutils/utils/__init__.py diff --git a/docutils/parsers/code_analyzer.py b/docutils/utils/code_analyzer.py similarity index 100% rename from docutils/parsers/code_analyzer.py rename to docutils/utils/code_analyzer.py diff --git a/docutils/parsers/rst/punctuation_chars.py b/docutils/utils/punctuation_chars.py similarity index 100% rename from docutils/parsers/rst/punctuation_chars.py rename to docutils/utils/punctuation_chars.py diff --git a/setup.py b/setup.py index 74a00a032..1719f3b45 100755 --- a/setup.py +++ b/setup.py @@ -135,6 +135,7 @@ what-you-see-is-what-you-get plaintext markup syntax.""", # wrap at col 60 'docutils.readers', # 'docutils.readers.python', # in the sandbox since 0.8 'docutils.transforms', + 'docutils.utils', 'docutils.math', 'docutils.writers', 'docutils.writers.html4css1', @@ -198,14 +199,26 @@ classifiers = [ 'Topic :: Text Processing', 'Natural Language :: English', # main/default language, keep first 'Natural Language :: Afrikaans', + 'Natural Language :: Brazilian Portuguese', + 'Natural Language :: Catalan', + 'Natural Language :: Czech', + 'Natural Language :: Dutch', 'Natural Language :: Esperanto', + 'Natural Language :: Finnish', 'Natural Language :: French', + 'Natural Language :: Galician', 'Natural Language :: German', 'Natural Language :: Italian', + 'Natural Language :: Japanese', + 'Natural Language :: Lithuanian', + 'Natural Language :: Polish', 'Natural Language :: Russian', + 'Natural Language :: Simplified Chinese ', 'Natural Language :: Slovak', 'Natural Language :: Spanish', - 'Natural Language :: Swedish',] + 'Natural Language :: Swedish', + 'Natural Language :: Traditional Chinese ', + ] """Trove classifiers for the Distutils "register" command; Python 2.3 and up.""" diff --git a/test/test_parsers/test_rst/test_directives/test_code.py b/test/test_parsers/test_rst/test_directives/test_code.py index 7157ff411..873d653ef 100644 --- a/test/test_parsers/test_rst/test_directives/test_code.py +++ b/test/test_parsers/test_rst/test_directives/test_code.py @@ -9,7 +9,7 @@ Test the 'code' directive in parsers/rst/directives/body.py. """ from __init__ import DocutilsTestSupport -from docutils.parsers.code_analyzer import with_pygments +from docutils.utils.code_analyzer import with_pygments def suite(): s = DocutilsTestSupport.ParserTestSuite() diff --git a/test/test_parsers/test_rst/test_directives/test_code_long.py b/test/test_parsers/test_rst/test_directives/test_code_long.py index 701161c75..f01535726 100644 --- a/test/test_parsers/test_rst/test_directives/test_code_long.py +++ b/test/test_parsers/test_rst/test_directives/test_code_long.py @@ -9,7 +9,7 @@ Test the 'code' directive in body.py with syntax_highlight = 'long'. """ from __init__ import DocutilsTestSupport -from docutils.parsers.code_analyzer import with_pygments +from docutils.utils.code_analyzer import with_pygments def suite(): s = DocutilsTestSupport.ParserTestSuite(suite_settings={'syntax_highlight':'long'}) diff --git a/test/test_parsers/test_rst/test_directives/test_include.py b/test/test_parsers/test_rst/test_directives/test_include.py index 53b335fc0..2d159cd2b 100755 --- a/test/test_parsers/test_rst/test_directives/test_include.py +++ b/test/test_parsers/test_rst/test_directives/test_include.py @@ -13,7 +13,7 @@ import sys from __init__ import DocutilsTestSupport from docutils.parsers.rst import states from docutils._compat import b -from docutils.parsers.code_analyzer import with_pygments +from docutils.utils.code_analyzer import with_pygments def suite(): s = DocutilsTestSupport.ParserTestSuite() diff --git a/test/test_parsers/test_rst/test_interpreted.py b/test/test_parsers/test_rst/test_interpreted.py index fcf3359d0..7bdce8b94 100755 --- a/test/test_parsers/test_rst/test_interpreted.py +++ b/test/test_parsers/test_rst/test_interpreted.py @@ -9,7 +9,7 @@ Tests for interpreted text in docutils/parsers/rst/states.py. """ from __init__ import DocutilsTestSupport -from docutils.parsers.code_analyzer import with_pygments +from docutils.utils.code_analyzer import with_pygments def suite(): s = DocutilsTestSupport.ParserTestSuite() diff --git a/test/test_utils.py b/test/test_utils.py index 94e36c719..563b36fbd 100755 --- a/test/test_utils.py +++ b/test/test_utils.py @@ -6,7 +6,7 @@ # Copyright: This module has been placed in the public domain. """ -Test module for utils.py. +Test module for utils/__init__.py. """ import unittest -- 2.11.4.GIT