pyegeria 5.4.0.28__py3-none-any.whl → 5.5.3.3__py3-none-any.whl

md_processing/md_processing_utils/generate_dr_help.py

@@ -1,29 +1,22 @@
 """
 This file contains general utility functions for processing Egeria Markdown
 """
-import json
 import os
 import sys
 from datetime import datetime
-from typing import List
 
 from loguru import logger
 from rich import print
 from rich.console import Console
-from rich.markdown import Markdown
 
 from commands.cat.dr_egeria_command_help import EGERIA_INBOX_PATH
-from md_processing.md_processing_utils.common_md_utils import (get_current_datetime_string, get_element_dictionary,
-                                                               update_element_dictionary,
-                                                               split_tb_string, str_to_bool, )
-from md_processing.md_processing_utils.extraction_utils import (process_simple_attribute, extract_attribute,
-                                                                get_element_by_name)
-from md_processing.md_processing_utils.md_processing_constants import (get_command_spec, load_commands, load_commands, COMMAND_DEFINITIONS)
-
-from md_processing.md_processing_utils.message_constants import (ERROR, INFO, WARNING, ALWAYS, EXISTS_REQUIRED)
-from pyegeria import EgeriaTech
-from pyegeria._globals import DEBUG_LEVEL
-from pyegeria.output_formatter import generate_entity_md_table
+from md_processing.md_processing_utils.md_processing_constants import (get_command_spec, load_commands,
+                                                                       COMMAND_DEFINITIONS,
+                                                                       add_default_upsert_attributes,
+                                                                       add_default_link_attributes)
+
+from pyegeria.core._globals import DEBUG_LEVEL
+from pyegeria.view.output_formatter import generate_entity_md_table, populate_columns_from_properties
 
 # Constants
 EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "200"))
@@ -69,18 +62,26 @@ def yes_no(input: str)->str:
 @logger.catch
 def _extract_help_fields(command: dict):
     """
-
+    Build a list of attribute dictionaries for a given command spec.
+    This prepares the data rows used to render the help table.
     """
 
     command_spec = get_command_spec(command)
-    attributes = command_spec.get('Attributes', [])
-    command_display_name = command_spec.get('display_name', None)
-    command_qn_prefix = command_spec.get('qn_prefix', None)
+    verb = command_spec.get('verb', None)
+    if verb == "Create":
+        distinguished_attributes = command_spec.get('Attributes', [])
+        attributes = add_default_upsert_attributes(distinguished_attributes)
+    elif verb in ["Link","Attach"]  :
+        distinguished_attributes = command_spec.get('Attributes', [])
+        attributes = add_default_link_attributes(distinguished_attributes)
+    else:
+        attributes = command_spec.get('Attributes', [])
+
 
     term_entry: list = []
     for attr in attributes:
         for key in attr:
-            if attr[key].get('level','Basic') != "Basic":
+            if attr[key].get('level', 'Basic') != "Basic":
                 continue
             attribute_name = key
             input_required = yes_no(attr[key].get('input_required', "No"))
@@ -93,19 +94,41 @@ def _extract_help_fields(command: dict):
             unique = yes_no(attr[key].get('unique', "No"))
             notes = attr[key].get('description', "")
             valid_values = attr[key].get('valid_values', [])
-            term_entry.append ({
-                'Attribute Name' : attribute_name,
-                'Input Required' : input_required,
-                'Read Only' : read_only,
-                'Generated' : generated,
-                'Default Value' : default,
-                'Notes' : notes,
-                'Unique Values' : unique,
-                'Valid Values' : valid_values,
-                })
+            term_entry.append({
+                'Attribute Name': attribute_name,
+                'Input Required': input_required,
+                'Read Only': read_only,
+                'Generated': generated,
+                'Default Value': default,
+                'Notes': notes,
+                'Unique Values': unique,
+                'Valid Values': valid_values,
+            })
 
     return term_entry
 
+@logger.catch
+def _extract_help_function(element: dict, columns_struct: dict) -> dict:
+    """
+    Return a populated columns data structure matching the signature and structure
+    of _extract_glossary_properties in glossary_manager.
+
+    Args:
+        element: One row (dict) describing a help attribute with keys matching columns_struct
+        columns_struct: Dict containing formats->columns definitions
+
+    Returns:
+        dict: A structure with key 'formats' and a 'columns' list whose entries have
+              their 'value' fields populated from the element dict.
+    """
+    # Normalize to a shape compatible with populate_columns_from_properties
+    normalized = {
+        'properties': element or {},
+        'elementHeader': {},
+    }
+    col_data = populate_columns_from_properties(normalized, columns_struct)
+    return col_data
+
 def create_help_terms():
     term_entry:str = ""
     glossary_name = "Egeria-Markdown"
@@ -118,13 +141,17 @@ def create_help_terms():
                {'name': 'Notes', 'key': 'Notes'},
                {'name': 'Unique Values', 'key': 'Unique Values'},
                {'name': 'Valid Values', 'key': 'Valid Values'}]
