ara-cli 0.1.9.69__py3-none-any.whl → 0.1.9.71__py3-none-any.whl

ara_cli/artefact_link_updater.py

@@ -34,7 +34,7 @@ class ArtefactLinkUpdater:
             # Check if it's a file and not a directory
             elif self.file_system.path.isfile(item_path) and Classifier.is_valid_classifier(extension):
                 # Read the content of the file
-                with open(item_path, 'r') as file:
+                with open(item_path, 'r', encoding='utf-8') as file:
                     content = file.read()
 
                 # Replace all occurrences of the old name with the new name using regular expressions
@@ -42,7 +42,7 @@ class ArtefactLinkUpdater:
                     content = pattern.sub(replacement, content)
 
                 # Write the updated content back to the file
-                with open(item_path, 'w') as file:
+                with open(item_path, 'w', encoding='utf-8') as file:
                     file.write(content)
 
     def remove_links_in_related_artefacts(self, artefact_name, dir_path="."):
@@ -65,12 +65,12 @@ class ArtefactLinkUpdater:
 
             # Check if it's a file and not a directory, and if extension is a valid artefact classifier
             elif self.file_system.path.isfile(item_path) and Classifier.is_valid_classifier(extension):
-                with open(item_path, 'r') as file:
+                with open(item_path, 'r', encoding='utf-8') as file:
                     content = file.read()
 
                 # Remove the artefact name from 'Contributes to' and 'Illustrates' lines
                 content = contribute_pattern.sub("Contributes to", content)
                 content = illustrates_pattern.sub("Illustrates", content)
 
-                with open(item_path, 'w') as file:
+                with open(item_path, 'w', encoding='utf-8') as file:
                     file.write(content)

ara_cli/artefact_models/artefact_model.py

@@ -197,6 +197,15 @@ class Artefact(BaseModel, ABC):
         self._file_path = file_path
         return self
 
+    @model_validator(mode="after")
+    def validate_contribution(self):
+        contribution = self.contribution
+        classifier = self.artefact_type.value
+        name = self.title
+        if not contribution:
+            warnings.warn(f"Contribution of {classifier} '{name}' is not set and will be empty")
+        return self
+
     @field_validator('artefact_type')
     def validate_artefact_type(cls, v):
         if not isinstance(v, ArtefactType):
@@ -230,7 +239,11 @@ class Artefact(BaseModel, ABC):
     def validate_title(cls, v):
         if not v.strip():
             raise ValueError("artefact_title must not be empty")
-        v = replace_space_with_underscore(v)
+        v = replace_space_with_underscore(v).strip()
+
+        whitelisted_placeholder = "<descriptive_title>"
+        if v == whitelisted_placeholder:
+            return v
 
         letters = list(string.ascii_letters)
         digits = list(string.digits)
@@ -243,12 +256,6 @@ class Artefact(BaseModel, ABC):
 
         return v
 
-    @field_validator('contribution')
-    def validate_contribution(cls, v):
-        if not v:
-            warnings.warn("Contribution is not set and will be empty")
-        return v
-
     @classmethod
     @abstractmethod
     def _title_prefix(cls) -> str:    # pragma: no cover

ara_cli/artefact_models/artefact_templates.py

@@ -207,7 +207,7 @@ def _default_issue(title: str) -> IssueArtefact:
     )
 
 
