Support file-level assertions as inline configuration
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 20.6k
- Forks
- 3.3k
- Métricas de merge de PR
- Métricas de PR pendientes
Descripción
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 https://github.com/python/mypy/issues/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 PtySessionand attempt importing this symbol from somewhere else, Mypy does not respect the platform condition.
For example, if you call
pty.openpty()insidemy_pkg._pty.unixand 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.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza por rastrear cómo Mypy gestiona las aserciones existentes de nivel superior sobre la plataforma y la versión de Python, y después examina la ruta de configuración o preprocesamiento en la que podría reconocerse una directiva de archivo inline. Compara la evaluación propuesta de dos variables con el comportamiento actual de la configuración de la plataforma. Se considera terminado cuando una aserción a nivel de archivo puede habilitar condicionalmente la comprobación sin cambiar el comportamiento en tiempo de ejecución, con cobertura para las expresiones de plataforma y versión compatibles.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- compilers, devtools
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 42/100