+    columns_struct = {"target_type": "Term", "formats": {
+                                          "types": "ALL",
+                                        "attributes": columns}
+                      }
 
     term_entry = """# Generating glossary entries for the documented commands\n\n
             This file contains generated Dr.Egeria commands to generate glossary term entries describing
             each Dr.Egeria command. 
 
 > Usage: Before executing this file, make sure you have a glossary named `Egeria-Markdown`
-> already created. If you Need to create one, you can use the \n"""
+> already created. If you Need to create one, you can use the `hey_egeria tui` command.\n"""
 
     for command, values in commands.items():
         if command == "exported":
@@ -137,14 +164,15 @@ def create_help_terms():
         term_entry+= "# Create Term\n"
         term_entry+= f"## Term Name\n\n{command}\n\n"
         term_entry+= f"## Description\n\n{command_description}\n\n"
-        term_entry+= f"## Owning Glossary\n\n{glossary_name}\n\n"
-        term_entry+= f"## Categories\n\nWriting Dr.Egeria Markdown\n\n"
+        term_entry+= f"## Glossary\n\n{glossary_name}\n\n"
+        term_entry+= f"## Folders\n\nWriting Dr.Egeria Markdown\n\n"
 
 
         du = _extract_help_fields(command)
-        output = generate_entity_md_table(du, "", "", _extract_help_fields, columns, None, "help" )
+        output = generate_entity_md_table(du, "", "", _extract_help_function, columns_struct, None, "help" )
 
         term_entry+= f"## Usage\n\n{output}\n\n___\n\n"
+
     print(term_entry)
     # Generate filename with current date and time in ISO 8601 format
     current_datetime = get_iso8601_datetime()

md_processing/md_processing_utils/generate_md_cmd_templates.py

@@ -3,24 +3,17 @@ This file contains general utility functions for processing Egeria Markdown
 """
 import os
 import sys
-from typing import List, Dict
 import io
-
+import copy
 from loguru import logger
 from rich import print
 from rich.console import Console
 
-from commands.cat.dr_egeria_command_help import EGERIA_INBOX_PATH
-from md_processing.md_processing_utils.common_md_utils import (get_current_datetime_string, get_element_dictionary,
-                                                               update_element_dictionary,
-                                                               split_tb_string, str_to_bool, )
-from md_processing.md_processing_utils.extraction_utils import (process_simple_attribute, extract_attribute,
-                                                                get_element_by_name)
-from md_processing.md_processing_utils.md_processing_constants import (get_command_spec, load_commands, load_commands, COMMAND_DEFINITIONS)
+from md_processing.md_processing_utils.md_processing_constants import (load_commands,
+                                                                       COMMAND_DEFINITIONS, add_default_link_attributes,
+                                                                       add_default_upsert_attributes)
 
-from md_processing.md_processing_utils.message_constants import (ERROR, INFO, WARNING, ALWAYS, EXISTS_REQUIRED)
-from pyegeria import EgeriaTech
-from pyegeria._globals import DEBUG_LEVEL
+from pyegeria.core._globals import DEBUG_LEVEL
 
 
 # Constants
@@ -61,7 +54,7 @@ def main():
     for command, values in commands.items():
         if command == "exported":
             continue
-        if values.get("level", "") not in ["Basic"]:
+        if values.get("level", "") not in ["Basic", "Advanced"]:
             continue
 
         family = values.get("family", "Other")
@@ -88,19 +81,27 @@ def main():
             command_output = io.StringIO()
 
             # Write command header
-            command_output.write(f"# **{command}**\n>\t{command_description}\n")
-            print(f"\n## {command_verb} **{command}**\n>\t{command_description}")
+            command_output.write(f"# {command}\n>\t{command_description}\n")
+            # print(f"\n## {command_verb} {command}\n>\t{command_description}")
+            print(f"\n# {command}\n>\t{command_description}")
 
             # Process command attributes
-            attributes = values['Attributes']
+            distinguished_attributes = values['Attributes']
+            if command_verb == "Link":
+                attributes = add_default_link_attributes(copy.deepcopy(distinguished_attributes))
+            elif command_verb == "Create":
+                attributes = add_default_upsert_attributes(copy.deepcopy(distinguished_attributes))
+            else:
+                attributes = add_default_link_attributes(copy.deepcopy(distinguished_attributes))
+
             for attribute in attributes:
                 for key, value in attribute.items():
-                    if value.get('level', "") not in ["Basic"]:
+                    if value.get('level', "") not in ["Basic","Advanced"]:
                         continue
                     user_specified = value.get('user_specified', 'true') in ["true", "True"]
 
-                    command_output.write(f"\n## **{key}**\n")
-                    print(f"\n### **{key}**")
+                    command_output.write(f"\n## {key}\n")
+                    print(f"\n### {key}")
 
                     command_output.write(f">\t**Input Required**: {value.get('input_required', 'false')}\n\n")
                     print(f">\tInput Required: {value.get('input_required', 'false')}")

md_processing/md_processing_utils/generate_md_templates.py

@@ -3,23 +3,14 @@ This file contains general utility functions for processing Egeria Markdown
 """
 import os
 import sys
-from typing import List
 
 from loguru import logger
 from rich import print
 from rich.console import Console
 
-from commands.cat.dr_egeria_command_help import EGERIA_INBOX_PATH
-from md_processing.md_processing_utils.common_md_utils import (get_current_datetime_string, get_element_dictionary,
-                                                               update_element_dictionary,
-                                                               split_tb_string, str_to_bool, )
-from md_processing.md_processing_utils.extraction_utils import (process_simple_attribute, extract_attribute,
-                                                                get_element_by_name)
-from md_processing.md_processing_utils.md_processing_constants import (get_command_spec, load_commands, load_commands, COMMAND_DEFINITIONS)
-
-from md_processing.md_processing_utils.message_constants import (ERROR, INFO, WARNING, ALWAYS, EXISTS_REQUIRED)
-from pyegeria import EgeriaTech
-from pyegeria._globals import DEBUG_LEVEL
+from md_processing.md_processing_utils.md_processing_constants import (load_commands, COMMAND_DEFINITIONS)
+
+from pyegeria.core._globals import DEBUG_LEVEL
 
 
 # Constants