Test Coverage Enhancement [Unit Tests, Doctests & Coverage Reports]

[bunyaminergen]

We need to improve the overall test coverage of this project by adding and refining:

• Unit Tests: To ensure each function and module behaves as expected.
• Doctests: To embed testable examples directly in the docstrings.
• Coverage Reports: To track how much of the code is exercised by the tests.

---

Goals / Tasks:

1. Set Up Test Framework

   • Choose or confirm a testing framework (e.g., pytest, unittest).
   • Establish or refine the test directory structure (e.g., a tests/ folder).

2. Implement Unit Tests

   • Write targeted tests for key modules, functions, and classes.
   • Cover typical use cases, edge cases, and error-handling scenarios.

3. Add Doctests

   • Insert >>> examples within the docstrings to serve as runnable tests.
   • Review existing docstrings and enhance them as needed.

4. Generate Coverage Reports

   • Use a tool like coverage.py to measure test coverage.
   • Produce readable reports (HTML, XML, etc.) for local and CI/CD use.
   • Consider setting a minimum required coverage threshold.

5. Optional: CI/CD Integration

   • Integrate tests into GitHub Actions or another CI service.
   • Automatically run tests and coverage checks on pull requests.

---

Additional Notes:

• Adhere to the project's coding standards (import order, docstring format, type annotations).
• Aim to refactor any complex parts of the code for easier testing, if needed.
• Coordinate with contributors or maintainers to ensure all critical paths are covered.

Please feel free to comment if you have any suggestions or questions. Thank you!