acryl-datahub 0.15.0.1rc13__py3-none-any.whl → 0.15.0.1rc14__py3-none-any.whl

datahub/specific/dataproduct.py

@@ -1,25 +1,25 @@
-from typing import Dict, List, Optional, Union
+from typing import List, Optional, Tuple
 
-from datahub.emitter.mcp_patch_builder import MetadataPatchProposal
+from datahub.emitter.mcp_patch_builder import MetadataPatchProposal, PatchPath
 from datahub.metadata.schema_classes import (
     DataProductAssociationClass as DataProductAssociation,
     DataProductPropertiesClass as DataProductProperties,
-    GlobalTagsClass as GlobalTags,
-    GlossaryTermAssociationClass as Term,
-    GlossaryTermsClass as GlossaryTerms,
     KafkaAuditHeaderClass,
-    OwnerClass as Owner,
-    OwnershipTypeClass,
     SystemMetadataClass,
-    TagAssociationClass as Tag,
 )
-from datahub.specific.custom_properties import CustomPropertiesPatchHelper
-from datahub.specific.ownership import OwnershipPatchHelper
-from datahub.utilities.urns.tag_urn import TagUrn
-from datahub.utilities.urns.urn import Urn
-
-
-class DataProductPatchBuilder(MetadataPatchProposal):
+from datahub.specific.aspect_helpers.custom_properties import HasCustomPropertiesPatch
+from datahub.specific.aspect_helpers.ownership import HasOwnershipPatch
+from datahub.specific.aspect_helpers.tags import HasTagsPatch
+from datahub.specific.aspect_helpers.terms import HasTermsPatch
+
+
+class DataProductPatchBuilder(
+    HasOwnershipPatch,
+    HasCustomPropertiesPatch,
+    HasTagsPatch,
+    HasTermsPatch,
+    MetadataPatchProposal,
+):
     def __init__(
         self,
         urn: str,
@@ -31,59 +31,16 @@ class DataProductPatchBuilder(MetadataPatchProposal):
             system_metadata=system_metadata,
             audit_header=audit_header,
         )
-        self.custom_properties_patch_helper = CustomPropertiesPatchHelper(
-            self, DataProductProperties.ASPECT_NAME
-        )
-        self.ownership_patch_helper = OwnershipPatchHelper(self)
-
-    def add_owner(self, owner: Owner) -> "DataProductPatchBuilder":
-        self.ownership_patch_helper.add_owner(owner)
-        return self
-
-    def remove_owner(
-        self, owner: str, owner_type: Optional[OwnershipTypeClass] = None
-    ) -> "DataProductPatchBuilder":
-        """
-        param: owner_type is optional
-        """
-        self.ownership_patch_helper.remove_owner(owner, owner_type)
-        return self
-
-    def set_owners(self, owners: List[Owner]) -> "DataProductPatchBuilder":
-        self.ownership_patch_helper.set_owners(owners)
-        return self
-
-    def add_tag(self, tag: Tag) -> "DataProductPatchBuilder":
-        self._add_patch(
-            GlobalTags.ASPECT_NAME, "add", path=f"/tags/{tag.tag}", value=tag
-        )
-        return self
-
-    def remove_tag(self, tag: Union[str, Urn]) -> "DataProductPatchBuilder":
-        if isinstance(tag, str) and not tag.startswith("urn:li:tag:"):
-            tag = TagUrn.create_from_id(tag)
-        self._add_patch(GlobalTags.ASPECT_NAME, "remove", path=f"/tags/{tag}", value={})
-        return self
-
-    def add_term(self, term: Term) -> "DataProductPatchBuilder":
-        self._add_patch(
-            GlossaryTerms.ASPECT_NAME, "add", path=f"/terms/{term.urn}", value=term
-        )
-        return self
 
