[tools] Merge util files

- dict RDFConversionFormats from file 'tools.utils' has been
  moved to RDF_CONVERSION_FORMATS in file 'tools.parser_utils' and
  all usages have been switched to the new dict.
- dict ConversionFormats from file 'tools.utils' has been moved to
  the only file its using it, 'tools.converters.format_converter'.
- The file 'tools.utils' has been removed.
- Docstrings have been updated.

Author: mpsonntag

odml/tools/converters/format_converter.py

@@ -1,4 +1,5 @@
 import argparse
+import copy
 import os
 import re
 import sys
@@ -7,14 +8,21 @@
 
 from .. import RDFWriter
 from . import VersionConverter
-from ..utils import ConversionFormats
+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
@@ -35,7 +43,7 @@ def convert(cls, args=None):
         """
         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",
@@ -55,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, '')
@@ -99,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):

odml/tools/parser_utils.py

@@ -6,6 +6,22 @@
 SUPPORTED_PARSERS = ['XML', 'YAML', 'JSON', 'RDF']
 
 
+RDF_CONVERSION_FORMATS = {
+    # rdflib version "4.2.2" serialization formats
+    'xml': '.rdf',
+    'pretty-xml': '.rdf',
+    'trix': '.rdf',
+    'n3': '.n3',
+    'turtle': '.ttl',
+    'ttl': '.ttl',
+    'ntriples': '.nt',
+    'nt': '.nt',
+    'nt11': '.nt',
+    'trig': '.trig',
+    'json-ld': '.jsonld'
+}
+
+
 class ParserException(Exception):
     """
     Exception wrapper used by various odML parsers.

odml/tools/rdf_converter.py

@@ -18,8 +18,7 @@
 from ..format import Format, Document, Section, Property
 from ..info import FORMAT_VERSION, INSTALL_PATH
 from .dict_parser import DictReader
-from .parser_utils import ParserException
-from .utils import RDFConversionFormats
+from .parser_utils import ParserException, RDF_CONVERSION_FORMATS
 
 try:
     unicode = unicode
@@ -303,15 +302,15 @@ def get_rdf_str(self, rdf_format="turtle"):
         Convert the current odML content of the parser to a common RDF graph
         and return the graph as a string object in the specified RDF format.
 
-        :param rdf_format: possible formats: 'xml', 'n3', 'turtle', 'nt', 'pretty-xml',
-                                             'trix', 'trig', 'nquads', 'json-ld'.
-               Full lists see in utils.RDFConversionFormats
+        :param rdf_format: RDF output format. Default format is 'turtle'.
+                           Available formats: 'xml', 'n3', 'turtle', 'nt',
+                           'pretty-xml', 'trix', 'trig', 'nquads', 'json-ld'.
 
         :return: string object
         """
-        if rdf_format not in RDFConversionFormats:
+        if rdf_format not in RDF_CONVERSION_FORMATS:
             msg = "odml.RDFWriter.get_rdf_str: Format for output files is incorrect."
-            msg = "%s Please choose from the list: %s" % (msg, list(RDFConversionFormats))
+            msg = "%s Please choose from the list: %s" % (msg, list(RDF_CONVERSION_FORMATS))
             raise ValueError(msg)
 
         return self.convert_to_rdf().serialize(format=rdf_format).decode("utf-8")
@@ -323,14 +322,14 @@ def write_file(self, filename, rdf_format="turtle"):
         RDF output format.
 
         :param filename:
-        :param rdf_format: Possible RDF output format. See utils.RDFConversionFormats
-                           for a full list of supported formats.
-                           Default format is 'turtle'.
+        :param rdf_format: RDF output format. Default format is 'turtle'.
+                           Available formats: 'xml', 'n3', 'turtle', 'nt',
+                           'pretty-xml', 'trix', 'trig', 'nquads', 'json-ld'.
         """
         data = self.get_rdf_str(rdf_format)
         filename_ext = filename
-        if filename.find(RDFConversionFormats.get(rdf_format)) < 0:
-            filename_ext += RDFConversionFormats.get(rdf_format)
+        if filename.find(RDF_CONVERSION_FORMATS.get(rdf_format)) < 0:
+            filename_ext += RDF_CONVERSION_FORMATS.get(rdf_format)
 
         with open(filename_ext, "w") as out_file:
             out_file.write(data)