python / python/cpython

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

Aperta
#156,031 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

tests type-bug
Lingua principale
Python
Stelle
77.2k
Fork
35.9k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia da CommandLineRunTimeTestCase.fetch_file() e confronta la relativa pulizia con i quattro utilizzi di self.addCleanup(urllib.request.urlcleanup) in test_urllib. Esegui ./python.exe -m test test_urllib test_httpservers e conferma che test_httpservers non lasci più installato urllib.request._opener né attivi l'avviso di modifica dell'ambiente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
testing-qa
Tipo di issue
Bug
Difficoltà
1/5
Tempo stimato
Meno di un'ora
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.