acryl-datahub-cloud 0.3.12rc3__py3-none-any.whl → 0.3.12rc4__py3-none-any.whl

acryl_datahub_cloud/sdk/assertion.py

@@ -14,7 +14,7 @@ from typing import Optional, Union
 
 from typing_extensions import Self
 
-from acryl_datahub_cloud.sdk.assertion_input import (
+from acryl_datahub_cloud.sdk.assertion_input.assertion_input import (
     ASSERTION_MONITOR_DEFAULT_TRAINING_LOOKBACK_WINDOW_DAYS,
     DEFAULT_DETECTION_MECHANISM,
     DEFAULT_SCHEDULE,
@@ -24,6 +24,7 @@ from acryl_datahub_cloud.sdk.assertion_input import (
     ExclusionWindowTypes,
     FixedRangeExclusionWindow,
     InferenceSensitivity,
+    TimeWindowSizeInputTypes,
     _DetectionMechanismTypes,
 )
 from acryl_datahub_cloud.sdk.entities.assertion import Assertion
@@ -85,21 +86,12 @@ class _HasSmartFunctionality:
     Mixin class that provides smart functionality for assertions.
     """
 
-    _SUPPORTED_WITH_FILTER_ASSERTION_TYPES = (
-        models.FreshnessAssertionInfoClass,
-        models.VolumeAssertionInfoClass,
-    )
-
     def __init__(
         self,
         *,
         sensitivity: InferenceSensitivity = DEFAULT_SENSITIVITY,
         exclusion_windows: list[ExclusionWindowTypes],
         training_data_lookback_days: int = ASSERTION_MONITOR_DEFAULT_TRAINING_LOOKBACK_WINDOW_DAYS,
-        incident_behavior: list[AssertionIncidentBehavior],
-        detection_mechanism: Optional[
-            _DetectionMechanismTypes
-        ] = DEFAULT_DETECTION_MECHANISM,
     ) -> None:
         """
         Initialize the smart functionality mixin.
@@ -115,8 +107,6 @@ class _HasSmartFunctionality:
         self._sensitivity = sensitivity
         self._exclusion_windows = exclusion_windows
         self._training_data_lookback_days = training_data_lookback_days
-        self._incident_behavior = incident_behavior
-        self._detection_mechanism = detection_mechanism
 
     @property
     def sensitivity(self) -> InferenceSensitivity:
@@ -130,14 +120,6 @@ class _HasSmartFunctionality:
     def training_data_lookback_days(self) -> int:
         return self._training_data_lookback_days
 
-    @property
-    def incident_behavior(self) -> list[AssertionIncidentBehavior]:
-        return self._incident_behavior
-
-    @property
-    def detection_mechanism(self) -> Optional[_DetectionMechanismTypes]:
-        return self._detection_mechanism
-
     @staticmethod
     def _get_sensitivity(monitor: Monitor) -> InferenceSensitivity:
         # 1. Check if the monitor has a sensitivity field
@@ -186,6 +168,115 @@ class _HasSmartFunctionality:
         assert isinstance(retrieved, int)
         return retrieved
 
+
+class _AssertionPublic(ABC):
+    """
+    Abstract base class that represents a public facing assertion and contains the common properties of all assertions.
+    """
+
+    _SUPPORTED_WITH_FILTER_ASSERTION_TYPES = (
+        models.FreshnessAssertionInfoClass,
+        models.VolumeAssertionInfoClass,
+    )
+
+    def __init__(
+        self,
+        *,
+        urn: AssertionUrn,
+        dataset_urn: DatasetUrn,
+        display_name: str,
+        mode: AssertionMode,
+        tags: list[TagUrn],
+        incident_behavior: list[AssertionIncidentBehavior],
+        detection_mechanism: Optional[
+            _DetectionMechanismTypes
+        ] = DEFAULT_DETECTION_MECHANISM,
+        created_by: Optional[CorpUserUrn] = None,
+        created_at: Union[datetime, None] = None,
+        updated_by: Optional[CorpUserUrn] = None,
+        updated_at: Optional[datetime] = None,
+    ):
+        """
+        Initialize the public facing assertion class.
+
+        Args:
+            urn: The urn of the assertion.
+            dataset_urn: The urn of the dataset that the assertion is for.
+            display_name: The display name of the assertion.
+            mode: The mode of the assertion (active, inactive).
+            tags: The tags of the assertion.
+            created_by: The urn of the user that created the assertion.
+            created_at: The timestamp of when the assertion was created.
+            updated_by: The urn of the user that updated the assertion.
+            updated_at: The timestamp of when the assertion was updated.
+        """
+        self._urn = urn
+        self._dataset_urn = dataset_urn
+        self._display_name = display_name
+        self._mode = mode
+        self._incident_behavior = incident_behavior
+        self._detection_mechanism = detection_mechanism
+        self._created_by = created_by
+        self._created_at = created_at
+        self._updated_by = updated_by
+        self._updated_at = updated_at
+        self._tags = tags
+
+    @property
+    def urn(self) -> AssertionUrn:
+        return self._urn
+
+    @property
+    def dataset_urn(self) -> DatasetUrn:
+        return self._dataset_urn
+
+    @property
+    def display_name(self) -> str:
+        return self._display_name
+
+    @property
+    def mode(self) -> AssertionMode:
+        return self._mode
+
+    @property
+    def incident_behavior(self) -> list[AssertionIncidentBehavior]:
+        return self._incident_behavior
+
+    @property
+    def detection_mechanism(self) -> Optional[_DetectionMechanismTypes]:
+        return self._detection_mechanism
+
+    @property
+    def created_by(self) -> Optional[CorpUserUrn]:
+        return self._created_by
+
+    @property
+    def created_at(self) -> Union[datetime, None]:
+        return self._created_at
+
+    @property
+    def updated_by(self) -> Optional[CorpUserUrn]:
+        return self._updated_by
+
+    @property
+    def updated_at(self) -> Union[datetime, None]:
+        return self._updated_at
+
+    @property
+    def tags(self) -> list[TagUrn]:
+        return self._tags
+
+    @staticmethod
+    def _get_incident_behavior(assertion: Assertion) -> list[AssertionIncidentBehavior]:
+        incident_behaviors = []
+        for action in assertion.on_failure + assertion.on_success:
+            if action.type == models.AssertionActionTypeClass.RAISE_INCIDENT:
+                incident_behaviors.append(AssertionIncidentBehavior.RAISE_ON_FAIL)
+            elif action.type == models.AssertionActionTypeClass.RESOLVE_INCIDENT:
+                incident_behaviors.append(AssertionIncidentBehavior.RESOLVE_ON_PASS)
+
+        return incident_behaviors
+
     @staticmethod
     def _get_detection_mechanism(
         assertion: Assertion,
@@ -193,7 +284,7 @@ class _HasSmartFunctionality:
         default: Optional[_DetectionMechanismTypes] = DEFAULT_DETECTION_MECHANISM,
     ) -> Optional[_DetectionMechanismTypes]:
         """Get the detection mechanism from the monitor and assertion."""
-        if not _HasSmartFunctionality._has_valid_monitor_info(monitor):
+        if not _AssertionPublic._has_valid_monitor_info(monitor):
             return default
 
         # 1. Check if the assertion has a parameters field
@@ -206,7 +297,7 @@ class _HasSmartFunctionality:
             )
             return default
 
-        parameters = _HasSmartFunctionality._get_assertion_parameters(monitor, default)
+        parameters = _AssertionPublic._get_assertion_parameters(monitor, default)
         if parameters is None:
             return _warn_and_return_default_detection_mechanism("parameters", default)
 
@@ -218,11 +309,11 @@ class _HasSmartFunctionality:
             if assertion.info is None:
                 return _warn_and_return_default_detection_mechanism("info", default)
             if isinstance(assertion.info, models.VolumeAssertionInfoClass):
-                return _HasSmartFunctionality._get_volume_detection_mechanism(
+                return _AssertionPublic._get_volume_detection_mechanism(
                     assertion, parameters, default
                 )
             elif isinstance(assertion.info, models.FreshnessAssertionInfoClass):
-                return _HasSmartFunctionality._get_freshness_detection_mechanism(
+                return _AssertionPublic._get_freshness_detection_mechanism(
                     assertion, parameters, default
                 )
             # TODO: Consider moving the detection mechanism logic to the assertion classes themselves e.g. _get_assertion_specific_detection_mechanism as an abstract method
@@ -236,53 +327,6 @@ class _HasSmartFunctionality:
                 f"AssertionEvaluationParametersType {parameters.type} not supported"
             )
 
-    @staticmethod
-    def _has_valid_monitor_info(monitor: Monitor) -> bool:
-        """Check if monitor has valid info and assertion monitor."""
-
-        def _warn_and_return_false(field_name: str) -> bool:
-            logger.warning(
-                f"Monitor {monitor.urn} does not have an `{field_name}` field, defaulting detection mechanism to {DEFAULT_DETECTION_MECHANISM}"
-            )
-            return False
-
-        if monitor.info is None:
-            return _warn_and_return_false("info")
-        if monitor.info.assertionMonitor is None:
-            return _warn_and_return_false("assertionMonitor")
-        if (
-            monitor.info.assertionMonitor.assertions is None
-            or len(monitor.info.assertionMonitor.assertions) == 0
-        ):
-            return _warn_and_return_false("assertionMonitor.assertions")
-
-        return True
-
-    @staticmethod
-    def _get_assertion_parameters(
-        monitor: Monitor,
-        default: Optional[_DetectionMechanismTypes] = DEFAULT_DETECTION_MECHANISM,
-    ) -> Optional[models.AssertionEvaluationParametersClass]:
-        """Get the assertion parameters from the monitor."""
-        # We know these are not None from _has_valid_monitor_info check
-        assert (
-            monitor is not None
-            and monitor.info is not None
-            and monitor.info.assertionMonitor is not None
-        )
-        assertion_monitor = monitor.info.assertionMonitor
-        assert (
-            assertion_monitor is not None and assertion_monitor.assertions is not None
-        )
-        assertions = assertion_monitor.assertions
-
-        if assertions[0].parameters is None:
-            logger.warning(
-                f"Monitor {monitor.urn} does not have a assertionMonitor.assertions[0].parameters, defaulting detection mechanism to {default}"
-            )
-            return None
-        return assertions[0].parameters
-
     @staticmethod
     def _get_freshness_detection_mechanism(
         assertion: Assertion,
@@ -302,7 +346,7 @@ class _HasSmartFunctionality:
         elif source_type == models.DatasetFreshnessSourceTypeClass.AUDIT_LOG:
             return DetectionMechanism.AUDIT_LOG
         elif source_type == models.DatasetFreshnessSourceTypeClass.FIELD_VALUE:
-            return _HasSmartFunctionality._get_field_value_detection_mechanism(
+            return _AssertionPublic._get_field_value_detection_mechanism(
                 assertion, parameters
             )
         elif source_type == models.DatasetFreshnessSourceTypeClass.DATAHUB_OPERATION:
@@ -332,7 +376,7 @@ class _HasSmartFunctionality:
         if source_type == models.DatasetVolumeSourceTypeClass.INFORMATION_SCHEMA:
             return DetectionMechanism.INFORMATION_SCHEMA
         elif source_type == models.DatasetVolumeSourceTypeClass.QUERY:
-            additional_filter = _HasSmartFunctionality._get_additional_filter(assertion)
+            additional_filter = _AssertionPublic._get_additional_filter(assertion)
             return DetectionMechanism.QUERY(additional_filter=additional_filter)
         elif source_type == models.DatasetVolumeSourceTypeClass.DATAHUB_DATASET_PROFILE:
             return DetectionMechanism.DATASET_PROFILE
@@ -356,7 +400,7 @@ class _HasSmartFunctionality:
             return DEFAULT_DETECTION_MECHANISM
 
         column_name = field.path
-        additional_filter = _HasSmartFunctionality._get_additional_filter(assertion)
+        additional_filter = _AssertionPublic._get_additional_filter(assertion)
 
         if field.kind == models.FreshnessFieldKindClass.LAST_MODIFIED:
             return DetectionMechanism.LAST_MODIFIED_COLUMN(
@@ -380,7 +424,7 @@ class _HasSmartFunctionality:
         if (
             not isinstance(
                 assertion.info,
-                _HasSmartFunctionality._SUPPORTED_WITH_FILTER_ASSERTION_TYPES,
+                _AssertionPublic._SUPPORTED_WITH_FILTER_ASSERTION_TYPES,
             )
             or assertion.info.filter is None
         ):
@@ -394,95 +438,52 @@ class _HasSmartFunctionality:
             )
         return assertion.info.filter.sql
 
+    @staticmethod
+    def _has_valid_monitor_info(monitor: Monitor) -> bool:
+        """Check if monitor has valid info and assertion monitor."""
 
-class _AssertionPublic(ABC):
-    """
-    Abstract base class that represents a public facing assertion and contains the common properties of all assertions.
-    """
-
-    def __init__(
-        self,
-        *,
-        urn: AssertionUrn,
-        dataset_urn: DatasetUrn,
-        display_name: str,
-        mode: AssertionMode,
-        tags: list[TagUrn],
-        created_by: Optional[CorpUserUrn] = None,
-        created_at: Union[datetime, None] = None,
-        updated_by: Optional[CorpUserUrn] = None,
-        updated_at: Optional[datetime] = None,
-    ):
-        """
-        Initialize the public facing assertion class.
-
-        Args:
-            urn: The urn of the assertion.
-            dataset_urn: The urn of the dataset that the assertion is for.
-            display_name: The display name of the assertion.
-            mode: The mode of the assertion (active, inactive).
-            tags: The tags of the assertion.
-            created_by: The urn of the user that created the assertion.
-            created_at: The timestamp of when the assertion was created.
-            updated_by: The urn of the user that updated the assertion.
-            updated_at: The timestamp of when the assertion was updated.
-        """
-        self._urn = urn
-        self._dataset_urn = dataset_urn
-        self._display_name = display_name
-        self._mode = mode
-        self._created_by = created_by
-        self._created_at = created_at
-        self._updated_by = updated_by
-        self._updated_at = updated_at
-        self._tags = tags
-
-    @property
-    def urn(self) -> AssertionUrn:
-        return self._urn
-
-    @property
-    def dataset_urn(self) -> DatasetUrn:
-        return self._dataset_urn
-
-    @property
-    def display_name(self) -> str:
-        return self._display_name
-
-    @property
-    def mode(self) -> AssertionMode:
-        return self._mode
-
-    @property
-    def created_by(self) -> Optional[CorpUserUrn]:
-        return self._created_by
-
-    @property
-    def created_at(self) -> Union[datetime, None]:
-        return self._created_at
-
-    @property
-    def updated_by(self) -> Optional[CorpUserUrn]:
-        return self._updated_by
+        def _warn_and_return_false(field_name: str) -> bool:
+            logger.warning(
+                f"Monitor {monitor.urn} does not have an `{field_name}` field, defaulting detection mechanism to {DEFAULT_DETECTION_MECHANISM}"
+            )
+            return False
 
-    @property
-    def updated_at(self) -> Union[datetime, None]:
-        return self._updated_at
+        if monitor.info is None:
+            return _warn_and_return_false("info")
+        if monitor.info.assertionMonitor is None:
+            return _warn_and_return_false("assertionMonitor")
+        if (
+            monitor.info.assertionMonitor.assertions is None
+            or len(monitor.info.assertionMonitor.assertions) == 0
+        ):
+            return _warn_and_return_false("assertionMonitor.assertions")
 
-    @property
-    def tags(self) -> list[TagUrn]:
-        return self._tags
+        return True
 
     @staticmethod
-    def _get_incident_behavior(assertion: Assertion) -> list[AssertionIncidentBehavior]:
-        incident_behaviors = []
-        for action in assertion.on_failure + assertion.on_success:
-            if action.type == models.AssertionActionTypeClass.RAISE_INCIDENT:
-                incident_behaviors.append(AssertionIncidentBehavior.RAISE_ON_FAIL)
-            elif action.type == models.AssertionActionTypeClass.RESOLVE_INCIDENT:
-                incident_behaviors.append(AssertionIncidentBehavior.RESOLVE_ON_PASS)
+    def _get_assertion_parameters(
+        monitor: Monitor,
+        default: Optional[_DetectionMechanismTypes] = DEFAULT_DETECTION_MECHANISM,
+    ) -> Optional[models.AssertionEvaluationParametersClass]:
+        """Get the assertion parameters from the monitor."""
+        # We know these are not None from _has_valid_monitor_info check
+        assert (
+            monitor is not None
+            and monitor.info is not None
+            and monitor.info.assertionMonitor is not None
+        )
+        assertion_monitor = monitor.info.assertionMonitor
+        assert (
+            assertion_monitor is not None and assertion_monitor.assertions is not None
+        )
+        assertions = assertion_monitor.assertions
 
-        return incident_behaviors
+        if assertions[0].parameters is None:
+            logger.warning(
+                f"Monitor {monitor.urn} does not have a assertionMonitor.assertions[0].parameters, defaulting detection mechanism to {default}"
+            )
+            return None
+        return assertions[0].parameters
 
     @staticmethod
     def _get_created_by(assertion: Assertion) -> Optional[CorpUserUrn]:
@@ -619,8 +620,6 @@ class SmartFreshnessAssertion(_HasSchedule, _HasSmartFunctionality, _AssertionPu
             sensitivity=sensitivity,
             exclusion_windows=exclusion_windows,
             training_data_lookback_days=training_data_lookback_days,
-            incident_behavior=incident_behavior,
-            detection_mechanism=detection_mechanism,
         )
         # Then initialize the parent class
         _AssertionPublic.__init__(
@@ -629,6 +628,8 @@ class SmartFreshnessAssertion(_HasSchedule, _HasSmartFunctionality, _AssertionPu
             dataset_urn=dataset_urn,
             display_name=display_name,
             mode=mode,
+            incident_behavior=incident_behavior,
+            detection_mechanism=detection_mechanism,
             created_by=created_by,
             created_at=created_at,
             updated_by=updated_by,
@@ -717,8 +718,6 @@ class SmartVolumeAssertion(_HasSchedule, _HasSmartFunctionality, _AssertionPubli
             sensitivity=sensitivity,
             exclusion_windows=exclusion_windows,
             training_data_lookback_days=training_data_lookback_days,
-            incident_behavior=incident_behavior,
-            detection_mechanism=detection_mechanism,
         )
         # Then initialize the parent class
         _AssertionPublic.__init__(
@@ -727,6 +726,8 @@ class SmartVolumeAssertion(_HasSchedule, _HasSmartFunctionality, _AssertionPubli
             dataset_urn=dataset_urn,
             display_name=display_name,
             mode=mode,
+            incident_behavior=incident_behavior,
+            detection_mechanism=detection_mechanism,
             created_by=created_by,
             created_at=created_at,
             updated_by=updated_by,
@@ -760,8 +761,158 @@ class SmartVolumeAssertion(_HasSchedule, _HasSmartFunctionality, _AssertionPubli
         )
 
 
+class FreshnessAssertion(_HasSchedule, _AssertionPublic):
+    """
+    A class that represents a freshness assertion.
+    """
+
+    def __init__(
+        self,
+        *,
+        urn: AssertionUrn,
+        dataset_urn: DatasetUrn,
+        display_name: str,
+        mode: AssertionMode,
+        schedule: models.CronScheduleClass,
+        freshness_schedule_check_type: Union[
+            str, models.FreshnessAssertionScheduleTypeClass
+        ],
+        lookback_window: Optional[TimeWindowSizeInputTypes],
+        tags: list[TagUrn],
+        incident_behavior: list[AssertionIncidentBehavior],
+        detection_mechanism: Optional[
+            _DetectionMechanismTypes
+        ] = DEFAULT_DETECTION_MECHANISM,
+        created_by: Optional[CorpUserUrn] = None,
+        created_at: Union[datetime, None] = None,
+        updated_by: Optional[CorpUserUrn] = None,
+        updated_at: Optional[datetime] = None,
+    ):
+        """
+        Initialize a freshness assertion.
+
+        Note: Values can be accessed, but not set on the assertion object.
+        To update an assertion, use the `upsert_*` method.
+        Args:
+            urn: The urn of the assertion.
+            dataset_urn: The urn of the dataset that the assertion is for.
+            display_name: The display name of the assertion.
+            mode: The mode of the assertion (active, inactive).
+            schedule: The schedule of the assertion.
+            freshness_schedule_check_type: The type of freshness schedule check to be used for the assertion.
+            lookback_window: The lookback window to be used for the assertion.
+            tags: The tags applied to the assertion.
+            incident_behavior: Whether to raise or resolve an incident when the assertion fails / passes.
+            detection_mechanism: The detection mechanism of the assertion.
+            created_by: The urn of the user that created the assertion.
+            created_at: The timestamp of when the assertion was created.
+            updated_by: The urn of the user that updated the assertion.
+            updated_at: The timestamp of when the assertion was updated.
+        """
+        _HasSchedule.__init__(self, schedule=schedule)
+        _AssertionPublic.__init__(
+            self,
+            urn=urn,
+            dataset_urn=dataset_urn,
+            display_name=display_name,
+            mode=mode,
+            incident_behavior=incident_behavior,
+            detection_mechanism=detection_mechanism,
+            created_by=created_by,
+            created_at=created_at,
+            updated_by=updated_by,
+            updated_at=updated_at,
+            tags=tags,
+        )
+        self._freshness_schedule_check_type = freshness_schedule_check_type
+        self._lookback_window = lookback_window
+
+    @property
+    def freshness_schedule_check_type(
+        self,
+    ) -> Union[str, models.FreshnessAssertionScheduleTypeClass]:
+        return self._freshness_schedule_check_type
+
+    @property
+    def lookback_window(self) -> Optional[TimeWindowSizeInputTypes]:
+        return self._lookback_window
+
+    @staticmethod
+    def _get_freshness_schedule_check_type(
+        assertion: Assertion,
+    ) -> Union[str, models.FreshnessAssertionScheduleTypeClass]:
+        if assertion.info is None:
+            raise SDKNotYetSupportedError(
+                f"Assertion {assertion.urn} does not have a freshness assertion info, which is not supported"
+            )
+        if isinstance(assertion.info, models.FreshnessAssertionInfoClass):
+            if assertion.info.schedule is None:
+                raise SDKNotYetSupportedError(
+                    f"Traditional freshness assertion {assertion.urn} does not have a schedule, which is not supported"
+                )
+            return assertion.info.schedule.type
+        else:
+            raise SDKNotYetSupportedError(
+                f"Assertion {assertion.urn} is not a freshness assertion"
+            )
+
+    @staticmethod
+    def _get_lookback_window(
+        assertion: Assertion,
+    ) -> Optional[models.FixedIntervalScheduleClass]:
+        if assertion.info is None:
+            raise SDKNotYetSupportedError(
+                f"Assertion {assertion.urn} does not have a freshness assertion info, which is not supported"
+            )
+        if isinstance(assertion.info, models.FreshnessAssertionInfoClass):
+            if assertion.info.schedule is None:
+                raise SDKNotYetSupportedError(
+                    f"Traditional freshness assertion {assertion.urn} does not have a schedule, which is not supported"
+                )
+            return assertion.info.schedule.fixedInterval
+        else:
+            raise SDKNotYetSupportedError(
+                f"Assertion {assertion.urn} is not a freshness assertion"
+            )
+
+    @classmethod
+    def _from_entities(cls, assertion: Assertion, monitor: Monitor) -> Self:
+        """
+        Create a freshness assertion from the assertion and monitor entities.
+        """
+        return cls(
+            urn=assertion.urn,
+            dataset_urn=assertion.dataset,
+            display_name=assertion.description or "",
+            mode=cls._get_mode(monitor),
+            schedule=cls._get_schedule(monitor),
+            freshness_schedule_check_type=cls._get_freshness_schedule_check_type(
+                assertion
+            ),
+            lookback_window=cls._get_lookback_window(assertion),
+            incident_behavior=cls._get_incident_behavior(assertion),
+            detection_mechanism=cls._get_detection_mechanism(assertion, monitor),
+            created_by=cls._get_created_by(assertion),
+            created_at=cls._get_created_at(assertion),
+            updated_by=cls._get_updated_by(assertion),
+            updated_at=cls._get_updated_at(assertion),
+            tags=cls._get_tags(assertion),
+        )
+
+
+class SmartColumnMetricAssertion(_HasSmartFunctionality, _AssertionPublic):
+    """
+    A class that represents a smart column metric assertion.
+    """
+
+    def __init__(self) -> None:
+        raise NotImplementedError("SmartColumnMetricAssertion is not implemented yet")
+
+
 AssertionTypes = Union[
     SmartFreshnessAssertion,
     SmartVolumeAssertion,
+    FreshnessAssertion,
+    SmartColumnMetricAssertion,
     # TODO: Add other assertion types here as we add them.
 ]