Docs for `urllib.request.urlcleanup` does not mention that it will `uninstall` openers installed with `urllib.request.install_opener`

[aucampia]

Documentation

urllib.request.install_opener sets urllib.request._opener to the supplied value:

cpython/Lib/urllib/request.py

Lines 217 to 219 in 90f1d77

	def install_opener(opener):
	global _opener
	_opener = opener

And urllib.request.urlcleanup sets urllib.requests._opener to None, thus essentially uninstalling any previously installed global opener:

cpython/Lib/urllib/request.py

Lines 282 to 293 in 90f1d77

	def urlcleanup():
	"""Clean up temporary files from urlretrieve calls."""
	for temp_file in _url_tempfiles:
	try:
	os.unlink(temp_file)
	except OSError:
	pass
	del _url_tempfiles[:]
	global _opener
	if _opener:
	_opener = None

However, this uninstallation of a previously installed global opener is not documented.

If the uninstallation of openers installed with install_opener is intended, then it would be best to document it in urlcleanup, and if it is not intended this should be a bug instead of a doc issue.

Linked PRs

• gh-102591: Document that urlcleanup resets the global opener #153562
• [3.15] gh-102591: Document that urlcleanup resets the global opener (GH-153562) #153588
• [3.14] gh-102591: Document that urlcleanup resets the global opener (GH-153562) #153589
• [3.13] gh-102591: Document that urlcleanup resets the global opener (GH-153562) #153590

[aucampia]

See also:

• Document that urllib.request.install_opener(None) will uninstall the global opener @ discuss.python.org

[arhadthedev]

@orsenthil (as an urllib expert)

[orsenthil]

However, this uninstallation of a previously installed global opener is not documented.

Please go ahead and submit a patch. Thank you.

[Taeknology]

Hi, I’d like to work on this documentation issue. I plan to update the urlcleanup() documentation to mention that it also resets the default global opener installed by install_opener(). I expect to submit a small documentation-only PR within the next few days.