ara-cli 0.1.10.5__py3-none-any.whl → 0.1.14.0__py3-none-any.whl

ara_cli/ara_command_action.py

@@ -23,23 +23,43 @@ def create_action(args):
     from ara_cli.artefact_reader import ArtefactReader
     from ara_cli.artefact_fuzzy_search import find_closest_rule
 
-    check_validity(Classifier.is_valid_classifier(args.classifier), "Invalid classifier provided. Please provide a valid classifier.")
-    check_validity(is_valid_filename(args.parameter), "Invalid filename provided. Please provide a valid filename.")
+    check_validity(
+        Classifier.is_valid_classifier(args.classifier),
+        "Invalid classifier provided. Please provide a valid classifier.",
+    )
+    check_validity(
+        is_valid_filename(args.parameter),
+        "Invalid filename provided. Please provide a valid filename.",
+    )
 
     def handle_parent_arguments(args):
-        parent_classifier = args.parent_classifier if hasattr(args, "parent_classifier") else None
+        parent_classifier = (
+            args.parent_classifier if hasattr(args, "parent_classifier") else None
+        )
         parent_name = args.parent_name if hasattr(args, "parent_name") else None
-        rule = args.rule if hasattr(args, 'rule') else None
-        invalid_classifier_message = "Invalid parent classifier provided. Please provide a valid classifier"
-        invalid_name_message = "Invalid filename provided for parent. Please provide a valid filename."
+        rule = args.rule if hasattr(args, "rule") else None
+        invalid_classifier_message = (
+            "Invalid parent classifier provided. Please provide a valid classifier"
+        )
+        invalid_name_message = (
+            "Invalid filename provided for parent. Please provide a valid filename."
+        )
         if parent_classifier and parent_name and rule:
-            check_validity(Classifier.is_valid_classifier(parent_classifier), invalid_classifier_message)
+            check_validity(
+                Classifier.is_valid_classifier(parent_classifier),
+                invalid_classifier_message,
+            )
             check_validity(is_valid_filename(parent_name), invalid_name_message)
-            parent_artefact = ArtefactReader.read_artefact(artefact_name=parent_name, classifier=parent_classifier)
+            parent_artefact = ArtefactReader().read_artefact(
+                artefact_name=parent_name, classifier=parent_classifier
+            )
             rule = find_closest_rule(parent_artefact, rule)
             return parent_classifier, parent_name, rule
         if parent_classifier and parent_name:
-            check_validity(Classifier.is_valid_classifier(parent_classifier), invalid_classifier_message)
+            check_validity(
+                Classifier.is_valid_classifier(parent_classifier),
+                invalid_classifier_message,
+            )
             check_validity(is_valid_filename(parent_name), invalid_name_message)
             return parent_classifier, parent_name, rule
         return None, None, None
@@ -61,7 +81,9 @@ def create_action(args):
         return
 
     artefact_creator = ArtefactCreator()
-    artefact_creator.run(args.parameter, args.classifier, parent_classifier, parent_name, rule)
+    artefact_creator.run(
+        args.parameter, args.classifier, parent_classifier, parent_name, rule
+    )
 
 
 @handle_errors(context="delete action", error_handler=error_handler)
@@ -78,22 +100,39 @@ def rename_action(args):
     from ara_cli.classifier import Classifier
     from ara_cli.filename_validator import is_valid_filename
 
-    check_validity(is_valid_filename(args.parameter), "Invalid filename provided. Please provide a valid filename.")
-    check_validity(Classifier.is_valid_classifier(args.classifier), "Invalid classifier provided. Please provide a valid classifier.")
-    check_validity(is_valid_filename(args.aspect), "Invalid new filename provided. Please provide a valid filename.")
+    check_validity(
+        is_valid_filename(args.parameter),
+        "Invalid filename provided. Please provide a valid filename.",
+    )
+    check_validity(
+        Classifier.is_valid_classifier(args.classifier),
+        "Invalid classifier provided. Please provide a valid classifier.",
+    )
+    check_validity(
+        is_valid_filename(args.aspect),
+        "Invalid new filename provided. Please provide a valid filename.",
+    )
 
     artefact_renamer = ArtefactRenamer()
     artefact_renamer.rename(args.parameter, args.aspect, args.classifier)
 
 
