python / python/cpython

Doc string for locals() partly contradicts the full documentation

Abierto
#126,170 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

docs
Lenguaje dominante
Python
Estrellas
77.2k
Forks
35.9k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

locals() documentation

>>> print(locals.__doc__)
Return a dictionary containing the current scope's local variables.

NOTE: Whether or not updates to this dictionary will affect name lookups in
the local scope and vice-versa is *implementation dependent* and not
covered by any backwards compatibility guarantees.

But in the docs:

At module scope, as well as when using exec() or eval() with a single namespace [...]

At class scope [...]

When using exec() or eval() with separate local and global arguments [...]

In all of the above cases, each call to locals() in a given frame of execution will return the same mapping object. Changes made through the mapping object returned from locals() will be visible as assigned, reassigned, or deleted local variables, and assigning, reassigning, or deleting local variables will immediately affect the contents of the returned mapping object.

In an optimized scope (including functions, generators, and coroutines), each call to locals() instead returns a fresh dictionary containing the current bindings of the function’s local variables and any nonlocal cell references. In this case, name binding changes made via the returned dict are not written back to the corresponding local variables or nonlocal cell references, and assigning, reassigning, or deleting local variables and nonlocal cell references does not affect the contents of previously returned dictionaries.

So either:

  • Behaviour is undefined and the full documentation fails to mention this in giving a complete description of it
  • The behaviour given in the full documentation is stable and can be relied upon, in which case the doc string is misleading

It feels like at least one of the two should be corrected/clarified.

Linked PRs
  • gh-127225

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

Comienza revisando la salida del docstring de locals() y el PR vinculado gh-127225; después, compárala con la descripción de la entrada documentada de locals(). Determina qué redacción cubre correctamente los casos de ámbito enumerados. La tarea estará terminada cuando el docstring y la documentación completa ya no se contradigan.

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

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
30/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.