python / python/cpython

compile(): `func_type` mode is not documented

Abierto
#153,528 0 comentarios 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

In 2019, compile() got a new mode="func_type" used to parse the signature of a function as AST:

  • commit dcfcd146f8e6fc5c2fc16a4c192a0c5f5ca8c53c
  • issue gh-79947
>>> compile('() -> int', '<string>', 'func_type', flags=ast.PyCF_ONLY_AST)
FunctionType(argtypes=[], returns=Name(id='int', ctx=Load()))

>>> import ast; ast.parse('() -> int', '<string>', 'func_type')
FunctionType(argtypes=[], returns=Name(id='int', ctx=Load()))

It's tested by test_type_comments using ast.parse() function.

The 'func_type' mode is documented in ast.parse() documentation:

In addition, if mode is 'func_type', the input syntax is modified to correspond to PEP 484 “signature type comments”, e.g. (str, int) -> List[str].

But it's not documented in the compile() function documentation. Should it be documented there as well? Maybe at least by redirecting to ast.parse()?

Linked PRs
  • gh-153542
  • gh-153561

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

Compara la documentación de la función compile() con la documentación existente de ast.parse() enlazada en el issue, centrándote en el modo no documentado 'func_type'. Se considera completado cuando la documentación de compile() describa este modo o redirija claramente a los lectores a la explicación de ast.parse(); revisa los PR enlazados gh-153542 y gh-153561 antes de empezar.

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
1/5
Tiempo estimado
Menos de una hora
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.