make stubgen generate PEP-561/typing docs compliant '-stubs' package directory names
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 20.6k
- Fork
- 3.3k
- Metriche di merge delle PR
- Metriche PR in attesa
Descrizione
Bug Report
the stubgen --output doesn't generate package directories named as mandated by PEP-561/the typing docs.
PEP-561 states that "The name of the stub package MUST follow the scheme foopkg-stubs for type stubs for the package named foopkg."
To Reproduce and Actual Behavior
currently the packages in are placed into subdirectories named like the package.
so for a package foobar, the stubs currently are generated into a out/foopkg directory, where out is the default for the --output parameter to stubgen, like so:
$ stubgen --inspect-mode --ignore-errors --package mypy
... lots of output
$ find out -type d
out/
out/mypy
out/mypy/server
out/mypy/plugins
out/mypy/dmypy
Expected Behavior
the output should instead have a -stubs suffix to the üpackage name, out/foopkg-stubs, like so:
$ stubgen --inspect-mode --ignore-errors --package mypy
... lots of output
$ find out -type d
out/
out/mypy-stubs
out/mypy-stubs/server
out/mypy-stubs/plugins
out/mypy-stubs/dmypy
Your Environment
$ pip list
Package Version
----------------- -------
mypy 1.11.2
mypy-extensions 1.0.0
$ python --version
Python 3.12.6
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dalla gestione di --output della CLI stubgen e riproduci la generazione del package usando le opzioni --inspect-mode, --ignore-errors e --package mostrate nel report. Traccia dove vengono denominati i directory dei package, quindi verifica che gli stub del package generati usino il suffisso richiesto -stubs e preservino i moduli annidati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- cli, tooling
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 45/100