python / python/cpython

importlib.resources opens Windows device names

Abierto
#136,516 13 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

pending stdlib topic-importlib type-bug
Lenguaje dominante
Python
Estrellas
77.2k
Forks
35.9k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

Bug report

Bug description:

The underlying issue here came up in #88992, but it seems like regardless of how this is fixed in zoneinfo, there may also be changes that should happen in importlib.resources as well, so I'm splitting this off into a new issue.

Apparently on Windows, there are certain special reserved device names like CON and NUL which you can open from within any directory, which means stuff like this will always succeed:

import importlib.resources

PACKAGE = "tzdata"  # This can be any package

importlib.resources.files(PACKAGE).open_binary("CON")

It seems that Windows is improving this, so that particular example might not work on modern Windows systems, but "NUL" still does. To the extent that CON still works, however, it's a particularly dangerous example because it starts reading from STDIN, which is not really what people are expecting here.

In general, importlib.resources is intended to be able to load resources from a package, but these special devices are not part of the package, and importlib.resources is only opening them as a quirk of the implementation. We should now allow these implementation details to leak into the interface.

From what I can tell these are kind of hard to detect, but I believe they don't show up when you actually list the contents of a directory, so in the worst case scenario we can do something like this:

if name not in os.listdir(parent):
    raise FileNotFoundError(...)

That would be fairly slow in the common case, though, so we can probably use some heuristics to narrow down whether or not we might be in the situation where we are about to open a Windows device, like so:

if OS_IS_WINDOWS and name in FROZEN_SET_OF_INTERFACE_NAMES and name not in os.listdir(parent):
    raise FileNotFoundError(...)

(This can possibly be simplified by having FROZEN_SET_OF_INTERFACE_NAMES be set to frozenset() at compile time in non-windows operating systems)

I'm assuming that we have a comprehensive list of all the reserved names that would have this property on any OS version, and FROZEN_SET_OF_INTERFACE_NAMES can be basically that list, or it can be a list determined at compile time based on your OS version. I'm also assuming that since it seems like this special devices thing is mostly going away, that list will never get any bigger, just smaller.

A related issue here is that importlib.resources also tends to return a bunch of stuff that is not actually a resource in the package, lke __init__.py and __pycache__. These do show up in iterdir and resources.is_resource(PACKAGE, "__init__.py") will return True, so these are a trickier case. If we end up with a solution that excludes these as well I'd be happy about it, but I think the more pressing issue is the device name thing, which is highly surprising and kind of obscure, platform-specific knowledge, so a lot of people won't even know to check for it and may not even have a machine on which it would cause problems.

@python/importlib-team @zooba @encukou

CPython versions tested on:

CPython main branch

Operating systems tested on:

Windows

Linked PRs
  • gh-136419
  • gh-137038
  • gh-137039

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Revisa los PRs enlazados gh-136419, gh-137038 y gh-137039; después, inspecciona la implementación de importlib.resources y su comportamiento al abrir recursos en Windows. Reproduce el ejemplo de NUL o CON en Windows e identifica las pruebas existentes que cubren la búsqueda de recursos. Se considerará completado cuando los nombres de dispositivos reservados no se abran como recursos de paquetes, mientras que los recursos de paquetes ordinarios sigan funcionando.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
backend-api-design
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.