+def _execute_list_method(method, classifier, artefact_name, list_filter, flag_name):
+    """Helper function to validate and execute list methods."""
+    if not classifier or not artefact_name:
+        raise AraError(
+            f"Both classifier and artefact_name are required for --{flag_name}"
+        )
+    method(classifier=classifier, artefact_name=artefact_name, list_filter=list_filter)
+
+
 @handle_errors(context="rename action", error_handler=error_handler)
 def list_action(args):
     from ara_cli.artefact_lister import ArtefactLister
     from ara_cli.list_filter import ListFilter
 
-    branch_classifier, branch_artefact_name = args.branch_args
-    children_classifier, children_artefact_name = args.children_args
-    data_classifier, data_artefact_name = args.data_args
+    classifier = args.classifier
+    artefact_name = args.artefact_name
 
     artefact_lister = ArtefactLister()
 
@@ -103,32 +142,30 @@ def list_action(args):
         include_extension=args.include_extension,
         exclude_extension=args.exclude_extension,
         include_tags=args.include_tags,
-        exclude_tags=args.exclude_tags
+        exclude_tags=args.exclude_tags,
     )
 
-    if branch_classifier and branch_artefact_name:
-        artefact_lister.list_branch(
-            classifier=branch_classifier,
-            artefact_name=branch_artefact_name,
-            list_filter=list_filter
-        )
-        return
-
-    if children_classifier and children_artefact_name:
-        artefact_lister.list_children(
-            classifier=children_classifier,
-            artefact_name=children_artefact_name,
-            list_filter=list_filter
-        )
-        return
+    # Map flags to their corresponding methods
+    flag_method_map = {
+        "branch": (args.branch, artefact_lister.list_branch),
+        "children": (args.children, artefact_lister.list_children),
+        "data": (args.data, artefact_lister.list_data),
+    }
 
