From 0a8b4c9525eaa8fee769c2bd57693fbfc417ed4e Mon Sep 17 00:00:00 2001
From: milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>
Date: Mon, 25 Jun 2012 13:16:03 +0000
Subject: [PATCH] math, error_reporting, and urischemes moved to the utils
 package.

git-svn-id: https://docutils.svn.sourceforge.net/svnroot/docutils/trunk/docutils@7464 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
---
 HISTORY.txt                               |  2 ++
 RELEASE-NOTES.txt                         | 24 +++++++++++++-----------
 docutils/__init__.py                      |  9 ++++++---
 docutils/core.py                          |  2 +-
 docutils/frontend.py                      |  2 +-
 docutils/io.py                            |  2 +-
 docutils/parsers/rst/directives/misc.py   |  2 +-
 docutils/parsers/rst/directives/tables.py |  2 +-
 docutils/parsers/rst/states.py            |  4 ++--
 docutils/statemachine.py                  |  2 +-
 docutils/utils/__init__.py                |  2 +-
 docutils/{ => utils}/error_reporting.py   |  0
 docutils/{ => utils}/math/__init__.py     |  0
 docutils/{ => utils}/math/latex2mathml.py |  2 +-
 docutils/{ => utils}/math/math2html.py    |  0
 docutils/{ => utils}/math/tex2unichar.py  |  0
 docutils/{ => utils}/math/unichar2tex.py  |  0
 docutils/{ => utils}/urischemes.py        |  0
 docutils/writers/html4css1/__init__.py    |  8 ++++----
 docutils/writers/latex2e/__init__.py      |  4 ++--
 setup.py                                  |  2 +-
 test/DocutilsTestSupport.py               |  5 +++--
 test/test_error_reporting.py              |  2 +-
 test/test_io.py                           |  2 +-
 tools/buildhtml.py                        |  2 +-
 25 files changed, 44 insertions(+), 36 deletions(-)
 rename docutils/{ => utils}/error_reporting.py (100%)
 rename docutils/{ => utils}/math/__init__.py (100%)
 rename docutils/{ => utils}/math/latex2mathml.py (99%)
 rename docutils/{ => utils}/math/math2html.py (100%)
 rename docutils/{ => utils}/math/tex2unichar.py (100%)
 rename docutils/{ => utils}/math/unichar2tex.py (100%)
 rename docutils/{ => utils}/urischemes.py (100%)

diff --git a/HISTORY.txt b/HISTORY.txt
index 793177ca1..4e9890ad9 100644
--- a/HISTORY.txt
+++ b/HISTORY.txt
@@ -19,6 +19,8 @@ Changes Since 0.9.1
 * General
   
   - Dropped support for Python 2.3.
+  - ``docutils/math``, ``docutils/error_reporting.py``, and
+    ``docutils/urischemes.py`` moved to the utils package.
 
 
 Release 0.9.1 (2012-06-17)
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
index 9b074c374..5dce2bbab 100644
--- a/RELEASE-NOTES.txt
+++ b/RELEASE-NOTES.txt
@@ -19,15 +19,6 @@ more detailed list of changes, please see the `Docutils History`_.
 Future changes
 ==============
 
-* docutils/math, docutils/error_reporting.py, and
-  docutils/urischemes.py will move to the utils package
-  Code importing these modules needs to adapt, e.g.::
-
-    try:
-        import docutils.math as math
-    except ImportError:
-        import docutils.utils.math as math
-
 * docutils.io.FileInput/FileOutput will no longer do a
   system-exit on IOError by default.
 
@@ -50,8 +41,19 @@ Changes Since 0.9.1
 
    Docutils 0.9.x is the last version supporting Python 2.3.
    
-   Docutils 0.10 is compatible with Python versions from 2.4 to 2.7,
-   as well as 3.1 and 3.2 (cf. `Python 3 compatibility`_).
+   Docutils 0.10 is compatible with Python versions from 2.4 to 3.2
+   (cf. `Python 3 compatibility`_).
+
+* General:
+
+  - ``docutils/math``, ``docutils/error_reporting.py``, and
+    ``docutils/urischemes.py`` moved to the utils package.
+    Code importing these modules needs to adapt, e.g.::
+    
+      try:
+          import docutils.math as math
+      except ImportError:
+          import docutils.utils.math as math
 
 .. _Python 3 compatibility: README.html#python-3-compatibility
 
