PyPI - pyegeria - Versions diffs - 5.3.9.9.7__py3-none-any.whl → 5.4.0__py3-none-any.whl - Mend

pyegeria 5.3.9.9.7py3-none-any.whl → 5.4.0py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (163) hide show

pyegeria/output_formatter.py CHANGED Viewed

@@ -1,11 +1,74 @@
 from datetime import datetime
+import re
 from typing import Any, Callable, Dict, List, Optional, Tuple, Union
+from pyegeria.utils import (camel_to_title_case)
+from markdown_it import MarkdownIt
 from rich.console import Console
+from pyegeria.mermaid_utilities import construct_mermaid_web
 console = Console(width= 250)
 # Constants
 MD_SEPARATOR = "\n---\n\n"
+def markdown_to_html(markdown_text: str) -> str:
+    """
+    Convert markdown text to HTML, with special handling for mermaid code blocks.
+    Args:
+        markdown_text: The markdown text to convert
+    Returns:
+        HTML string
+    """
+    # Initialize markdown-it
+    md = MarkdownIt()
+    # Find all mermaid code blocks
+    mermaid_blocks = re.findall(r'```mermaid\n(.*?)\n```', markdown_text, re.DOTALL)
+    # Replace each mermaid block with a placeholder
+    placeholders = []
+    for i, block in enumerate(mermaid_blocks):
+        placeholder = f"MERMAID_PLACEHOLDER_{i}"
+        markdown_text = markdown_text.replace(f"```mermaid\n{block}\n```", placeholder)
+        placeholders.append((placeholder, block))
+    # Convert markdown to HTML
+    html_text = md.render(markdown_text)
+    # Replace placeholders with rendered mermaid HTML
+    for placeholder, mermaid_block in placeholders:
+        mermaid_html = construct_mermaid_web(mermaid_block)
+        html_text = html_text.replace(placeholder, mermaid_html)
+    # Add basic HTML structure
+    html_text = f"""
+    <!DOCTYPE html>
+    <html>
+    <head>
+        <meta charset="UTF-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <title>Egeria Report</title>
+        <style>
+            body {{ font-family: Arial, sans-serif; line-height: 1.6; padding: 20px; }}
+            h1 {{ color: #2c3e50; }}
+            h2 {{ color: #3498db; }}
+            pre {{ background-color: #f8f8f8; padding: 10px; border-radius: 5px; overflow-x: auto; }}
+            table {{ border-collapse: collapse; width: 100%; margin-bottom: 20px; }}
+            th, td {{ border: 1px solid #ddd; padding: 8px; text-align: left; }}
+            th {{ background-color: #f2f2f2; }}
+            tr:nth-child(even) {{ background-color: #f9f9f9; }}
+        </style>
+    </head>
+    <body>
+        {html_text}
+    </body>
+    </html>
+    """
+    return html_text
 def make_preamble(obj_type: str, search_string: str, output_format: str = 'MD') -> Tuple[str, Optional[str]]:
     """
     Creates a preamble string and an elements action based on the given object type, search string,
@@ -26,14 +89,16 @@ def make_preamble(obj_type: str, search_string: str, output_format: str = 'MD')
             - A string or None indicating the action description for the elements,
               depending on the output format.
     """
-    search_string = search_string if search_string else "All Elements"
+    # search_string = search_string if search_string else "All Elements"
+    elements_md = ""
     elements_action = "Update " + obj_type
     if output_format == "FORM":
-        preamble = (f"\n# Update {obj_type} Form - created at {datetime.now().strftime('%Y-%m-%d %H:%M')}\n"
-                    f"\t {obj_type} found from the search string:  `{search_string}`\n\n")
+        preamble = f"\n# Update {obj_type} Form - created at {datetime.now().strftime('%Y-%m-%d %H:%M')}\n"
+        if search_string:
+            preamble +=  f"\t {obj_type} found from the search string:  `{search_string}`\n\n"
         return preamble, elements_action
     elif output_format == "REPORT":
