Refactor package structure #342
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Created the 'odml.tools.converters' directory. - Moved format_converter and version_converter to new directory. - Updated setup.py and imports in all affected files.
- Use simplified import of classes where applicable - Update documentation and docstrings to new package structure
- 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.
The files fuzzy_finder and query_creater deal with odml specific rdf. Conceptually they are best kept seperate from other convenience tools and parsers.
Re-added 'odml.tools.version_converter.py' that imports the 'VersionConverter' class from its new location 'odml.tools.converters' and prints a deprecation warning. This ensures backwards compatibility with dependent tools like odml-ui during a grace period.
achilleas-k
approved these changes
Nov 29, 2019
This was referenced Dec 6, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR refactors the package structure to reduce the number of import cycles and make various parser classes available via the
__init__files. Command line scripts should be unaffected by the changes.The PR closes #317 and #333.
This PR includes the following changes
odml.tools.convertersis added.format_converterandversion_converterare moved into this directory.version_converter, a dummy file is left at its original location. It imports theVersionConverterclass from its new location and prints a deprecation warning.RDFConversionFormatsfrom filetools.utilshas been moved toRDF_CONVERSION_FORMATSin filetools.parser_utilsand all usages have been switched to the new dict.ConversionFormatsfrom filetools.utilshas been moved to the only file its using it,tools.converters.format_converter.tools.utilshas been removed.odml.rdfis added and the filesfuzzy_finderandquery_creatorare moved into this directory. Both files provide convenience and additional functions for odML specific RDF and are fairly independent from the rest of the library. Conceptually they are best kept separate from other convenience tools and parsers.