-    def remove_term(self, term: Union[str, Urn]) -> "DataProductPatchBuilder":
-        if isinstance(term, str) and not term.startswith("urn:li:glossaryTerm:"):
-            term = "urn:li:glossaryTerm:" + term
-        self._add_patch(
-            GlossaryTerms.ASPECT_NAME, "remove", path=f"/terms/{term}", value={}
-        )
-        return self
+    @classmethod
+    def _custom_properties_location(cls) -> Tuple[str, PatchPath]:
+        return DataProductProperties.ASPECT_NAME, ("customProperties",)
 
     def set_name(self, name: str) -> "DataProductPatchBuilder":
         self._add_patch(
             DataProductProperties.ASPECT_NAME,
             "add",
-            path="/name",
+            path=("name",),
             value=name,
         )
         return self
@@ -92,37 +49,18 @@ class DataProductPatchBuilder(MetadataPatchProposal):
         self._add_patch(
             DataProductProperties.ASPECT_NAME,
             "add",
-            path="/description",
+            path=("description",),
             value=description,
         )
         return self
 
-    def set_custom_properties(
-        self, custom_properties: Dict[str, str]
-    ) -> "DataProductPatchBuilder":
-        self._add_patch(
-            DataProductProperties.ASPECT_NAME,
-            "add",
-            path="/customProperties",
-            value=custom_properties,
-        )
-        return self
-
-    def add_custom_property(self, key: str, value: str) -> "DataProductPatchBuilder":
-        self.custom_properties_patch_helper.add_property(key, value)
-        return self
-
-    def remove_custom_property(self, key: str) -> "DataProductPatchBuilder":
-        self.custom_properties_patch_helper.remove_property(key)
-        return self
-
     def set_assets(
         self, assets: List[DataProductAssociation]
     ) -> "DataProductPatchBuilder":
         self._add_patch(
             DataProductProperties.ASPECT_NAME,
             "add",
-            path="/assets",
+            path=("assets",),
             value=assets,
         )
         return self
@@ -131,7 +69,7 @@ class DataProductPatchBuilder(MetadataPatchProposal):
         self._add_patch(
             DataProductProperties.ASPECT_NAME,
             "add",
-            path=f"/assets/{self.quote(asset_urn)}",
+            path=("assets", asset_urn),
             value=DataProductAssociation(destinationUrn=asset_urn),
         )
         return self
@@ -140,7 +78,7 @@ class DataProductPatchBuilder(MetadataPatchProposal):
         self._add_patch(
             DataProductProperties.ASPECT_NAME,
             "remove",
-            path=f"/assets/{self.quote(asset_urn)}",
+            path=("assets", asset_urn),
             value={},
         )
         return self
@@ -149,7 +87,7 @@ class DataProductPatchBuilder(MetadataPatchProposal):
         self._add_patch(
             DataProductProperties.ASPECT_NAME,
             "add",
-            path="/externalUrl",
+            path=("externalUrl",),
             value=external_url,
         )
         return self

datahub/specific/dataset.py

@@ -1,27 +1,27 @@
-from typing import Dict, Generic, List, Optional, Tuple, TypeVar, Union
+from typing import Generic, List, Optional, Tuple, TypeVar, Union
 
-from datahub.emitter.mcp_patch_builder import MetadataPatchProposal
+from datahub.emitter.mcp_patch_builder import MetadataPatchProposal, PatchPath
 from datahub.metadata.com.linkedin.pegasus2avro.common import TimeStamp
 from datahub.metadata.schema_classes import (
     DatasetPropertiesClass as DatasetProperties,
     EditableDatasetPropertiesClass as EditableDatasetProperties,
     EditableSchemaMetadataClass as EditableSchemaMetadata,
     FineGrainedLineageClass as FineGrainedLineage,
-    GlobalTagsClass as GlobalTags,
     GlossaryTermAssociationClass as Term,
-    GlossaryTermsClass as GlossaryTerms,
     KafkaAuditHeaderClass,
-    OwnerClass as Owner,
-    OwnershipTypeClass,
     SchemaMetadataClass,
     SystemMetadataClass,
     TagAssociationClass as Tag,
     UpstreamClass as Upstream,
     UpstreamLineageClass as UpstreamLineage,
 )