-    if data_classifier and data_artefact_name:
-        artefact_lister.list_data(
-            classifier=data_classifier,
-            artefact_name=data_artefact_name,
-            list_filter=list_filter
+    for flag_name, (flag_value, method) in flag_method_map.items():
+        if flag_value:
+            _execute_list_method(
+                method, classifier, artefact_name, list_filter, flag_name
+            )
+            return
+
+    # If both classifier and artefact_name are present, but no specific action flag (branch, children, data)
+    # was provided, raise an error as per requirements.
+    if classifier and artefact_name:
+        raise AraError(
+            f"To list specific info for '{classifier} {artefact_name}', "
+            "you must provide one of: --children, --branch, or --data."
         )
-        return
 
     artefact_lister.list_files(list_filter=list_filter)
 
@@ -146,7 +183,7 @@ def list_tags_action(args):
     tag_extractor = TagExtractor()
     tag_groups = tag_extractor.extract_tags(
         filtered_extra_column=getattr(args, "filtered_extra_column", False),
-        list_filter=list_filter
+        list_filter=list_filter,
     )
 
     if args.json:
@@ -171,66 +208,91 @@ def prompt_action(args):
     from ara_cli.classifier import Classifier
     from ara_cli.filename_validator import is_valid_filename
 
-    check_validity(Classifier.is_valid_classifier(args.classifier), "Invalid classifier provided. Please provide a valid classifier.")
-    check_validity(is_valid_filename(args.parameter), "Invalid filename provided. Please provide a valid filename.")
+    check_validity(
+        Classifier.is_valid_classifier(args.classifier),
+        "Invalid classifier provided. Please provide a valid classifier.",
+    )
+    check_validity(
+        is_valid_filename(args.parameter),
+        "Invalid filename provided. Please provide a valid filename.",
+    )
 
     classifier = args.classifier
     param = args.parameter
     init = args.steps
-    write = getattr(args, 'write', False)
+    write = getattr(args, "write", False)
 
     def handle_init():
         from ara_cli.prompt_handler import initialize_prompt_templates
+
         initialize_prompt_templates(classifier, param)
 
     def handle_init_rag():
         from ara_cli.prompt_handler import initialize_prompt_templates
         from ara_cli.prompt_rag import search_and_add_relevant_files_to_prompt_givens
+
         initialize_prompt_templates(classifier, param)
         search_and_add_relevant_files_to_prompt_givens(classifier, param)
 
     def handle_load():
         from ara_cli.prompt_handler import load_selected_prompt_templates
+
         load_selected_prompt_templates(classifier, param)
 
     def handle_send():
         from ara_cli.prompt_handler import create_and_send_custom_prompt
+
         create_and_send_custom_prompt(classifier, param)
 
     def handle_load_and_send():
-        from ara_cli.prompt_handler import load_selected_prompt_templates, create_and_send_custom_prompt
+        from ara_cli.prompt_handler import (
+            load_selected_prompt_templates,
+            create_and_send_custom_prompt,
+        )
+
         load_selected_prompt_templates(classifier, param)
         create_and_send_custom_prompt(classifier, param)
 
     def handle_extract():
         from ara_cli.prompt_extractor import extract_and_save_prompt_results
         from ara_cli.update_config_prompt import update_artefact_config_prompt_files
+
         extract_and_save_prompt_results(classifier, param, write=write)
         print(f"automatic update after extract")
         update_artefact_config_prompt_files(classifier, param, automatic_update=True)
 
     def handle_chat():
         from ara_cli.prompt_chat import initialize_prompt_chat_mode
+
         chat_name = args.chat_name
         reset = args.reset
         output_mode = args.output_mode
         append_strings = args.append
         restricted = args.restricted
-        initialize_prompt_chat_mode(classifier, param, chat_name, reset=reset, output_mode=output_mode, append_strings=append_strings, restricted=restricted)
+        initialize_prompt_chat_mode(
+            classifier,
+            param,
+            chat_name,
+            reset=reset,
+            output_mode=output_mode,
+            append_strings=append_strings,
+            restricted=restricted,
+        )
 
     def handle_update():
         from ara_cli.update_config_prompt import update_artefact_config_prompt_files
+
         update_artefact_config_prompt_files(classifier, param, automatic_update=True)
 
     command_dispatcher = {
-        'init': handle_init,
-        'init-rag': handle_init_rag,
-        'load': handle_load,
-        'send': handle_send,
-        'load-and-send': handle_load_and_send,
-        'extract': handle_extract,
-        'chat': handle_chat,
-        'update': handle_update,
+        "init": handle_init,
+        "init-rag": handle_init_rag,
+        "load": handle_load,
+        "send": handle_send,
+        "load-and-send": handle_load_and_send,
+        "extract": handle_extract,
+        "chat": handle_chat,
+        "update": handle_update,
     }
 
     if init in command_dispatcher:
@@ -255,7 +317,11 @@ def chat_action(args):
     chat_file_path = join(cwd, chat_name)
 
     with suppress_stdout(output_mode):
-        chat = Chat(chat_file_path, reset=reset) if not restricted else Chat(chat_file_path, reset=reset, enable_commands=whitelisted_commands)
+        chat = (
+            Chat(chat_file_path, reset=reset)
+            if not restricted
+            else Chat(chat_file_path, reset=reset, enable_commands=whitelisted_commands)
+        )
 
     if append_strings:
         chat.append_strings(append_strings)
@@ -299,20 +365,22 @@ def load_action(args):
     default_patterns = {
         "rules": "*.rules.md",
         "intention": "*.intention.md",
-        "commands": "*.commands.md"
+        "commands": "*.commands.md",
     }
 
     default_pattern = default_patterns.get(template_type)
 
     if not template_name and not default_pattern:
-        raise AraError(f"A template name is required for template type '{template_type}'.")
+        raise AraError(
+            f"A template name is required for template type '{template_type}'."
+        )
 
     loader = TemplateLoader()  # No chat instance for CLI context
     success = loader.load_template(
         template_name=template_name,
         template_type=template_type,
         chat_file_path=chat_file_path,
-        default_pattern=default_pattern
+        default_pattern=default_pattern,
     )
 
     if not success:
@@ -324,7 +392,10 @@ def template_action(args):
     from ara_cli.classifier import Classifier
     from ara_cli.template_manager import TemplatePathManager
 
-    check_validity(Classifier.is_valid_classifier(args.classifier), "Invalid classifier provided. Please provide a valid classifier.")
+    check_validity(
+        Classifier.is_valid_classifier(args.classifier),
+        "Invalid classifier provided. Please provide a valid classifier.",
+    )
 
     template_manager = TemplatePathManager()
     content = template_manager.get_template_content(args.classifier)
@@ -356,7 +427,9 @@ def fetch_templates_action(args):
             shutil.copy2(source, target)
 
     custom_prompt_templates_subdir = config.custom_prompt_templates_subdir
-    local_prompt_modules_dir = join(prompt_templates_dir, custom_prompt_templates_subdir)
+    local_prompt_modules_dir = join(
+        prompt_templates_dir, custom_prompt_templates_subdir
+    )
     os.makedirs(local_prompt_modules_dir, exist_ok=True)
     for subdir in subdirs:
         os.makedirs(join(local_prompt_modules_dir, subdir), exist_ok=True)
@@ -377,14 +450,14 @@ def read_action(args):
         include_extension=args.include_extension,
         exclude_extension=args.exclude_extension,
         include_tags=args.include_tags,
-        exclude_tags=args.exclude_tags
+        exclude_tags=args.exclude_tags,
     )
 
     command = ReadCommand(
         classifier=classifier,
         artefact_name=artefact_name,
         read_mode=read_mode,
-        list_filter=list_filter
+        list_filter=list_filter,
     )
 
     command.execute()
