python / python/cpython

test_httpservers leaves urllib.request._opener installed for the rest of the test run

Offen
#156,031 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

Bug report

Bug description:

test_httpservers installs a process-wide default URL opener and never removes it, so regrtest reports it as altering the execution environment:

Warning -- urllib.requests._opener was modified by test_httpservers
Warning --   Before: None
Warning --   After:  <urllib.request.OpenerDirector object at 0x10d5f0f80>
test_httpservers failed (env changed)

Repro on current main, takes a couple of seconds:

./python.exe -m test test_urllib test_httpservers

The leak comes from CommandLineRunTimeTestCase.fetch_file():

def fetch_file(self, path, context=None):
    req = urllib.request.Request(path, method='GET')
    with urllib.request.urlopen(req, context=context) as res:
        return res.read()

context defaults to None, and the plain HTTP tests call it without one. urlopen() only builds a throwaway opener when a context is passed; otherwise it installs the module global:

https://github.com/python/cpython/blob/main/Lib/urllib/request.py#L177-L186

global _opener
if context:
    https_handler = HTTPSHandler(context=context)
    opener = build_opener(https_handler)
elif _opener is None:
    _opener = opener = build_opener()
else:
    opener = _opener

So after test_httpservers runs, urllib.request._opener is a live OpenerDirector for the rest of the process, and any later test that goes through urlopen() silently gets it instead of a fresh one.

Why this has not shown up in CI: save_env.py only watches the resource when urllib.request is already imported, since try_get_module() raises SkipTestEnvironment otherwise. Under -j, and when running test_httpservers on its own, the module is not in sys.modules at the point regrtest snapshots the environment, so the resource is never tracked and the leak is invisible. It only appears in a sequential run, after some earlier test has imported urllib.request.

test_urllib already guards against this with self.addCleanup(urllib.request.urlcleanup) in four places, and urlcleanup() resets _opener, so the same one-liner fits here.

CPython versions tested on:

CPython main branch

Operating systems tested on:

macOS


sorry if I've got any of the details wrong here. I traced this myself and used Claude Code as a second pair of eyes on the reasoning, so any mistakes are mine and I'd rather be told than not. college freshman, just trying to be useful where I can :)

Linked PRs
  • gh-156032

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 bei CommandLineRunTimeTestCase.fetch_file() und vergleiche dessen Bereinigung mit den vier Verwendungen von self.addCleanup(urllib.request.urlcleanup) in test_urllib. Führe ./python.exe -m test test_urllib test_httpservers aus und bestätige, dass test_httpservers urllib.request._opener nicht mehr installiert lässt und keine Warnung über eine Umgebungsänderung auslöst.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
testing-qa
Issue-Typ
Bug
Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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