refactor: reorganize utils package

docs/3_usage_api.rst

@@ -69,7 +69,7 @@ Formatting Validation Results
 Validation results can be rendered using different output formatters provided by
 the library. Two formatter types are available: *text* and *JSON*.  
 Both rely on the ``rich`` Python library and integrate with the
-``rocrate_validator.io.output.console.Console`` class, which extends
+``rocrate_validator.utils.io_helpers.output.console.Console`` class, which extends
 ``rich.console.Console`` to support custom formatter registration.
 
 To format results, create a ``Console`` instance, register one formatter,
@@ -86,8 +86,8 @@ to a file.
 
 .. code-block:: python
 
-    from rocrate_validator.io.output.console import Console
-    from rocrate_validator.io.output.text import TextOutputFormatter
+    from rocrate_validator.utils.io_helpers.output.console import Console
+    from rocrate_validator.utils.io_helpers.output.text import TextOutputFormatter
 
     console = Console()
     console.register_formatter(TextOutputFormatter())
@@ -114,8 +114,8 @@ programmatic processing, or integration with external tools.
 
 .. code-block:: python
 
-    from rocrate_validator.io.output.console import Console
-    from rocrate_validator.io.output.json import JSONOutputFormatter
+    from rocrate_validator.utils.io_helpers.output.console import Console
+    from rocrate_validator.utils.io_helpers.output.json import JSONOutputFormatter
 
     console = Console()
     console.register_formatter(JSONOutputFormatter())

rocrate_validator/__init__.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 def get_version():
-    from rocrate_validator.utils import get_version
+    from rocrate_validator.utils.versioning import get_version
     return get_version()
 
 

rocrate_validator/cli/commands/errors.py

@@ -17,7 +17,7 @@
 
 from rich.console import Console
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator.errors import (InvalidProfilePath, ProfileNotFound,
                                       ProfilesDirectoryNotFound)
 

rocrate_validator/cli/commands/profiles.py

@@ -21,16 +21,17 @@
 from rich.panel import Panel
 from rich.table import Table
 
-import rocrate_validator.log as logging
 from rocrate_validator import services
 from rocrate_validator.cli.commands.errors import handle_error
 from rocrate_validator.cli.main import cli, click
-from rocrate_validator.colors import get_severity_color
 from rocrate_validator.constants import DEFAULT_PROFILE_IDENTIFIER
-from rocrate_validator.rocv_io.output.text.layout.report import get_app_header_rule
 from rocrate_validator.models import (LevelCollection, RequirementLevel,
                                       Severity)
-from rocrate_validator.utils import get_profiles_path, shorten_path
+from rocrate_validator.utils import log as logging
+from rocrate_validator.utils.io_helpers.colors import get_severity_color
+from rocrate_validator.utils.io_helpers.output.text.layout.report import \
+    get_app_header_rule
+from rocrate_validator.utils.paths import get_profiles_path, shorten_path
 
 # set the default profiles path
 DEFAULT_PROFILES_PATH = get_profiles_path()

rocrate_validator/cli/commands/validate.py

@@ -23,21 +23,22 @@
 from rich.padding import Padding
 from rich.rule import Rule
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator import services
 from rocrate_validator.cli.commands.errors import handle_error
 from rocrate_validator.cli.main import cli
 from rocrate_validator.cli.ui.text.validate import ValidationCommandView
 from rocrate_validator.errors import ROCrateInvalidURIError