diff --git a/docutils/__init__.py b/docutils/__init__.py
index d83f691df..c558d2118 100644
--- a/docutils/__init__.py
+++ b/docutils/__init__.py
@@ -26,9 +26,6 @@ Modules:
 - statemachine.py: A finite state machine specialized for
   regular-expression-based text filters.
 
-- urischemes.py: Contains a complete mapping of known URI addressing
-  scheme names to descriptions.
-
 Subpackages:
 
 - languages: Language-specific mappings of terms.
@@ -44,6 +41,12 @@ Subpackages:
 - utils: Contains the ``Reporter`` system warning class and miscellaneous
   utilities used by readers, writers, and transforms.
 
+  utils/urischemes.py: Contains a complete mapping of known URI addressing
+  scheme names to descriptions.
+
+- utils/math: Contains functions for conversion of mathematical notation
+  between different formats (LaTeX, MathML, text, ...).
+
 - writers: Format-specific output translators.
 """
 
diff --git a/docutils/core.py b/docutils/core.py
index 3557cc05b..03fd4e549 100644
--- a/docutils/core.py
+++ b/docutils/core.py
@@ -20,7 +20,7 @@ from docutils import __version__, __version_details__, SettingsSpec
 from docutils import frontend, io, utils, readers, writers
 from docutils.frontend import OptionParser
 from docutils.transforms import Transformer
-from docutils.error_reporting import ErrorOutput, ErrorString
+from docutils.utils.error_reporting import ErrorOutput, ErrorString
 import docutils.readers.doctree
 
 class Publisher:
diff --git a/docutils/frontend.py b/docutils/frontend.py
index 4f18af9ee..b8087afe4 100644
--- a/docutils/frontend.py
+++ b/docutils/frontend.py
@@ -38,7 +38,7 @@ from optparse import SUPPRESS_HELP
 import docutils
 import docutils.utils
 import docutils.nodes
-from docutils.error_reporting import locale_encoding, ErrorOutput, ErrorString
+from docutils.utils.error_reporting import locale_encoding, ErrorOutput, ErrorString
 
 
 def store_multiple(option, opt, value, parser, *args, **kwargs):
diff --git a/docutils/io.py b/docutils/io.py
index b992e6d71..ff7a5b428 100644
--- a/docutils/io.py
+++ b/docutils/io.py
@@ -15,7 +15,7 @@ import re
 import codecs
 from docutils import TransformSpec
 from docutils._compat import b
-from docutils.error_reporting import locale_encoding, ErrorString, ErrorOutput
+from docutils.utils.error_reporting import locale_encoding, ErrorString, ErrorOutput
 
 
 class InputError(IOError): pass
diff --git a/docutils/parsers/rst/directives/misc.py b/docutils/parsers/rst/directives/misc.py
index 7ff998064..5c87edb6e 100644
--- a/docutils/parsers/rst/directives/misc.py
+++ b/docutils/parsers/rst/directives/misc.py
@@ -11,7 +11,7 @@ import os.path
 import re
 import time
 from docutils import io, nodes, statemachine, utils
-from docutils.error_reporting import SafeString, ErrorString
+from docutils.utils.error_reporting import SafeString, ErrorString
 from docutils.parsers.rst import Directive, convert_directive_function
 from docutils.parsers.rst import directives, roles, states
 from docutils.parsers.rst.directives.body import CodeBlock, NumberLines
diff --git a/docutils/parsers/rst/directives/tables.py b/docutils/parsers/rst/directives/tables.py
index fcf3c2b83..9ae2365c5 100644
--- a/docutils/parsers/rst/directives/tables.py
+++ b/docutils/parsers/rst/directives/tables.py
@@ -14,7 +14,7 @@ import os.path
 import csv
 
 from docutils import io, nodes, statemachine, utils
-from docutils.error_reporting import SafeString
+from docutils.utils.error_reporting import SafeString
 from docutils.utils import SystemMessagePropagation
 from docutils.parsers.rst import Directive
 from docutils.parsers.rst import directives
diff --git a/docutils/parsers/rst/states.py b/docutils/parsers/rst/states.py
index 5776287f6..a15aac317 100644
--- a/docutils/parsers/rst/states.py
+++ b/docutils/parsers/rst/states.py
@@ -111,7 +111,7 @@ except ImportError:
     import docutils.utils.roman as roman
 from types import FunctionType, MethodType
 
-from docutils import nodes, statemachine, utils, urischemes
+from docutils import nodes, statemachine, utils
 from docutils import ApplicationError, DataError
 from docutils.statemachine import StateMachineWS, StateWS
 from docutils.nodes import fully_normalize_name as normalize_name
@@ -120,7 +120,7 @@ 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.utils import escape2null, unescape, column_width
-from docutils.utils import punctuation_chars
+from docutils.utils import punctuation_chars, urischemes
 
 class MarkupError(DataError): pass
 class UnknownInterpretedRoleError(DataError): pass
diff --git a/docutils/statemachine.py b/docutils/statemachine.py
index 8431a1293..0c26ee3d2 100644
--- a/docutils/statemachine.py
+++ b/docutils/statemachine.py
@@ -111,7 +111,7 @@ import re
 import types
 import unicodedata
 from docutils import utils
-from docutils.error_reporting import ErrorOutput
+from docutils.utils.error_reporting import ErrorOutput
 
 
 class StateMachine:
diff --git a/docutils/utils/__init__.py b/docutils/utils/__init__.py
index 67bb86d00..6ab4ff8e2 100644
--- a/docutils/utils/__init__.py
+++ b/docutils/utils/__init__.py
@@ -17,7 +17,7 @@ import unicodedata
 from docutils import ApplicationError, DataError
 from docutils import nodes
 from docutils.io import FileOutput
-from docutils.error_reporting import ErrorOutput, SafeString
+from docutils.utils.error_reporting import ErrorOutput, SafeString
 
 
 class SystemMessage(ApplicationError):
diff --git a/docutils/error_reporting.py b/docutils/utils/error_reporting.py
similarity index 100%
rename from docutils/error_reporting.py
rename to docutils/utils/error_reporting.py
diff --git a/docutils/math/__init__.py b/docutils/utils/math/__init__.py
similarity index 100%
rename from docutils/math/__init__.py
rename to docutils/utils/math/__init__.py
diff --git a/docutils/math/latex2mathml.py b/docutils/utils/math/latex2mathml.py
similarity index 99%
rename from docutils/math/latex2mathml.py
rename to docutils/utils/math/latex2mathml.py
index 8b10ce1ea..05dad53c1 100644
--- a/docutils/math/latex2mathml.py
+++ b/docutils/utils/math/latex2mathml.py
@@ -19,7 +19,7 @@
 
 # Based on the `latex_math` sandbox project by Jens Jørgen Mortensen
 
-import docutils.math.tex2unichar as tex2unichar
+import docutils.utils.math.tex2unichar as tex2unichar
 
 #        TeX      spacing    combining
 over = {'acute':    u'\u00B4', # u'\u0301',
diff --git a/docutils/math/math2html.py b/docutils/utils/math/math2html.py
similarity index 100%
rename from docutils/math/math2html.py
rename to docutils/utils/math/math2html.py
diff --git a/docutils/math/tex2unichar.py b/docutils/utils/math/tex2unichar.py
similarity index 100%
rename from docutils/math/tex2unichar.py
rename to docutils/utils/math/tex2unichar.py
diff --git a/docutils/math/unichar2tex.py b/docutils/utils/math/unichar2tex.py
similarity index 100%
rename from docutils/math/unichar2tex.py
rename to docutils/utils/math/unichar2tex.py
diff --git a/docutils/urischemes.py b/docutils/utils/urischemes.py
similarity index 100%
rename from docutils/urischemes.py
rename to docutils/utils/urischemes.py
diff --git a/docutils/writers/html4css1/__init__.py b/docutils/writers/html4css1/__init__.py
index 761b9f601..6d6c17cc8 100644
--- a/docutils/writers/html4css1/__init__.py
+++ b/docutils/writers/html4css1/__init__.py
@@ -32,11 +32,11 @@ except ImportError:
         PIL = None
 import docutils
 from docutils import frontend, nodes, utils, writers, languages, io
-from docutils.error_reporting import SafeString
+from docutils.utils.error_reporting import SafeString
 from docutils.transforms import writer_aux
-from docutils.math import unichar2tex, pick_math_environment
-from docutils.math.latex2mathml import parse_latex_math
-from docutils.math.math2html import math2html
+from docutils.utils.math import unichar2tex, pick_math_environment
+from docutils.utils.math.latex2mathml import parse_latex_math
+from docutils.utils.math.math2html import math2html
 
 class Writer(writers.Writer):
 
diff --git a/docutils/writers/latex2e/__init__.py b/docutils/writers/latex2e/__init__.py
index 8c58806e3..a6acf7335 100644
--- a/docutils/writers/latex2e/__init__.py
+++ b/docutils/writers/latex2e/__init__.py
@@ -24,9 +24,9 @@ try:
 except ImportError:
     import docutils.utils.roman as roman
 from docutils import frontend, nodes, languages, writers, utils, io
-from docutils.error_reporting import SafeString
+from docutils.utils.error_reporting import SafeString
 from docutils.transforms import writer_aux
-from docutils.math import pick_math_environment, unichar2tex
+from docutils.utils.math import pick_math_environment, unichar2tex
 
 class Writer(writers.Writer):
 
diff --git a/setup.py b/setup.py
index fb8037a4d..7b95bccbd 100755
--- a/setup.py
+++ b/setup.py
@@ -132,7 +132,7 @@ what-you-see-is-what-you-get plaintext markup syntax.""", # wrap at col 60
                  # 'docutils.readers.python', # in the sandbox since 0.8
                  'docutils.transforms',
                  'docutils.utils',
