📝 Add docstrings to feat_patch

[coderabbitai]

Docstrings generation was requested by @laike9m.

• Support test_code to add pyright-config comment #98 (comment)

The following files were modified:

• tests/assets/challenges/basic-foo-pyright-config/question.py
• tests/conftest.py
• tests/test_identical.py
• views/challenge.py
• views/views.py

These files were kept as they were

• tests/test_challenge.py

These file types are not supported

• docs/Contribute.md

ℹ️ Note

CodeRabbit cannot perform edits on its own pull requests yet.

[coderabbitai]

Important

Review skipped

CodeRabbit bot authored PR detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[laike9m]

This Pull Request introduces significant improvements to the type-checking challenge system, primarily by enhancing how Pyright configurations are handled.

Here's a summary of the key changes and my review:

Key Changes:

1. Embedded Pyright Configuration: The PR introduces a mechanism to embed challenge-specific Pyright configuration directives directly within the question.py and solution.py files, separated by a ## End of test code ## marker. This allows for fine-grained control over type-checking rules for individual challenges.
2. PYRIGHT_BASIC_CONFIG: A comprehensive set of default Pyright configuration directives has been added (views/challenge.py), ensuring consistent and strict type-checking across all challenges unless overridden.
3. Refactored Test Code Extraction:
   • The test_identical.py test now correctly extracts only the actual test code (before the Pyright config marker) when comparing question.py and solution.py.
   • The get_challenge endpoint in views/views.py also truncates the displayed test code, preventing the embedded Pyright config from being shown to users.
4. Improved Pyright Error Reporting: The _type_check_with_pyright method in views/challenge.py now distinguishes between errors originating from user code, test code, and the embedded Pyright configuration. Errors in the Pyright configuration itself are no longer considered to be failures for passing the challenge.
5. Enhanced Code Readability and Maintainability:
   • Docstrings have been added or improved for several functions and fixtures, enhancing clarity.
   • The PYRIGHT_MESSAGE_REGEX now uses named capture groups, which is a good practice for regex maintainability.
   • The hint_file fixture and ALL_HINTS variable were removed from tests/conftest.py, simplifying the test setup for hints, which are now handled directly via the ChallengeManager.

Constructive Feedback:

• No Newline at End of File: I noticed that some of the modified files (e.g., tests/assets/challenges/basic-foo-pyright-config/question.py, tests/conftest.py, tests/test_identical.py, views/challenge.py, views/views.py) still lack a newline at the end of the file. While not critical for functionality, it's a common style preference and can sometimes cause issues with certain tools. This is a pre-existing issue, and it's fine if this PR doesn't address it, but it's something to keep in mind for future code quality improvements.

Conclusion:

This is a well-designed and executed PR. The changes significantly improve the functionality and flexibility of the type-checking challenge system. The separation of test code from Pyright configuration, the introduction of a base configuration, and the refined error reporting are all excellent additions. The improvements in documentation are also very welcome.

I'm approving this PR.