-from datahub.specific.custom_properties import CustomPropertiesPatchHelper
-from datahub.specific.ownership import OwnershipPatchHelper
-from datahub.specific.structured_properties import StructuredPropertiesPatchHelper
+from datahub.specific.aspect_helpers.custom_properties import HasCustomPropertiesPatch
+from datahub.specific.aspect_helpers.ownership import HasOwnershipPatch
+from datahub.specific.aspect_helpers.structured_properties import (
+    HasStructuredPropertiesPatch,
+)
+from datahub.specific.aspect_helpers.tags import HasTagsPatch
+from datahub.specific.aspect_helpers.terms import HasTermsPatch
 from datahub.utilities.urns.tag_urn import TagUrn
 from datahub.utilities.urns.urn import Urn
 
@@ -48,7 +48,7 @@ class FieldPatchHelper(Generic[_Parent]):
         self._parent._add_patch(
             self.aspect_name,
             "add",
-            path=f"/{self.aspect_field}/{self.field_path}/globalTags/tags/{tag.tag}",
+            path=(self.aspect_field, self.field_path, "globalTags", "tags", tag.tag),
             value=tag,
         )
         return self
@@ -59,7 +59,7 @@ class FieldPatchHelper(Generic[_Parent]):
         self._parent._add_patch(
             self.aspect_name,
             "remove",
-            path=f"/{self.aspect_field}/{self.field_path}/globalTags/tags/{tag}",
+            path=(self.aspect_field, self.field_path, "globalTags", "tags", tag),
             value={},
         )
         return self
@@ -68,7 +68,13 @@ class FieldPatchHelper(Generic[_Parent]):
         self._parent._add_patch(
             self.aspect_name,
             "add",
-            path=f"/{self.aspect_field}/{self.field_path}/glossaryTerms/terms/{term.urn}",
+            path=(
+                self.aspect_field,
+                self.field_path,
+                "glossaryTerms",
+                "terms",
+                term.urn,
+            ),
             value=term,
         )
         return self
@@ -79,7 +85,7 @@ class FieldPatchHelper(Generic[_Parent]):
         self._parent._add_patch(
             self.aspect_name,
             "remove",
-            path=f"/{self.aspect_field}/{self.field_path}/glossaryTerms/terms/{term}",
+            path=(self.aspect_field, self.field_path, "glossaryTerms", "terms", term),
             value={},
         )
         return self
@@ -88,7 +94,14 @@ class FieldPatchHelper(Generic[_Parent]):
         return self._parent
 
 
