Type stubs for single-file top-level modules
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 1.8k
- Forks
- 302
- Merge moyen
- 23 h
- PR mergées (30 j)
- 8
Description
PEP 561 currently states the following:
Package maintainers who wish to support type checking of their code MUST add a marker file named
py.typedto their package supporting typing.
I consider this requirement to be problematic for Python libraries that are written in another programing language and distributed as compiled .so files. PEP 561 currently does not provide a way to mark .so files residing directly in site-packages/ to be typed, resulting in typed shared libraries needing to introduce an intermediary __init__.py file such as the following:
from ._native import *
__doc__ = _native.__doc__
if hasattr(_native, "__all__"):
__all__ = _native.__all__
While this works for static type checkers I think this is obviously suboptimal because it has several undesired side-effects. Let's take the following as an example:
site-packages
├── my_project
│ ├── __init__.py
│ ├── _native.cpython-36m-x86_64-linux-gnu.so
│ └── py.typed
The unintended side-effects are:
- You can import
my_project._native. _nativeshows up in the documentation generated by pydoc. E.g. under PACKAGE CONTENTS for the documentation ofmy_projectand invoking e.g.help(my_project.foobar)will tell you thatfoobarresides in the modulemy_project._native.my_project.__file__now is the__init__.pyfile instead of the.sofile, potentially misleading developers into thinking the package is implemented in Python
So I really think PEP 561 should be amended to provide some way of marking single-file packages as "typed" without having to resort to hacks such as defining an intermediary __init__.py since that introduces a bunch of undesired side-effects that have the potential to confuse API users.
What do you think about this?
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
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 lire PEP 561 et les exemples de l’issue concernant les modules compilés dans un seul fichier, puis comparez le comportement décrit avec la manière dont pydoc signale le contenu des packages et file. Le travail sera considéré comme terminé lorsqu’une manière acceptée de marquer comme typés les modules .so installés directement aura été proposée et documentée, sans les effets secondaires intermédiaires de init.py.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- Calme
- Clarté
- Plutôt claire
- Accessibilité débutants
- 38/100