[stubgen] C++ signature in docstring falsely included in generated stubs
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 C/C++ signatures are included in the C modules docstring. It is parsed as an overload.
To Reproduce
This script for examples outputs 2 signatures:
import mypy.stubdoc
sigs = mypy.stubdoc.infer_sig_from_docstring(
"""
addLane(data: MyStruct) -> None
C++: addLane(const MyStruct data) --> void
""",
"addLane",
)
if sigs is not None:
for sig in sigs:
print(sig)
Expected Behavior
There should only be one signature in the resulting stub.
Actual Behavior
there are two signatures produced
FunctionSig(name='addLane', args=[ArgSig(name='data', type='MyStruct', default=False)], ret_type='None')
FunctionSig(name='addLane', args=[ArgSig(name='constMyStructdata', type=None, default=False)], ret_type='void')
Your Environment
- stubgen version: 1.13.0
- Python version used: 3.12
I have a pull request to solve this, https://github.com/python/mypy/pull/17658
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 das Problem mit dem Skript im Bericht. Sieh dir Pull Request #17658 wegen der bereits vorhandenen Arbeit und der zugehörigen stubdoc-Parsing-Tests an. Als erledigt gilt die Aufgabe, wenn die C++-style-Zeile nicht als zweite Signatur ausgegeben wird, während die Python-Signatur erhalten bleibt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- tooling
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 25/100