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

examples/test_jacquard_data_sets_scenarios.py

@@ -0,0 +1,94 @@
+"""
+PDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+Scenario tests for JacquardDataSets.
+"""
+import time
+from typing import List, Optional
+from dataclasses import dataclass
+
+from rich import print as rprint
+from rich.console import Console
+from rich.table import Table
+
+from examples.jacquard_data_sets import JacquardDataSets
+from pyegeria.core._exceptions import PyegeriaException
+
+VIEW_SERVER = "qs-view-server"
+PLATFORM_URL = "https://localhost:9443"
+USER_ID = "peterprofile"
+USER_PWD = "secret"
+
+console = Console(width=200)
+
+
+@dataclass
+class TestResult:
+    scenario_name: str
+    status: str
+    duration: float
+    message: str = ""
+
+
+class JacquardDataSetsScenarioTester:
+    def __init__(self):
+        self.client: Optional[JacquardDataSets] = None
+        self.results: List[TestResult] = []
+
+    def setup(self) -> bool:
+        try:
+            self.client = JacquardDataSets(VIEW_SERVER, PLATFORM_URL, USER_ID, USER_PWD)
+            self.client.create_egeria_bearer_token(USER_ID, USER_PWD)
+            return True
+        except Exception:
+            return False
+
+    def teardown(self):
+        if self.client:
+            self.client.close_session()
+
+    def scenario_tabular_data_set_discovery(self) -> TestResult:
+        name = "Tabular Data Set Discovery"
+        start_time = time.perf_counter()
+        try:
+            # 1. Find assets by name
+            assets = self.client.find_assets_by_name("Valid Metadata Value Set List")
+            
+            # 2. Find tabular data sets
+            datasets = self.client.find_tabular_data_sets()
+            
+            return TestResult(name, "PASSED", time.perf_counter() - start_time, f"Found {len(assets) if assets else 0} assets and {len(datasets) if datasets else 0} datasets")
+        except PyegeriaException as e:
+            return TestResult(name, "FAILED", time.perf_counter() - start_time, str(e))
+        except Exception as e:
+            return TestResult(name, "FAILED", time.perf_counter() - start_time, f"Unexpected error: {e}")
+
+    def run_all_scenarios(self):
+        if not self.setup():
+            rprint("[bold red]Setup failed, skipping scenarios[/bold red]")
+            return
+        
+        self.results.append(self.scenario_tabular_data_set_discovery())
+        self.teardown()
+        self.print_results_summary()
+
+    def print_results_summary(self):
+        table = Table(title="Jacquard Data Sets Scenario Results")
+        table.add_column("Scenario", style="cyan")
+        table.add_column("Status", justify="center")
+        table.add_column("Duration (s)", justify="right")
+        table.add_column("Message")
+        for res in self.results:
+            style = "green" if res.status == "PASSED" else "red"
+            table.add_row(res.scenario_name, f"[{style}]{res.status}[/{style}]", f"{res.duration:.2f}", res.message)
+        console.print(table)
+
+
+def test_jacquard_data_sets_scenarios():
+    tester = JacquardDataSetsScenarioTester()
+    tester.run_all_scenarios()
+
+
+if __name__ == "__main__":
+    test_jacquard_data_sets_scenarios()

md_processing/__init__.py

