python / python/cpython

help(typing.Annotated[foo, ...]) should return the doc for _AnnotatedAlias

Abierto
#97,796 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

topic-typing type-bug
Lenguaje dominante
Python
Estrellas
77.2k
Forks
36k
Merge medio
1 d 9 h
PR fusionados (30 d)
558

Descripción

Split off from #89543; the module issue is fixed but other issues raised in the comments still remain valid. For the following code

>>> from typing import Annotated, Callable
>>> t = Annotated[int | str, "Some metadata"]
>>> help(t)
Help on _AnnotatedAlias in module typing:

Annotated = int | str

We should arguably ignore the instance and return the same thing as help(typing._AnnotatedAlias), analogously to help(int | str) returning the docs for Union

Linked PRs
  • gh-97813

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 con el comportamiento reproducido de help(typing.Annotated[...]) y compáralo con help(typing._AnnotatedAlias) y help(int | str). El cambio estará terminado cuando la instancia de Annotated devuelva la documentación de _AnnotatedAlias en lugar de la salida actual específica de la instancia.

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

Evaluación

Stack tecnológico
python
Área
developer-experience
Tipo de issue
Error
Dificultad
3/5
Tiempo estimado
1-2 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.