python / python/cpython

Allow relative imports in the `__main__` module

Offen
#126,926 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

type-feature
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
35.9k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Feature or enhancement

Proposal:

Expanding on https://github.com/python/cpython/issues/109853#issuecomment-2076845977

@zooba, were you envisioning to do this for all scenarios where a __main__ module is exists? I think that makes sense for consistency, but we may want to consider all scenarios to make sure the UX makes sense.

AFAICT, these should be all of them:

(this refers to relative imports in the same directory, it does not cover relative imports to the parent directory)

  1. Running a package module via python -m <module>
    • Relative imports already work here, no changes needed.
  2. Running a source or extension module via python -m <module>
    • Relative imports don't work here.
    • Allowing relative imports here feels a bit weird, especially if we were to enable -P by default. For it to run, the module would have to be in sys.path, meaning it probably installed rather than being provided by the user, so there isn't much necessity for relative imports.
  3. Running a package module directly (python <module.zip>)
    • Relative imports already work here, no changes needed.
  4. Running a file directly (python <script.py>)
    • Relative imports don't work here.
  5. Running a command string via python -c <command>
    • Relative imports don't work here.
    • There's no canonical base directory to use as a reference, should we use the current directory?
  6. Running a command string via the stdin
    • Relative imports don't work here.
    • There's no canonical base directory to use as a reference, should we use the current directory?
  7. Running the repl
    • Relative imports don't work here.
    • There's no canonical base directory to use as a reference, should we use the current directory?

I think 4), 5), 6), and 7) are the only use-cases that call for relative imports to work. 2) feels a bit weird, but it may be worth supporting for consistency.

I played a bit with the code, and the implementing this doesn't seem much difficult. I was able to write a working PoC targeting only 4) with much difficulty, so I don't think that's a worry.

Considering this, do we think it makes sense to make this change?
If so, should it cover all scenarios, or do we want to keep some of them as-is?

For further reflection, how much of an actual improvement would this actually be over the current behavior of adding the current directory to sys.path?
I can't help but feel a bit like we are trading one weird behavior for another.

Has this already been discussed elsewhere?

No response given

Links to previous discussion of this feature:

No response

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, die verknüpfte Diskussion in Issue 109853 zu lesen, und vergleiche die sieben hier aufgeführten main-Ausführungsszenarien, insbesondere direkte Dateien, -c, stdin und die REPL. Bestimme, welche Fälle relative Importe unterstützen sollten, welches Verzeichnis als Referenz dienen sollte, wenn keine kanonische Basis existiert, und ob sich das Verhalten dadurch verbessert, das aktuelle Verzeichnis zu sys.path hinzuzufügen. Als erledigt gilt die Aufgabe, wenn der unterstützte Umfang und die daraus resultierende Benutzererfahrung vor der Implementierung vereinbart sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
backend
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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