python / python/cpython

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

オープン
#156,031 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

tests type-bug
主要言語
Python
スター
77.2k
フォーク
35.9k
PR マージ指標
PR 指標を取得中

説明

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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

CommandLineRunTimeTestCase.fetch_file() から始め、そのクリーンアップを test_urllib にある 4 つの self.addCleanup(urllib.request.urlcleanup) の使用箇所と比較してください。./python.exe -m test test_urllib test_httpservers を実行し、test_httpservers が urllib.request._opener をインストールされたままにせず、環境変更の警告も発生させないことを確認してください。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
testing-qa
issue の種類
バグ
難易度
1/5
見積もり時間
1時間未満
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。