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

Uploaded Source

Built Distribution

grep_ast-0.2.2-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: grep-ast-0.2.2.tar.gz
  • Upload date:
  • Size: 10.7 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.2.tar.gz
Algorithm Hash digest
SHA256 60c545509a21cdba47125b1f700a8b6596add6573b62f009cb95adab9f009b73
MD5 f485f0dc1d6943b27d9a3922e36b452d
BLAKE2b-256 5b97f5732d8667ee9b0d83f168d4c7910511a907ce11aa0038923e09f5c84da1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: grep_ast-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 11.5 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d1be3b7c9290c568e97d71ae5cb816b5539346dd6a8951b4105094016becd1f6
MD5 c5ce8f5824eeb0bef0cc7f78c85120f5
BLAKE2b-256 96e3834862bf17a0273be78d17df046a7715901eb2c3e43445584d86d31ef458

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