Skip to main content

Annotate AST trees with source code positions

Project description

https://img.shields.io/pypi/v/asttokens.svg https://img.shields.io/pypi/pyversions/asttokens.svg https://github.com/gristlabs/asttokens/actions/workflows/build-and-test.yml/badge.svg https://readthedocs.org/projects/asttokens/badge/?version=latest https://coveralls.io/repos/github/gristlabs/asttokens/badge.svg

The asttokens module annotates Python abstract syntax trees (ASTs) with the positions of tokens and text in the source code that generated them.

It makes it possible for tools that work with logical AST nodes to find the particular text that resulted in those nodes, for example for automated refactoring or highlighting.

Installation

asttokens is available on PyPI: https://pypi.python.org/pypi/asttokens/:

pip install asttokens

The code is on GitHub: https://github.com/gristlabs/asttokens.

The API Reference is here: http://asttokens.readthedocs.io/en/latest/api-index.html.

Usage

ASTTokens can annotate both trees built by ast, AND those built by astroid.

Here’s an example:

import asttokens, ast
source = "Robot('blue').walk(steps=10*n)"
atok = asttokens.ASTTokens(source, parse=True)

Once the tree has been marked, nodes get .first_token, .last_token attributes, and the ASTTokens object offers helpful methods:

attr_node = next(n for n in ast.walk(atok.tree) if isinstance(n, ast.Attribute))
print(atok.get_text(attr_node))
start, end = attr_node.last_token.startpos, attr_node.last_token.endpos
print(atok.text[:start] + 'RUN' + atok.text[end:])

Which produces this output:

Robot('blue').walk
Robot('blue').RUN(steps=10*n)

The ASTTokens object also offers methods to walk and search the list of tokens that make up the code (or a particular AST node), which is more useful and powerful than dealing with the text directly.

Contribute

To contribute:

  1. Fork this repository, and clone your fork.

  2. Install the package with test dependencies (ideally in a virtualenv) with:

    pip install -e '.[test]'
  3. Run tests in your current interpreter with the command pytest or python -m pytest.

  4. Run tests across all supported interpreters with the tox command. You will need to have the interpreters installed separately. We recommend pyenv for that. Use tox -p auto to run the tests in parallel.

  5. By default certain tests which take a very long time to run are skipped, but they are run in CI. These are marked using the pytest marker slow and can be run on their own with pytest -m slow or as part of the full suite with pytest -m ''.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

asttokens-3.0.0.tar.gz (62.0 kB view details)

Uploaded Source

Built Distribution

asttokens-3.0.0-py3-none-any.whl (26.9 kB view details)

Uploaded Python 3

File details

Details for the file asttokens-3.0.0.tar.gz.

File metadata

  • Download URL: asttokens-3.0.0.tar.gz
  • Upload date:
  • Size: 62.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.0

File hashes

Hashes for asttokens-3.0.0.tar.gz
Algorithm Hash digest
SHA256 0dcd8baa8d62b0c1d118b399b2ddba3c4aff271d0d7a9e0d4c1681c79035bbc7
MD5 7d99c4c80190c3ba64839138ea827970
BLAKE2b-256 4ae782da0a03e7ba5141f05cce0d302e6eed121ae055e0456ca228bf693984bc

See more details on using hashes here.

File details

Details for the file asttokens-3.0.0-py3-none-any.whl.

File metadata

  • Download URL: asttokens-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 26.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.0

File hashes

Hashes for asttokens-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e3078351a059199dd5138cb1c706e6430c05eff2ff136af5eb4790f9d28932e2
MD5 2c867920c8a02c96736f4caff4f1757e
BLAKE2b-256 258ac46dcc25341b5bce5472c718902eb3d38600a903b14fa6aeecef3f21a46f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page