Repository navigation
compile(): func_type mode is not documented #153528
Description
In 2019, compile() got a new mode="func_type" used to parse the signature of a function as AST:
- commit dcfcd14
- issue Merge typed_ast back into CPython #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()?
Activity
[-]compile(): `mode="func_type"` is not documented[/-][+]compile(): `func_type` mode is not documented[/+]pythongh-153528: Document `mode="func_type"` in `compile()`
pythongh-153528: Document `mode="func_type"` in `compile()`
pythongh-153528: Document `mode="func_type"` in `compile()`
gh-153528: Document `mode="func_type"` in `compile()` (#153561)
[3.15] gh-153528: Document `mode="func_type"` in `compile()` (GH-153561…
[3.14] gh-153528: Document `mode="func_type"` in `compile()` (GH-153561…