https://github.com/simonpercivall/astunparse

An AST unparser for Python
https://github.com/simonpercivall/astunparse

developer-tools python

Last synced: 27 days ago
JSON representation

An AST unparser for Python

• Host: GitHub
• URL: https://github.com/simonpercivall/astunparse
• Owner: simonpercivall
• License: other
• Created: 2014-03-31T15:34:54.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2023-08-18T23:41:57.000Z (over 1 year ago)
• Last Synced: 2024-05-22T14:32:47.572Z (7 months ago)
• Topics: developer-tools, python
• Language: Python
• Size: 76.2 KB
• Stars: 215
• Watchers: 9
• Forks: 53
• Open Issues: 26
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

• awesome-python-ast - astunparse - a factored out version of unparse found in the Python source distribution (Tools)

README

        
============

AST Unparser

============

.. image:: https://badge.fury.io/py/astunparse.png

    :target: http://badge.fury.io/py/astunparse

.. image:: https://travis-ci.org/simonpercivall/astunparse.png?branch=master

    :target: https://travis-ci.org/simonpercivall/astunparse

.. image:: https://readthedocs.org/projects/astunparse/badge/

    :target: https://astunparse.readthedocs.org/

An AST unparser for Python.

This is a factored out version of ``unparse`` found in the Python

source distribution; under Demo/parser in Python 2 and under Tools/parser

in Python 3.

Basic example::

    import inspect

    import ast

    import astunparse

    # get back the source code

    astunparse.unparse(ast.parse(inspect.getsource(ast)))

    # get a pretty-printed dump of the AST

    astunparse.dump(ast.parse(inspect.getsource(ast)))

This library is single-source compatible with Python 2.6 through Python 3.5. It

is authored by the Python core developers; I have simply merged the Python 2.7

and the Python 3.5 source and test suites, and added a wrapper. This factoring

out is to provide a library implementation that supports both versions.

Added to this is a pretty-printing ``dump`` utility function.

The test suite both runs specific tests and also roundtrips much of the

standard library.

Extensions and Alternatives

---------------------------

Similar projects include:

    * codegen_

    * astor_

    * astmonkey_

    * astprint_

None of these roundtrip much of the standard library and fail several of the basic

tests in the ``test_unparse`` test suite.

This library uses mature and core maintained code instead of trying to patch

existing libraries. The ``unparse`` and the ``test_unparse`` modules

are under the PSF license.

Extensions include:

    * typed-astunparse: extends astunparse to support type annotations.

* Documentation: http://astunparse.rtfd.org.

Features

--------

* unparses Python AST.

* pretty-prints AST.

.. _codegen: https://github.com/andreif/codegen

.. _astor: https://github.com/berkerpeksag/astor

.. _astmonkey: https://github.com/konradhalas/astmonkey

.. _astprint: https://github.com/Manticore/astprint