add type stub for `os.reload_environ` by guoci · Pull Request #14938 · python/typeshed

guoci · 2025-10-28T21:29:21Z

No description provided.

github-actions · 2025-10-28T21:37:08Z

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉

AlexWaygood

Thank you. It looks like the reason why we forgot to add this is that the CPython team forgot to add this function to __all__ when they added it. This then meant that our tests didn't flag it as missing from the module. (In general, if __all__ is defined in a module, our tests only complain if something is missing from the stub if that thing is included in __all__.)

Would you be interested in also making a PR to CPython to add "reload_environ" to os.__all__? Feel free to tag me on the PR and I can help get it merged

guoci · 2025-10-29T15:25:04Z

@AlexWaygood Should I do this to the other recent typeshed missing stubs as well?

AlexWaygood · 2025-10-29T15:43:56Z

@AlexWaygood Should I do this to the other recent typeshed missing stubs as well?

I think this is the only one where the reason why it wasn't picked up by our tests was that it wasn't included in __all__.

sys.__all__ does not exist:
- the reason why sys.androidapilevel wasn't picked up by our tests despite it being missing is that it only exists on Android, and we don't have any CI jobs in typeshed that run on Android.
- sys._current_exceptions wasn't flagged as being missing because it starts with a leading underscore, and if a module doesn't have __all__ defined then all symbols that start with leading underscores are assumed to be private by our tests (this one was an exception, since it is documented)
sysconfig.__all__ does exist, but I think it's probably intentional that _get_preferred_schemes doesn't exist in __all__ -- the docs for that method say "End users should not use this function". I think since it is documented, probably the best thing is to add it to the stubs... but given that "end users should not use this function", I'm not really sure why it's documented 😆

guoci · 2025-10-29T15:51:27Z

