Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asottile/astpretty
Pretty print the output of python stdlib `ast.parse`.
https://github.com/asottile/astpretty
ast pretty-print python
Last synced: 6 days ago
JSON representation
Pretty print the output of python stdlib `ast.parse`.
- Host: GitHub
- URL: https://github.com/asottile/astpretty
- Owner: asottile
- License: mit
- Created: 2017-03-19T23:15:34.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T01:22:45.000Z (about 1 month ago)
- Last Synced: 2024-11-05T05:21:32.582Z (about 1 month ago)
- Topics: ast, pretty-print, python
- Language: Python
- Size: 242 KB
- Stars: 190
- Watchers: 4
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-python-ast - astpretty - Pretty print the output of python stdlib `ast.parse`. (Tools)
README
[](https://github.com/asottile/astpretty/actions/workflows/main.yml)
[](https://results.pre-commit.ci/latest/github/asottile/astpretty/main)
astpretty
=========
Pretty print the output of python stdlib `ast.parse`.
astpretty is intended to be a replacement for `ast.dump`.
## Installation
```bash
pip install astpretty
```
## Usage
`astpretty` provides two api functions:
### `astpretty.pprint(node, indent=FOUR_SPACE_INDENT, show_offsets=True)`
Print a representation of the ast node.
```python
>>> astpretty.pprint(ast.parse('if x == y: y += 4').body[0])
If(
lineno=1,
col_offset=0,
test=Compare(
lineno=1,
col_offset=3,
left=Name(lineno=1, col_offset=3, id='x', ctx=Load()),
ops=[Eq()],
comparators=[Name(lineno=1, col_offset=8, id='y', ctx=Load())],
),
body=[
AugAssign(
lineno=1,
col_offset=11,
target=Name(lineno=1, col_offset=11, id='y', ctx=Store()),
op=Add(),
value=Num(lineno=1, col_offset=16, n=4),
),
],
orelse=[],
)
```
`indent` allows control over the indentation string:
```python
>>> astpretty.pprint(ast.parse('if x == y: y += 4').body[0], indent=' ')
If(
lineno=1,
col_offset=0,
test=Compare(
lineno=1,
col_offset=3,
left=Name(lineno=1, col_offset=3, id='x', ctx=Load()),
ops=[Eq()],
comparators=[Name(lineno=1, col_offset=8, id='y', ctx=Load())],
),
body=[
AugAssign(
lineno=1,
col_offset=11,
target=Name(lineno=1, col_offset=11, id='y', ctx=Store()),
op=Add(),
value=Num(lineno=1, col_offset=16, n=4),
),
],
orelse=[],
)
```
`show_offsets` controls whether the output includes line / column information:
```python
>>> astpretty.pprint(ast.parse('x += 5').body[0], show_offsets=False)
AugAssign(
target=Name(id='x', ctx=Store()),
op=Add(),
value=Num(n=5),
)
```
### `astpretty.pformat(node, indent=FOUR_SPACE_INDENT, show_offsets=True)`
Return a string representation of the ast node.
Arguments are identical to `astpretty.pprint`.
```python
>>> astpretty.pformat(ast.parse('if x == y: y += 4').body[0])
"If(\n lineno=1,\n col_offset=0,\n test=Compare(\n lineno=1,\n col_offset=3,\n left=Name(lineno=1, col_offset=3, id='x', ctx=Load()),\n ops=[Eq()],\n comparators=[Name(lineno=1, col_offset=8, id='y', ctx=Load())],\n ),\n body=[\n AugAssign(\n lineno=1,\n col_offset=11,\n target=Name(lineno=1, col_offset=11, id='y', ctx=Store()),\n op=Add(),\n value=Num(lineno=1, col_offset=16, n=4),\n ),\n ],\n orelse=[],\n)"
```
### Comparison with stdlib `ast.dump`
```python
>>> print(ast.dump(ast.parse('if x == y: y += 4').body[0]))
If(test=Compare(left=Name(id='x', ctx=Load()), ops=[Eq()], comparators=[Name(id='y', ctx=Load())]), body=[AugAssign(target=Name(id='y', ctx=Store()), op=Add(), value=Num(n=4))], orelse=[])
```