@@ -0,0 +1,90 @@
+"""
+This package contains functions to parse and process Egeria Markdown (Freddie)
+"""
+from md_processing.md_commands.governance_officer_commands import (process_gov_definition_upsert_command,
+                                                                   process_gov_def_link_detach_command,
+                                                                   process_supporting_gov_def_link_detach_command,
+                                                                   process_gov_def_context_command,
+                                                                   process_governed_by_link_detach_command
+                                                                   )
+
+
+from md_processing.md_commands.product_manager_commands import (process_digital_product_upsert_command,
+                                                                process_agreement_upsert_command,
+                                                                process_collection_upsert_command,
+                                                                process_link_agreement_item_command,
+                                                                process_add_to_collection_command,
+                                                                process_product_dependency_command,
+                                                                process_attach_collection_command,
+                                                                process_attach_subscriber_command,
+                                                                process_csv_element_upsert_command,
+                                                               )
+
+from md_processing.md_commands.solution_architect_commands import (process_blueprint_upsert_command,
+                                                                   process_solution_component_upsert_command,
+                                                                   process_component_link_unlink_command,
+                                                                   process_information_supply_chain_upsert_command,
+                                                                   process_information_supply_chain_link_unlink_command,
+                                                                   )
+
+from md_processing.md_commands.data_designer_commands import (process_data_field_upsert_command,
+                                                              process_data_spec_upsert_command,
+                                                              process_data_dict_upsert_command,
+                                                              process_data_structure_upsert_command)
+
+from md_processing.md_commands.feedback_commands import (process_add_comment_command, process_journal_entry_command,
+                                                         process_upsert_note_command, process_attach_note_log_command,
+                                                         process_upsert_informal_tag_command, process_tag_element_command)
+
+
+
+from md_processing.md_commands.glossary_commands import (process_glossary_upsert_command,
+                                                         process_term_upsert_command,
+                                                         process_link_term_term_relationship_command,
+                                                         )
+from md_processing.md_commands.project_commands import (process_project_upsert_command, process_link_project_dependency_command,
+                                                        process_link_project_hierarchy_command)
+
+from md_processing.md_commands.ext_ref_commands import (process_external_reference_upsert_command,
+                                                        process_link_to_media_reference_command,
+                                                        process_link_to_external_reference_command,
+                                                        process_link_to_cited_document_command,
+
+                                                        )
+
+# Re-export all functions from the original md_processing_utils.py to maintain backward compatibility
+from md_processing.md_processing_utils.common_md_utils import (render_markdown, is_valid_iso_date, set_debug_level,
+                                                               get_current_datetime_string, print_msg, EGERIA_WIDTH,
+                                                               debug_level, get_element_dictionary,
+                                                               update_element_dictionary, clear_element_dictionary,
+                                                               is_present, find_key_with_value,
+                                                               process_provenance_command, set_delete_request_body,
+                                                               set_rel_request_body, set_filter_request_body,
+                                                               set_update_body, set_peer_gov_def_request_body, set_rel_prop_body,
+                                                               set_gov_prop_body, set_element_prop_body, set_create_body,
+                                                               GOVERNANCE_POLICIES, GOVERNANCE_CONTROLS, GOVERNANCE_DRIVERS
+                                                               )
+from md_processing.md_processing_utils.extraction_utils import (extract_command_plus, extract_command,
+                                                                extract_attribute, process_simple_attribute,
+                                                                process_name_list, process_element_identifiers,
+                                                                get_element_by_name, update_a_command)
+from md_processing.md_processing_utils.md_processing_constants import ( pre_command,
+                                                                       command_seperator, EXISTS_REQUIRED,
+                                                                       GLOSSARY_NAME_LABELS,
+                                                                       TERM_NAME_LABELS, PROJECT_NAME_LABELS,
+                                                                       BLUEPRINT_NAME_LABELS, COMPONENT_NAME_LABELS,
+                                                                       SOLUTION_ROLE_LABELS, SOLUTION_ACTOR_ROLE_LABELS,
+                                                                       SOLUTION_LINKING_ROLE_LABELS, OUTPUT_LABELS,
+                                                                       SEARCH_LABELS, GUID_LABELS,
+                                                                       ELEMENT_OUTPUT_FORMATS, TERM_RELATIONSHPS,
+                                                                       command_list, COMMAND_DEFINITIONS, GOV_COM_LIST,
+                                                                       GOV_LINK_LIST, COLLECTIONS_LIST, SIMPLE_COLLECTIONS,
+                                                                       LIST_COMMANDS, PROJECT_COMMANDS, EXT_REF_UPSERT,
+                                                                       LINK_EXT_REF, LINK_MEDIA, LINK_CITED_DOC)
+# Import functions from md_processing_constants
+from md_processing.md_processing_utils.md_processing_constants import (load_commands, get_command_spec, get_attribute,
+                                                                       get_attribute_labels, get_alternate_names)
+# Import message constants
+
+from md_processing.md_processing_utils.common_md_proc_utils import process_output_command
+from md_processing.md_commands.view_commands import process_format_set_action, process_output_command

