bam-masterdata 0.2.0__tar.gz → 0.3.1__tar.gz

{bam_masterdata-0.2.0 → bam_masterdata-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: bam-masterdata
-Version: 0.2.0
+Version: 0.3.1
 Summary: The BAM Data Store utility tools and masterdata models wrapped in a Python package with a front-end web interface.
 Author-email: BAM Data Store <datastore@bam.de>
 Maintainer-email: "Jose M. Pizarro" <jose.pizarro-blanco@bam.de>
@@ -57,6 +57,7 @@ Provides-Extra: docu
 Requires-Dist: mkdocs-material; extra == "docu"
 Requires-Dist: mkdocs-click; extra == "docu"
 Requires-Dist: mkdocstrings-python; extra == "docu"
+Dynamic: license-file
 
 <h1 align="center">
   <picture>

{bam_masterdata-0.2.0 → bam_masterdata-0.3.1}/bam_masterdata/_version.py

@@ -1,8 +1,13 @@
-# file generated by setuptools_scm
+# file generated by setuptools-scm
 # don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
 TYPE_CHECKING = False
 if TYPE_CHECKING:
-    from typing import Tuple, Union
+    from typing import Tuple
+    from typing import Union
+
     VERSION_TUPLE = Tuple[Union[int, str], ...]
 else:
     VERSION_TUPLE = object
@@ -12,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.2.0'
-__version_tuple__ = version_tuple = (0, 2, 0)
+__version__ = version = '0.3.1'
+__version_tuple__ = version_tuple = (0, 3, 1)

bam_masterdata-0.3.1/bam_masterdata/checker/__init__.py

@@ -0,0 +1 @@
+from .checker import MasterdataChecker, no_validation_errors

bam_masterdata-0.3.1/bam_masterdata/checker/checker.py

@@ -0,0 +1,101 @@
+from bam_masterdata.checker.masterdata_validator import MasterdataValidator
+from bam_masterdata.checker.source_loader import SourceLoader
+from bam_masterdata.logger import logger
+from bam_masterdata.metadata.entities_dict import EntitiesDict
+from bam_masterdata.utils import load_validation_rules
+
+
+class MasterdataChecker:
+    VALID_MODES = {"self", "incoming", "validate", "compare", "all", "individual"}
+
+    def __init__(self):
+        """
+        Initialize the comparator with validation rules and set the datamodel directory.
+        """
+        self.current_model: dict = None
+        self.new_entities: dict = None
+        self.logger = logger
+        self.validation_rules: dict = {}
+
+    def load_current_model(self, datamodel_dir: str = "./bam_masterdata/datamodel/"):
+        """
+        Load and transform the current data model (Pydantic classes) into JSON.
+
+        Uses the default datamodel directory unless overridden.
+        """
+        self.logger.info(f"Loading current data model from: {datamodel_dir}")
+        entities_dict = EntitiesDict(python_path=datamodel_dir, logger=self.logger)
+        self.current_model = entities_dict.single_json()
+
+    def load_new_entities(self, source: str):
+        """
+        Load new entities from various sources (Python classes, Excel, etc.).
+        """
+        self.logger.info(f"Loading new entities from: {source}")
+        loader = SourceLoader(source)
+        self.new_entities = loader.load()
+
+    def check(self, mode: str = "all") -> dict:
+        """
+        Run validations.
+
+        Modes:
+        - "self" -> Validate only the current data model.
+        - "incoming" -> Validate only the new entity structure.
+        - "validate" -> Validate both the current model and new entities.
+        - "compare" -> Compare new entities against the current model.
+        - "all" -> Run both validation types.
+        - "individual" -> Run individual repositories validations.
+
+        Before running, ensure that required models are loaded based on the mode.
+
+        Returns:
+            dict: Validation results.
+        """
+        # Validate mode selection
+        if mode not in self.VALID_MODES:
+            raise ValueError(f"Invalid mode: {mode}. Choose from {self.VALID_MODES}.")
+
+        # Load required models based on the selected mode
+        if (
+            mode in ["self", "validate", "compare", "all"]
+            and self.current_model is None
+        ):
+            self.logger.info("Current model is missing. Loading now...")
+            self.load_current_model()
+
+        if (
+            mode in ["incoming", "validate", "compare", "all"]
+            and self.new_entities is None
+        ):
+            raise ValueError(
+                "New entities must be loaded before validation in 'incoming', 'validate', 'compare', or 'all' modes."
+            )
+
+        # Load the validation rules
+        if (
+            mode in ["self", "incoming", "validate", "all"]
+            and self.validation_rules == {}
+        ):
+            self.validation_rules = load_validation_rules(self.logger)
+
+        validator = MasterdataValidator(
+            self.new_entities, self.current_model, self.validation_rules
+        )
+        return validator.validate(mode)
+
+
+def no_validation_errors(validation_results: dict) -> bool:
+    """
+    Check if there are no validation errors in the results.
+
+    Args:
+        validation_results (dict): The dictionary containing the specific validation results.
+
+    Returns:
+        bool: True if there are no validation errors, False otherwise.
+    """
+
+    if not isinstance(validation_results, dict):
+        return False
+    return all(no_validation_errors(v) for v in validation_results.values())