Clarify the method of distribution for stub files with extension only packages.
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 1.8k
- Forks
- 302
- Ø Merge
- 23 Std.
- Gemergte PRs (30 T.)
- 8
Beschreibung
PEP-0561 does not mention extension packages, packages that consist of just an .so file. Given that PEP-484 mentions extension modules as a use case for stub files, could the typing documentation make it more clear what the ideal layout of an extension only package is?
It appears to be valid to have a package structure like the following:
.../site-packages/
mypackage/
__init__.pyi
py.typed
mypackage.cpython-37m-x86_64-linux-gnu.so
@ethanhs suggested in https://github.com/python/peps/issues/2318 that this is the correct way of doing things.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
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
Lesen Sie zunächst die im Issue genannten Verweise auf PEP-0561 und PEP-484 und sehen Sie sich anschließend die Typing-Dokumentation zur Paketverteilung und zu Stub-Dateien an. Klären Sie, ob das gezeigte Paketlayout, das nur Erweiterungen enthält, unterstützt wird, und dokumentieren Sie das ideale Layout einschließlich der Platzierung von init.pyi und py.typed.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 42/100