What about enum.show_flag_values (#14928)?

AlexWaygood · 2025-10-29T16:16:52Z

Good point! Yep, that one should also probably be added to __all__ at runtime!

AlexWaygood · 2025-10-29T21:13:34Z

@guoci how did you find these, out of interest?

guoci · 2025-10-30T15:05:01Z

@AlexWaygood I wrote a script that matches the CPython reStructuredText documentation against the typeshed type stubs. My goal is to automate the process of integrating typeshed’s type information into the CPython docs.

AlexWaygood · 2025-10-30T15:13:06Z

Very cool -- you could consider contributing something like that script to stubtest, which is the tool we use in our CI to detect when something is present at runtime but not present in the stub. If something appears in CPython's documentation, that's a pretty good reason to make sure we include it in the stubs. We could probably make sure all objects that are explicitly documented are included in this set here as things that should always be included in the stubs.

guoci · 2025-10-30T15:20:15Z

Sure!

guoci · 2026-02-22T17:56:57Z

@AlexWaygood I have open sourced my tool to find missing stubs at https://github.com/guoci/typeshedding_cpython_docs.

guoci · 2026-03-03T20:00:55Z

Here is a list of missing stubs for branch 3.14:

API	module	src
AbstractEventLoopPolicy	asyncio	asyncio-policy.rst
AbstractEventLoopPolicy.get_event_loop	asyncio	asyncio-policy.rst
AbstractEventLoopPolicy.set_event_loop	asyncio	asyncio-policy.rst
AbstractEventLoopPolicy.new_event_loop	asyncio	asyncio-policy.rst
DefaultEventLoopPolicy	asyncio	asyncio-policy.rst
WindowsSelectorEventLoopPolicy	asyncio	asyncio-policy.rst
WindowsProactorEventLoopPolicy	asyncio	asyncio-policy.rst
QueueEmptyError	concurrent.interpreters	concurrent.interpreters.rst
QueueFullError	concurrent.interpreters	concurrent.interpreters.rst
FTP_TLS.ssl_version	ftplib	ftplib.rst
MADV_SOFT_OFFLINE	mmap	mmap.rst
MAP_ALIGNED_SUPER	mmap	mmap.rst
MAP_CONCEAL	mmap	mmap.rst
set_error_mode	msvcrt	msvcrt.rst
OUT_TO_DEFAULT	msvcrt	msvcrt.rst
OUT_TO_STDERR	msvcrt	msvcrt.rst
OUT_TO_MSGBOX	msvcrt	msvcrt.rst
REPORT_ERRMODE	msvcrt	msvcrt.rst
CrtSetReportMode	msvcrt	msvcrt.rst
CrtSetReportFile	msvcrt	msvcrt.rst
CRT_WARN	msvcrt	msvcrt.rst
CRT_ERROR	msvcrt	msvcrt.rst
CRT_ASSERT	msvcrt	msvcrt.rst
CRTDBG_MODE_DEBUG	msvcrt	msvcrt.rst
CRTDBG_MODE_FILE	msvcrt	msvcrt.rst
CRTDBG_MODE_WNDW	msvcrt	msvcrt.rst
CRTDBG_REPORT_MODE	msvcrt	msvcrt.rst
VC_ASSEMBLY_PUBLICKEYTOKEN	msvcrt	msvcrt.rst
LIBRARIES_ASSEMBLY_NAME_PREFIX	msvcrt	msvcrt.rst
RLIMIT_VMEM	resource	resource.rst
RLIMIT_SBSIZE	resource	resource.rst
RLIMIT_SWAP	resource	resource.rst
RLIMIT_NPTS	resource	resource.rst
RLIMIT_KQUEUES	resource	resource.rst
RUSAGE_BOTH	resource	resource.rst
BDADDR_BREDR	socket	socket.rst
BDADDR_LE_PUBLIC	socket	socket.rst
BDADDR_LE_RANDOM	socket	socket.rst
SOL_L2CAP	socket	socket.rst
SOL_SCO	socket	socket.rst
SOL_BLUETOOTH	socket	socket.rst
L2CAP_LM	socket	socket.rst
SO_HCI_EVT_FILTER	socket	socket.rst
SO_HCI_PKT_FILTER	socket	socket.rst
HCI_DEV_NONE	socket	socket.rst
HCI_CHANNEL_RAW	socket	socket.rst
HCI_CHANNEL_USER	socket	socket.rst
HCI_CHANNEL_MONITOR	socket	socket.rst
HCI_CHANNEL_CONTROL	socket	socket.rst
HCI_CHANNEL_LOGGING	socket	socket.rst
SO_REUSEPORT_LB	socket	socket.rst
_emscripten_info	sys	sys.rst
_emscripten_info.emscripten_version	sys	sys.rst
_emscripten_info.runtime	sys	sys.rst
_emscripten_info.pthreads	sys	sys.rst
_emscripten_info.shared_memory	sys	sys.rst
getobjects	sys	sys.rst
_jit	sys	sys.rst
_jit.is_available	sys	sys.rst
_jit.is_enabled	sys	sys.rst
_jit.is_active	sys	sys.rst

add type stub for sys.reload_environ

1994708

AlexWaygood changed the title ~~add type stub for sys.reload_environ~~ add type stub for os.reload_environ Oct 29, 2025

AlexWaygood approved these changes Oct 29, 2025

View reviewed changes

AlexWaygood merged commit 1bfd069 into python:main Oct 29, 2025
63 checks passed

guoci mentioned this pull request Oct 29, 2025

gh-120057: add os.reload_environ to __all__ python/cpython#140763

Merged

This was referenced Oct 29, 2025

gh-140766: add enum.show_flag_values and enum.bin to enum.__all__ python/cpython#140765

Merged

Missing enum.show_flag_values in enum.__all__ python/cpython#140766

Closed

guoci deleted the add_sys_reload_environ branch November 15, 2025 17:16

guoci mentioned this pull request Nov 19, 2025

Typeshed path override breaks stdlib types facebook/pyrefly#1621

Open

Uh oh!

Conversation

guoci commented Oct 28, 2025

Uh oh!

github-actions bot commented Oct 28, 2025

Uh oh!

AlexWaygood left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

guoci commented Oct 29, 2025

Uh oh!

AlexWaygood commented Oct 29, 2025

Uh oh!

guoci commented Oct 29, 2025

Uh oh!

AlexWaygood commented Oct 29, 2025

Uh oh!

AlexWaygood commented Oct 29, 2025

Uh oh!

guoci commented Oct 30, 2025

Uh oh!

AlexWaygood commented Oct 30, 2025

Uh oh!

guoci commented Oct 30, 2025

Uh oh!

guoci commented Feb 22, 2026

Uh oh!

guoci commented Mar 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants