stubgen: combine `--include-docstrings` and typeshed
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20.6k
- Forks
- 3.3k
- PR merge metrics
- PR metrics pending
Description
Feature
Run stubgen --include-docstrings -p $STDLIB_PACKAGE --typeshed (?) or some other way and have it generate a stub that has the same syntax as the typeshed with docstrings included.
Pitch
Right now, stubgen --include-docstrings -p builtins generates
…
class str:
…
def strip(self, *args, **kwargs):
"""Return a copy of the string with leading and trailing whitespace removed.
If chars is given and not None, remove characters in chars instead."""
…
whereas using the typeshed annotations it might instead look like
class str(Sequence[str]):
…
@overload
def strip(self: LiteralString, chars: LiteralString | None = None, /) -> LiteralString:
"""Return a copy of the string with leading and trailing whitespace removed.
If chars is given and not None, remove characters in chars instead."""
@overload
def strip(self, chars: str | None = None, /) -> str: # type: ignore[misc]
"""Return a copy of the string with leading and trailing whitespace removed.
If chars is given and not None, remove characters in chars instead."""
…
Apologies
I'm new to the mypy project, so please feel to close this if it is out of scope or if I have misunderstood your aim with stubgen. My particular use case is using this in pyright to get proper stdlib stub docstrings; it imports these from typeshed whose stubs don't include docstrings. (See typeshed discussion here.)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the stubgen entry point and how it handles --include-docstrings and --typeshed. Compare generated output for a stdlib package such as builtins with the corresponding typeshed annotations and docstrings. Done means a documented approach or implementation that combines typeshed syntax with generated docstrings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100