Improved typing and minor fix in yaml utils methods

[kuutsav]

User Description

• Changed default args to None, mutable defaults like lists are not recommend in python as they are stateful in subsequent calls.
• Removed some f strings where the string was static.
• load_yaml had a path which could have returned None, causing the dict read after that step to raise an exception, I've added an explicit exception in load_yaml in case try_fix_yaml fails as well.

---

PR Type

Enhancement, Bug fix

---

Description

• Added from __future__ import annotations for forward compatibility.
• Changed keys_fix_yaml parameter type from List[str] to Optional[List[str]] in load_yaml and try_fix_yaml functions.
• Added checks for None and defaulted keys_fix_yaml to an empty list if not provided.
• Improved error handling by raising an exception when YAML parsing fails after attempting to fix formatting.
• Removed redundant f-strings in logging statements.

---

Changes walkthrough 📝

Relevant files

Enhancement

utils.py Improved typing, error handling, and logging in YAML utility methods. cover_agent/utils.py Added from __future__ import annotations for forward compatibility. Changed keys_fix_yaml parameter type from List[str] to Optional[List[str]] in load_yaml and try_fix_yaml functions. Added checks for None and defaulted keys_fix_yaml to an empty list if not provided. Improved error handling by raising an exception when YAML parsing fails after attempting to fix formatting. Removed redundant f-strings in logging statements. +20/-8

---

💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[codiumai-pr-agent-pro[bot]]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review [1-5]	2
🧪 Relevant tests	No
🔒 Security concerns	No
⚡ Key issues to review	Error Handling: The exception raised in load_yaml uses a variable e in the string formatting, but e is not included in the formatted string. This will cause a runtime error. Consider modifying the exception message to correctly include the error information.
	Consistency: The try_fix_yaml function returns either a dictionary or None. It's important to ensure that all calling functions handle these two possible return types appropriately.

[codiumai-pr-agent-pro[bot]]

PR Code Suggestions ✨

Category	Suggestion	Score
Possible bug	Raise a more specific exception type and remove the reference to an undefined variable ___ **Instead of raising a generic Exception with a formatted string that references an undefined variable e, consider raising a more specific exception type and removing the reference to e to avoid confusion.** [cover_agent/utils.py [39-41]](https://github.com/Codium-ai/cover-agent/pull/101/files#diff-4b68afa4ecc709b261a42ca40bfe986f4d150bf47184bdecdadc4954d434dcb0R39-R41) ```diff -raise Exception( - "Failed to parse AI prediction after fixing YAML formatting. Error: {e}." +raise ValueError( + "Failed to parse AI prediction after fixing YAML formatting." ) ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 10 Why: The suggestion correctly identifies a major issue where an undefined variable 'e' is referenced in an exception message, and it recommends using a more specific exception type, which is a crucial improvement for error handling.	10
Best practice	Specify the exception type in the except clause to avoid masking unexpected errors ___ **Instead of using a bare except clause, specify the exception type to catch only the expected exceptions and avoid masking other unexpected errors.** [cover_agent/utils.py [89-90]](https://github.com/Codium-ai/cover-agent/pull/101/files#diff-4b68afa4ecc709b261a42ca40bfe986f4d150bf47184bdecdadc4954d434dcb0R89-R90) ```diff -except: +except yaml.YAMLError: pass ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 8 Why: Specifying the exception type in the `except` clause is a best practice to avoid catching unintended exceptions, which can help in identifying and debugging other issues in the code.	8
Enhancement	Add a log message for the case when YAML parsing fails after all attempts ___ **Add a specific log message for the case when the YAML parsing fails after all attempts, to provide better insight into the failure.** [cover_agent/utils.py [115]](https://github.com/Codium-ai/cover-agent/pull/101/files#diff-4b68afa4ecc709b261a42ca40bfe986f4d150bf47184bdecdadc4954d434dcb0R115-R115) ```diff -pass +logging.error("Failed to parse AI prediction after all attempts.") ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 7 Why: Adding a specific log message for failures after all parsing attempts enhances the debuggability and traceability of the code, which is a valuable improvement for maintaining the code.	7