-def template_artefact_of_type(artefact_type: ArtefactType, title: str) -> Artefact:
+def template_artefact_of_type(artefact_type: ArtefactType, title: str = "<descriptive_title>") -> Artefact:
     default_creation_functions = {
         ArtefactType.vision: _default_vision,
         ArtefactType.businessgoal: _default_businessgoal,

ara_cli/artefact_models/feature_artefact_model.py

@@ -363,27 +363,43 @@ class FeatureArtefact(Artefact):
 
     @classmethod
     def deserialize(cls, text: str) -> 'FeatureArtefact':
-        fields = super()._parse_common_fields(text)
+        """
+        Deserializes the feature file using a robust extract-and-reinject strategy.
+        1. Hides all docstrings by replacing them with placeholders.
+        2. Parses the sanitized text using the original, simple parsing logic.
+        3. Re-injects the original docstring content back into the parsed objects.
+        This prevents the parser from ever being confused by content within docstrings.
+        """
+        # 1. Hide all docstrings from the entire file text first.
+        sanitized_text, docstrings = cls._hide_docstrings(text)
+
+        # 2. Perform the original parsing logic on the SANITIZED text.
+        # This part of the code is now "safe" because it will never see a docstring.
+        fields = super()._parse_common_fields(sanitized_text)
+        intent = FeatureIntent.deserialize(sanitized_text)
+        background = cls.deserialize_background(sanitized_text)
+        scenarios = cls.deserialize_scenarios(sanitized_text)
 
-        intent = FeatureIntent.deserialize(text)
-        background = cls.deserialize_background(text)
-        scenarios = cls.deserialize_scenarios(text)
-
-        fields['scenarios'] = scenarios
-        fields['background'] = background
         fields['intent'] = intent
+        fields['background'] = background
+        fields['scenarios'] = scenarios
+
+        # 3. Re-inject the docstrings back into the parsed scenarios.
+        if fields['scenarios'] and docstrings:
+            for scenario in fields['scenarios']:
+                if isinstance(scenario, (Scenario, ScenarioOutline)):
+                    scenario.steps = cls._reinject_docstrings_into_steps(scenario.steps, docstrings)
 
         return cls(**fields)
 
     @classmethod
     def deserialize_scenarios(cls, text):
-        lines = [line.strip()
-                 for line in text.strip().splitlines() if line.strip()]
-
+        if not text: return []
+        lines = [line.strip() for line in text.strip().splitlines() if line.strip()]
         scenarios = []
         idx = 0
         while idx < len(lines):
-            line = lines[idx].strip()
+            line = lines[idx]
             if line.startswith('Scenario:'):
                 scenario, next_idx = Scenario.from_lines(lines, idx)
                 scenarios.append(scenario)
@@ -398,16 +414,54 @@ class FeatureArtefact(Artefact):
 
     @classmethod
     def deserialize_background(cls, text):
-        lines = [line.strip()
-                 for line in text.strip().splitlines() if line.strip()]
-
+        if not text: return None
+        lines = [line.strip() for line in text.strip().splitlines() if line.strip()]
         background = None
         idx = 0
         while idx < len(lines):
-            line = lines[idx].strip()
+            line = lines[idx]
             if line.startswith('Background:'):
-                background, next_idx = Background.from_lines(lines, idx)
+                background, _ = Background.from_lines(lines, idx)
                 break
-            else:
-                idx += 1
+            idx += 1
         return background
+
+
+    @staticmethod
+    def _hide_docstrings(text: str) -> Tuple[str, Dict[str, str]]:
+        """
+        Finds all docstring blocks ('''...''') in the text,
+        replaces them with a unique placeholder, and returns the sanitized
+        text and a dictionary mapping placeholders to the original docstrings.
+        """
+        docstrings = {}
+        placeholder_template = "__DOCSTRING_PLACEHOLDER_{}__"
+
+        def replacer(match):
+            # This function is called for each found docstring.
+            key = placeholder_template.format(len(docstrings))
+            docstrings[key] = match.group(0)  # Store the full matched docstring
+            return key
+
+        # The regex finds ''' followed by any character (including newlines)
+        # in a non-greedy way (.*?) until the next '''.
+        sanitized_text = re.sub(r'"""[\s\S]*?"""', replacer, text)
+
+        return sanitized_text, docstrings
+
+    @staticmethod
+    def _reinject_docstrings_into_steps(steps: List[str], docstrings: Dict[str, str]) -> List[str]:
+        """
+        Iterates through a list of steps, finds any placeholders,
+        and replaces them with their original docstring content.
+        """
+        rehydrated_steps = []
+        for step in steps:
+            for key, value in docstrings.items():
+                if key in step:
+                    # Replace the placeholder with the original, full docstring block.
+                    # This handles cases where the step is just the placeholder,
+                    # or the placeholder is at the end of a line (e.g., "Then I see... __PLACEHOLDER__").
+                    step = step.replace(key, value)
+            rehydrated_steps.append(step)
+        return rehydrated_steps

ara_cli/artefact_models/serialize_helper.py

@@ -15,4 +15,4 @@ def as_a_serializer(as_a):
     else:
         as_a_prefix = "As a"
 
-    return f"{as_a_prefix} {role}"
+    return f"{as_a_prefix} {role}".strip()

ara_cli/artefact_reader.py

@@ -10,20 +10,21 @@ import re
 
 class ArtefactReader:
     @staticmethod
-    def read_artefact(artefact_name, classifier) -> tuple[str, dict[str, str]]:
+    def read_artefact_data(artefact_name, classifier, classified_file_info = None) -> tuple[str, dict[str, str]]:
         if not Classifier.is_valid_classifier(classifier):
             print("Invalid classifier provided. Please provide a valid classifier.")
             return None, None
 
-        file_classifier = FileClassifier(os)
-        classified_file_info = file_classifier.classify_files()
+        if not classified_file_info:
+            file_classifier = FileClassifier(os)
+            classified_file_info = file_classifier.classify_files()
         artefact_info_of_classifier = classified_file_info.get(classifier, [])
 
         for artefact_info in artefact_info_of_classifier:
             file_path = artefact_info["file_path"]
             artefact_title = artefact_info["title"]
             if artefact_title == artefact_name:
-                with open(file_path, 'r') as file:
+                with open(file_path, 'r', encoding='utf-8') as file:
                     content = file.read()
                 return content, artefact_info
 
@@ -36,25 +37,14 @@ class ArtefactReader:
         return None, None
 
     @staticmethod
-    def read_single_artefact(artefact_name, classifier, classified_file_info=None) -> Artefact:
-        if not Classifier.is_valid_classifier(classifier):
-            print("Invalid classifier provided. Please provide a valid classifier.")
+    def read_artefact(artefact_name, classifier, classified_file_info=None) -> Artefact:
+        content, artefact_info = ArtefactReader.read_artefact_data(artefact_name, classifier, classified_file_info)
+        if not content or not artefact_info:
             return None
-        if not classified_file_info:
-            file_classifier = FileClassifier(os)
-            classified_file_info = file_classifier.classify_files()
-        artefact_info_of_classifier = classified_file_info.get(classifier, [])
-
-        for artefact_info in artefact_info_of_classifier:
-            file_path = artefact_info["file_path"]
-            artefact_title = artefact_info["title"]
-            if artefact_title == artefact_name:
-                with open(file_path, 'r') as file:
-                    content = file.read()
-                artefact = artefact_from_content(content)
-                artefact._file_path = file_path
-                return artefact
-        return None
+        file_path = artefact_info["file_path"]
+        artefact = artefact_from_content(content)
+        artefact._file_path = file_path
+        return artefact
 
     @staticmethod
     def extract_parent_tree(artefact_content):
@@ -94,24 +84,12 @@ class ArtefactReader:
                      for artefact_type in classified_artefacts.keys()}
         for artefact_type, artefact_info_dicts in classified_artefacts.items():
             for artefact_info in artefact_info_dicts:
