bug inferring signatures from docstrings in stubgenc
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 20.6k
- Forks
- 3.3k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
Bug Report
When generating stubs from c modules, stubgen uses mypy.stubdoc to parse signatures from docstrings, if they are present, however, this does not work if the function takes no arguments
To Reproduce
Function with args:
>>> from mypy.stubdoc import infer_sig_from_docstring
>>> infer_sig_from_docstring('func(x) -> int', 'func')
[FunctionSig(name='func', args=[ArgSig(name='x', type=None, default=False)], ret_type='int')]
Function without args:
>>>: infer_sig_from_docstring('func() -> int', 'func')
[] # <--- no signature!!!!
The fact that no signatures are returned means that the stubs that are generated look like this:
def func(*args, **kwargs) -> Any
...
But given that we have a docstring with a valid signature, the stubs should look like this:
def func() -> int
...
This seems like a bug. I'll make a PR to fix this when I have some time.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit mypy.stubdoc.infer_sig_from_docstring und reproduziere die beiden Beispiele aus dem Issue. Verfolge anschließend, wie stubgen die zurückgegebenen Signaturen verwendet. Fertig ist die Aufgabe, wenn ein parameterloser Docstring wie func() -> int eine Signatur ergibt und stubgen den entsprechenden typisierten Funktionsstub statt eines *args/**kwargs-Fallbacks erzeugt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- devtools
- Issue-Typ
- Bug
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 45/100