Skip to main content

A tool to grep through the AST of a source file

Project description

grep-ast

Grep soure code files and see matching lines with useful context that show how they fit into the code. See the loops, functions, methods, classes, etc that contain all the matching lines. Get a sense of what's inside a matched class or function definition. You see relevant code from every layer of the abstract syntax tree, above and below the matches.

Grep-AST is built with tree-sitter and tree-sitter-languages. So it supports a lot of popular code languages.

Install

python -m pip install git+https://github.com/paul-gauthier/grep-ast.git

Usage

Basic usage:

grep-ast [pattern] [filenames...]

Full options list:

usage: grep_ast.py [-h] [-i] [--color] [--no-color] [--encoding ENCODING] [--languages] [--verbose]
                   [pat] [filenames ...]

positional arguments:
  pat                  the pattern to search for
  filenames            the files to display

options:
  -h, --help           show this help message and exit
  -i, --ignore-case    ignore case distinctions
  --color              force color printing
  --no-color           disable color printing
  --encoding ENCODING  file encoding
  --languages          print the parsers table
  --verbose            enable verbose output

Examples

Here we search for "encoding" in the source to this tool:

aider screencast

Here we search for "TreeContext" in the source to this tool:

aider screencast

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

grep-ast-0.1.0.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

grep_ast-0.1.0-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

Details for the file grep-ast-0.1.0.tar.gz.

File metadata

  • Download URL: grep-ast-0.1.0.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for grep-ast-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d2f6c723fe8757c28fb95fb8369d1a69f53ce48710cbe5f99b6a8b76d12a64c9
MD5 63923c5d0e8ac63d23302d0b61b3f7d8
BLAKE2b-256 f963b4e30bee86f9521d99c186f2ef43a649f0ecf59232716e2342363416c30c

See more details on using hashes here.

File details

Details for the file grep_ast-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: grep_ast-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for grep_ast-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a8588042f391edcb8efb7154aeb4af562976a0ca5c17e62f135e0b2a5dfbdfed
MD5 9f707ac3aad04805e447880e476a899a
BLAKE2b-256 5581d480c1bd7b2299ee43af3116bf2a31af7c24890254028d3cfdb40f3f2276

See more details on using hashes here.

Supported by

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