Merge pull request #342 from mpsonntag/refactor

Refactor package structure

LGTM

Author: achilleas-k

appveyor.yml

@@ -1,21 +1,32 @@
+version: 1.4.{build}
+
+image: Visual Studio 2017
+
 environment:
   matrix:
     - PYTHON: "C:\\Python27"
-      PYVER: "2.7"
-    - PYTHON: "C:\\Python35"
-      PYVER: "3.5"
+      PYVER: 2
+      BITS: 32
     - PYTHON: "C:\\Python36"
-      PYVER: "3.6"
+      PYVER: 3
+      BITS: 32
     - PYTHON: "C:\\Python37"
-      PYVER: "3.7"
+      PYVER: 3
+      BITS: 32
     - PYTHON: "C:\\Python27-x64"
-      PYVER: "2.7"
-    - PYTHON: "C:\\Python35-x64"
-      PYVER: "3.5"
+      PYVER: 2
+      BITS: 64
     - PYTHON: "C:\\Python36-x64"
-      PYVER: "3.6"
+      PYVER: 3
+      BITS: 64
     - PYTHON: "C:\\Python37-x64"
-      PYVER: "3.7"
+      PYVER: 3
+      BITS: 64
+
+init:
+  - "ECHO %PYTHON% %vcvars% (%bits%)"
+  - ps: $env:PATH = "$env:PYTHON;$env:PATH;"
+  - python -c "import sys;print('Python version is {}'.format(sys.version))"
 
 build: false
 

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/rdf/__init__.py

@@ -1,4 +1,4 @@
-from odml.tools.query_creator import QueryCreator, QueryParser, QueryParserFuzzy
+from .query_creator import QueryCreator, QueryParser, QueryParserFuzzy
 
 
 class FuzzyFinder(object):

odml/tools/fuzzy_finder.py renamed to odml/rdf/fuzzy_finder.py

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

odml/tools/query_creator.py renamed to odml/rdf/query_creator.py

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

odml/scripts/odml_convert.py

@@ -0,0 +1,4 @@
+from .dict_parser import DictReader, DictWriter
+from .odmlparser import ODMLReader, ODMLWriter
+from .rdf_converter import RDFReader, RDFWriter
+from .xmlparser import XMLReader, XMLWriter

odml/scripts/odml_to_rdf.py

@@ -0,0 +1,3 @@
+from .version_converter import VersionConverter
+# FormatConverter depends on VersionConverter
+from .format_converter import FormatConverter

odml/tools/__init__.py

@@ -1,40 +1,49 @@
 import argparse
+import copy
 import os
 import re
 import sys
 
 import odml
-from .rdf_converter import RDFWriter
-from .version_converter import VersionConverter
-from .utils import ConversionFormats
+
+from .. import RDFWriter
+from . import VersionConverter
+from ..parser_utils import RDF_CONVERSION_FORMATS
 
 try:
     unicode = unicode
 except NameError:
     unicode = str
 
 
+CONVERSION_FORMATS = copy.deepcopy(RDF_CONVERSION_FORMATS)
+CONVERSION_FORMATS.update({
+    'v1_1': '.xml',
+    'odml': '.odml'
+})
+
+
 class FormatConverter(object):
 
     @classmethod
     def convert(cls, args=None):
         """
         Enable usage of the argparse for calling convert_dir(...)
         Example:
-            1) >> python format_converter.py ./..path../input_dir v1_1 -out ./..path../output_dir -r
+            1) >> python -m odml.tools.converters.format_converter ./..path../input_dir v1_1 -out ./..path../output_dir -r
             
                Convert files from the path <./..path../input_dir> to .xml odml version 1.1,
                writes them into <./..path../output_dir> including subdirectories 
                and its files from the input path.
             
-            2) >> python format_converter.py ./..path../input_dir odml
+            2) >> python -m odml.tools.converters.format_converter ./..path../input_dir odml
             
                Converts files from path <./..path../input_dir> to .odml,
                writes them into <./..path../input_dir_odml> not including subdirectories.
         """
         parser = argparse.ArgumentParser(description="Convert directory with odml files to another format")
         parser.add_argument("input_dir", help="Path to input directory")
-        parser.add_argument("result_format", choices=list(ConversionFormats),
+        parser.add_argument("result_format", choices=list(CONVERSION_FORMATS),
                             help="Format of output files")
         parser.add_argument("-out", "--output_dir", help="Path for output directory")
         parser.add_argument("-r", "--recursive", action="store_true",
@@ -54,11 +63,11 @@ def convert_dir(cls, input_dir, output_dir, parse_subdirs, res_format):
                            Possible choices: "v1_1" (converts to version 1.1 from version 1 xml)
                                              "odml" (converts to .odml from version 1.1 .xml files)
                                              "turtle", "nt" etc. (converts to rdf formats from version 1.1 .odml files)
-                                             (see full list of rdf serializers in utils.ConversionFormats)
+                                             (see full list of rdf serializers in CONVERSION_FORMATS)
         """
-        if res_format not in ConversionFormats:
+        if res_format not in CONVERSION_FORMATS:
             raise ValueError("Format for output files is incorrect. "
-                             "Please choose from the list: {}".format(list(ConversionFormats)))
+                             "Please choose from the list: {}".format(list(CONVERSION_FORMATS)))
 
         cls._check_input_output_directory(input_dir, output_dir)
         input_dir = os.path.join(input_dir, '')
@@ -98,14 +107,14 @@ def _convert_file(cls, input_path, output_path, res_format):
                 p, _ = os.path.splitext(output_path)
                 output_path = p + ".odml"
             odml.save(odml.load(input_path), output_path)
-        elif res_format in ConversionFormats:
-            if not output_path.endswith(ConversionFormats[res_format]):
+        elif res_format in CONVERSION_FORMATS:
+            if not output_path.endswith(CONVERSION_FORMATS[res_format]):
                 p, _ = os.path.splitext(output_path)
-                output_path = p + ConversionFormats[res_format]
+                output_path = p + CONVERSION_FORMATS[res_format]
             RDFWriter(odml.load(input_path)).write_file(output_path, res_format)
         else:
             raise ValueError("Format for output files is incorrect. "
-                             "Please choose from the list: {}".format(list(ConversionFormats)))
+                             "Please choose from the list: {}".format(list(CONVERSION_FORMATS)))
 
     @staticmethod
     def _create_sub_directory(dir_path):