validio-sdk 7.4.2__tar.gz → 8.0.0__tar.gz

{validio_sdk-7.4.2 → validio_sdk-8.0.0}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: validio-sdk
-Version: 7.4.2
+Version: 8.0.0
 Summary: SDK to interact with the Validio platform
-Home-page: https://validio.io/
 License: Apache-2.0
+License-File: LICENSE
 Author: Validio
 Author-email: support@validio.io
 Requires-Python: >=3.10,<4.0
@@ -11,11 +11,15 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: camel-converter (>=3.0.0,<4.0.0)
 Requires-Dist: gql[all] (>=3.5.0,<4.0.0)
 Requires-Dist: platformdirs (>=3.5.0,<4.0.0)
 Requires-Dist: rich (==13.9.4)
 Project-URL: Documentation, https://dev.validio.io/sdk-docs
+Project-URL: Homepage, https://validio.io/
 Description-Content-Type: text/markdown
 
 # validio-sdk

{validio_sdk-7.4.2 → validio_sdk-8.0.0}/pyproject.toml

@@ -3,7 +3,7 @@ name = "validio-sdk"
 # This version does not represent the released version or any tag. For each
 # release we automatically bump this before building and publishing so this
 # should be kept at 0.0.1dev1
-version = "7.4.2"
+version = "8.0.0"
 description = "SDK to interact with the Validio platform"
 authors = ["Validio <support@validio.io>"]
 license = "Apache-2.0"

{validio_sdk-7.4.2 → validio_sdk-8.0.0}/validio_sdk/_api/api.py

@@ -258,6 +258,10 @@ class APIClient:
         async with self.client as session:
             return await get_namespaces(session, namespace_id)
 
+    async def get_namespace_role_configs(self) -> list[dict[str, Any]]:
+        async with self.client as session:
+            return await get_namespace_role_configs(session)
+
     async def create_namespace(
         self,
         namespace_id: str,
@@ -418,7 +422,6 @@ async def get_sources(
           project
           dataset
           table
-          lookbackDays
           schedule
           billingProject
         }
@@ -438,7 +441,6 @@ async def get_sources(
           catalog
           database
           table
-          lookbackDays
           schedule
         }
       }
@@ -457,7 +459,6 @@ async def get_sources(
           database
           schema
           table
-          lookbackDays
           schedule
         }
       }
@@ -466,7 +467,6 @@ async def get_sources(
           database
           schema
           table
-          lookbackDays
           schedule
         }
       }
@@ -475,7 +475,6 @@ async def get_sources(
           catalog
           schema
           table
-          lookbackDays
           schedule
           httpPath
         }
@@ -515,7 +514,6 @@ async def get_sources(
           database
           schema
           table
-          lookbackDays
           schedule
         }
       }
@@ -526,7 +524,6 @@ async def get_sources(
           database
           schema
           table
-          lookbackDays
           schedule
         }
       }
@@ -549,7 +546,6 @@ async def get_sources(
         config {
           database
           table
-          lookbackDays
           schedule
         }
       }
@@ -975,6 +971,19 @@ async def get_credentials(
           optBaseUrl: baseUrl
         }
       }
+      ... on AwsBedrockCredential {
+        config {
+          model
+          region
+          optBaseUrl: baseUrl
+          auth {
+            __typename
+            ... on AwsBedrockCredentialAccessKey {
+              accessKeyId
+            }
+          }
+        }
+      }
       ... on AwsCredential {
         config {
           accessKey
@@ -1312,6 +1321,29 @@ async def get_channels(
           }
         }
       }