-                 'docutils.math',
+                 'docutils.utils.math',
                  'docutils.writers',
                  'docutils.writers.html4css1',
                  # 'docutils.writers.html4strict',  # in the sandbox!
diff --git a/test/DocutilsTestSupport.py b/test/DocutilsTestSupport.py
index edece3fac..2988768b6 100644
--- a/test/DocutilsTestSupport.py
+++ b/test/DocutilsTestSupport.py
@@ -9,7 +9,7 @@ Exports the following:
 :Modules:
     - `statemachine` is 'docutils.statemachine'
     - `nodes` is 'docutils.nodes'
-    - `urischemes` is 'docutils.urischemes'
+    - `urischemes` is 'docutils.utils.urischemes'
     - `utils` is 'docutils.utils'
     - `transforms` is 'docutils.transforms'
     - `states` is 'docutils.parsers.rst.states'
@@ -65,7 +65,8 @@ try:
     import package_unittest
     import docutils
     import docutils.core
-    from docutils import frontend, nodes, statemachine, urischemes, utils
+    from docutils import frontend, nodes, statemachine, utils
+    from docutils.utils import urischemes
     from docutils.transforms import universal
     from docutils.parsers import rst
     from docutils.parsers.rst import states, tableparser, roles, languages
diff --git a/test/test_error_reporting.py b/test/test_error_reporting.py
index 989d04518..89ae7ae8d 100644
--- a/test/test_error_reporting.py
+++ b/test/test_error_reporting.py
@@ -36,7 +36,7 @@ except ImportError: # new in Python 2.6
 
 import DocutilsTestSupport              # must be imported before docutils
 from docutils import core, parsers, frontend, utils