+                title = artefact_info["title"]
                 try:
-                    with open(artefact_info["file_path"], 'r') as file:
-                        content = file.read()
-                    artefact = artefact_from_content(content)
-                    if not artefact:
-                        continue
-                    # Store the full file path in the artefact
-                    artefact._file_path = artefact_info["file_path"]
+                    artefact = ArtefactReader.read_artefact(title, artefact_type, classified_artefacts)
                     artefacts[artefact_type].append(artefact)
-                    # else:
-                        # Include file path if deserialization fails
-                        # FIXME: LOOK INTO IT
-                        # artefacts[artefact_type].append(file_path)
-                except Exception:
-                    # TODO: catch only specific exceptions
-                    # TODO: implament error message for deserialization or "ara scan" or "ara autofix"
-                    # print(f"Warning: Could not deserialize artefact at {artefact_info}: {e}")
-                    # artefacts[artefact_type].append(file_path)
+                except Exception as e:
+                    print(f"Failed to read {artefact_type} '{title}' with an error: ", e)
                     continue
         return artefacts
 

ara_cli/artefact_renamer.py

@@ -75,7 +75,7 @@ class ArtefactRenamer:
             raise ValueError(f"Invalid classifier: {classifier}")
 
         # Read the file content
-        with open(artefact_path, 'r') as file:
+        with open(artefact_path, 'r', encoding='utf-8') as file:
             content = file.read()
 
         # Find the old title line
