The "include-docstrings" option doesn't work
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 20.6k
- Fork
- 3.3k
- Metriche di merge delle PR
- Metriche PR in attesa
Descrizione
After cloning the latest Mypy version available on GitHub, I see the "include-docstrings" option available, but running stubgen on an extension module that provides docstrings results in no docstrings at all.
To Reproduce
git clone https://github.com/python/mypy.git
python -m build
python -m pip install mypy-1.7.0+dev-py3-none-any.whl
stubgen --include-docstrings -p myextmodule[.pyd]
python -m mypy.stubgen --include-docstrings -p myextmodule[.pyd]
Expected Behavior
The .pyi file generated from stubgen should contain docstrings declared in the extension module, for classes and functions.
Actual Behavior
There is no docstrings at all, but they exist in the extension module. I have confirmed using help(myextmodule).
Your Environment
python 3.11 for Windows x64
myextmodule installed onto site-packages
- Mypy version used: 1.7.0+dev
- Mypy command-line flags: --include-docstrings -p myextmodule
- Mypy configuration options from
mypy.ini(and other config files): - Python version used: cp3.11
I know this is a new feature, but it seems not to work out.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dai punti di ingresso di stubgen utilizzati da stubgen --include-docstrings e python -m mypy.stubgen, quindi riproduci il comportamento con un modulo di estensione su Python 3.11. Traccia il modo in cui l’opzione gestisce classi e funzioni e verifica che il .pyi generato includa le docstring esistenti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- devtools
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100