Skip to content

Support file-level assertions as inline configuration #19013

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ofek opened this issue May 1, 2025 · 2 comments
Open

Support file-level assertions as inline configuration #19013

ofek opened this issue May 1, 2025 · 2 comments
Labels
feature topic-configuration Configuration files and flags

Comments

@ofek
Copy link

ofek commented May 1, 2025

Feature

One would be able to do:

# mypy: assert=platform == "win32" and python_version >= "3.10"

and the file would only be checked if sys.platform is win32 and the tuple sys.version_info is greater than or equal to (3, 10). This is similar to the environment markers used in dependency definitions but with only support for the two static platform variables that are already used by Mypy.

Implementation-wise, there would be a pre-processing step that transforms the Python version string (if present) into a tuple. This way you can pass those two variables directly to eval.

Pitch

This would significantly help in situations such as #19009. Brief recap:

When you have the following provider module:

if sys.platform == "win32":
    from my_pkg._pty.windows import PtySession
else:
    from my_pkg._pty.unix import PtySession

and attempt importing this symbol from somewhere else, Mypy does not respect the platform condition.

For example, if you call pty.openpty() inside my_pkg._pty.unix and run Mypy on Windows it will show:

Module has no attribute "openpty"  [attr-defined]

The best solution available is adding a top-level assertion as introduced here. For example, on top of the module my_pkg._pty.unix you would put assert sys.platform != "win32".

This is suboptimal because it requires modifying runtime behavior. The sys import is required, perhaps only for the assertion, and if there are imports that only exist conditionally the assertion has to be in the middle of the standard import block on top.

Adding a file-level comment is the most pragmatic option at hand, in lieu of adding an option that automatically propagates conditional static assertions to enclosed imports.

@sterliakov
Copy link
Collaborator

It might be easier to support the following idiom:

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    import sys
    
    assert sys.platform == 'linux'

as equivalent to top-level assert. It won't be a trivial change, but might still be easier than assert.

(beware of https://peps.python.org/pep-0781/ - should it get accepted, typing import won't be necessary too, this will be almost a no-op at runtime - simple if condition evaluation, insignificant for the import time)

@ofek
Copy link
Author

ofek commented May 1, 2025

That would indeed be nicer than the current situation but it still requires 3 lines of code and would still have to be inserted before imports that don't exist without the condition.

@sterliakov sterliakov added the topic-configuration Configuration files and flags label May 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature topic-configuration Configuration files and flags
Projects
None yet
Development

No branches or pull requests

2 participants