python / python/mypy

stubgen builds stubs for private modules

Offen
#16,808 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

bug topic-stubgen
Vorherrschende Sprache
Python
Sterne
20.6k
Forks
3.3k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

In a Python package consisting of only one file

foobar/_main.py
# _main.py
def f(x: int) -> int:
    return x + 1

the function f can only be reached via a private path, namely _main.f. Still, when running

stubgen foobar/

the corresponding stub is created in

out/_main.pyi

without specifying --include-private.

This is with mypy 1.8.0 [Python 3.11.6].

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, das Problem mit dem gezeigten Paket foobar/_main.py und dem Befehl stubgen foobar/ zu reproduzieren. Verfolge, wie stubgen private Module behandelt, und vergleiche das Ergebnis mit der Option --include-private. Als erledigt gilt die Aufgabe, wenn das private Modul ohne diese Option nicht ausgegeben wird, während das dokumentierte Verhalten zur Einbeziehung unverändert bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
cli, tooling
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.