acryl-datahub 1.0.0rc18__py3-none-any.whl → 1.3.0.1rc9__py3-none-any.whl

datahub/sdk/chart.py

@@ -0,0 +1,386 @@
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Dict, List, Optional, Sequence, Type, Union
+
+from deprecated.sphinx import deprecated
+from typing_extensions import Self
+
+import datahub.metadata.schema_classes as models
+from datahub.emitter.enum_helpers import get_enum_options
+from datahub.metadata.urns import ChartUrn, DatasetUrn, Urn
+from datahub.sdk._shared import (
+    ActorUrnOrStr,
+    ChangeAuditStampsMixin,
+    DataPlatformInstanceUrnOrStr,
+    DataPlatformUrnOrStr,
+    DatasetUrnOrStr,
+    DomainInputType,
+    HasContainer,
+    HasDomain,
+    HasInstitutionalMemory,
+    HasOwnership,
+    HasPlatformInstance,
+    HasSubtype,
+    HasTags,
+    HasTerms,
+    LinksInputType,
+    OwnersInputType,
+    ParentContainerInputType,
+    TagsInputType,
+    TermsInputType,
+)
+from datahub.sdk.dataset import Dataset
+from datahub.sdk.entity import Entity, ExtraAspectsType
+from datahub.utilities.sentinels import Unset, unset
+
+
+class Chart(
+    ChangeAuditStampsMixin,
+    HasPlatformInstance,
+    HasSubtype,
+    HasOwnership,
+    HasContainer,
+    HasInstitutionalMemory,
+    HasTags,
+    HasTerms,
+    HasDomain,
+    Entity,
+):
+    """Represents a chart in DataHub."""
+
+    __slots__ = ()
+
+    @classmethod
+    def get_urn_type(cls) -> Type[ChartUrn]:
+        """Get the URN type for charts.
+        Returns:
+            The ChartUrn class.
+        """
+        return ChartUrn
+
+    def __init__(
+        self,
+        *,
+        # Identity.
+        name: str,
+        platform: DataPlatformUrnOrStr,
+        display_name: Optional[str] = None,
+        platform_instance: Optional[DataPlatformInstanceUrnOrStr] = None,
+        # Chart properties.
+        description: Optional[str] = "",
+        external_url: Optional[str] = None,
+        chart_url: Optional[str] = None,
+        custom_properties: Optional[Dict[str, str]] = None,
+        last_modified: Optional[datetime] = None,
+        last_modified_by: Optional[ActorUrnOrStr] = None,
+        created_at: Optional[datetime] = None,
+        created_by: Optional[ActorUrnOrStr] = None,
+        deleted_on: Optional[datetime] = None,
+        deleted_by: Optional[ActorUrnOrStr] = None,
+        last_refreshed: Optional[datetime] = None,
+        chart_type: Optional[Union[str, models.ChartTypeClass]] = None,
+        access: Optional[str] = None,
+        input_datasets: Optional[Sequence[Union[DatasetUrnOrStr, Dataset]]] = None,
+        # Standard aspects.
+        parent_container: ParentContainerInputType | Unset = unset,
+        subtype: Optional[str] = None,
+        owners: Optional[OwnersInputType] = None,
+        links: Optional[LinksInputType] = None,
+        tags: Optional[TagsInputType] = None,
+        terms: Optional[TermsInputType] = None,
+        domain: Optional[DomainInputType] = None,
+        extra_aspects: ExtraAspectsType = None,
+    ):
+        """Initialize a new Chart instance."""
+        urn = ChartUrn.create_from_ids(
+            platform=str(platform),
+            name=name,
+            platform_instance=str(platform_instance) if platform_instance else None,
+        )
+        super().__init__(urn)
+        self._set_extra_aspects(extra_aspects)
+
+        self._set_platform_instance(platform, platform_instance)
+        self._ensure_chart_props(display_name=display_name)
+        self._init_chart_properties(
+            description,
+            display_name,
+            external_url,
+            chart_url,
+            custom_properties,
+            last_modified,
+            last_modified_by,
+            created_at,
+            created_by,
+            last_refreshed,
+            deleted_on,
+            deleted_by,
+            chart_type,
+            access,
+            input_datasets,
+        )
+        self._init_standard_aspects(
+            parent_container, subtype, owners, links, tags, terms, domain
+        )
+
+    @classmethod
+    def _new_from_graph(cls, urn: Urn, current_aspects: models.AspectBag) -> Self:
+        assert isinstance(urn, ChartUrn)
+        entity = cls(
+            platform=urn.dashboard_tool,
+            name=urn.chart_id,
+        )
+        return entity._init_from_graph(current_aspects)
+
+    def _init_chart_properties(
+        self,
+        description: Optional[str],
+        display_name: Optional[str],
+        external_url: Optional[str],
+        chart_url: Optional[str],
+        custom_properties: Optional[Dict[str, str]],
+        last_modified: Optional[datetime],
+        last_modified_by: Optional[ActorUrnOrStr],
+        created_at: Optional[datetime],
+        created_by: Optional[ActorUrnOrStr],
+        last_refreshed: Optional[datetime],
+        deleted_on: Optional[datetime],
+        deleted_by: Optional[ActorUrnOrStr],
+        chart_type: Optional[Union[str, models.ChartTypeClass]],
+        access: Optional[str],
+        input_datasets: Optional[Sequence[Union[DatasetUrnOrStr, Dataset]]],
+    ) -> None:
+        """Initialize chart-specific properties."""
+        if description is not None:
+            self.set_description(description)
+        if display_name is not None:
+            self.set_display_name(display_name)
+        if external_url is not None:
+            self.set_external_url(external_url)
+        if chart_url is not None:
+            self.set_chart_url(chart_url)
+        if custom_properties is not None:
+            self.set_custom_properties(custom_properties)
+        if last_modified is not None:
+            self.set_last_modified(last_modified)
+        if last_modified_by is not None:
+            self.set_last_modified_by(last_modified_by)
+        if created_at is not None:
+            self.set_created_at(created_at)
+        if created_by is not None:
+            self.set_created_by(created_by)
+        if deleted_on is not None:
+            self.set_deleted_on(deleted_on)
+        if deleted_by is not None:
+            self.set_deleted_by(deleted_by)
+        if last_refreshed is not None:
+            self.set_last_refreshed(last_refreshed)
+        if chart_type is not None:
+            self.set_chart_type(chart_type)
+        if access is not None:
+            self.set_access(access)
+        if input_datasets is not None:
+            self.set_input_datasets(input_datasets)
+
+    def _init_standard_aspects(
+        self,
+        parent_container: ParentContainerInputType | Unset,
+        subtype: Optional[str],
+        owners: Optional[OwnersInputType],
+        links: Optional[LinksInputType],
+        tags: Optional[TagsInputType],
+        terms: Optional[TermsInputType],
+        domain: Optional[DomainInputType],
+    ) -> None:
+        """Initialize standard aspects."""
+        if parent_container is not unset:
+            self._set_container(parent_container)
+        if subtype is not None:
+            self.set_subtype(subtype)
+        if owners is not None:
+            self.set_owners(owners)
+        if links is not None:
+            self.set_links(links)
+        if tags is not None:
+            self.set_tags(tags)
+        if terms is not None:
+            self.set_terms(terms)
+        if domain is not None:
+            self.set_domain(domain)
+
+    @property
+    def urn(self) -> ChartUrn:
+        assert isinstance(self._urn, ChartUrn)
+        return self._urn
+
+    def _ensure_chart_props(
+        self, display_name: Optional[str] = None
+    ) -> models.ChartInfoClass:
+        """Ensure chart properties exist, using a safer approach."""
+        return self._setdefault_aspect(
+            models.ChartInfoClass(
+                title=display_name or self.urn.chart_id,
+                description="",
+                lastModified=models.ChangeAuditStampsClass(),
+            )
+        )
+
+    def _get_audit_stamps(self) -> models.ChangeAuditStampsClass:
+        """Get the audit stamps from the chart properties."""
+        return self._ensure_chart_props().lastModified
+
+    def _set_audit_stamps(self, audit_stamps: models.ChangeAuditStampsClass) -> None:
+        """Set the audit stamps on the chart properties."""
+        self._ensure_chart_props().lastModified = audit_stamps
+
+    @property
+    def name(self) -> str:
+        """Get the name of the chart."""
+        return self.urn.chart_id
+
+    @property
+    @deprecated("Use display_name instead", version="1.2.0.7")
+    def title(self) -> str:
+        """Get the display name of the chart."""
+        return self.display_name
+
+    @deprecated("Use set_display_name instead", version="1.2.0.7")
+    def set_title(self, title: str) -> None:
+        """Set the display name of the chart."""
+        self.set_display_name(title)
+
+    @property
+    def description(self) -> Optional[str]:
+        """Get the description of the chart."""
+        return self._ensure_chart_props().description
+
+    def set_description(self, description: str) -> None:
+        """Set the description of the chart."""
+        self._ensure_chart_props().description = description
+
+    @property
+    def display_name(self) -> str:
+        """Get the display name of the chart."""
+        return self._ensure_chart_props().title
+
+    def set_display_name(self, display_name: str) -> None:
+        """Set the display name of the chart."""
+        self._ensure_chart_props().title = display_name
+
+    @property
+    def external_url(self) -> Optional[str]:
+        """Get the external URL of the chart."""
+        return self._ensure_chart_props().externalUrl
+
+    def set_external_url(self, external_url: str) -> None:
+        """Set the external URL of the chart."""
+        self._ensure_chart_props().externalUrl = external_url
+
+    @property
+    def chart_url(self) -> Optional[str]:
+        """Get the chart URL."""
+        return self._ensure_chart_props().chartUrl
+
+    def set_chart_url(self, chart_url: str) -> None:
+        """Set the chart URL."""
+        self._ensure_chart_props().chartUrl = chart_url
+
+    @property
+    def custom_properties(self) -> Dict[str, str]:
+        """Get the custom properties of the chart."""
+        return self._ensure_chart_props().customProperties
+
+    def set_custom_properties(self, custom_properties: Dict[str, str]) -> None:
+        """Set the custom properties of the chart."""
+        self._ensure_chart_props().customProperties = custom_properties
+
+    @property
+    def last_refreshed(self) -> Optional[datetime]:
+        """Get the last refresh timestamp of the chart."""
+        last_refreshed_time = self._ensure_chart_props().lastRefreshed
+        return (
+            datetime.fromtimestamp(last_refreshed_time)
+            if last_refreshed_time is not None
+            else None
+        )
+
+    def set_last_refreshed(self, last_refreshed: datetime) -> None:
+        """Set the last refresh timestamp of the chart."""
+        chart_props = self._ensure_chart_props()
+        chart_props.lastRefreshed = int(last_refreshed.timestamp())
+
+    @property
+    def chart_type(self) -> Optional[str]:
+        """Get the type of the chart as a string."""
+        chart_type = self._ensure_chart_props().type
+        return str(chart_type) if chart_type is not None else None
+
+    def set_chart_type(self, chart_type: Union[str, models.ChartTypeClass]) -> None:
+        """Set the type of the chart."""
+        if isinstance(chart_type, str):
+            chart_type_options = get_enum_options(models.ChartTypeClass)
+            if chart_type not in chart_type_options:
+                raise ValueError(
+                    f"Invalid chart type: {chart_type}; valid types are {chart_type_options}"
+                )
+        self._ensure_chart_props().type = chart_type
+
+    @property
+    def access(self) -> Optional[str]:
+        """Get the access level of the chart as a string."""
+        access = self._ensure_chart_props().access
+        return str(access) if access is not None else None
+
+    def set_access(self, access: Union[str, models.AccessLevelClass]) -> None:
+        """Set the access level of the chart."""
+        if isinstance(access, str):
+            assert access in get_enum_options(models.AccessLevelClass), (
+                f"Invalid access level: {access}"
+            )
+        self._ensure_chart_props().access = access
+
+    @property
+    def input_datasets(self) -> List[DatasetUrn]:
+        """Get the input datasets of the chart."""
+        props = self._ensure_chart_props()
+        # Convert all inputs to DatasetUrn
+        return [DatasetUrn.from_string(input_urn) for input_urn in (props.inputs or [])]
+
+    def set_input_datasets(
+        self, input_datasets: Sequence[Union[DatasetUrnOrStr, Dataset]]
+    ) -> None:
+        """Set the input datasets of the chart."""
+        # Convert all inputs to strings
+        inputs = []
+        for input_dataset in input_datasets:
+            if isinstance(input_dataset, Dataset):
+                inputs.append(str(input_dataset.urn))
+            else:
+                inputs.append(str(input_dataset))
+        self._ensure_chart_props().inputs = inputs
+
+    def add_input_dataset(self, input_dataset: Union[DatasetUrnOrStr, Dataset]) -> None:
+        """Add an input to the chart."""
+        if isinstance(input_dataset, Dataset):
+            input_dataset_urn = input_dataset.urn
+        elif isinstance(input_dataset, str):
+            input_dataset_urn = DatasetUrn.from_string(input_dataset)
+        else:  # isinstance(input_dataset, DatasetUrn)
+            input_dataset_urn = input_dataset
+
+        chart_props = self._ensure_chart_props()
+        inputs = chart_props.inputs or []
+        if str(input_dataset_urn) not in inputs:
+            inputs.append(str(input_dataset_urn))
+        chart_props.inputs = inputs
+
+    def remove_input_dataset(
+        self, input_dataset: Union[DatasetUrnOrStr, Dataset]
+    ) -> None:
+        """Remove an input from the chart."""
+        chart_props = self._ensure_chart_props()
+        inputs = chart_props.inputs or []
+        if input_dataset in inputs:
+            inputs.remove(str(input_dataset))
+            chart_props.inputs = inputs

