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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: grep-ast-0.0.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.0.1.tar.gz
Algorithm Hash digest
SHA256 3fdd57f08d13b731126f6f59de5d93a1f058a8584fe353c98c6551367933c31f
MD5 a625fe4a0ad104c192373fa57b804141
BLAKE2b-256 7cd8b4224f1622c6dd87159848d155e653ad9bbdefcc135b943286c411c841bf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: grep_ast-0.0.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.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5636f9698e17345985853cb6cf9f4814bac7fc8134c0195a7ef4781bceca3d43
MD5 645a6b2ffe8a14d6f3a0e3e14129da2e
BLAKE2b-256 a7c83c3b17ac79bd31b29063ee27efc97eb9924ed591ae3f13b94754d3907ad5

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