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.2.1.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

grep_ast-0.2.1-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: grep-ast-0.2.1.tar.gz
  • Upload date:
  • Size: 10.3 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.2.1.tar.gz
Algorithm Hash digest
SHA256 0c01d8100fdf3642777556270aec9a754f40ef327250594eade141dd730f5c18
MD5 d6d02e4061b2f3ded3de93482f7b0012
BLAKE2b-256 feec024b32df40b25d18e277ce440ba98dc600e72869dc4b1a4f7a9a1e607f48

See more details on using hashes here.

File details

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

File metadata

  • Download URL: grep_ast-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 11.1 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.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 517006df5cb19e373b8112556bf9fed5f199b4279fc3941bc513f4bbead98f28
MD5 3a1d53a770e88676a7430d58dc6e484b
BLAKE2b-256 f37a9406f50c4624d044e84c21928eb298e7388dbaf05dc1e85b699503917b1e

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