pyegeria 5.4.3.3__py3-none-any.whl → 5.4.3.4__py3-none-any.whl

md_processing/md_processing_utils/common_md_utils.py

@@ -240,6 +240,14 @@ def set_find_body(object_type: str, attributes: dict)->dict:
 
 
 def set_create_body(object_type: str, attributes: dict)->dict:
+    """
+    Build the OUTER request body for a create action (NewElementRequestBody).
+
+    Notes on two-layer convention:
+    - Outer layer (this function): action wrapper with metadata like externalSource*, effectiveTime, anchor/parent hints, and an empty "properties" field.
+    - Inner layer: an element-type-specific Properties structure built by set_element_prop_body, set_product_body, set_data_field_body, etc.
+    Callers should build the inner body separately with the appropriate helper and then assign it to body["properties"].
+    """
     prop_name = object_type.replace(" ", "")
     body = {
         "class": "NewElementRequestBody",
@@ -266,6 +274,13 @@ def set_create_body(object_type: str, attributes: dict)->dict:
 
 
 def set_update_body(object_type: str, attributes: dict)->dict:
+    """
+    Build the OUTER request body for an update action (UpdateElementRequestBody).
+
+    Two-layer convention:
+    - Outer layer (this function) provides action metadata and an empty "properties" slot.
+    - Inner layer must be constructed via element-specific helpers (e.g., set_element_prop_body) and assigned to the returned dict's "properties" key by the caller before invoking the client.
+    """
     return {
       "class" : "UpdateElementRequestBody",
       "externalSourceGUID": attributes.get('External Source GUID', {}).get('guid', None),
@@ -292,6 +307,16 @@ def set_rel_prop_body(object_type: str, attributes: dict)->dict:
         }
 
 def set_element_prop_body(object_type: str, qualified_name: str, attributes: dict)->dict:
+    """
+    Build the INNER element-specific Properties body to be placed under the outer body's "properties" key.
+
+    This returns the typed properties structure (e.g., "ReferenceableProperties" subtypes) appropriate for the object_type.
+    Usage example:
+    - outer = set_create_body(object_type, attributes)
+    - props = set_element_prop_body(object_type, qualified_name, attributes)
+    - outer["properties"] = props
+    - client.create_xxx(outer)
+    """
     prop_name = object_type.replace(" ", "")
     display_name = attributes.get('Display Name', {}).get('value', None)
 
@@ -323,7 +348,21 @@ def set_product_body(object_type: str, qualified_name: str, attributes: dict)->d
     prop_bod["nextVersion"] = attributes.get('Next Version Date', {}).get('value', [])
     return prop_bod
 
-
+def set_data_field_body(object_type: str, qualified_name: str, attributes: dict)->dict:
+    prop_bod = set_element_prop_body(object_type, qualified_name, attributes)
+    prop_bod["namespace"] = attributes.get('Namespace', {}).get('value', None)
+    prop_bod["aliases"] = attributes.get('Aliases', {}).get('value', [])
+    prop_bod["namePatterns"] = attributes.get('Name Patterns', {}).get('value', [])
+    prop_bod["defaultValue"] = attributes.get('Default Value', {}).get('value', None)
+    prop_bod["isNullable"] = attributes.get('Is Nullable', {}).get('value', None)
+    prop_bod["dataType"] = attributes.get('Data Type', {}).get('value', None)
+    prop_bod["units"] = attributes.get('Units', {}).get('value', None)
+    prop_bod["minimumLength"] = attributes.get('Minimum Length', {}).get('value', None)
+    prop_bod["length"] = attributes.get('Length', {}).get('value', None)
+    prop_bod["precision"] = attributes.get('Precision', {}).get('value', None)
+    prop_bod["orderedValues"] = attributes.get('Ordered Values', {}).get('value', [])
+    prop_bod["sortOrder"] = attributes.get('Sort Order', {}).get('value', None)
+    return prop_bod
 
 def set_update_status_body(object_type: str, attributes: dict)->dict:
     return {
@@ -394,6 +433,11 @@ def update_gov_body_for_type(object_type: str, body: dict, attributes: dict) ->
 
 
 def set_rel_request_body(object_type: str, attributes: dict)->dict:
+    """
+    Build the OUTER request body for creating a relationship (NewRelationshipRequestBody).
+    The inner relationship properties must be assigned to the returned dict under the "properties" key,
+    commonly via set_rel_prop_body or set_rel_request_body_for_type.
+    """
     return {
       "class" : "NewRelationshipRequestBody",
       "externalSourceGUID": attributes.get('External Source GUID', {}).get('guid', None),
@@ -416,6 +460,11 @@ def set_peer_gov_def_request_body(object_type: str, attributes: dict)->dict:
     return rel_body
 
 def set_rel_request_body_for_type(object_type: str, attributes: dict)->dict:
+    """
+    Convenience helper that builds both layers (outer + inner) for a relationship of a known type.
+    It creates the outer NewRelationshipRequestBody via set_rel_request_body and fills rel_body["properties"]
+    with a typed properties structure under the "class" of f"{object_type}Properties".
+    """
     rel_body = set_rel_request_body(object_type, attributes)
     # class_prop = camel_to_title_case(object_type) + "Properties"
     class_prop = f"{object_type}Properties"

md_processing/md_processing_utils/extraction_utils.py

@@ -421,7 +421,7 @@ def get_element_by_name(egeria_client, element_type: str, element_name: str) ->
                 return q_name, guid, unique, exists
 
     # Haven't seen this element before
-    property_names = ['qualifiedName', 'name', 'displayName', 'title']
+    property_names = ['qualifiedName', 'displayName', 'title']
     open_metadata_type_name = None
     details = egeria_client.get_elements_by_property_value(element_name, property_names, open_metadata_type_name)
     if isinstance(details, str):
@@ -430,12 +430,19 @@ def get_element_by_name(egeria_client, element_type: str, element_name: str) ->
         exists = False
         return None, None, unique, exists
     if len(details) > 1:
-        msg = (f"More than one element with name {element_name} found, please specify a "
-               f"**Qualified Name**")
-        print_msg("DEBUG-ERROR", msg, debug_level)
-        unique = False
-        exists = None
-        return element_name, None, unique, exists
+        if q_name is None:
+            q_name = egeria_client.__create_qualified_name__(element_type, element_name)
+            guid = egeria_client.__get_guid__(qualified_name=q_name)
+            update_element_dictionary(q_name, {'guid': guid})
+            exists = True if guid != "No elements found" else False
+            return q_name, guid, unique, exists
+        else:
+            msg = (f"More than one element with name {element_name} found, please specify a "
+                   f"**Qualified Name**")
+            print_msg("DEBUG-ERROR", msg, debug_level)
+            unique = False
+            exists = None
+            return element_name, None, unique, exists
 
     el_qname = details[0]["properties"].get('qualifiedName', None)
     el_guid = details[0]['elementHeader']['guid']

md_processing/md_processing_utils/md_processing_constants.py

@@ -150,7 +150,7 @@ command_list = ["Provenance", "Create Glossary", "Update Glossary", "Create Term
                 "Update Data Structure", "Create Data Dictionary", "Update Data Dictionary", "Create Data Dict",
                 "Update Data Dict",
                 "View Data Structures", "View Data Structure", "View Data Fields", "View Data Field",
-                "View Dataa Classes", "View Data Class", "Create Data Class", "Update Data Class",
+                "View Data Classes", "View Data Class", "Create Data Class", "Update Data Class",
                 "Create Digital Product", "Create Data Product", "Update Digital Product", "Update Data Product",
                 "Create Agreement", "Update Agreement",
                 "Link Digital Products", "Link Product-Product", "Detach Digital Products", "Detach Product-Product",