Skip to main content

No project description provided

Project description

ast-comments

An extension to the built-in ast module. Finds comments in source code and adds them to the parsed tree.

Installation

pip install ast-comments

Usage

There is no difference in usage between ast and ast-comments

>>> from ast_comments import *
>>> tree = parse("hello = 'hello' # comment to hello")

Parsed tree is an instance of the original ast.Module object. The only difference is that there is a new type of tree node: Comment

>>> tree
<_ast.Module object at 0x7ffba52322e0>
>>> tree.body
[<ast.Assign object at 0x10a01d5b0>, <ast_comments.Comment object at 0x10a09e0a0>]
>>> tree.body[1].value
'# comment to hello'
>>> dump(tree)
"Module(body=[Assign(targets=[Name(id='hello', ctx=Store())], value=Constant(value='hello')), Comment(value='# comment to hello', inline=True)], type_ignores=[])"

If you have python3.9 or above it's also possible to unparse the tree object with its comments preserved.

>>> print(unparse(tree))
hello = 'hello'  # comment to hello

Note: Python compile() cannot be run on the tree output from parse. The included pre_compile_fixer() function can be used to fix the tree (stripping comment nodes) if it will be necessary to compile the output.

More examples can be found in test_parse.py and test_unparse.py.

Contributing

You are welcome to open an issue or create a pull request

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

ast_comments-1.2.3.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

ast_comments-1.2.3-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file ast_comments-1.2.3.tar.gz.

File metadata

  • Download URL: ast_comments-1.2.3.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.17 Darwin/24.5.0

File hashes

Hashes for ast_comments-1.2.3.tar.gz
Algorithm Hash digest
SHA256 f9d003e9608b54195bd822b1d359a18e24573d2d8beff0307d7dc6f9d0cd0ba6
MD5 4c8e46eb923136665a1c77974a6b1f25
BLAKE2b-256 549fbe024de83c52e7aecb7d3871c3e4c24bc0df377fb752fa65745c36b8f35f

See more details on using hashes here.

File details

Details for the file ast_comments-1.2.3-py3-none-any.whl.

File metadata

  • Download URL: ast_comments-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.17 Darwin/24.5.0

File hashes

Hashes for ast_comments-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2b2319312027a523dd4b30381a7662da8fdd16210786db3402d8e1b1df12a886
MD5 b8419d9efc695c9607ecc33e8382486c
BLAKE2b-256 3ac385f81c3fe2f7a2bd634239056bffac4bfb4324761c787845f78dc264082c

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