+      ... on ServiceNowChannel {
+        config {
+          applicationLinkUrl
+          instanceUrl
+          statusMapping {
+            triage
+            investigating
+            resolved
+            serviceNowActive
+            resolvedCloseCode
+            notAnAnomalyCloseCode
+          }
+          serviceNowAuth: auth {
+            __typename
+            ... on ServiceNowBasicAuth {
+              username
+            }
+            ... on ServiceNowOAuth {
+              clientId
+            }
+          }
+        }
+      }
     }
     """
 
@@ -1360,6 +1392,7 @@ async def get_channels(
             [
                 ("msTeamsInteractiveMessageEnabled", "interactiveMessageEnabled"),
                 ("emailInteractiveMessageEnabled", "interactiveMessageEnabled"),
+                ("serviceNowAuth", "auth"),
             ],
         )
 
@@ -1952,6 +1985,50 @@ async def get_validators(
         }}
         {reference_source_config}
       }}
+      ... on ReferentialIntegrityValidator {{
+        config {{
+          keyFields {{
+            sourceField
+            referenceField
+          }}
+          valueFields {{
+            sourceField
+            referenceField
+          }}
+          referenceSource {{
+            resourceName
+          }}
+          referenceWindow {{
+            resourceName
+          }}
+          referenceFilter {{
+            resourceName
+          }}
+          initializeWithBackfill
+          threshold {{
+            ...ThresholdDetails
+          }}
+        }}
+      }}
+      ... on ReconciliationValidator {{
+        config {{
+          reconciliationMetric: metric
+          segmentationFieldMapping {{
+            sourceField
+            referenceField
+          }}
+          referenceValidatorLeft {{
+            resourceName
+          }}
+          referenceValidatorRight {{
+            resourceName
+          }}
+          initializeWithBackfill
+          threshold {{
+            ...ThresholdDetails
+          }}
+        }}
+      }}
       ... on SqlValidator {{
         config {{
           query
@@ -2041,6 +2118,7 @@ async def get_validators(
                 ("categoricalDistributionMetric", "metric"),
                 ("distributionMetric", "metric"),
                 ("numericAnomalyMetric", "metric"),
+                ("reconciliationMetric", "metric"),
                 ("relativeTimeMetric", "metric"),
                 ("relativeVolumeMetric", "metric"),
                 ("volumeMetric", "metric"),
@@ -2257,6 +2335,21 @@ async def get_namespaces(
     return await execute(session, query, variable_values=variable_values)
 
 
+async def get_namespace_role_configs(
+    session: Session,
+) -> list[dict[str, Any]]:
+    query = """
+    query {
+        roleConfigs(input: {type: Namespace}) {
+            id
+            name
+            isSystemRole
+        }
+    }
+    """
+    return await execute(session, query)
+
+
 async def create_namespace(
     session: Session,
     namespace_id: str,

{validio_sdk-7.4.2 → validio_sdk-8.0.0}/validio_sdk/code/_import.py

@@ -6,7 +6,10 @@ from typing import Any, cast
 from validio_sdk.exception import ValidioError
 from validio_sdk.resource._resource import DiffContext, Resource
 from validio_sdk.resource._serde import IGNORE_CHANGES_FIELD_NAME
-from validio_sdk.resource._server_resources import CREDENTIALS_WITH_DEPENDENCIES
+from validio_sdk.resource._util import (
+    _CREDENTIALS_WITH_DEPENDENCIES,
+    _VALIDATORS_WITH_DEPENDENCIES,
+)
 from validio_sdk.resource.channels import Channel
 from validio_sdk.resource.credentials import Credential
 from validio_sdk.resource.filters import Filter
@@ -320,7 +323,8 @@ def add_resource_decls(
         # others last.
         resources.sort(
             key=lambda p: (
-                p[1].__class__.__name__ in CREDENTIALS_WITH_DEPENDENCIES,
+                p[1].__class__.__name__ in _CREDENTIALS_WITH_DEPENDENCIES,
+                p[1].__class__.__name__ in _VALIDATORS_WITH_DEPENDENCIES,
                 p[0],
             )
         )

{validio_sdk-7.4.2 → validio_sdk-8.0.0}/validio_sdk/code/plan.py

@@ -24,7 +24,6 @@ from validio_sdk.resource._resource import (
 )
 from validio_sdk.resource._server_resources import load_resources
 from validio_sdk.resource._util import SourceSchemaReinference
-from validio_sdk.resource.channels import WebhookChannel
 from validio_sdk.resource.tags import Tag
 
 
@@ -228,7 +227,7 @@ def _create_resource_diff_object(
     show_secrets: bool,
     rewrites: dict[str, Any] | None = None,
     secret_fields_changed: dict[str, Any] | None = None,
-    is_manifest: bool = False,
+    manifest: Resource | Diffable | dict | None = None,
 ) -> dict[str, object]:
     if rewrites is None:
         rewrites = {}
@@ -236,13 +235,24 @@ def _create_resource_diff_object(
     if secret_fields_changed is None:
         secret_fields_changed = {}
 
+    is_manifest = manifest is None
+
     data = dict(r) if not isinstance(r, dict) else r
+    manifest_data = (
+        dict(manifest)
+        if not isinstance(manifest, dict) and manifest is not None
+        else manifest
+    )
 
     diff_object = {}
     for k, v in data.items():
         if k.startswith("_"):
             continue
 
+        nested_manifest_data = (
+            manifest_data.get(k) if isinstance(manifest_data, dict) else None
+        )
+
         if k in rewrites:
             diff_object[k] = rewrites[k]
         elif isinstance(v, Resource | Diffable | dict):
@@ -251,7 +261,7 @@ def _create_resource_diff_object(
                 v,
                 show_secrets,
                 secret_fields_changed=ch if not isinstance(ch, bool) else {},
-                is_manifest=is_manifest,
+                manifest=nested_manifest_data,
             )
         elif hasattr(v, "__dict__") and not isinstance(v, Enum):
             ch = secret_fields_changed.get(k)
@@ -259,7 +269,7 @@ def _create_resource_diff_object(
                 v.__dict__,
                 show_secrets,
                 secret_fields_changed=ch if not isinstance(ch, bool) else {},
-                is_manifest=is_manifest,
+                manifest=nested_manifest_data,
             )
         elif isinstance(v, list):
             if len(v) == 0 or not isinstance(v[0], Diffable):
@@ -272,7 +282,7 @@ def _create_resource_diff_object(
                     _create_resource_diff_object(
                         item.__dict__,
                         show_secrets,
-                        is_manifest=is_manifest,
+                        manifest=None,
                     )
                 )
 
@@ -280,41 +290,28 @@ def _create_resource_diff_object(
         else:
             diff_object[k] = v
 
-    # Mask any sensitive info if requested.
-    if not show_secrets and hasattr(r, "_secret_fields"):
-        secret_fields = r._secret_fields()
-
-        if secret_fields:
-            for field in secret_fields:
-                # We want to avoid overriding webhook_url if it is None already
-                # which may give a misleading impression that it is set to a value.
-                #
-                # For any channel that is not the WebhookChannel, we will always
-                # flag it as changed if any secrets have changed, which is consistent
-                # with existing behavior.
-                #
-                # This workaround until webhook URL is deprecated fully from some
-                # channels (VR-4047).
-                flag_webhook_url_as_changed = False
-                if not isinstance(r, WebhookChannel) and field == "webhook_url":
-                    if hasattr(r, "webhook_url") and not r.webhook_url:
-                        continue
-                    if any(
-                        secret_fields_changed[secret_field]
-                        for secret_field in secret_fields_changed
-                    ):
-                        flag_webhook_url_as_changed = True
-
-                if (
-                    # Special case handling for webhook URL
-                    flag_webhook_url_as_changed
-                    or
-                    # If the field does not exist in the secrets changed dict then
-                    # don't flag it as changed
-                    secret_fields_changed.get(field)
-                ) and not is_manifest:
-                    diff_object[field] = "REDACTED-PREVIOUS"
-                else:
-                    diff_object[field] = "REDACTED"
+    # Nothing to mask, no secrets
+    if not hasattr(r, "_secret_fields"):
+        return diff_object
+
+    for secret_field in r._secret_fields():
+        # The field can either be in the map set to False, or absent, to be
+        # treated as unchanged.
+        field_changed = (
+            secret_field in secret_fields_changed
+            and secret_fields_changed[secret_field]
+        )
+
+        if is_manifest:
+            if not show_secrets:
+                diff_object[secret_field] = "REDACTED"
+        elif field_changed:
+            diff_object[secret_field] = (
+                "UNKNOWN" if show_secrets else "REDACTED-PREVIOUS"
+            )
+        elif not show_secrets:
+            diff_object[secret_field] = "REDACTED"
+        elif manifest_data and secret_field in manifest_data:
+            diff_object[secret_field] = manifest_data[secret_field]
 
     return diff_object

{validio_sdk-7.4.2 → validio_sdk-8.0.0}/validio_sdk/resource/_diff.py

@@ -38,6 +38,7 @@ from validio_sdk.resource._util import SourceSchemaReinference, _sanitized_error
 from validio_sdk.resource.replacement import (
     CascadeReplacementReason,
     ImmutableFieldReplacementReason,
+    RecreateOnChangeReplacementReason,
     ReplacementContext,
     ReplacementReason,
 )
@@ -217,16 +218,20 @@ def _compute_replacements(
             graph_diff.replacement_ctx, parent_resource_type
         )
 
-        to_replace = {
-            name: (resource_update, resource_update.replacement_field)
-            for name, resource_update in to_update.items()
-            if resource_update.replacement_field
-        }
+        to_replace: dict[str, ReplacementReason] = {}
+        for name, resource_update in to_update.items():
+            if resource_update.replacement_field:
+                to_replace[name] = ImmutableFieldReplacementReason(
+                    field_name=resource_update.replacement_field,
+                    resource_update=resource_update,
+                )
+            elif resource_update.manifest.recreate_on_change:
+                to_replace[name] = RecreateOnChangeReplacementReason(
+                    resource_update=resource_update,
+                )
 
-        for name, (resource_update, replacement_field) in to_replace.items():
-            replacement_ctx[name] = ImmutableFieldReplacementReason(
-                field_name=replacement_field, resource_update=resource_update
-            )
+        for name, reason in to_replace.items():
+            replacement_ctx[name] = reason
             _visit_resource_to_replace(
                 manifest_ctx=manifest_ctx,
                 server_ctx=server_ctx,
@@ -594,52 +599,87 @@ def diff(
 
     # No changes yet. Next, descend into the nested fields. If we find any
     # changes, then mark _this_ resource as changed.
-    server_nested_objects = server_object._nested_objects()
-    for field, manifest in manifest_object._nested_objects().items():
-        server = server_nested_objects[field]
-
-        # No possible change if both are unset.
-        if manifest is None and server is None:
-            continue
-
-        # If exactly one of them is None, then we definitely have a change.
-        if manifest is None or server is None:
-            return ResourceUpdate(manifest_resource, server_resource)
+    # For immutable nested objects, changes require the resource to be recreated.
+    nested_object_sources = [
+        (
+            manifest_object._mutable_nested_objects(),
+            server_object._mutable_nested_objects(),
+            False,
+        ),
+        (
+            manifest_object._immutable_nested_objects(),
+            server_object._immutable_nested_objects(),
+            True,
+        ),
+    ]
+    for manifest_nested, server_nested, is_immutable in nested_object_sources:
+        for field, manifest in manifest_nested.items():
+            server = server_nested[field]
+            replacement_field = field if is_immutable else None
 
-        if isinstance(server, list) != isinstance(manifest, list):
-            return ResourceUpdate(manifest_resource, server_resource)
+            # No possible change if both are unset.
+            if manifest is None and server is None:
+                continue
 
-        if isinstance(server, list) and isinstance(manifest, list):
-            if len(server) != len(manifest):
-                return ResourceUpdate(manifest_resource, server_resource)
+            # If exactly one of them is None, then we definitely have a change.
+            if manifest is None or server is None:
+                return ResourceUpdate(
+                    manifest_resource,
+                    server_resource,
+                    replacement_field=replacement_field,
+                )
 
-            for i in range(len(server)):
-                # Descend into both objects to diff.
-                collected_diff = diff(
-                    manifest[i],
-                    server[i],
-                    curr_depth + 1,
+            if isinstance(server, list) != isinstance(manifest, list):
+                return ResourceUpdate(
                     manifest_resource,
                     server_resource,
+                    replacement_field=replacement_field,
                 )
 
-                if collected_diff:
-                    # The returned diff is that of the full resource (not
-                    # just the nested object that had a change). So we can
-                    # exit with it.
-                    return collected_diff
+            if isinstance(server, list) and isinstance(manifest, list):
+                if len(server) != len(manifest):
+                    return ResourceUpdate(
+                        manifest_resource,
+                        server_resource,
+                        replacement_field=replacement_field,
+                    )
+
+                for i in range(len(server)):
+                    # Descend into both objects to diff.
+                    collected_diff = diff(
+                        manifest[i],
+                        server[i],
+                        curr_depth + 1,
+                        manifest_resource,
+                        server_resource,
+                    )
+
+                    if collected_diff:
+                        # For immutable, flag for replacement. For mutable,
+                        # return the collected diff directly.
+                        if is_immutable:
+                            return ResourceUpdate(
+                                manifest_resource,
+                                server_resource,
+                                replacement_field=replacement_field,
+                            )
+                        return collected_diff
 
-            continue
+                continue
 
-        # Descend into both objects to diff.
-        collected_diff = diff(
-            manifest, server, curr_depth + 1, manifest_resource, server_resource
-        )
-        if collected_diff:
-            # The returned diff is that of the full resource (not
-            # just the nested object that had a change). So we can
-            # exit with it.
-            return collected_diff
+            collected_diff = diff(
+                manifest, server, curr_depth + 1, manifest_resource, server_resource
+            )
+            if collected_diff:
+                # For immutable, flag for replacement. For mutable,
+                # return the collected diff directly.
+                if is_immutable:
+                    return ResourceUpdate(
+                        manifest_resource,
+                        server_resource,
+                        replacement_field=replacement_field,
+                    )
+                return collected_diff
 
     # No update to make
     return None

{validio_sdk-7.4.2 → validio_sdk-8.0.0}/validio_sdk/resource/_diffable.py

@@ -41,7 +41,7 @@ class Diffable(ABC):
     within a resource be sure to account for how that field should be diffed.
     Every field reachable from a resource, should be returned by exactly one
     of the listed APIs here, with the exception of `_replace_on_type_change_fields`
-    which can overlap with `_nested_objects`.
+    which can overlap with `_mutable_nested_objects`.
     """
 
     @abstractmethod