md_processing/command_dispatcher.py

@@ -0,0 +1,33 @@
+from typing import Callable, Dict, Any, Optional
+from loguru import logger
+
+class CommandDispatcher:
+    """
+    Registry and dispatcher for Dr.Egeria markdown commands.
+    """
+    def __init__(self):
+        self._registry: Dict[str, Callable] = {}
+
+    def register(self, command_name: str, handler: Callable):
+        """
+        Register a handler for a specific command name.
+        """
+        self._registry[command_name] = handler
+        logger.debug(f"Registered command handler for: {command_name}")
+
+    def get_handler(self, command_name: str) -> Optional[Callable]:
+        """
+        Retrieve the handler for a given command name.
+        """
+        return self._registry.get(command_name)
+
+    def dispatch(self, command_name: str, *args, **kwargs) -> Any:
+        """
+        Execute the handler for the given command.
+        """
+        handler = self.get_handler(command_name)
+        if handler:
+            return handler(*args, **kwargs)
+        else:
+            logger.warning(f"No handler registered for command: {command_name}")
+            return None

md_processing/command_mapping.py

@@ -0,0 +1,221 @@
+from md_processing.command_dispatcher import CommandDispatcher
+
+# Import all command handlers
+from md_processing.md_commands.project_commands import process_link_project_dependency_command
+from md_processing.md_commands.product_manager_commands import process_csv_element_upsert_command
+from md_processing import (
+    process_glossary_upsert_command, process_term_upsert_command,
+    process_provenance_command,
+    process_project_upsert_command, process_blueprint_upsert_command,
+    process_solution_component_upsert_command, process_component_link_unlink_command,
+    process_link_term_term_relationship_command,
+    process_information_supply_chain_upsert_command,
+    process_information_supply_chain_link_unlink_command,
+    process_digital_product_upsert_command, process_agreement_upsert_command,
+    process_collection_upsert_command, process_link_agreement_item_command,
+    process_gov_definition_upsert_command,
+    process_governed_by_link_detach_command,
+    process_gov_def_link_detach_command, process_product_dependency_command,
+    process_add_to_collection_command, process_attach_collection_command,
+    # process_gov_def_context_command, 
+    process_supporting_gov_def_link_detach_command,
+    process_attach_subscriber_command, process_output_command,
+    process_link_project_hierarchy_command,
+    process_external_reference_upsert_command,
+    process_link_to_external_reference_command, process_link_to_media_reference_command,
+    process_link_to_cited_document_command, 
+    EXT_REF_UPSERT, LINK_CITED_DOC, LINK_MEDIA, LINK_EXT_REF,
+    COLLECTIONS_LIST, SIMPLE_COLLECTIONS, GOV_COM_LIST, GOV_LINK_LIST,
+    LIST_COMMANDS, PROJECT_COMMANDS
+)
+
+from md_processing.md_commands.data_designer_commands import (
+    process_data_spec_upsert_command,
+    process_data_dict_upsert_command,
+    process_data_field_upsert_command,
+    process_data_structure_upsert_command,
+    process_data_class_upsert_command
+)
+
+from md_processing.md_commands.feedback_commands import (
+    process_add_comment_command, process_journal_entry_command,
+    process_upsert_note_command, process_attach_note_log_command,
+    process_upsert_informal_tag_command, process_tag_element_command
+)
+
+def setup_dispatcher() -> CommandDispatcher:
+    dispatcher = CommandDispatcher()
+
+    # Provenance
+    dispatcher.register("Provenance", lambda client, block, directive: process_provenance_command(client.input_file if hasattr(client, 'input_file') else "unknown", block)) 
+    # Note: process_provenance_command in dr_egeria takes (input_file, current_block). 
+    # But dispatch calls with (client, current_block, directive). 
+    # We might need to adjust the signature or use a wrapper.
+    # Actually, in dr_egeria.py: result = process_provenance_command(input_file, current_block)
+    # The dispatcher will likely be called as dispatch(command, client, block, directive)
+    # Use a lambda to adapt if necessary, or better yet, standardized handler signatures.
+    # For now, let's keep the mapping logic close to the original.
+
+    # Feedback Commands
+    for cmd in ["Create Comment", "Update Comment"]:
+        dispatcher.register(cmd, process_add_comment_command)
+    
+    dispatcher.register("Create Journal Entry", process_journal_entry_command)
+
+    for cmd in ["Create Note", "Update Note"]:
+        dispatcher.register(cmd, process_upsert_informal_tag_command) # Wait, check original file.
+        # Original: 
+        # elif potential_command in ["Create Note", "Update Note"]:
+        #     result = process_upsert_note_command(client, current_block, directive)
+    
+    # Correcting mapping based on review
+    for cmd in ["Create Note", "Update Note"]:
+        dispatcher.register(cmd, process_upsert_note_command)
+
+    for cmd in ["Link NoteLog", "Detach NoteLog"]:
+        dispatcher.register(cmd, process_attach_note_log_command)
+
+    for cmd in ["Create Informal Tag", "Update Informal Tag"]:
+        dispatcher.register(cmd, process_upsert_informal_tag_command)
+
+    for cmd in ["Link Tag", "Detach Tag", "Link Tag->Element"]:
+        dispatcher.register(cmd, process_tag_element_command)
+
+    # External References
+    for cmd in EXT_REF_UPSERT:
+        dispatcher.register(cmd, process_external_reference_upsert_command)
+    
+    for cmd in LINK_EXT_REF:
+        dispatcher.register(cmd, process_link_to_external_reference_command)
+        
+    for cmd in LINK_MEDIA:
+        dispatcher.register(cmd, process_link_to_media_reference_command)
+        
+    for cmd in LINK_CITED_DOC:
+        dispatcher.register(cmd, process_link_to_cited_document_command)
+
+    # Glossary
+    for cmd in ["Create Glossary", "Update Glossary"]:
+        dispatcher.register(cmd, process_glossary_upsert_command)
+
+    for cmd in ["Create Term", "Update Term"]:
+        dispatcher.register(cmd, process_term_upsert_command)
+
+    for cmd in ["Create Term-Term Relationship", "Update Term-Term Relationship", 
+                "Link Termss", "Detach Terms", "Link Term-Term Relationship", "Detach Term-Term Relationship"]:
+        dispatcher.register(cmd, process_link_term_term_relationship_command)
+
+    # Output / List / View
+    for cmd in LIST_COMMANDS:
+        dispatcher.register(cmd, process_output_command)
+        
+    for cmd in ["List Glossaries", "List Terms", "List Glossary Terms", "View Glossaries",
+                "View Terms", "View Glossary Terms", "View Report"]:
+        dispatcher.register(cmd, process_output_command)
+
+    # Projects
+    for cmd in PROJECT_COMMANDS:
+        dispatcher.register(cmd, process_project_upsert_command)
+
+    for cmd in ["Link Parent Project", "Attach Parent Project", "Detach Parent Project"]:
+        dispatcher.register(cmd, process_link_project_hierarchy_command)
+
+    for cmd in ["Link Project Dependency", "Attach Project Dependency", "Detach Project Dependency"]:
+        dispatcher.register(cmd, process_link_project_dependency_command)
+
+    # Blueprints & Solution Components
+    for cmd in ["Create Blueprint", "Update Blueprint", "Create Solution Blueprint", "Update Solution Blueprint"]:
+        dispatcher.register(cmd, process_blueprint_upsert_command)
+
+    for cmd in ["Create Solution Component", "Update Solution Component"]:
+        dispatcher.register(cmd, process_solution_component_upsert_command)
+
+    for cmd in ["Link Solution Components", "Link Solution Component Peers", "Wire Solution Components",
+                "Unlink Solution Components", "Detach Solution Components", "Detach Solution Component Peers"]:
+        dispatcher.register(cmd, process_component_link_unlink_command)
+
+    # Information Supply Chain
+    for cmd in ["Create Information Supply Chain", "Update Information Supply Chain"]:
+        dispatcher.register(cmd, process_information_supply_chain_upsert_command)
+
+    for cmd in ["Link Information Supply Chain Peers", "Link Information Supply Chains",
+                "Link Supply Chains", "Unlink Information Supply Chain Peers",
+                "Unlink Information Supply Chains", "Unlink Supply Chains"]:
+        dispatcher.register(cmd, process_information_supply_chain_link_unlink_command)
+
+    # Data Designer
+    for cmd in ["Create Data Spec", "Create Data Specification", "Update Data Spec", "Update Data Specification"]:
+        dispatcher.register(cmd, process_data_spec_upsert_command)
+
+    for cmd in ["Create Data Dict", "Create Data Dictionary", "Update Data Spec", "Update Data Dictionary"]: # Note: Update Data Spec is repeated here in original
+        dispatcher.register(cmd, process_data_dict_upsert_command)
+
+    for cmd in ["Create Data Field", "Update Data Field"]:
+        dispatcher.register(cmd, process_data_field_upsert_command)
+
+    for cmd in ["Create Data Structure", "Update Data Structure"]:
+        dispatcher.register(cmd, process_data_structure_upsert_command)
+
+    for cmd in ["Create Data Class", "Update Data Class"]:
+        dispatcher.register(cmd, process_data_class_upsert_command)
+
+    for cmd in ["View Data Dictionaries", "View Data Dictionary", "View Data Specifications", "View Data Specs",
+                "View Data Structures", "View Data Structure", "View Data Fields", "View Data Field",
+                "View Data Classes", "View Data Class"]:
+         dispatcher.register(cmd, process_output_command)
+
+    # Collections
+    for cmd in ["Create Digital Product Catalog", "Create Collection","Create Folder", "Create Root Collection",
+                "Update Digital Product Catalog", "Update Collection","Update Folder", "Update Root Collection"]:
+        dispatcher.register(cmd, process_collection_upsert_command)
+    
+    for cmd in SIMPLE_COLLECTIONS:
+        dispatcher.register(cmd, process_collection_upsert_command)
+
+    for cmd in ["Link Collection->Resource", "Detach Collection->Resource"]:
+        dispatcher.register(cmd, process_attach_collection_command)
+
+    for cmd in ["Add Member->Collection", "Detach Member->Collection", "Add Member", "Remove Member",
+                "Add to Folder", "Remove from Folder"]:
+        dispatcher.register(cmd, process_add_to_collection_command)
+
+
+    # Digital Products & Agreements
+    for cmd in ["Create Digital Product", "Create Data Product","Update Digital Product", "Update Data Product"]:
+        dispatcher.register(cmd, process_digital_product_upsert_command)
+
+    for cmd in ["Create Agreement", "Create Data Sharing Agreement", "Create Digital Subscription",
+                "Create Product Subscription", "Update Agreement", "Update Data Sharing Agreement",
+                "Update Digital Subscription", "Update Product Subscription"]:
+        dispatcher.register(cmd, process_agreement_upsert_command)
+
+    for cmd in ["Link Agreement->Item", "Detach Agreement->Item"]:
+        dispatcher.register(cmd, process_link_agreement_item_command)
+        
+    for cmd in ["Link Subscriber->Subscription", "Detach Subscriber->Subscription"]:
+         dispatcher.register(cmd, process_attach_subscriber_command)
+         
+    for cmd in ["Link Digital Products", "Detach Digital Products",
+                "Link Product-Product", "Detach Product-Product"]:
+        dispatcher.register(cmd, process_product_dependency_command)
+
+
+    # CSV
+    for cmd in ["Create CSV File"]:
+        dispatcher.register(cmd, process_csv_element_upsert_command)
+
+    # Governance
+    for cmd in GOV_COM_LIST:
+        dispatcher.register(cmd, process_gov_definition_upsert_command)
+
+    for cmd in GOV_LINK_LIST:
+        dispatcher.register(cmd, process_gov_def_link_detach_command)
+        
+    for cmd in ["Link Governance Mechanism", "Detach Governance Mechanism",
+                "Link Governance Response", "Detach Governance Response"]:
+        dispatcher.register(cmd, process_supporting_gov_def_link_detach_command)
+
+    for cmd in ["Link Governed By", "Detach Governed By"]:
+        dispatcher.register(cmd, process_governed_by_link_detach_command)
+
+    return dispatcher