-class DatasetPatchBuilder(MetadataPatchProposal):
+class DatasetPatchBuilder(
+    HasOwnershipPatch,
+    HasCustomPropertiesPatch,
+    HasStructuredPropertiesPatch,
+    HasTagsPatch,
+    HasTermsPatch,
+    MetadataPatchProposal,
+):
     def __init__(
         self,
         urn: str,
@@ -98,34 +111,16 @@ class DatasetPatchBuilder(MetadataPatchProposal):
         super().__init__(
             urn, system_metadata=system_metadata, audit_header=audit_header
         )
-        self.custom_properties_patch_helper = CustomPropertiesPatchHelper(
-            self, DatasetProperties.ASPECT_NAME
-        )
-        self.ownership_patch_helper = OwnershipPatchHelper(self)
-        self.structured_properties_patch_helper = StructuredPropertiesPatchHelper(self)
-
-    def add_owner(self, owner: Owner) -> "DatasetPatchBuilder":
-        self.ownership_patch_helper.add_owner(owner)
-        return self
 
-    def remove_owner(
-        self, owner: str, owner_type: Optional[OwnershipTypeClass] = None
-    ) -> "DatasetPatchBuilder":
-        """
-        param: owner_type is optional
-        """
-        self.ownership_patch_helper.remove_owner(owner, owner_type)
-        return self
-
-    def set_owners(self, owners: List[Owner]) -> "DatasetPatchBuilder":
-        self.ownership_patch_helper.set_owners(owners)
-        return self
+    @classmethod
+    def _custom_properties_location(cls) -> Tuple[str, PatchPath]:
+        return DatasetProperties.ASPECT_NAME, ("customProperties",)
 
     def add_upstream_lineage(self, upstream: Upstream) -> "DatasetPatchBuilder":
         self._add_patch(
             UpstreamLineage.ASPECT_NAME,
             "add",
-            path=f"/upstreams/{self.quote(upstream.dataset)}",
+            path=("upstreams", upstream.dataset),
             value=upstream,
         )
         return self
@@ -136,14 +131,14 @@ class DatasetPatchBuilder(MetadataPatchProposal):
         self._add_patch(
             UpstreamLineage.ASPECT_NAME,
             "remove",
-            path=f"/upstreams/{dataset}",
+            path=("upstreams", dataset),
             value={},
         )
         return self
 
     def set_upstream_lineages(self, upstreams: List[Upstream]) -> "DatasetPatchBuilder":
         self._add_patch(
-            UpstreamLineage.ASPECT_NAME, "add", path="/upstreams", value=upstreams
+            UpstreamLineage.ASPECT_NAME, "add", path=("upstreams",), value=upstreams
         )
         return self
 
@@ -159,7 +154,7 @@ class DatasetPatchBuilder(MetadataPatchProposal):
             self._add_patch(
                 UpstreamLineage.ASPECT_NAME,
                 "add",
-                path=DatasetPatchBuilder.quote_fine_grained_path(
+                path=self._build_fine_grained_path(
                     transform_op, downstream_urn, query_id, upstream_urn
                 ),
                 value={"confidenceScore": fine_grained_lineage.confidenceScore},
@@ -179,12 +174,15 @@ class DatasetPatchBuilder(MetadataPatchProposal):
         return transform_op, downstream_urn, query_id
 
     @classmethod
-    def quote_fine_grained_path(
+    def _build_fine_grained_path(
         cls, transform_op: str, downstream_urn: str, query_id: str, upstream_urn: str
-    ) -> str:
+    ) -> PatchPath:
         return (
-            f"/fineGrainedLineages/{cls.quote(transform_op)}/"
-            f"{cls.quote(downstream_urn)}/{cls.quote(query_id)}/{cls.quote(upstream_urn)}"
+            "fineGrainedLineages",
+            transform_op,
+            downstream_urn,
+            query_id,
+            upstream_urn,
         )
 
     def remove_fine_grained_upstream_lineage(
@@ -199,7 +197,7 @@ class DatasetPatchBuilder(MetadataPatchProposal):
             self._add_patch(
                 UpstreamLineage.ASPECT_NAME,
                 "remove",
-                path=DatasetPatchBuilder.quote_fine_grained_path(
+                path=self._build_fine_grained_path(
                     transform_op, downstream_urn, query_id, upstream_urn
                 ),
                 value={},
@@ -212,37 +210,11 @@ class DatasetPatchBuilder(MetadataPatchProposal):
         self._add_patch(
             UpstreamLineage.ASPECT_NAME,
             "add",
-            path="/fineGrainedLineages",
+            path=("fineGrainedLineages",),
             value=fine_grained_lineages,
         )
         return self
 
-    def add_tag(self, tag: Tag) -> "DatasetPatchBuilder":
-        self._add_patch(
-            GlobalTags.ASPECT_NAME, "add", path=f"/tags/{tag.tag}", value=tag
-        )
-        return self
-
-    def remove_tag(self, tag: Union[str, Urn]) -> "DatasetPatchBuilder":
-        if isinstance(tag, str) and not tag.startswith("urn:li:tag:"):
-            tag = TagUrn.create_from_id(tag)
-        self._add_patch(GlobalTags.ASPECT_NAME, "remove", path=f"/tags/{tag}", value={})
-        return self
-
-    def add_term(self, term: Term) -> "DatasetPatchBuilder":
-        self._add_patch(
-            GlossaryTerms.ASPECT_NAME, "add", path=f"/terms/{term.urn}", value=term
-        )
-        return self
-
-    def remove_term(self, term: Union[str, Urn]) -> "DatasetPatchBuilder":
-        if isinstance(term, str) and not term.startswith("urn:li:glossaryTerm:"):
-            term = "urn:li:glossaryTerm:" + term
-        self._add_patch(
-            GlossaryTerms.ASPECT_NAME, "remove", path=f"/terms/{term}", value={}
-        )
-        return self
-
     def for_field(
         self, field_path: str, editable: bool = True
     ) -> FieldPatchHelper["DatasetPatchBuilder"]:
@@ -269,38 +241,11 @@ class DatasetPatchBuilder(MetadataPatchProposal):
                     else EditableDatasetProperties.ASPECT_NAME
                 ),
                 "add",
-                path="/description",
+                path=("description",),
                 value=description,
             )
         return self
 
-    def set_custom_properties(
-        self, custom_properties: Dict[str, str]
-    ) -> "DatasetPatchBuilder":
-        self._add_patch(
-            DatasetProperties.ASPECT_NAME,
-            "add",
-            path="/customProperties",
-            value=custom_properties,
-        )
-        return self
-
-    def add_custom_property(self, key: str, value: str) -> "DatasetPatchBuilder":
-        self.custom_properties_patch_helper.add_property(key, value)
-        return self
-
-    def add_custom_properties(
-        self, custom_properties: Optional[Dict[str, str]] = None
-    ) -> "DatasetPatchBuilder":
-        if custom_properties is not None:
-            for key, value in custom_properties.items():
-                self.custom_properties_patch_helper.add_property(key, value)
-        return self
-
-    def remove_custom_property(self, key: str) -> "DatasetPatchBuilder":
-        self.custom_properties_patch_helper.remove_property(key)
-        return self
-
     def set_display_name(
         self, display_name: Optional[str] = None
     ) -> "DatasetPatchBuilder":
@@ -308,7 +253,7 @@ class DatasetPatchBuilder(MetadataPatchProposal):
             self._add_patch(
                 DatasetProperties.ASPECT_NAME,
                 "add",
-                path="/name",
+                path=("name",),
                 value=display_name,
             )
         return self
@@ -320,7 +265,7 @@ class DatasetPatchBuilder(MetadataPatchProposal):
             self._add_patch(
                 DatasetProperties.ASPECT_NAME,
                 "add",
-                path="/qualifiedName",
+                path=("qualifiedName",),
                 value=qualified_name,
             )
         return self
@@ -332,7 +277,7 @@ class DatasetPatchBuilder(MetadataPatchProposal):
             self._add_patch(
                 DatasetProperties.ASPECT_NAME,
                 "add",
-                path="/created",
+                path=("created",),
                 value=timestamp,
             )
         return self
@@ -344,37 +289,7 @@ class DatasetPatchBuilder(MetadataPatchProposal):
             self._add_patch(
                 DatasetProperties.ASPECT_NAME,
                 "add",
-                path="/lastModified",
+                path=("lastModified",),
                 value=timestamp,
             )
         return self
-
-    def set_structured_property(
-        self, property_name: str, value: Union[str, float, List[Union[str, float]]]
-    ) -> "DatasetPatchBuilder":
-        """
-        This is a helper method to set a structured property.
-        @param property_name: the name of the property (either bare or urn form)
-        @param value: the value of the property (for multi-valued properties, this can be a list)
-        """
-        self.structured_properties_patch_helper.set_property(property_name, value)
-        return self
-
-    def add_structured_property(
-        self, property_name: str, value: Union[str, float]
-    ) -> "DatasetPatchBuilder":
-        """
-        This is a helper method to add a structured property.
-        @param property_name: the name of the property (either bare or urn form)
-        @param value: the value of the property (for multi-valued properties, this value will be appended to the list)
-        """
-        self.structured_properties_patch_helper.add_property(property_name, value)
-        return self
-
-    def remove_structured_property(self, property_name: str) -> "DatasetPatchBuilder":
-        """
-        This is a helper method to remove a structured property.
-        @param property_name: the name of the property (either bare or urn form)
-        """
-        self.structured_properties_patch_helper.remove_property(property_name)
-        return self

datahub/specific/form.py

@@ -5,15 +5,13 @@ from datahub.metadata.schema_classes import (
     FormInfoClass as FormInfo,
     FormPromptClass,
     KafkaAuditHeaderClass,
-    OwnerClass as Owner,
-    OwnershipTypeClass,
     SystemMetadataClass,
 )
-from datahub.specific.ownership import OwnershipPatchHelper
+from datahub.specific.aspect_helpers.ownership import HasOwnershipPatch
 from datahub.utilities.urns.urn import Urn
 
 
-class FormPatchBuilder(MetadataPatchProposal):
+class FormPatchBuilder(HasOwnershipPatch, MetadataPatchProposal):
     def __init__(
         self,
         urn: str,
@@ -23,31 +21,13 @@ class FormPatchBuilder(MetadataPatchProposal):
         super().__init__(
             urn, system_metadata=system_metadata, audit_header=audit_header
         )
-        self.ownership_patch_helper = OwnershipPatchHelper(self)
-
-    def add_owner(self, owner: Owner) -> "FormPatchBuilder":
-        self.ownership_patch_helper.add_owner(owner)
-        return self
-
-    def remove_owner(
-        self, owner: str, owner_type: Optional[OwnershipTypeClass] = None
-    ) -> "FormPatchBuilder":
-        """
-        param: owner_type is optional
-        """
-        self.ownership_patch_helper.remove_owner(owner, owner_type)
-        return self
-
-    def set_owners(self, owners: List[Owner]) -> "FormPatchBuilder":
-        self.ownership_patch_helper.set_owners(owners)
-        return self
 
     def set_name(self, name: Optional[str] = None) -> "FormPatchBuilder":
         if name is not None:
             self._add_patch(
                 FormInfo.ASPECT_NAME,
                 "add",
-                path="/name",
+                path=("name",),
                 value=name,
             )
         return self
@@ -57,7 +37,7 @@ class FormPatchBuilder(MetadataPatchProposal):
             self._add_patch(
                 FormInfo.ASPECT_NAME,
                 "add",
-                path="/description",
+                path=("description",),
                 value=description,
             )
         return self
@@ -67,7 +47,7 @@ class FormPatchBuilder(MetadataPatchProposal):
             self._add_patch(
                 FormInfo.ASPECT_NAME,
                 "add",
-                path="/type",
+                path=("type",),
                 value=type,
             )
         return self
@@ -76,7 +56,7 @@ class FormPatchBuilder(MetadataPatchProposal):
         self._add_patch(
             FormInfo.ASPECT_NAME,
             "add",
-            path=f"/prompts/{self.quote(prompt.id)}",
+            path=("prompts", prompt.id),
             value=prompt,
         )
         return self
@@ -90,7 +70,7 @@ class FormPatchBuilder(MetadataPatchProposal):
         self._add_patch(
             FormInfo.ASPECT_NAME,
             "remove",
-            path=f"/prompts/{self.quote(prompt_id)}",
+            path=("prompts", prompt_id),
             value=prompt_id,
         )
         return self
@@ -104,7 +84,7 @@ class FormPatchBuilder(MetadataPatchProposal):
         self._add_patch(
             FormInfo.ASPECT_NAME,
             "add",
-            path="/actors/owners",
+            path=("actors", "owners"),
             value=is_ownership,
         )
         return self
@@ -113,7 +93,7 @@ class FormPatchBuilder(MetadataPatchProposal):
         self._add_patch(
             FormInfo.ASPECT_NAME,
             "add",
-            path=f"/actors/users/{self.quote(str(user_urn))}",
+            path=("actors", "users", user_urn),
             value=user_urn,
         )
         return self
@@ -122,7 +102,7 @@ class FormPatchBuilder(MetadataPatchProposal):
         self._add_patch(
             FormInfo.ASPECT_NAME,
             "remove",
-            path=f"/actors/users/{self.quote(str(user_urn))}",
+            path=("actors", "users", user_urn),
             value=user_urn,
         )
         return self
@@ -131,7 +111,7 @@ class FormPatchBuilder(MetadataPatchProposal):
         self._add_patch(
             FormInfo.ASPECT_NAME,
             "add",
-            path=f"/actors/groups/{self.quote(str(group_urn))}",
+            path=("actors", "groups", group_urn),
             value=group_urn,
         )
         return self
@@ -140,7 +120,7 @@ class FormPatchBuilder(MetadataPatchProposal):
         self._add_patch(
             FormInfo.ASPECT_NAME,
             "remove",
-            path=f"/actors/groups/{self.quote(str(group_urn))}",
+            path=("actors", "groups", group_urn),
             value=group_urn,
         )
         return self