@@ -89,5 +89,5 @@ class ArtefactRenamer:
         new_content = content.replace(old_title_line, new_title_line, 1)
 
         # Write the updated content back to the file
-        with open(artefact_path, 'w') as file:
+        with open(artefact_path, 'w', encoding='utf-8') as file:
             file.write(new_content)

ara_cli/artefact_scan.py

@@ -2,13 +2,21 @@ from textwrap import indent
 import os
 
 
-def check_file(file_path, artefact_class):
+def check_file(file_path, artefact_class, classified_artefact_info=None):
     from pydantic import ValidationError
+    from ara_cli.artefact_fuzzy_search import extract_artefact_names_of_classifier
+    from ara_cli.file_classifier import FileClassifier
+
     try:
         with open(file_path, "r", encoding="utf-8") as f:
             content = f.read()
     except OSError as e:
         return False, f"File error: {e}"
+
+    if not classified_artefact_info:
+        file_classifier = FileClassifier(os)
+        classified_artefact_info = file_classifier.classify_files()
+
     try:
         artefact_instance = artefact_class.deserialize(content)
 
@@ -19,6 +27,23 @@ def check_file(file_path, artefact_class):
             reason = (f"Filename-Title Mismatch: The file name '{file_name_without_ext}' "
                       f"does not match the artefact title '{artefact_instance.title}'.")
             return False, reason
+        
+        # Check contribution reference validity
+        contribution = artefact_instance.contribution
+        if contribution and contribution.artefact_name and contribution.classifier:
+            
+            # Find all artefact names of the referenced classifier
+            all_artefact_names = extract_artefact_names_of_classifier(
+                classified_files=classified_artefact_info,
+                classifier=contribution.classifier
+            )
+            
+            # Check if the referenced artefact exists
+            if contribution.artefact_name not in all_artefact_names:
+                reason = (f"Invalid Contribution Reference: The contribution references "
+                          f"'{contribution.classifier}' artefact '{contribution.artefact_name}' "
+                          f"which does not exist.")
+                return False, reason
 
         return True, None
     except (ValidationError, ValueError, AssertionError) as e:
@@ -37,7 +62,7 @@ def find_invalid_files(classified_artefact_info, classifier):
             continue
         if ".data" in artefact_info["file_path"]:
             continue
-        is_valid, reason = check_file(artefact_info["file_path"], artefact_class)
+        is_valid, reason = check_file(artefact_info["file_path"], artefact_class, classified_artefact_info)
         if not is_valid:
             invalid_files.append((artefact_info["file_path"], reason))
     return invalid_files
@@ -45,7 +70,7 @@ def find_invalid_files(classified_artefact_info, classifier):
 
 def show_results(invalid_artefacts):
     has_issues = False
-    with open("incompatible_artefacts_report.md", "w") as report:
+    with open("incompatible_artefacts_report.md", "w", encoding="utf-8") as report:
         report.write("# Artefact Check Report\n\n")
         for classifier, files in invalid_artefacts.items():
             if files:

ara_cli/chat.py

@@ -154,7 +154,7 @@ Start chatting (type 'HELP'/'h' for available commands, 'QUIT'/'q' to exit chat
         return None
 
     def start_non_interactive(self):
-        with open(self.chat_name, 'r') as file:
+        with open(self.chat_name, 'r', encoding='utf-8') as file:
             content = file.read()
         print(content)
 

ara_cli/file_classifier.py

@@ -1,6 +1,6 @@
 from ara_cli.classifier import Classifier
 from ara_cli.artefact_models.artefact_model import Artefact
-from ara_cli.artefact_fuzzy_search import find_closest_name_match
+from ara_cli.artefact_fuzzy_search import find_closest_name_matches
 from functools import lru_cache
 from typing import Optional
 import textwrap
@@ -17,7 +17,7 @@ class FileClassifier:
             info["title"] for info in classified_artefacts.get(classifier, [])]
         if name in all_artefact_names:
             return name