-from docutils.error_reporting import SafeString, ErrorString, ErrorOutput
+from docutils.utils.error_reporting import SafeString, ErrorString, ErrorOutput
 from docutils._compat import b, bytes
 
 oldlocale = None
diff --git a/test/test_io.py b/test/test_io.py
index 13f25abe0..74ce14dce 100755
--- a/test/test_io.py
+++ b/test/test_io.py
@@ -12,7 +12,7 @@ import unittest, sys
 import DocutilsTestSupport              # must be imported before docutils
 from docutils import io
 from docutils._compat import b, bytes
-from docutils.error_reporting import locale_encoding
+from docutils.utils.error_reporting import locale_encoding
 from test_error_reporting import BBuf, UBuf
 
 class mock_stdout(UBuf):
diff --git a/tools/buildhtml.py b/tools/buildhtml.py
index 74dd69fb1..6c0ce98d7 100755
--- a/tools/buildhtml.py
+++ b/tools/buildhtml.py
@@ -29,7 +29,7 @@ from fnmatch import fnmatch
 import docutils
 from docutils import ApplicationError
 from docutils import core, frontend, utils
-from docutils.error_reporting import ErrorOutput, ErrorString
+from docutils.utils.error_reporting import ErrorOutput, ErrorString
 from docutils.parsers import rst
 from docutils.readers import standalone, pep
 from docutils.writers import html4css1, pep_html
-- 
2.11.4.GIT