Add py.typed file (PEP 561) #116
Open
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
Add include directive for type hints in usp package
There was a problem hiding this comment.
Pull Request Overview
This PR adds PEP 561 compliance to the ultimate-sitemap-parser package by adding a py.typed marker file, enabling type checkers like mypy to use the package's type hints. This is beneficial since the package already contains type annotations throughout its codebase (e.g., in helpers.py).
Key changes:
- Added
py.typedmarker file to theusppackage directory - Updated
pyproject.tomlto include thepy.typedfile in the distribution
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| usp/py.typed | Adds PEP 561 marker file to indicate the package distributes type information |
| pyproject.toml | Adds include directive to ensure py.typed file is included in package distribution |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
No description provided.