-        return find_closest_name_match(name, all_artefact_names)
+        return find_closest_name_matches(name, all_artefact_names)
 
     @lru_cache(maxsize=None)
     def read_file_content(self, file_path):
@@ -68,7 +68,7 @@ class FileClassifier:
         files_by_classifier = {classifier: [] for classifier in Classifier.ordered_classifiers()}
 
         for root, _, files in self.file_system.walk("."):
-            if root.endswith(".data"):
+            if root.endswith(".data") or root.endswith("templates"):
                 continue
             for file in files:
                 file_path = self.file_system.path.join(root, file)

ara_cli/file_lister.py

@@ -28,7 +28,7 @@ def generate_markdown_listing(directories, file_types_to_be_listed, output_file_
                 if any(fnmatch.fnmatch(file, pattern) for pattern in file_types_to_be_listed):
                     markdown_lines.append(f"{indent} - [] {file}")
 
-    with open(output_file_path, "w") as md_file:
+    with open(output_file_path, "w", encoding="utf-8") as md_file:
         md_file.write('\n'.join(markdown_lines))
 
 

ara_cli/list_filter.py

@@ -35,7 +35,7 @@ class ListFilterMonad:
     def default_content_retrieval(file):
         # Default strategy assumes file is a path and attempts to read it
         try:
-            with open(file, 'r') as f:
+            with open(file, 'r', encoding='utf-8') as f:
                 return f.read()
         except Exception as e:
             print(f"Error reading file {file}: {e}")

ara_cli/output_suppressor.py

@@ -6,7 +6,7 @@ from contextlib import contextmanager
 @contextmanager
 def suppress_stdout(suppress=False):
     if suppress:
-        with open(os.devnull, "w") as devnull:
+        with open(os.devnull, "w", encoding="utf-8") as devnull:
             old_stdout = sys.stdout
             sys.stdout = devnull
             try:

ara_cli/prompt_extractor.py

@@ -21,7 +21,7 @@ def extract_responses(document_path, relative_to_ara_root=False):
     print(f"Debug: Starting extraction from {document_path}")
     block_extraction_counter = 0
 
-    with open(document_path, 'r') as file:
+    with open(document_path, 'r', encoding='utf-8') as file:
         content = file.read()
 
     cwd = os.getcwd()
@@ -81,7 +81,7 @@ def extract_responses(document_path, relative_to_ara_root=False):
             artefact_path = artefact.file_path
             directory = os.path.dirname(artefact_path)
             os.makedirs(directory, exist_ok=True)
-            with open(artefact_path, 'w') as file:
+            with open(artefact_path, 'w', encoding='utf-8') as file:
                 file.write(serialized_artefact)
 
             os.chdir(original_directory)
@@ -92,7 +92,7 @@ def extract_responses(document_path, relative_to_ara_root=False):
 
     os.chdir(cwd)
     # Save the updated markdown content
-    with open(document_path, 'w') as file:
+    with open(document_path, 'w', encoding='utf-8') as file:
         file.write(updated_content)
 
     print(f"End of extraction. Found {block_extraction_counter} blocks.")

ara_cli/prompt_handler.py

@@ -3,7 +3,7 @@ import litellm
 from ara_cli.classifier import Classifier
 from ara_cli.artefact_creator import ArtefactCreator
 from ara_cli.template_manager import TemplatePathManager
-from ara_cli.ara_config import ConfigManager
+from ara_cli.ara_config import ConfigManager, LLMConfigItem
 from ara_cli.file_lister import generate_markdown_listing
 from os.path import exists, join
 import os
@@ -20,15 +20,15 @@ class LLMSingleton:
 
     def __init__(self, model_id):
         config = ConfigManager().get_config()
-        llm_config = config.llm_config
-        selected_config = llm_config[str(model_id)]
+        selected_config = config.llm_config.get(str(model_id))
 
         if not selected_config:
             raise ValueError(f"No configuration found for the model: {model_id}")
 
         LLMSingleton._model = model_id
-
-        self.config_parameters = selected_config
+        
+        # Typesafe for None values inside the config.
+        self.config_parameters = selected_config.model_dump(exclude_none=True)
 
         LLMSingleton._instance = self
 
@@ -74,15 +74,14 @@ def read_string_from_file(path):
 def send_prompt(prompt):
     chat = LLMSingleton.get_instance()
 
-    # remove provider from config parameters
     config_parameters = chat.config_parameters.copy()
-    del config_parameters["provider"]
+    if "provider" in config_parameters:
+        del config_parameters["provider"]
 
     completion = litellm.completion(
         **config_parameters,
         messages=prompt,
-        stream=True,
-        max_tokens=32768
+        stream=True
     )
     for chunk in completion:
         yield chunk
@@ -436,4 +435,4 @@ def generate_config_prompt_givens_file(prompt_data_path, config_prompt_givens_na
 
         # Write the updated listing back to the file
         with open(config_prompt_givens_path, 'w', encoding='utf-8') as file:
-            file.write("".join(updated_listing))
+            file.write("".join(updated_listing))

ara_cli/prompt_rag.py

@@ -16,7 +16,7 @@ def find_files_in_prompt_config_givens(search_file, prompt_givens_file_path):
     header_stack = []
     modified_lines = []  # To store the modified file content
 
-    with open(prompt_givens_file_path, 'r') as file:
+    with open(prompt_givens_file_path, 'r', encoding='utf-8') as file:
         for line in file:
             if line.strip().startswith('#'):
                 level = line.count('#')
@@ -37,7 +37,7 @@ def find_files_in_prompt_config_givens(search_file, prompt_givens_file_path):
 
     if file_found:
         # Rewrite the file with the modified content if any line was changed
-        with open(prompt_givens_file_path, 'w') as file:
+        with open(prompt_givens_file_path, 'w', encoding='utf-8') as file:
             file.writelines(modified_lines)
 
     return file_found

ara_cli/template_manager.py

@@ -34,7 +34,7 @@ class TemplatePathManager:
 
         template_path = (base_path / f"template.{classifier}")
 
-        with template_path.open('r') as file:
+        with template_path.open('r', encoding='utf-8') as file:
             content = file.read()
 
         return content
@@ -113,7 +113,7 @@ class ArtefactFileManager:
     def save_behave_steps_to_file(self, artefact_name, behave_steps):
         self.navigator.navigate_to_target()
         file_path = f"features/steps/{artefact_name}_steps.py"
-        with open(file_path, 'w') as file:
+        with open(file_path, 'w', encoding='utf-8') as file:
             file.write(behave_steps)
 
 

ara_cli/templates/prompt-modules/blueprints/complete_pytest_unittest.blueprint.md

@@ -24,4 +24,4 @@ Modify and/or create unit tests so this is fully covered:
 <snippet you want to cover in the next step>
 ```
 
-Give me only what is relevant to testing this snippet. Use parametrization where applicable. Mock all dependencies of tested code.
+Give me only what is relevant to testing this snippet. Use parametrization where applicable. Split into multiple tests instead of using if-else blocks. Mock all dependencies of tested code.

ara_cli/update_config_prompt.py

@@ -5,13 +5,13 @@ from ara_cli.prompt_handler import generate_config_prompt_template_file, generat
 
 def read_file(filepath):
     """Read and return the content of a file."""
-    with open(filepath, 'r') as file:
+    with open(filepath, 'r', encoding='utf-8') as file:
         return file.read()
 
 
 def write_file(filepath, content):
     """Write content to a file."""
-    with open(filepath, 'w') as file:
+    with open(filepath, 'w', encoding='utf-8') as file:
         file.write(content)
 
 

ara_cli/version.py

@@ -1,2 +1,2 @@
 # version.py
-__version__ = "0.1.9.69"   # fith parameter like .0 for local install test purposes only. official numbers should be 4 digit numbers
+__version__ = "0.1.9.71"   # fith parameter like .0 for local install test purposes only. official numbers should be 4 digit numbers

{ara_cli-0.1.9.69.dist-info → ara_cli-0.1.9.71.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ara_cli
-Version: 0.1.9.69
+Version: 0.1.9.71
 Requires-Dist: litellm
 Requires-Dist: llama-index
 Requires-Dist: llama-index-llms-openai