@@ -402,7 +475,7 @@ def reconnect_action(args):
     artefact_name = args.parameter
     parent_classifier = args.parent_classifier
     parent_name = args.parent_name
-    rule = args.rule if hasattr(args, 'rule') else None
+    rule = args.rule if hasattr(args, "rule") else None
 
     read_error_message = f"Could not connect {classifier} '{artefact_name}' to {parent_classifier} '{parent_name}'"
 
@@ -411,27 +484,27 @@ def reconnect_action(args):
     file_classifier = FileClassifier(os)
     classified_file_info = file_classifier.classify_files()
 
-    artefact = ArtefactReader.read_artefact(
+    reader = ArtefactReader()
+    artefact = reader.read_artefact(
         artefact_name=artefact_name,
         classifier=classifier,
-        classified_file_info=classified_file_info
+        classified_file_info=classified_file_info,
     )
 
     if not artefact:
         raise AraError(read_error_message)
 
-    parent = ArtefactReader.read_artefact(
+    parent = reader.read_artefact(
         artefact_name=parent_name,
         classifier=parent_classifier,
-        classified_file_info=classified_file_info
+        classified_file_info=classified_file_info,
     )
 
     if not parent:
         raise AraError(read_error_message)
 
     contribution = Contribution(
-        artefact_name=parent.title,
-        classifier=parent.artefact_type
+        artefact_name=parent.title, classifier=parent.artefact_type
     )
 
     if rule:
@@ -440,7 +513,7 @@ def reconnect_action(args):
         feedback_message += f" using rule '{closest_rule}'"
 
     artefact.contribution = contribution
-    with open(artefact.file_path, 'w', encoding='utf-8') as file:
+    with open(artefact.file_path, "w", encoding="utf-8") as file:
         artefact_content = artefact.serialize()
         file.write(artefact_content)
 
@@ -459,16 +532,20 @@ def read_status_action(args):
     artefact_info = file_classifier.classify_files()
     artefact_info_dicts = artefact_info.get(classifier, [])
 
-    all_artefact_names = [artefact_info["title"] for artefact_info in artefact_info_dicts]
+    all_artefact_names = [
+        artefact_info["title"] for artefact_info in artefact_info_dicts
+    ]
     if artefact_name not in all_artefact_names:
-        suggest_close_name_matches(artefact_name, all_artefact_names, report_as_error=True)
+        suggest_close_name_matches(
+            artefact_name, all_artefact_names, report_as_error=True
+        )
         return
 
-    artefact_info = next(filter(
-        lambda x: x["title"] == artefact_name, artefact_info_dicts
-    ))
+    artefact_info = next(
+        filter(lambda x: x["title"] == artefact_name, artefact_info_dicts)
+    )
 
-    with open(artefact_info["file_path"], 'r', encoding='utf-8') as file:
+    with open(artefact_info["file_path"], "r", encoding="utf-8") as file:
         content = file.read()
     artefact = artefact_from_content(content)
 
@@ -492,16 +569,20 @@ def read_user_action(args):
     artefact_info = file_classifier.classify_files()
     artefact_info_dicts = artefact_info.get(classifier, [])
 
-    all_artefact_names = [artefact_info["title"] for artefact_info in artefact_info_dicts]
+    all_artefact_names = [
+        artefact_info["title"] for artefact_info in artefact_info_dicts
+    ]
     if artefact_name not in all_artefact_names:
-        suggest_close_name_matches(artefact_name, all_artefact_names, report_as_error=True)
+        suggest_close_name_matches(
+            artefact_name, all_artefact_names, report_as_error=True
+        )
         return
 
-    artefact_info = next(filter(
-        lambda x: x["title"] == artefact_name, artefact_info_dicts
-    ))
+    artefact_info = next(
+        filter(lambda x: x["title"] == artefact_name, artefact_info_dicts)
+    )
 
-    with open(artefact_info["file_path"], 'r', encoding='utf-8') as file:
+    with open(artefact_info["file_path"], "r", encoding="utf-8") as file:
         content = file.read()
     artefact = artefact_from_content(content)
 
@@ -526,32 +607,37 @@ def set_status_action(args):
     artefact_name = args.parameter
     new_status = args.new_status
 
-    if new_status.startswith('@'):
-        new_status = new_status.lstrip('@')
+    if new_status.startswith("@"):
+        new_status = new_status.lstrip("@")
 
-    check_validity(new_status in status_tags, "Invalid status provided. Please provide a valid status.")
+    check_validity(
+        new_status in status_tags,
+        "Invalid status provided. Please provide a valid status.",
+    )
 
     file_classifier = FileClassifier(os)
     classified_artefacts_info = file_classifier.classify_files()
     classified_artefact_dict = classified_artefacts_info.get(classifier, [])
-    all_artefact_names = [artefact_info["title"] for artefact_info in classified_artefact_dict]
+    all_artefact_names = [
+        artefact_info["title"] for artefact_info in classified_artefact_dict
+    ]
 
     if artefact_name not in all_artefact_names:
         suggest_close_name_matches(artefact_name, all_artefact_names)
         return
 
-    artefact_info = next(filter(
-        lambda x: x["title"] == artefact_name, classified_artefact_dict
-    ))
+    artefact_info = next(
+        filter(lambda x: x["title"] == artefact_name, classified_artefact_dict)
+    )
 
-    with open(artefact_info["file_path"], 'r', encoding='utf-8') as file:
+    with open(artefact_info["file_path"], "r", encoding="utf-8") as file:
         content = file.read()
     artefact = artefact_from_content(content)
 
     artefact.status = new_status
 
     serialized_content = artefact.serialize()
-    with open(f"{artefact_info['file_path']}", 'w', encoding='utf-8') as file:
+    with open(f"{artefact_info['file_path']}", "w", encoding="utf-8") as file:
         file.write(serialized_content)
 
     print(f"Status of task '{artefact_name}' has been updated to '{new_status}'.")
@@ -566,23 +652,25 @@ def set_user_action(args):
     artefact_name = args.parameter
     new_user = args.new_user
 
-    if new_user.startswith('@'):
-        new_user = new_user.lstrip('@')
+    if new_user.startswith("@"):
+        new_user = new_user.lstrip("@")
 
     file_classifier = FileClassifier(os)
     classified_artefacts_info = file_classifier.classify_files()
     classified_artefact_dict = classified_artefacts_info.get(classifier, [])
-    all_artefact_names = [artefact_info["title"] for artefact_info in classified_artefact_dict]
+    all_artefact_names = [
+        artefact_info["title"] for artefact_info in classified_artefact_dict
+    ]
 
     if artefact_name not in all_artefact_names:
         suggest_close_name_matches(artefact_name, all_artefact_names)
         return
 
-    artefact_info = next(filter(
-        lambda x: x["title"] == artefact_name, classified_artefact_dict
-    ))
+    artefact_info = next(
+        filter(lambda x: x["title"] == artefact_name, classified_artefact_dict)
+    )
 
-    with open(artefact_info["file_path"], 'r', encoding='utf-8') as file:
+    with open(artefact_info["file_path"], "r", encoding="utf-8") as file:
         content = file.read()
     artefact = artefact_from_content(content)
 
@@ -590,7 +678,7 @@ def set_user_action(args):
 
     serialized_content = artefact.serialize()
 
-    with open(artefact_info["file_path"], 'w', encoding='utf-8') as file:
+    with open(artefact_info["file_path"], "w", encoding="utf-8") as file:
         file.write(serialized_content)
 
     print(f"User of task '{artefact_name}' has been updated to '{new_user}'.")
@@ -654,7 +742,7 @@ def autofix_action(args):
                 single_pass=args.single_pass,
                 deterministic=run_deterministic,
                 non_deterministic=run_non_deterministic,
-                classified_artefact_info=classified_artefact_info
+                classified_artefact_info=classified_artefact_info,
             )
 
     print("\nAutofix process completed. Please review the changes.")
@@ -666,11 +754,11 @@ def extract_action(args):
 
     filename = args.filename
     force = args.force
-    write = getattr(args, 'write', False)
+    write = getattr(args, "write", False)
     command = ExtractCommand(
         file_name=filename,
         force=force,
         write=write,
-        output=lambda msg: print(msg, file=sys.stdout)
+        output=lambda msg: print(msg, file=sys.stdout),
     )
-    command.execute()
+    command.execute()