dagster-datacontract 0.1.2__tar.gz → 0.2.1__tar.gz

{dagster_datacontract-0.1.2 → dagster_datacontract-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dagster-datacontract
-Version: 0.1.2
+Version: 0.2.1
 Summary: Load metadata and asset check spesifications from data contracts.
 Author-email: Fredrik Bakken <fredrik@dataheim.io>
 Requires-Python: >=3.11.10
@@ -52,7 +52,7 @@ data_contract = DataContractLoader(
     name=asset_name,
     metadata=data_contract.metadata,
     tags=data_contract.tags,
-    description=data_contract.description,
+    description=data_contract.load_description(),
     owners=data_contract.owner,
     code_version=data_contract.version,
 )

{dagster_datacontract-0.1.2 → dagster_datacontract-0.2.1}/README.md

@@ -39,7 +39,7 @@ data_contract = DataContractLoader(
     name=asset_name,
     metadata=data_contract.metadata,
     tags=data_contract.tags,
-    description=data_contract.description,
+    description=data_contract.load_description(),
     owners=data_contract.owner,
     code_version=data_contract.version,
 )

{dagster_datacontract-0.1.2 → dagster_datacontract-0.2.1}/dagster_datacontract/__init__.py

@@ -23,7 +23,6 @@ class DataContractLoader:
         )
         self.metadata = self._load_metadata()
         self.tags = self._load_tags()
-        self.description = self._load_description()
         self.owner = self._load_owner()
         self.version = self._load_version()
         self.cron_schedule = self._load_cron_schedule()
@@ -76,23 +75,6 @@ class DataContractLoader:
 
         return tags
 
-    def _load_description(self) -> str | None:
-        model_description = self.data_contract_specification.models.get(
-            self.asset_name
-        ).description.replace("\n", "\n\n")
-        info_description = self.data_contract_specification.info.description.replace(
-            "\n", "\n\n"
-        )
-
-        if model_description and info_description:
-            return f"{model_description}\n\n{info_description}"
-        elif model_description:
-            return textwrap.dedent(model_description)
-        elif info_description:
-            return textwrap.dedent(info_description)
-
-        return None
-
     def _load_owner(self) -> list[str] | None:
         owner = self.data_contract_specification.info.owner
 
@@ -112,7 +94,69 @@ class DataContractLoader:
         except AttributeError:
             return None
 
+    def load_description(
+        self, config: dict[str, Any] | None = None, separator: str = "\n"
+    ) -> str | None:
+        """Load and return a formatted description string based on the data contract specification.
+
+        This method composes a description by pulling text from different parts
+        of the data contract specification (e.g., model and info descriptions),
+        joining them using the specified separator.
+
+        Args:
+            config (dict[str, Any] | None, optional): A configuration dictionary
+                specifying the order in which to concatenate the description parts.
+                Defaults to `{"order": ["model", "info"]}`.
+            separator (str, optional): A string used to separate different parts
+                of the description. Defaults to a newline character (`"\n"`).
+
+        Returns:
+            str | None: A single string combining the specified description parts
+            if available, otherwise `None`.
+
+
+        Example:
+            >>> self.load_description()
+            'Model description...\nInfo description...'
+        """
+        default_config = {"order": ["model", "info"]}
+
+        configuration = default_config | (config or {})
+
+        descriptions = {
+            "model": self.data_contract_specification.models.get(
+                self.asset_name
+            ).description,
+            "info": self.data_contract_specification.info.description,
+        }
+
+        parts = []
+        for key in configuration["order"]:
+            desc = descriptions.get(key).replace("\n", f"{separator}\n")
+            if desc:
+                parts.append(textwrap.dedent(desc))
+
+        if parts:
+            return f"{separator}\n".join(parts)
+
+        return None
+
     def load_data_quality_checks(self) -> dg.AssetChecksDefinition:
+        """Define and return a data quality check for the specified asset.
+
+        This method registers a data quality check using the `@dg.asset_check`
+        decorator. The check runs the data contract's `test()` method and returns
+        the result as a `dg.AssetCheckResult`. The result is considered "passed"
+        if the test outcome matches `ResultEnum.passed`.
+
+        The check is marked as blocking, which means failures may halt downstream
+        processing in a data pipeline.
+
+        Returns:
+            dg.AssetChecksDefinition: The defined asset quality check function,
+            registered with Dagster's data quality framework.
+        """
+
         @dg.asset_check(
             asset=self.asset_key,
             blocking=True,
@@ -130,6 +174,27 @@ class DataContractLoader:
         return check_asset
 
     def load_freshness_checks(self, lower_bound_delta: timedelta):
+        """Generate and return freshness checks for the asset based on update recency.
+
+        This method builds freshness checks using Dagster's
+        `build_last_update_freshness_checks` utility. It ensures that the specified
+        asset has been updated within a given time window (`lower_bound_delta`).
+        A cron schedule (`self.cron_schedule`) defines when the check should run.
+
+        Args:
+            lower_bound_delta (timedelta): The minimum acceptable time difference
+                between the current time and the asset's last update timestamp.
+                If the asset is older than this delta, the check will fail.
+
+        Returns:
+            list[AssetCheckSpec] | AssetChecksDefinition: A freshness check definition
+            that can be returned from `define_asset_checks` to register the check.
+
+
+        Example:
+            >>> self.load_freshness_checks(timedelta(hours=24))
+            # Ensures the asset was updated in the last 24 hours.
+        """
         freshness_checks = dg.build_last_update_freshness_checks(
             assets=[self.asset_name],
             lower_bound_delta=lower_bound_delta,

{dagster_datacontract-0.1.2 → dagster_datacontract-0.2.1}/dagster_datacontract.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dagster-datacontract
-Version: 0.1.2
+Version: 0.2.1
 Summary: Load metadata and asset check spesifications from data contracts.
 Author-email: Fredrik Bakken <fredrik@dataheim.io>
 Requires-Python: >=3.11.10
@@ -52,7 +52,7 @@ data_contract = DataContractLoader(
     name=asset_name,
     metadata=data_contract.metadata,
     tags=data_contract.tags,
-    description=data_contract.description,
+    description=data_contract.load_description(),
     owners=data_contract.owner,
     code_version=data_contract.version,
 )

{dagster_datacontract-0.1.2 → dagster_datacontract-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dagster-datacontract"
-version = "0.1.2"
+version = "0.2.1"
 description = "Load metadata and asset check spesifications from data contracts."
 authors = [
     { name = "Fredrik Bakken", email = "fredrik@dataheim.io" }