python / python/cpython

PYTHONDONTWRITEBYTECODE documentation is incorrect

Offen
#143,134 6 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

Documentation

PYTHONDONTWRITEBYTECODE is documented in Doc/using/cmdline.rst as:

If this is set to a non-empty string, Python won't try to write .pyc files on the import of source modules.

This is incorrect. The variable is obtained in Python/initconfig.c as:

    int dont_write_bytecode = 0;
    _Py_get_env_flag(use_env, &dont_write_bytecode, "PYTHONDONTWRITEBYTECODE");
    if (dont_write_bytecode) {
        config->write_bytecode = 0;
    }

and _Py_get_env_flag reads the environment variable value as integer, treating non-integer string as 1. Specifically, this means that PYTHONDONTWRITEBYTECODE=0 will not suppress writing .pyc files, even though the environment variable is assigned a non-empty string "0".

Linked PRs
  • gh-143144

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 in Doc/using/cmdline.rst und vergleiche das dokumentierte Verhalten mit Python/initconfig.c, insbesondere den im Issue gezeigten _Py_get_env_flag-Aufruf. Aktualisiere die Beschreibung der Umgebungsvariablen, sodass deren Ganzzahl-Parsing und das Verhalten von PYTHONDONTWRITEBYTECODE=0 korrekt sind; die Dokumentation ist fertig, wenn die Formulierung mit der Implementierung übereinstimmt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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