typed-astunparse is to typed-ast as astunparse is to ast
Project description
The typed-astunparse is to typed-ast as astunparse is to ast. In short: unparsing of Python 3 abstract syntax trees (AST) with type comments.
The built-in ast module can parse Python source code into AST. It can’t, however, generate source code from the AST. That’s where astunparse comes in. Using a refactored version of an obscure script found in official Python repository, it provides code generation capability for native Python AST.
The ast and astunparse modules, however, completely ignore type comments introduced in
PEP 484. They treat them like all other comments, so when you parse the code using
compile()
, your type comments will be lost. There is no place for them in the AST, so
obviously they also cannot be unparsed.
The typed-ast module provides an updated AST including type comments defined in PEP 484 and a parser for Python code that contains such comments.
Unfortunately, typed-ast doesn’t provide any means to go from AST back to source code with type comments. This is where this module, typed-astunparse, comes in. It provides unparser for AST defined in typed-ast.
requirements
Python version >= 3.4.
Python libraries as specified in requirements.txt.
Tested on Linux, OS X and Windows.
installation
For simplest installation use pip
:
pip install typed-astunparse
You can also build your own version:
git clone https://github.com/mbdevpl/typed-astunparse
cd typed-astunparse
python -m unittest discover # make sure the tests pass
python setup.py bdist_wheel
ls -1tr dist/*.whl | tail -n 1 | xargs pip install
usage
Example of roundtrip from code through AST to code:
import typed_ast.ast3
import typed_astunparse
code = 'my_string = None # type: str'
roundtrip = typed_astunparse.unparse(typed_ast.ast3.parse(code))
print(roundtrip)
for more examples see examples.ipynb notebook.
links
ast:
astunparse:
https://pypi.python.org/pypi/astunparse
PEP 483 - The Theory of Type Hints:
PEP 484 - Type Hints:
PEP 3107 - Function Annotations:
PEP 526 - Syntax for Variable Annotations:
typed-ast:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for typed_astunparse-2.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a43e39b2033d33e07f3f6d5391ad1f85bacf601bb7e73690a47fd33ff2bd56bf |
|
MD5 | 084d336bff415067c2abd9f2007899dc |
|
BLAKE2b-256 | fa0ffc3bc1f6811a4de772049db2e648c10599e38bb4d8c24ae8cc2f440c910e |