A Python wrapper for ripgrep, providing fast and efficient text searching and file listing capabilities.

ripgrep-rs is a Python package that wraps the functionality of ripgrep, a line-oriented search tool that recursively searches directories for a regex pattern. This package allows you to harness the power and speed of ripgrep directly from your Python code.

Unlike many other ripgrep bindings for Python, ripgrep-rs doesn't shell out to the ripgrep command-line tool. Instead, it reimplements core ripgrep logic in Rust and provides a direct interface to Python via PyO3.

pip install ripgrep-rs

from ripgrep_rs import search

# Perform a simple search, returning a list of string results grouped by file.
results = search(
    patterns=["pattern"],
    paths=["path/to/search"],
    globs=["*.py"],
)
for result in results:
    print(result)

from ripgrep_rs import search_structured

# Returns parsed SearchMatch objects instead of raw strings.
matches = search_structured(
    patterns=["def "],
    paths=["src/"],
    globs=["*.py"],
    max_total=10,
)
for m in matches:
    print(f"{m.path}:{m.line_number}: {m.line_text}")
    for sm in m.submatches:
        print(f"  match: [{sm.start}:{sm.end}] {sm.text!r}")

from ripgrep_rs import files, files_with_info

# List files respecting .gitignore
file_list = files(
    paths=["src/"],
    globs=["*.py"],
    hidden=False,
)

# List files with metadata (size, mtime, permissions, etc.)
file_info = files_with_info(
    paths=["src/"],
    globs=["*.py"],
    absolute=True,
)
for path, info in file_info.items():
    print(f"{path}: {info.size} bytes, modified {info.mtime}")

Search for regex patterns in files, returning raw formatted string results.

Search for regex patterns, returning parsed SearchMatch objects.

List files that would be searched, respecting ignore rules.

List files with detailed metadata, returning a dict mapping paths to FileInfo objects.

Same parameters as files().

PySortMode(kind=PySortModeKind.Path, reverse=False)

Enum with values: Path, LastModified, LastAccessed, Created.

This project uses maturin for building the Python package from Rust code.

git clone https://github.com/phil65/python-ripgrep
cd python-ripgrep
pip install maturin
maturin develop

MIT License - see LICENSE file for details.

This project is based on ripgrep by Andrew Gallant.