Support PEP-0561 compatible stub-only packages #671
Merged
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
|
I've renamed the |
mhils
reviewed
Feb 28, 2024
pdoc/doc_pyi.py
Outdated
| module_part_name[0] = f"{module_part_name[0]}-stubs" | ||
| module_stub_path = "/".join(module_part_name) | ||
|
|
||
| for path_dir in sys.path: |
There was a problem hiding this comment.
Suggested change
| for path_dir in sys.path: | |
| for search_dir in sys.path: |
maybe? Strong +1 to not overriding builtins, but path in the variable name is typically a Path object. I'd be equally happy with just d.
Add support for stub-only package. The typehints for the package `flyingcircus` could be in the `flyingcircus-stubs` package.
ErikDeSmedt
force-pushed
the
pep_0561_stubs_package
branch
from
b5808ae
to
c17eb4f
Compare
|
Thanks for the quick review. |
ErikDeSmedt
added a commit
to ErikDeSmedt/greenlight
that referenced
this pull request
Mar 4, 2024
We use pdoc to generate a reference of the python `glclient`-library. We suffered some issues related to missing type-hints. The work-around was to remove the type-hints before generating the docs. I've found 3 causes of warnings. 1. Missing export of `SignerHandle` (See Blockstream#368) 2. Poorly defined imports in auto-generated GRPC-code (See Blockstream#369) 3. pdoc failing to import type from type-stubs (See mitmproxy/pdoc#671) All of these 3 issues have been addressed so we don't need the hack anymore.
cdecker
pushed a commit
to ErikDeSmedt/greenlight
that referenced
this pull request
Jun 6, 2024
We use pdoc to generate a reference of the python `glclient`-library. We suffered some issues related to missing type-hints. The work-around was to remove the type-hints before generating the docs. I've found 3 causes of warnings. 1. Missing export of `SignerHandle` (See Blockstream#368) 2. Poorly defined imports in auto-generated GRPC-code (See Blockstream#369) 3. pdoc failing to import type from type-stubs (See mitmproxy/pdoc#671) All of these 3 issues have been addressed so we don't need the hack anymore.
cdecker
pushed a commit
to Blockstream/greenlight
that referenced
this pull request
Jun 7, 2024
We use pdoc to generate a reference of the python `glclient`-library. We suffered some issues related to missing type-hints. The work-around was to remove the type-hints before generating the docs. I've found 3 causes of warnings. 1. Missing export of `SignerHandle` (See #368) 2. Poorly defined imports in auto-generated GRPC-code (See #369) 3. pdoc failing to import type from type-stubs (See mitmproxy/pdoc#671) All of these 3 issues have been addressed so we don't need the hack anymore.
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.
Add support for stub-only package.
The typehints for the package
flyingcircuscould be in theflyingcircus-stubspackage.