Skip to main content

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 available on GitHub: https://github.com/gristlabs/asttokens.

Usage

asttokens work with both Python2 and Python3. Here’s an example:

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

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(tree) if isinstance(n, ast.Attribute), None)
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.

Tests

Tests are in the tests/ subdirectory. To run all tests, run:

nosetests

Release files for asttokens 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for asttokens 1.0.0
File Size Uploaded
asttokens-1.0.0.tar.gz 27.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for asttokens 1.0.0
File Interpreter ABI Platform
asttokens-1.0.0-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 45.7 kB

Release files / asttokens-1.0.0.tar.gz

Download URL asttokens-1.0.0.tar.gz
Size 27.7 kB
Tags Source
SHA-256 checksum
How to use checksums
f53b378b9f036f1f574fb8acda0dd8530ec31362803d0326908169af04e6b271
BLAKE2b-256 checksum
How to use checksums
07ae0e23b26fc8325305820238f45bb0a6ea6b494c326342a29e7ee33d061428
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / asttokens-1.0.0-py2.py3-none-any.whl

Download URL asttokens-1.0.0-py2.py3-none-any.whl
Size 18.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
80963b9a813e43616b2405e3cb3627c586a5d5e3d1f01282e46e9f3a148d7b26
BLAKE2b-256 checksum
How to use checksums
5ee48a37f65bcbcd56ad0508dbf48ee6b368d6b8daaef83dfde76e728b1a8f00
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

3.0.2

2 release files

3.0.1

2 release files

3.0.0

2 release files

2.4.1

2 release files

2.4.0

2 release files

2.3.0

2 release files

2.2.1

2 release files

2.2.0

2 release files

2.1.0

2 release files

2.0.8

2 release files

2.0.7

2 release files

2.0.6

2 release files

2.0.5

2 release files

2.0.4

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.1.15

2 release files

1.1.14

2 release files

1.1.12

2 release files

1.1.10

2 release files

1.1.9

2 release files

1.1.8

2 release files

1.1.7

2 release files

1.1.6

2 release files

1.1.5

2 release files

1.1.4

2 release files

1.1.3

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.1

2 release files

This release

1.0.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page