Apply PEP561 #520
Merged
Apply PEP561 #520
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #520 +/- ##
==========================================
+ Coverage 96.19% 96.31% +0.12%
==========================================
Files 10 11 +1
Lines 867 869 +2
==========================================
+ Hits 834 837 +3
+ Misses 33 32 -1 ☔ View full report in Codecov by Sentry. |
till-m
reviewed
Sep 20, 2024
pyproject.toml
Outdated
| packages = [{include = "bayes_opt"}] | ||
| packages = [ | ||
| {include = "bayes_opt"}, | ||
| {include = "bayes_opt/py.typed"}, |
There was a problem hiding this comment.
It seems this explicit include might not actually be necessary.
There was a problem hiding this comment.
In local, I ran the poetry build command to verify that py.typed was included.
But I prefer to be explicit rather than implicit.
Of course, this is just my personal preference, but if you prefer simplicity, it seems better to remove it.
I'll fix it as soon as you point it out.
This reverts commit 59785c5.
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.
closes: #493
PEP561: https://peps.python.org/pep-0561/
Based on the previous discussion, type hinting using
TypeVarwas ruled out as it would be a barrier to entry for casual users. Instead, #507 was merged in.In my opinion, this library fully meets the needs of the existing contributors and users,
so it makes sense to add
py.typedto let users know that this library provides sufficient type hints.