-from rocrate_validator.rocv_io.input import get_single_char, multiple_choice
-from rocrate_validator.rocv_io.output.console import Console
-from rocrate_validator.rocv_io.output.json import JSONOutputFormatter
-from rocrate_validator.rocv_io.output.text import TextOutputFormatter
-from rocrate_validator.rocv_io.output.text.layout.report import (
+from rocrate_validator.utils.io_helpers.input import get_single_char, multiple_choice
+from rocrate_validator.utils.io_helpers.output.console import Console
+from rocrate_validator.utils.io_helpers.output.json import JSONOutputFormatter
+from rocrate_validator.utils.io_helpers.output.text import TextOutputFormatter
+from rocrate_validator.utils.io_helpers.output.text.layout.report import (
     LiveTextProgressLayout, get_app_header_rule)
 from rocrate_validator.models import (Severity, ValidationResult,
                                       ValidationSettings)
-from rocrate_validator.utils import get_profiles_path, validate_rocrate_uri
+from rocrate_validator.utils.uri import validate_rocrate_uri
+from rocrate_validator.utils.paths import get_profiles_path
 
 # from rich.markdown import Markdown
 # from rich.table import Table

rocrate_validator/cli/main.py

@@ -16,11 +16,11 @@
 
 import rich_click as click
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator.cli.utils import running_in_jupyter
-from rocrate_validator.rocv_io.output.console import Console
-from rocrate_validator.rocv_io.output.pager import SystemPager
-from rocrate_validator.utils import get_version
+from rocrate_validator.utils.io_helpers.output.console import Console
+from rocrate_validator.utils.io_helpers.output.pager import SystemPager
+from rocrate_validator.utils.versioning import get_version
 
 # set up logging
 logger = logging.getLogger(__name__)

rocrate_validator/cli/ui/text/validate.py

@@ -16,11 +16,11 @@
 
 from typing import Any, Callable, Optional
 
-import rocrate_validator.log as logging
-from rocrate_validator.rocv_io.output.console import Console
-from rocrate_validator.rocv_io.output.pager import SystemPager
-from rocrate_validator.rocv_io.output.text import TextOutputFormatter
-from rocrate_validator.rocv_io.output.text.layout.report import ValidationReportLayout
+from rocrate_validator.utils import log as logging
+from rocrate_validator.utils.io_helpers.output.console import Console
+from rocrate_validator.utils.io_helpers.output.pager import SystemPager
+from rocrate_validator.utils.io_helpers.output.text import TextOutputFormatter
+from rocrate_validator.utils.io_helpers.output.text.layout.report import ValidationReportLayout
 from rocrate_validator.models import (ValidationResult, ValidationSettings,
                                       ValidationStatistics)
 

rocrate_validator/cli/utils.py

@@ -14,7 +14,7 @@
 
 import os
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 
 # set up logging
 logger = logging.getLogger(__name__)

rocrate_validator/events.py

@@ -19,7 +19,7 @@
 
 import enum_tools
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 
 # Set up logging
 logger = logging.getLogger(__name__)

rocrate_validator/models.py

@@ -31,7 +31,7 @@
 import enum_tools
 from rdflib import RDF, RDFS, Graph, Namespace, URIRef
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator import __version__
 from rocrate_validator.constants import (DEFAULT_ONTOLOGY_FILE,
                                          DEFAULT_PROFILE_IDENTIFIER,
@@ -48,9 +48,11 @@
                                       ROCrateMetadataNotFoundError)
 from rocrate_validator.events import Event, EventType, Publisher, Subscriber
 from rocrate_validator.rocrate import ROCrate
-from rocrate_validator.utils import (URI, MapIndex, MultiIndexMap,
-                                     get_profiles_path,
-                                     get_requirement_name_from_file)
+from rocrate_validator.utils.collections import (MapIndex)
+from rocrate_validator.utils.paths import get_profiles_path
+from rocrate_validator.utils.python_helpers import get_requirement_name_from_file
+from rocrate_validator.utils.uri import URI
+from rocrate_validator.utils.collections import MultiIndexMap
 
 # set the default profiles path
 DEFAULT_PROFILES_PATH = get_profiles_path()

rocrate_validator/profiles/ro-crate/must/0_file_descriptor_format.py

@@ -14,11 +14,11 @@
 
 from typing import Any
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator.models import ValidationContext
 from rocrate_validator.requirements.python import (PyFunctionCheck, check,
                                                    requirement)
-from rocrate_validator.utils import HttpRequester
+from rocrate_validator.utils.http import HttpRequester
 
 # set up logging
 logger = logging.getLogger(__name__)

rocrate_validator/profiles/ro-crate/must/4_data_entity_metadata.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator.models import ValidationContext
 from rocrate_validator.requirements.python import (PyFunctionCheck, check,
                                                    requirement)

rocrate_validator/profiles/ro-crate/should/2_root_data_entity_relative_uri.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator.models import ValidationContext
 from rocrate_validator.requirements.python import (PyFunctionCheck, check,
                                                    requirement)

rocrate_validator/profiles/ro-crate/should/4_data_entity_existence.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator.models import ValidationContext
 from rocrate_validator.requirements.python import (PyFunctionCheck, check,
                                                    requirement)

rocrate_validator/profiles/ro-crate/should/5_web_data_entity_metadata.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator.models import ValidationContext
 from rocrate_validator.requirements.python import (PyFunctionCheck, check,
                                                    requirement)

rocrate_validator/profiles/workflow-ro-crate/may/1_main_workflow.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator.models import ValidationContext
 from rocrate_validator.requirements.python import (PyFunctionCheck, check,
                                                    requirement)

rocrate_validator/profiles/workflow-ro-crate/must/0_main_workflow.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator.models import ValidationContext
 from rocrate_validator.requirements.python import (PyFunctionCheck, check,
                                                    requirement)

rocrate_validator/requirements/python/__init__.py

@@ -17,12 +17,12 @@
 from pathlib import Path
 from typing import Callable, Optional, Type
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator.models import (LevelCollection, Profile, Requirement,
                                       RequirementCheck, RequirementLevel,
                                       RequirementLoader, Severity,
                                       ValidationContext)
-from rocrate_validator.utils import get_classes_from_file
+from rocrate_validator.utils.python_helpers import get_classes_from_file
 
 # set up logging
 logger = logging.getLogger(__name__)

rocrate_validator/requirements/shacl/checks.py

@@ -16,7 +16,7 @@
 from timeit import default_timer as timer
 from typing import Optional
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator.errors import ROCrateMetadataNotFoundError
 from rocrate_validator.events import EventType
 from rocrate_validator.models import (LevelCollection, Requirement,

rocrate_validator/requirements/shacl/models.py

@@ -21,7 +21,7 @@
 from rdflib.term import Node
 
 from rocrate_validator.constants import SHACL_NS
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator.models import LevelCollection, RequirementLevel, Severity
 from rocrate_validator.requirements.shacl.utils import (ShapesList,
                                                         compute_key,
@@ -139,7 +139,7 @@ def __str__(self):
             return f"{class_name} ({hash(self)})"
 
     def __repr__(self):
-        return f"{ self.__class__.__name__}({hash(self)})"
+        return f"{self.__class__.__name__}({hash(self)})"
 
     def __eq__(self, other):
         if not isinstance(other, Shape):

rocrate_validator/requirements/shacl/requirements.py

@@ -17,7 +17,7 @@
 
 from rdflib import RDF
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator.constants import VALIDATOR_NS
 from rocrate_validator.models import (Profile, Requirement, RequirementCheck,
                                       RequirementLevel, RequirementLoader)

rocrate_validator/requirements/shacl/utils.py

@@ -21,7 +21,7 @@
 from rdflib import RDF, BNode, Graph, Namespace
 from rdflib.term import Node
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator.constants import RDF_SYNTAX_NS, SHACL_NS
 from rocrate_validator.errors import BadSyntaxError
 from rocrate_validator.models import Severity

rocrate_validator/requirements/shacl/validator.py

@@ -23,7 +23,7 @@
 from rdflib import BNode, Graph
 from rdflib.term import Node, URIRef
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator.constants import (DEFAULT_ONTOLOGY_FILE,
                                          RDF_SERIALIZATION_FORMATS,
                                          RDF_SERIALIZATION_FORMATS_TYPES,

rocrate_validator/rocrate.py

@@ -26,9 +26,11 @@
 
 from rdflib import Graph
 
-from rocrate_validator import log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator.errors import ROCrateInvalidURIError
-from rocrate_validator.utils import URI, HttpRequester, validate_rocrate_uri
+from rocrate_validator.utils.uri import validate_rocrate_uri
+from rocrate_validator.utils.http import HttpRequester
+from rocrate_validator.utils.uri import URI
 
 # set up logging
 logger = logging.getLogger(__name__)

rocrate_validator/services.py

@@ -18,11 +18,13 @@
 from pathlib import Path
 from typing import Optional, Union
 
-import rocrate_validator.log as logging
+from rocrate_validator.utils import log as logging
 from rocrate_validator.events import Subscriber
 from rocrate_validator.models import (Profile, Severity, ValidationResult,
                                       ValidationSettings, Validator)
-from rocrate_validator.utils import URI, HttpRequester, get_profiles_path
+from rocrate_validator.utils.uri import URI
+from rocrate_validator.utils.paths import get_profiles_path
+from rocrate_validator.utils.http import HttpRequester
 
 # set the default profiles path
 DEFAULT_PROFILES_PATH = get_profiles_path()