-        elements_md = (f"# {obj_type} Report - created at {datetime.now().strftime('%Y-%m-%d %H:%M')}\n"
+        elements_md += (f"# {obj_type} Report - created at {datetime.now().strftime('%Y-%m-%d %H:%M')}\n"
                        f"\t{obj_type}  found from the search string:  `{search_string}`\n\n")
         elements_action = None
         return elements_md, elements_action
@@ -53,16 +118,32 @@ def make_md_attribute(attribute_name: str, attribute_value: str, output_type: st
         str: Formatted markdown for the attribute
     """
     output = ""
-    attribute_value = attribute_value.strip() if attribute_value else ""
-    attribute_title = attribute_name.title() if attribute_name else ""
+    if isinstance(attribute_value,str):
+        attribute_value = attribute_value.strip() if attribute_value else ""
+    elif isinstance(attribute_value,list):
+        attribute_value = ",\n".join(attribute_value)
+    if attribute_name:
+        if attribute_name.upper() == "GUID":
+            attribute_title = attribute_name.upper()
+        else:
+            # attribute_title = attribute_name.title()
+            attribute_title = camel_to_title_case(attribute_name)
+    else:
+        attribute_title = ""
     if output_type in ["FORM", "MD"]:
+        if attribute_name.lower() in [ "mermaid", "links", "implemented by", "sub_components"]:
+            return '\n'
         output = f"## {attribute_title}\n{attribute_value}\n\n"
     elif output_type == "REPORT":
-        if attribute_value:
+        if attribute_title in ['Mermaid Graph', 'Mermaid']:
+            output = f"## Mermaid Graph\n\n```mermaid\n{attribute_value}\n```\n"
+        elif attribute_value:
             output = f"## {attribute_title}\n{attribute_value}\n\n"
     return output
-def format_for_markdown_table(text: str) -> str:
+def format_for_markdown_table(text: str, guid: str = None) -> str:
     """
     Format text for markdown tables by replacing newlines with spaces and escaping pipe characters.
     No truncation is applied to allow full-length text display regardless of console width.
@@ -76,9 +157,15 @@ def format_for_markdown_table(text: str) -> str:
     if not text:
         return ""
     # Replace newlines with spaces and escape pipe characters
-    return text.replace("\n", " ").replace("|", "\\|")
+    if isinstance(text, list):
+        text = "\n".join(text)
+    t = text.replace("\n", " ").replace("|", "\\|")
+    if '::' in t and guid:
+        t = f" [{t}](#{guid}) "
+    return t
-def generate_entity_md(elements: List[Dict],
+def generate_entity_md(elements: List[Dict],
                       elements_action: str,
                       output_format: str,
                       entity_type: str,
@@ -101,33 +188,44 @@ def generate_entity_md(elements: List[Dict],
     elements_md = ""
     for element in elements:
+        if element is None:
+            continue
         props = extract_properties_func(element)
         # Get additional properties if function is provided
         additional_props = {}
         if get_additional_props_func:
-            additional_props = get_additional_props_func(element, props['guid'], output_format)
+            additional_props = get_additional_props_func(element,props['GUID'], output_format)
+        display_name = props.get('displayName', None)
+        if display_name is None:
+            display_name = props.get('title', None)
+            if display_name is None:
+                display_name = "NO DISPLAY NAME"
         # Format header based on output format
         if output_format in ['FORM', 'MD']:
             elements_md += f"# {elements_action}\n\n"
-            elements_md += f"## {entity_type} Name \n\n{props['display_name']}\n\n"
+            elements_md += f"## {entity_type} Name \n\n{display_name}\n\n"
         elif output_format == 'REPORT':
-            elements_md += f"# {entity_type} Name: {props['display_name']}\n\n"
+            elements_md += f'<a id="{props["GUID"]}"></a>\n\n# {entity_type} Name: {display_name}\n\n'
         else:
-            elements_md += f"## {entity_type} Name \n\n{props['display_name']}\n\n"
+            elements_md += f"## {entity_type} Name \n\n{display_name}\n\n"
         # Add common attributes
         for key, value in props.items():
-            if key not in ['guid', 'properties', 'display_name']:
+            if output_format in ['FORM', 'MD', 'DICT'] and key == 'mermaid':
+                continue
+            if key not in [ 'properties', 'display_name']:
                 elements_md += make_md_attribute(key.replace('_', ' '), value, output_format)
         # Add additional properties
         for key, value in additional_props.items():
             elements_md += make_md_attribute(key.replace('_', ' '), value, output_format)
-        # Add GUID
-        elements_md += make_md_attribute("GUID", props['guid'], output_format)
+        # # Add GUID
+        # elements_md += make_md_attribute("GUID",props['GUID'], output_format)
         # Add separator if not the last element
         if element != elements[-1]:
@@ -160,8 +258,10 @@ def generate_entity_md_table(elements: List[Dict],
     # Handle pluralization - if entity_type ends with 'y', use 'ies' instead of 's'
     entity_type_plural = f"{entity_type[:-1]}ies" if entity_type.endswith('y') else f"{entity_type}s"
-    elements_md = f"# {entity_type_plural} Table\n\n"
-    elements_md += f"{entity_type_plural} found from the search string: `{search_string}`\n\n"
+    elements_md = ""
+    if output_format == "LIST":
+        elements_md = f"# {entity_type_plural} Table\n\n"
+        elements_md += f"{entity_type_plural} found from the search string: `{search_string}`\n\n"
     # Add column headers
     header_row = "| "
@@ -175,12 +275,15 @@ def generate_entity_md_table(elements: List[Dict],
     # Add rows
     for element in elements:
-        props = extract_properties_func(element)
+        if output_format == "help":
+            props = element
+        else:
+            props = extract_properties_func(element)
         # Get additional properties if function is provided
         additional_props = {}
         if get_additional_props_func:
-            additional_props = get_additional_props_func(element, props['guid'], output_format)
+            additional_props = get_additional_props_func(element,props['GUID'], output_format)
         # Build row
         row = "| "
@@ -196,7 +299,7 @@ def generate_entity_md_table(elements: List[Dict],
             # Format the value if needed
             if 'format' in column and column['format']:
-                value = format_for_markdown_table(value)
+                value = format_for_markdown_table(value, props['GUID'])
             row += f"{value} | "
@@ -227,19 +330,21 @@ def generate_entity_dict(elements: List[Dict],
     result = []
     for element in elements:
+        if element is None:
+            continue
         props = extract_properties_func(element)
         # Get additional properties if function is provided
         additional_props = {}
         if get_additional_props_func:
-            additional_props = get_additional_props_func(element, props['guid'], output_format)
+            additional_props = get_additional_props_func(element,props['GUID'], output_format)
         # Create entity dictionary
         entity_dict = {}
         # Add properties based on include/exclude lists
         for key, value in props.items():
-            if key != 'properties':  # Skip the raw properties object
+            if key not in [ 'properties', 'mermaid']:  # Skip the raw properties object
                 if (include_keys is None or key in include_keys) and (
                         exclude_keys is None or key not in exclude_keys):
                     entity_dict[key] = value
@@ -289,15 +394,19 @@ def extract_basic_dict(elements: Union[Dict, List[Dict]]) -> Union[Dict, List[Di
         # Add classifications if present
         classifications = elements['elementHeader'].get('classifications', [])
         if classifications:
-            classification_names = ""
+            classification_names = "["
             for classification in classifications:
-                classification_names += f"* {classification['classificationName']}\n"
-            body['classification_names'] = classification_names
+                if len(classification_names) > 1:
+                    classification_names += ", "
+                classification_names += f"{classification['classificationName']}"
+            body['classification_names'] = classification_names + ']'
         return body
     result = []
     for element in elements:
+        if element is None:
+            continue
         body = {'guid': element['elementHeader']['guid']}
         for key in element['properties']:
             body[key] = element['properties'][key]
@@ -305,10 +414,12 @@ def extract_basic_dict(elements: Union[Dict, List[Dict]]) -> Union[Dict, List[Di
         # Add classifications if present
         classifications = element['elementHeader'].get('classifications', [])
         if classifications:
-            classification_names = ""
+            classification_names = "["
             for classification in classifications:
-                classification_names += f"* {classification['classificationName']}\n"
-            body['classifications'] = classification_names
+                if len(classification_names) > 1:
+                    classification_names += ", "
+                classification_names += f"{classification['classificationName']}"
+            body['classifications'] = classification_names + ']'
         result.append(body)
     return result
@@ -327,7 +438,7 @@ def generate_output(elements: Union[Dict, List[Dict]],
         elements: Dictionary or list of dictionaries containing element data
         search_string: The search string used to find the elements
         entity_type: The type of entity (e.g., "Glossary", "Term", "Category")
-        output_format: The desired output format (MD, FORM, REPORT, LIST, DICT, MERMAID)
+        output_format: The desired output format (MD, FORM, REPORT, LIST, DICT, MERMAID, HTML)
         extract_properties_func: Function to extract properties from an element
         get_additional_props_func: Optional function to get additional properties
         columns: Optional list of column definitions for table output
@@ -347,6 +458,20 @@ def generate_output(elements: Union[Dict, List[Dict]],
     if output_format == 'MERMAID':
         return extract_mermaid_only(elements)
+    elif output_format == 'HTML':
+        # First generate the REPORT format output
+        report_output = generate_output(
+            elements=elements,
+            search_string=search_string,
+            entity_type=entity_type,
+            output_format="REPORT",
+            extract_properties_func=extract_properties_func,
+            get_additional_props_func=get_additional_props_func
+        )
+        # Convert the markdown to HTML
+        return markdown_to_html(report_output)
     elif output_format == 'DICT':
         return generate_entity_dict(
             elements=elements,
@@ -370,7 +495,7 @@ def generate_output(elements: Union[Dict, List[Dict]],
             output_format=output_format
         )
-    else:  # MD, FORM, REPORT
+    else:  #  MD, FORM, REPORT
         elements_md, elements_action = make_preamble(
             obj_type=entity_type,
             search_string=search_string,

pyegeria 5.3.9.9.7__py3-none-any.whl → 5.4.0__py3-none-any.whl

pyegeria 5.3.9.9.7py3-none-any.whl → 5.4.0py3-none-any.whl