Added type hints and better docstrings #9
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive type annotations and modernizes docstrings throughout the codebase to improve code quality and developer experience. The changes enable static type checking with mypy and enforce documentation standards with pydocstyle.
Key changes:
- Added complete type annotations for all functions, methods, and properties
- Converted all docstrings from reStructuredText to Google/NumPy style format
- Enabled strict mypy type checking and pydocstyle linting in configuration
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| urlpath/init.py | Added type annotations and comprehensive Google-style docstrings for all classes and methods |
| tests/test_url.py | Added return type annotations (-> None) to all test functions |
| pyproject.toml | Enabled mypy strict mode and pydocstyle linting with Google convention |
| CHANGELOG.md | Documented the type annotation and docstring improvements |
Comments suppressed due to low confidence (1)
urlpath/init.py:1
- The line has a malformed bullet point marker '=-' instead of '-'.
"""Object-oriented URL from `urllib.parse` and `pathlib`."""
| requests.Response object from the HEAD request. | ||
| """ | ||
| url = str(self) | ||
| return requests.options(url, **kwargs) |
There was a problem hiding this comment.
The head() method is incorrectly calling requests.options() instead of requests.head(). This will return OPTIONS response instead of HEAD response.
Suggested change
| return requests.options(url, **kwargs) | |
| return requests.head(url, **kwargs) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added type hinting and docstrings.