datahub/sdk/container.py

@@ -23,12 +23,14 @@ from datahub.sdk._shared import (
     HasInstitutionalMemory,
     HasOwnership,
     HasPlatformInstance,
+    HasStructuredProperties,
     HasSubtype,
     HasTags,
     HasTerms,
     LinksInputType,
     OwnersInputType,
     ParentContainerInputType,
+    StructuredPropertyInputType,
     TagsInputType,
     TermsInputType,
     make_time_stamp,
@@ -44,6 +46,7 @@ class Container(
     HasContainer,
     HasOwnership,
     HasInstitutionalMemory,
+    HasStructuredProperties,
     HasTags,
     HasTerms,
     HasDomain,
@@ -78,6 +81,7 @@ class Container(
         tags: Optional[TagsInputType] = None,
         terms: Optional[TermsInputType] = None,
         domain: Optional[DomainInputType] = None,
+        structured_properties: Optional[StructuredPropertyInputType] = None,
         extra_aspects: ExtraAspectsType = None,
     ):
         # Hack: while the type annotations say container_key is always a ContainerKey,
@@ -145,6 +149,9 @@ class Container(
             self.set_terms(terms)
         if domain is not None:
             self.set_domain(domain)
+        if structured_properties is not None:
+            for key, value in structured_properties.items():
+                self.set_structured_property(property_urn=key, values=value)
 
     @classmethod
     def _new_from_graph(cls, urn: Urn, current_aspects: models.AspectBag) -> Self: