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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: grep-ast-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 0469b2a58995156b2a1cc1d63db0dcd004027aabad9bdea6ef910feccdeb9f17
MD5 c717df6fdfeef4314e0b3d50ace9d00a
BLAKE2b-256 1c0aac64d608a33da5eb87eaed2f7f3bc427a7a5ba3f2bf8f38c6e933b84e518

See more details on using hashes here.

File details

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

File metadata

  • Download URL: grep_ast-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9e0c7539f3a796d6d8b379111c12c6af86d2fe7c2e1fb8047e502cd54bddb73e
MD5 94543f915849406990c82efc65016845
BLAKE2b-256 a1cb455ebbb9195c058f7530e55ff2345c1b5743bece8dda5fb969ea6637b210

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