Converters package cleanup

- Use simplified import of classes where applicable
- Update documentation and docstrings to new package structure

Author: mpsonntag

doc/tools.rst

@@ -14,44 +14,50 @@ Tools
 =====
 Several tools are provided with the :py:mod:`odml.tools` package.
 
-ODMLParser
+DictParser
 ----------
-.. automodule:: odml.tools.odmlparser
+.. automodule:: odml.tools.dict_parser
    :members:
    :inherited-members:
    :undoc-members:
 
-XMLParser
----------
-.. automodule:: odml.tools.xmlparser
+ODMLParser
+----------
+.. automodule:: odml.tools.odmlparser
    :members:
    :inherited-members:
    :undoc-members:
 
-DictParser
-----------
-.. automodule:: odml.tools.dict_parser
+RDFConverter
+----------------
+.. automodule:: odml.tools.rdf_converter
    :members:
    :inherited-members:
    :undoc-members:
 
-FormatConverter
-----------------
-.. automodule:: odml.tools.format_converter
+XMLParser
+---------
+.. automodule:: odml.tools.xmlparser
    :members:
    :inherited-members:
    :undoc-members:
 
-VersionConverter
+.. _converters:
+
+Convenience converters
+======================
+Several convenience converters are provided with the :py:mod:`odml.tools.converters` package.
+
+FormatConverter
 ----------------
-.. automodule:: odml.tools.version_converter
+.. automodule:: odml.tools.converters.format_converter
    :members:
    :inherited-members:
    :undoc-members:
 
-RDFConverter
+VersionConverter
 ----------------
-.. automodule:: odml.tools.rdf_converter
+.. automodule:: odml.tools.converters.version_converter
    :members:
    :inherited-members:
    :undoc-members:

odml/scripts/odml_convert.py

@@ -35,7 +35,7 @@
 
 import odml
 
-from odml.tools.converters.version_converter import VersionConverter as VerConf
+from odml.tools.converters import VersionConverter as VerConf
 
 try:
     unicode = unicode

odml/scripts/odml_to_rdf.py

@@ -37,7 +37,7 @@
 import odml
 
 from odml.tools.odmlparser import ODMLReader, ODMLWriter
-from odml.tools.converters.version_converter import VersionConverter as VerConf
+from odml.tools.converters import VersionConverter as VerConf
 
 try:
     unicode = unicode

odml/tools/dict_parser.py

@@ -138,7 +138,8 @@ def to_odml(self, parsed_doc):
 
         elif self.parsed_doc.get('odml-version') != FORMAT_VERSION:
             msg = ("Cannot parse odML document with format version '%s'. \n"
-                   "\tUse the 'tools.VersionConverter' to import previous odML formats."
+                   "\tUse the 'VersionConverter' from 'odml.tools.converters' "
+                   "to import previous odML formats."
                    % self.parsed_doc.get('odml-version'))
             raise InvalidVersionException(msg)
 

odml/tools/xmlparser.py

@@ -182,7 +182,8 @@ def _handle_version(root):
                                   "in <odML> tag.\n")
         elif root.attrib['version'] != FORMAT_VERSION:
             msg = ("Cannot parse odML document with format version '%s'. \n"
-                   "\tUse the 'tools.VersionConverter' to import previous odML formats."
+                   "\tUse the 'VersionConverter' from 'odml.tools.converters' "
+                   "to import previous odML formats."
                    % root.attrib['version'])
             raise InvalidVersionException(msg)
 

test/test_format_converter.py

@@ -3,7 +3,7 @@
 import unittest
 from contextlib import contextmanager
 
-from odml.tools.converters.format_converter import FormatConverter
+from odml.tools.converters import FormatConverter
 
 FC = FormatConverter
 

test/test_version_converter.py

@@ -13,7 +13,7 @@
 from contextlib import contextmanager
 from lxml import etree as ET
 from odml.terminology import REPOSITORY_BASE
-from odml.tools.converters.version_converter import VersionConverter
+from odml.tools.converters import VersionConverter
 
 try:
     unicode = unicode

test/test_version_converter_integration.py

@@ -9,7 +9,7 @@
 import unittest
 
 from odml import load
-from odml.tools.converters.version_converter import VersionConverter as VC
+from odml.tools.converters import VersionConverter as VC
 
 
 class TestVersionConverterIntegration(unittest.TestCase):