@@ -57,16 +57,27 @@ class Diffable(ABC):
         return set({})
 
     @abstractmethod
-    def _nested_objects(
+    def _mutable_nested_objects(
         self,
     ) -> dict[str, "Diffable | list[Diffable] | None"]:
-        """Returns any nested objects contained within this object.
+        """Returns any mutable nested objects contained within this object.
 
-        Nested objects will be diff-ed recursively.
+        Mutable nested objects will be diff-ed recursively.
         ...
         :returns dict[field, Optional[object]].
         """
 
+    def _immutable_nested_objects(
+        self,
+    ) -> dict[str, "Diffable | list[Diffable] | None"]:
+        """Returns any immutable nested objects contained within this object.
+
+        Immutable nested objects cannot be updated after creation.
+        ...
+        :returns dict[field, Optional[object]].
+        """
+        return {}
+
     def __iter__(self) -> Iterator[Any]:
         yield from self.__dict__.items()
 
@@ -83,7 +94,7 @@ class Diffable(ABC):
         if self._secret_fields():
             return True
 
-        for nested in self._nested_objects().values():
+        for nested in self._mutable_nested_objects().values():
             if isinstance(nested, list):
                 for n in nested:
                     if n._has_secret_fields(curr_depth=curr_depth + 1):
@@ -98,7 +109,8 @@ class Diffable(ABC):
         return {
             *self._immutable_fields(),
             *self._mutable_fields(),
-            *self._nested_objects().keys(),
+            *self._mutable_nested_objects().keys(),
+            *self._immutable_nested_objects().keys(),
             *self._ignored_fields(),
         }
 
@@ -239,7 +251,7 @@ class ApiSecretChangeNestedResource(Diffable):
         data[NODE_TYPE_FIELD_NAME] = self.__class__.__name__
         return data
 
-    def _nested_objects(
+    def _mutable_nested_objects(
         self,
     ) -> dict[str, "Diffable | list[Diffable] | None"]:
         return {}