bug inferring signatures from docstrings in stubgenc
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 20.6k
- Forks
- 3.3k
- Métriques de merge des PR
- Métriques de PR en attente
Description
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.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par mypy.stubdoc.infer_sig_from_docstring et reproduisez les deux exemples de l’issue, puis suivez la manière dont stubgen utilise les signatures renvoyées. C’est terminé lorsqu’un docstring sans argument tel que func() -> int produit une signature et que stubgen génère le stub de fonction typé correspondant au lieu d’un fallback *args/**kwargs.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- devtools
- Type d'issue
- Bug
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 45/100