rgapi 0.1.1__tar.gz → 0.1.4__tar.gz

rgapi-0.1.4/.github/workflows/ci.yml

@@ -0,0 +1,83 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+    tags: ['v*']
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - run: cargo test
+
+  linux:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: PyO3/maturin-action@v1
+        with:
+          args: --release --out dist -i python3.10 -i python3.11 -i python3.12 -i python3.13
+          manylinux: auto
+          before-script-linux: |
+            python3.13 -m pip install 'fastship>=0.0.13'
+            python3.13 -m fastship.rs_prep --release
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-linux
+          path: dist
+
+  macos:
+    needs: test
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.13'
+      - run: python -m pip install 'fastship>=0.0.13'
+      - run: python -m fastship.rs_prep --release
+      - uses: PyO3/maturin-action@v1
+        with:
+          args: --release --out dist -i python3.10 -i python3.11 -i python3.12 -i python3.13
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-macos
+          path: dist
+
+  sdist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: -o dist
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-sdist
+          path: dist
+
+  publish:
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: [linux, macos, sdist]
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+      - uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

{rgapi-0.1.1 → rgapi-0.1.4}/.gitignore

@@ -1,3 +1,4 @@
+dist/
 Cargo.lock
 tags
 /target/

{rgapi-0.1.1 → rgapi-0.1.4}/Cargo.lock

@@ -11,12 +11,6 @@ dependencies = [
  "memchr",
 ]
 
-[[package]]
-name = "autocfg"
-version = "1.5.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53"
-
 [[package]]
 name = "bstr"
 version = "1.12.1"
@@ -149,15 +143,6 @@ dependencies = [
  "winapi-util",
 ]
 
-[[package]]
-name = "indoc"
-version = "2.0.7"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "79cf5c93f93228cf8efb3ba362535fb11199ac548a09ce117c9b1adc3030d706"
-dependencies = [
- "rustversion",
-]
-
 [[package]]
 name = "libc"
 version = "0.2.186"
@@ -166,9 +151,9 @@ checksum = "68ab91017fe16c622486840e4c83c9a37afeff978bd239b5293d61ece587de66"
 
 [[package]]
 name = "log"
-version = "0.4.32"
+version = "0.4.33"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "953f07c43838f8e6f9758cab68bf5bed85465e7587ebe0b823f1bcd81978ad3a"
+checksum = "0ceec5bc11778974d1bcb055b18002eba7f4b3518b6a0081b3af5f21666da9ad"
 
 [[package]]
 name = "memchr"
@@ -185,15 +170,6 @@ dependencies = [
  "libc",
 ]
 
-[[package]]
-name = "memoffset"
-version = "0.9.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a"
-dependencies = [
- "autocfg",
-]
-
 [[package]]
 name = "once_cell"
 version = "1.21.4"
@@ -217,37 +193,32 @@ dependencies = [
 
 [[package]]
 name = "pyo3"
-version = "0.23.5"
+version = "0.29.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7778bffd85cf38175ac1f545509665d0b9b92a198ca7941f131f85f7a4f9a872"
+checksum = "cd274650b21d4bfc26a0a47587962c1edb425f69287324355cd040c3ea66071c"
 dependencies = [
- "cfg-if",
- "indoc",
  "libc",
- "memoffset",
  "once_cell",
  "portable-atomic",
  "pyo3-build-config",
  "pyo3-ffi",
  "pyo3-macros",
- "unindent",
 ]
 
 [[package]]
 name = "pyo3-build-config"
-version = "0.23.5"
+version = "0.29.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "94f6cbe86ef3bf18998d9df6e0f3fc1050a8c5efa409bf712e661a4366e010fb"
+checksum = "c5e2a7d2f0d013342f295c048ad19237add5154a55b1c5a254c0ec93d4109078"
 dependencies = [
- "once_cell",
  "target-lexicon",
 ]
 
 [[package]]
 name = "pyo3-ffi"
-version = "0.23.5"
+version = "0.29.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e9f1b4c431c0bb1c8fb0a338709859eed0d030ff6daa34368d3b152a63dfdd8d"
+checksum = "ca85c467da1bbc8d866eea5deff9cf29ea5f7785054a17da36e65bda9c05845b"
 dependencies = [
  "libc",
  "pyo3-build-config",
@@ -255,9 +226,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-macros"
-version = "0.23.5"
+version = "0.29.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "fbc2201328f63c4710f68abdf653c89d8dbc2858b88c5d88b0ff38a75288a9da"
+checksum = "9ac53762fd065daa3194dd09337a38bd793a188100fd1a9304c4ab312d901771"
 dependencies = [
  "proc-macro2",
  "pyo3-macros-backend",
@@ -267,13 +238,12 @@ dependencies = [
 
 [[package]]
 name = "pyo3-macros-backend"
-version = "0.23.5"
+version = "0.29.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "fca6726ad0f3da9c9de093d6f116a93c1a38e417ed73bf138472cf4064f72028"
+checksum = "4ca3a1557399783172dc5bf39cfca835157732532cba56b71d2292161e53b362"
 dependencies = [
  "heck",
  "proc-macro2",
- "pyo3-build-config",
  "quote",
  "syn",
 ]
@@ -306,7 +276,7 @@ checksum = "d6f6ff9a378485b298a5286656da665ba74413d36db0979633275d2e708145d4"
 
 [[package]]
 name = "rgapi"
-version = "0.1.1"
+version = "0.1.4"
 dependencies = [
  "globset",
  "grep-matcher",
@@ -316,12 +286,6 @@ dependencies = [
  "pyo3",
 ]
 
-[[package]]
-name = "rustversion"
-version = "1.0.22"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
-
 [[package]]
 name = "same-file"
 version = "1.0.6"
@@ -373,9 +337,9 @@ dependencies = [
 
 [[package]]
 name = "target-lexicon"
-version = "0.12.16"
+version = "0.13.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "61c41af27dd6d1e27b1b16b489db798443478cef1f06a660c96db617ba5de3b1"
+checksum = "adb6935a6f5c20170eeceb1a3835a49e12e19d792f6dd344ccc76a985ca5a6ca"
 
 [[package]]
 name = "unicode-ident"
@@ -383,12 +347,6 @@ version = "1.0.24"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
 
-[[package]]
-name = "unindent"
-version = "0.2.4"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7264e107f553ccae879d21fbea1d6724ac785e8c3bfc762137959b5802826ef3"
-
 [[package]]
 name = "walkdir"
 version = "2.5.0"

{rgapi-0.1.1 → rgapi-0.1.4}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rgapi"
-version = "0.1.1"
+version = "0.1.4"
 edition = "2021"
 license = "MIT OR Apache-2.0"
 description = "Python API for ripgrep-style file walking and searching"
@@ -14,12 +14,12 @@ name = "rgapi"
 crate-type = ["cdylib", "rlib"]
 
 [dependencies]
-globset = "0.4.18"
-grep-matcher = "0.1.8"
-grep-regex = "0.1.14"
-grep-searcher = "0.1.16"
-ignore = "0.4.26"
-pyo3 = { version = "0.23", optional = true }
+globset = ">=0.4.18"
+grep-matcher = ">=0.1.8"
+grep-regex = ">=0.1.14"
+grep-searcher = ">=0.1.16"
+ignore = ">=0.4.26"
+pyo3 = { version = ">=0.28", optional = true }
 
 [features]
 extension-module = ["pyo3", "pyo3/extension-module"]

{rgapi-0.1.1 → rgapi-0.1.4}/DEV.md

@@ -17,17 +17,23 @@ The public Python API lives in `python/rgapi/__init__.py`. The extension module
 ## Commands
 
 ```bash
-cargo fmt --check
-cargo check
-maturin develop
-pytest -q
+ship-rs-test
 ```
 
-Run `cargo test` for Rust unit tests. Run `chkstyle` after Python edits once tests pass.
+Run `cargo fmt --check` and `cargo check` for Rust-only edits. Run `chkstyle` after Python edits once tests pass.
 
 ## Release
 
-Release plumbing mirrors exhash. `tools/bump.sh` bumps the patch version in `pyproject.toml` and `Cargo.toml`; `tools/bump2.sh` bumps the minor version; `tools/release.sh` tags the current version and pushes `main` plus tags. The GitHub workflow builds wheels for Python 3.10-3.13 on Linux and macOS and publishes artifacts to GitHub Releases and PyPI when a `v*` tag is pushed.
+The canonical version lives in `Cargo.toml`. `pyproject.toml` gets the Python package version from Cargo via `dynamic = ["version"]`.
+
+Release flow is: release first, then bump.
+
+1. Run `ship-rs-test`.
+2. Confirm the release version in `Cargo.toml` (`[package].version`).
+3. Run `ship-rs-release`.
+4. After pushing the release tag, run `ship-rs-bump`, commit the `Cargo.toml` version bump, and push to `main` without a tag.
+
+The GitHub workflow builds wheels for Python 3.10-3.13 on Linux and macOS and publishes artifacts to GitHub Releases and PyPI when a `v*` tag is pushed.
 
 ## Design notes
 

{rgapi-0.1.1 → rgapi-0.1.4}/PKG-INFO

@@ -1,8 +1,12 @@
 Metadata-Version: 2.4
 Name: rgapi
-Version: 0.1.1
+Version: 0.1.4
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Dist: fastship>=0.0.12 ; extra == 'dev'
+Requires-Dist: maturin>=1.0,<2.0 ; extra == 'dev'
+Requires-Dist: pytest ; extra == 'dev'
+Provides-Extra: dev
 Summary: Python API for ripgrep-style file walking and searching
 Home-Page: https://github.com/AnswerDotAI/rgapi
 Author-email: Jeremy Howard <j@fast.ai>
@@ -54,6 +58,7 @@ pip install rgapi
 ## Semantics
 
 `fd` and `walk` return slash-separated paths relative to `root`. They use the `ignore` crate, so `.gitignore` and the usual ripgrep filters apply by default. Hidden files are skipped unless `hidden=True`. Pass `ignore=False` to disable ignore filtering. Symlinks are not followed unless `follow_links=True`; `same_file_system=True` avoids crossing filesystem boundaries. Traversal is parallel, and result order is not guaranteed; use `sorted(...)` if order matters.
+`root` arguments accept `str` or `pathlib.Path` and expand `~`; `search_path` also accepts path-like file paths. Display labels such as `display_path` are stringified without expansion.
 
 `fd` adds fd-like filtering on top of `walk`: `pattern` is a substring match on the relative path, and `include`/`exclude` use glob syntax. `glob=` is accepted as an alias for `include=`. A basename glob such as `*.py` also matches recursively, so it finds `src/app.py`. Use `ext="py"` or `ext=["py", "rs"]` for extension filters, `min_depth=`/`max_depth=` to bound recursion, and `max_filesize=` to skip files above a byte limit.
 
@@ -73,12 +78,10 @@ matches      list of (start, end) byte offsets for match rows
 
 `SearchLine` has a structured `repr`, an rg-style `str`, and `SearchLine.asdict()` returns row fields as a plain Python dict. `rg(..., paths=True)` returns unique matched paths, and `rg(..., count=True)` returns the total number of match spans. `paths` and `count` cannot both be set.
 
-`before_context`, `after_context`, and `context` match the shape of `rg -B`, `rg -A`, and `rg -C`. Files containing NUL bytes or invalid UTF-8 are skipped.
+`before_context`, `after_context`, and `context` are like `rg -B`, `rg -A`, and `rg -C`. Files containing NUL bytes or invalid UTF-8 are skipped.
 
 Search is case-sensitive by default, matching `rg`. Use `smart_case=True` for `rg --smart-case` behavior, or `case_sensitive=False` to force case-insensitive matching.
 
-`rg` and `rg_iter` check Python signals while waiting for search results, so notebook interrupts and `KeyboardInterrupt` cancel traversal cooperatively. Cancellation is prompt between files and while results are streaming; a single huge file that produces no callbacks may continue until that file scan returns.
-
 ## Benchmarks
 
 `tools/bench.py` compares the `rg` CLI with in-process `rgapi`. Run it against a release build. One run on this machine, using best time from seven repeats:

{rgapi-0.1.1 → rgapi-0.1.4}/README.md

@@ -39,6 +39,7 @@ pip install rgapi
 ## Semantics
 
 `fd` and `walk` return slash-separated paths relative to `root`. They use the `ignore` crate, so `.gitignore` and the usual ripgrep filters apply by default. Hidden files are skipped unless `hidden=True`. Pass `ignore=False` to disable ignore filtering. Symlinks are not followed unless `follow_links=True`; `same_file_system=True` avoids crossing filesystem boundaries. Traversal is parallel, and result order is not guaranteed; use `sorted(...)` if order matters.
+`root` arguments accept `str` or `pathlib.Path` and expand `~`; `search_path` also accepts path-like file paths. Display labels such as `display_path` are stringified without expansion.
 
 `fd` adds fd-like filtering on top of `walk`: `pattern` is a substring match on the relative path, and `include`/`exclude` use glob syntax. `glob=` is accepted as an alias for `include=`. A basename glob such as `*.py` also matches recursively, so it finds `src/app.py`. Use `ext="py"` or `ext=["py", "rs"]` for extension filters, `min_depth=`/`max_depth=` to bound recursion, and `max_filesize=` to skip files above a byte limit.
 
@@ -58,12 +59,10 @@ matches      list of (start, end) byte offsets for match rows
 
 `SearchLine` has a structured `repr`, an rg-style `str`, and `SearchLine.asdict()` returns row fields as a plain Python dict. `rg(..., paths=True)` returns unique matched paths, and `rg(..., count=True)` returns the total number of match spans. `paths` and `count` cannot both be set.
 
-`before_context`, `after_context`, and `context` match the shape of `rg -B`, `rg -A`, and `rg -C`. Files containing NUL bytes or invalid UTF-8 are skipped.
+`before_context`, `after_context`, and `context` are like `rg -B`, `rg -A`, and `rg -C`. Files containing NUL bytes or invalid UTF-8 are skipped.
 
 Search is case-sensitive by default, matching `rg`. Use `smart_case=True` for `rg --smart-case` behavior, or `case_sensitive=False` to force case-insensitive matching.
 
-`rg` and `rg_iter` check Python signals while waiting for search results, so notebook interrupts and `KeyboardInterrupt` cancel traversal cooperatively. Cancellation is prompt between files and while results are streaming; a single huge file that produces no callbacks may continue until that file scan returns.
-
 ## Benchmarks
 
 `tools/bench.py` compares the `rg` CLI with in-process `rgapi`. Run it against a release build. One run on this machine, using best time from seven repeats:

{rgapi-0.1.1 → rgapi-0.1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "maturin"
 
 [project]
 name = "rgapi"
-version = "0.1.1"
+dynamic = ["version"]
 description = "Python API for ripgrep-style file walking and searching"
 license = {text = "MIT OR Apache-2.0"}
 requires-python = ">=3.10"
@@ -15,6 +15,9 @@ classifiers = [
     "Programming Language :: Python :: Implementation :: CPython",
 ]
 
+[project.optional-dependencies]
+dev = ["fastship>=0.0.12", "maturin>=1.0,<2.0", "pytest"]
+
 [project.urls]
 Homepage = "https://github.com/AnswerDotAI/rgapi"
 Repository = "https://github.com/AnswerDotAI/rgapi"
@@ -24,3 +27,6 @@ Issues = "https://github.com/AnswerDotAI/rgapi/issues"
 features = ["extension-module"]
 python-source = "python"
 module-name = "rgapi._core"
+
+[tool.fastship]
+branch = "main"

rgapi-0.1.4/python/rgapi/__init__.py

@@ -0,0 +1,211 @@
+from os import fspath
+from pathlib import Path
+
+from . import _core
+
+Regex = _core.Regex
+SearchLine = _core.SearchLine
+RgIter = _core.RgIter
+def compile(
+    pattern:str, # Regex pattern to compile
+    case_sensitive:bool|None=None, # True/False forces case; None allows `smart_case`
+    smart_case:bool=False # Match `rg --smart-case` behavior
+) -> Regex:
+    "Compile a regex matcher for `search_text`, `search_path`, and direct matching."
+    return _core.compile(pattern, case_sensitive=case_sensitive, smart_case=smart_case)
+
+class SearchResults(list):
+    "List of `SearchLine` rows with rg-style text display."
+    def __str__(self): return "\n".join(map(str, self))
+    def _repr_pretty_(self, p, cycle): p.text("..." if cycle else str(self))
+
+
+def _listify(value):
+    if value is None: return []
+    if isinstance(value, str): return [value]
+    return list(value)
+def _fs_path(path): return str(Path(path).expanduser())
+def _display_path(path): return None if path is None else fspath(path)
+def _filters(glob=None, include=None, exclude=None, ext=None):
+    includes = _listify(include) + _listify(glob)
+    for suffix in _listify(ext):
+        suffix = str(suffix)
+        if suffix.startswith("."): suffix = suffix[1:]
+        includes.append(f"*.{suffix}")
+    return includes, _listify(exclude)
+
+
+def _context(context, before_context, after_context):
+    if context: return context, context
+    return before_context, after_context
+
+
+def walk(
+    root:str|Path=".", # Directory to walk (expands `~`)
+    hidden:bool=False, # Include hidden files and directories
+    ignore:bool=True, # Respect `.gitignore` and other ignore files
+    max_depth:int|None=None, # Maximum directory depth to descend
+    min_depth:int|None=None, # Minimum depth for returned paths
+    max_filesize:int|None=None, # Skip files larger than this many bytes
+    follow_links:bool=False, # Follow symbolic links while walking
+    same_file_system:bool=False, # Do not cross filesystem boundaries
+    path_re:str|None=None, # Regex that returned relative paths must match
+    skip_path_re:str|None=None, # Regex for relative paths to skip
+    skip_dir=None, # Directory glob or globs to prune
+    skip_dir_re:str|None=None, # Directory regex used to prune traversal
+    files:bool=True, # Include files in results
+    dirs:bool=False # Include directories in results
+) -> list[str]:
+    "Walk a directory and return relative file and/or directory paths."
+    return _core.walk(_fs_path(root), hidden, ignore, max_depth, min_depth, max_filesize, follow_links,
+        same_file_system, path_re, skip_path_re, _listify(skip_dir), skip_dir_re, files, dirs)
+
+
+def fd(
+    root:str|Path=".", # Directory to walk (expands `~`)
+    pattern:str|None=None, # Substring that relative paths must contain
+    glob=None, # Include glob or globs; alias for `include`
+    include=None, # Include glob or globs, e.g. `*.py`
+    exclude=None, # Exclude glob or globs, e.g. `test_*.py`
+    ext=None, # Extension or extensions to include, without needing `*.`
+    hidden:bool=False, # Include hidden files and directories
+    ignore:bool=True, # Respect `.gitignore` and other ignore files
+    max_depth:int|None=None, # Maximum directory depth to descend
+    min_depth:int|None=None, # Minimum depth for returned paths
+    max_filesize:int|None=None, # Skip files larger than this many bytes
+    follow_links:bool=False, # Follow symbolic links while walking
+    same_file_system:bool=False, # Do not cross filesystem boundaries
+    path_re:str|None=None, # Regex that returned relative paths must match
+    skip_path_re:str|None=None, # Regex for relative paths to skip
+    skip_dir=None, # Directory glob or globs to prune
+    skip_dir_re:str|None=None, # Directory regex used to prune traversal
+    files:bool=True, # Include files in results
+    dirs:bool=False # Include directories in results
+) -> list[str]:
+    "Find paths with fd-style filters and gitignore support."
+    include, exclude = _filters(glob, include, exclude, ext)
+    return _core.find(_fs_path(root), pattern, include, exclude, hidden, ignore, max_depth, min_depth, max_filesize,
+        follow_links, same_file_system, path_re, skip_path_re, _listify(skip_dir), skip_dir_re, files, dirs)
+
+
+def _rg_args(pattern, root, glob, include, exclude, ext, hidden, ignore, max_depth, min_depth, max_filesize,
+    follow_links, same_file_system, path_re, skip_path_re, skip_dir, skip_dir_re, case_sensitive, smart_case,
+    before_context, after_context, context):
+    include, exclude = _filters(glob, include, exclude, ext)
+    before_context, after_context = _context(context, before_context, after_context)
+    return (pattern, _fs_path(root), include, exclude, hidden, ignore, max_depth, min_depth, max_filesize, follow_links, same_file_system,
+        path_re, skip_path_re, _listify(skip_dir), skip_dir_re, case_sensitive, smart_case, before_context, after_context)
+
+
+def rg(
+    pattern:str, # Regex pattern to search for
+    root:str|Path=".", # Directory to search (expands `~`)
+    glob=None, # Include glob or globs; alias for `include`
+    include=None, # Include glob or globs, e.g. `*.py`
+    exclude=None, # Exclude glob or globs, e.g. `test_*.py`
+    ext=None, # Extension or extensions to include, without needing `*.`
+    hidden:bool=False, # Include hidden files and directories
+    ignore:bool=True, # Respect `.gitignore` and other ignore files
+    max_depth:int|None=None, # Maximum directory depth to descend
+    min_depth:int|None=None, # Minimum depth for returned/searched files
+    max_filesize:int|None=None, # Skip files larger than this many bytes
+    follow_links:bool=False, # Follow symbolic links while walking
+    same_file_system:bool=False, # Do not cross filesystem boundaries
+    path_re:str|None=None, # Regex that searched relative paths must match
+    skip_path_re:str|None=None, # Regex for relative paths to skip
+    skip_dir=None, # Directory glob or globs to prune
+    skip_dir_re:str|None=None, # Directory regex used to prune traversal
+    case_sensitive:bool|None=None, # True/False forces case; None allows `smart_case`
+    smart_case:bool=False, # Match `rg --smart-case` behavior
+    before_context:int=0, # Lines of context before each match, like `rg -B`
+    after_context:int=0, # Lines of context after each match, like `rg -A`
+    context:int=0, # Sets both before and after context, like `rg -C`
+    paths:bool=False, # Return unique matched paths instead of rows
+    count:bool=False # Return total match span count instead of rows
+):
+    "Search files and return `SearchResults`, matched paths, or a count."
+    assert not (paths and count), "paths and count are mutually exclusive"
+    args = _rg_args(pattern, root, glob, include, exclude, ext, hidden, ignore, max_depth, min_depth, max_filesize,
+        follow_links, same_file_system, path_re, skip_path_re, skip_dir, skip_dir_re, case_sensitive, smart_case,
+        before_context, after_context, context)
+    if paths:
+        seen, res = set(), []
+        for row in _core.rg_iter(*args):
+            if row.kind != "match" or row.path in seen: continue
+            seen.add(row.path)
+            res.append(row.path)
+        return res
+    if count: return sum(len(row.matches) for row in _core.rg_iter(*args) if row.kind == "match")
+    return SearchResults(_core.rg(*args))
+
+
+def rg_iter(
+    pattern:str, # Regex pattern to search for
+    root:str|Path=".", # Directory to search (expands `~`)
+    glob=None, # Include glob or globs; alias for `include`
+    include=None, # Include glob or globs, e.g. `*.py`
+    exclude=None, # Exclude glob or globs, e.g. `test_*.py`
+    ext=None, # Extension or extensions to include, without needing `*.`
+    hidden:bool=False, # Include hidden files and directories
+    ignore:bool=True, # Respect `.gitignore` and other ignore files
+    max_depth:int|None=None, # Maximum directory depth to descend
+    min_depth:int|None=None, # Minimum depth for returned/searched files
+    max_filesize:int|None=None, # Skip files larger than this many bytes
+    follow_links:bool=False, # Follow symbolic links while walking
+    same_file_system:bool=False, # Do not cross filesystem boundaries
+    path_re:str|None=None, # Regex that searched relative paths must match
+    skip_path_re:str|None=None, # Regex for relative paths to skip
+    skip_dir=None, # Directory glob or globs to prune
+    skip_dir_re:str|None=None, # Directory regex used to prune traversal
+    case_sensitive:bool|None=None, # True/False forces case; None allows `smart_case`
+    smart_case:bool=False, # Match `rg --smart-case` behavior
+    before_context:int=0, # Lines of context before each match, like `rg -B`
+    after_context:int=0, # Lines of context after each match, like `rg -A`
+    context:int=0 # Sets both before and after context, like `rg -C`
+) -> RgIter:
+    "Search files lazily, yielding `SearchLine` rows."
+    args = _rg_args(pattern, root, glob, include, exclude, ext, hidden, ignore, max_depth, min_depth, max_filesize,
+        follow_links, same_file_system, path_re, skip_path_re, skip_dir, skip_dir_re, case_sensitive, smart_case,
+        before_context, after_context, context)
+    return _core.rg_iter(*args)
+
+
+def search_text(
+    matcher:Regex, # Compiled `Regex` from `compile()`
+    text:str, # Text to search
+    path:str|Path="<text>", # Path label stored in results
+    before_context:int=0, # Lines of context before each match
+    after_context:int=0, # Lines of context after each match
+    context:int=0 # Sets both before and after context, like `rg -C`
+) -> SearchResults:
+    "Search an in-memory string with a compiled matcher."
+    before_context, after_context = _context(context, before_context, after_context)
+    return SearchResults(_core.search_text(matcher, text, _display_path(path), before_context, after_context))
+
+
+def search_path(
+    matcher:Regex, # Compiled `Regex` from `compile()`
+    path:str|Path, # File path to search (expands `~`)
+    display_path:str|Path|None=None, # Path stored in results; defaults to `path`
+    before_context:int=0, # Lines of context before each match
+    after_context:int=0, # Lines of context after each match
+    context:int=0 # Sets both before and after context, like `rg -C`
+) -> SearchResults:
+    "Search one file with a compiled matcher."
+    before_context, after_context = _context(context, before_context, after_context)
+    return SearchResults(_core.search_path(matcher, _fs_path(path), _display_path(display_path), before_context, after_context))
+
+
+__all__ = [
+    "Regex",
+    "RgIter",
+    "SearchLine",
+    "SearchResults",
+    "compile",
+    "fd",
+    "rg",
+    "rg_iter",
+    "search_path",
+    "search_text",
+    "walk",
+]

{rgapi-0.1.1 → rgapi-0.1.4}/src/python.rs

@@ -13,7 +13,7 @@ use crate::{
     search_text as search_text_core, FindOptions, RgIter, RgOptions, SearchLine,
 };
 
-#[pyclass(name = "SearchLine", eq)]
+#[pyclass(name = "SearchLine", eq, skip_from_py_object)]
 #[derive(Clone, PartialEq)]
 struct SearchLinePy {
     #[pyo3(get)]
@@ -105,7 +105,7 @@ fn check_signals_or_cancel(py: Python<'_>, iter: &RgIter) -> PyResult<()> {
 fn next_rg_line_py(py: Python<'_>, iter: &mut RgIter) -> PyResult<Option<SearchLinePy>> {
     loop {
         check_signals_or_cancel(py, iter)?;
-        let res = py.allow_threads(|| iter.next_timeout(Duration::from_millis(50)));
+        let res = py.detach(|| iter.next_timeout(Duration::from_millis(50)));
         check_signals_or_cancel(py, iter)?;
         match res {
             Ok(Ok(line)) => return Ok(Some(SearchLinePy::from(line))),
@@ -123,7 +123,7 @@ fn collect_rg_py(py: Python<'_>, mut iter: RgIter) -> PyResult<Vec<SearchLinePy>
     }
     Ok(res)
 }
-#[pyclass(name = "Regex")]
+#[pyclass(name = "Regex", skip_from_py_object)]
 #[derive(Clone)]
 struct RegexPy {
     #[pyo3(get)]

{rgapi-0.1.1 → rgapi-0.1.4}/tests/test_rgapi.py

@@ -35,6 +35,21 @@ def test_fd_is_relative_and_respects_ignore_hidden_and_globs(tmp_path):
     assert set(fd(str(tmp_path), exclude="*.py")) == {"bad.txt", "bin.dat"}
     assert set(walk(str(tmp_path), files=True, dirs=False)) == found
 
+def test_pathlike_arguments_and_expanduser(tmp_path, monkeypatch):
+    make_tree(tmp_path)
+    assert "src/app.py" in fd(tmp_path)
+    assert walk(tmp_path, path_re=r"\.py$") == ["src/app.py"]
+    assert [r.path for r in rg("TODO", tmp_path, include="*.py")] == ["src/app.py"]
+    assert list(rg_iter("TODO", tmp_path, include="*.py")) == rg("TODO", tmp_path, include="*.py")
+    matcher = compile("TODO")
+    text_label = tmp_path / "memory.txt"
+    assert search_text(matcher, "TODO\n", path=text_label)[0].path == str(text_label)
+    display = tmp_path / "display.py"
+    assert search_path(matcher, tmp_path / "src" / "app.py", display_path=display)[0].path == str(display)
+
+    monkeypatch.setenv("HOME", str(tmp_path))
+    assert fd("~", glob="*.py") == ["src/app.py"]
+
 
 def test_path_filters_prune_dirs_and_follow_links(tmp_path):
     (tmp_path / "src").mkdir()

rgapi-0.1.1/.github/workflows/ci.yml

@@ -1,62 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: [main]
-    tags: ['v*']
-  pull_request:
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v6
-      - run: cargo test
-
-  build:
-    needs: test
-    strategy:
-      matrix:
-        os: [ubuntu-latest, macos-latest]
-        python: ['3.10', '3.11', '3.12', '3.13']
-    runs-on: ${{ matrix.os }}
-    steps:
-      - uses: actions/checkout@v6
-      - uses: dtolnay/rust-toolchain@stable
-      - uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python }}
-      - run: tools/build.sh release
-      - uses: PyO3/maturin-action@v1
-        with:
-          command: build
-          args: --release -o dist
-      - uses: actions/upload-artifact@v4
-        with:
-          name: wheel-${{ matrix.os }}-py${{ matrix.python }}
-          path: dist/*.whl
-
-  publish:
-    if: startsWith(github.ref, 'refs/tags/v')
-    needs: build
-    runs-on: ubuntu-latest
-    permissions:
-      id-token: write
-      contents: write
-    steps:
-      - uses: actions/checkout@v6
-      - uses: PyO3/maturin-action@v1
-        with:
-          command: sdist
-          args: -o dist
-      - uses: actions/download-artifact@v4
-        with:
-          path: dist
-          merge-multiple: true
-      - uses: softprops/action-gh-release@v2
-        with:
-          files: dist/*
-          generate_release_notes: true
-      - uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          packages-dir: dist/

rgapi-0.1.1/python/rgapi/__init__.py

@@ -1,208 +0,0 @@
-from . import _core
-
-Regex = _core.Regex
-SearchLine = _core.SearchLine
-RgIter = _core.RgIter
-def compile(
-    pattern, # Regex pattern to compile
-    case_sensitive=None, # True/False forces case; None allows `smart_case`
-    smart_case=False # Match `rg --smart-case` behavior
-):
-    "Compile a regex matcher for `search_text`, `search_path`, and direct matching."
-    return _core.compile(pattern, case_sensitive=case_sensitive, smart_case=smart_case)
-
-class SearchResults(list):
-    "List of `SearchLine` rows with rg-style text display."
-    def __str__(self): return "\n".join(map(str, self))
-    def _repr_pretty_(self, p, cycle): p.text("..." if cycle else str(self))
-
-
-def _listify(value):
-    if value is None: return []
-    if isinstance(value, str): return [value]
-    return list(value)
-
-
-def _filters(glob=None, include=None, exclude=None, ext=None):
-    includes = _listify(include) + _listify(glob)
-    for suffix in _listify(ext):
-        suffix = str(suffix)
-        if suffix.startswith("."): suffix = suffix[1:]
-        includes.append(f"*.{suffix}")
-    return includes, _listify(exclude)
-
-
-def _context(context, before_context, after_context):
-    if context: return context, context
-    return before_context, after_context
-
-
-def walk(
-    root=".", # Directory to walk
-    hidden=False, # Include hidden files and directories
-    ignore=True, # Respect `.gitignore` and other ignore files
-    max_depth=None, # Maximum directory depth to descend
-    min_depth=None, # Minimum depth for returned paths
-    max_filesize=None, # Skip files larger than this many bytes
-    follow_links=False, # Follow symbolic links while walking
-    same_file_system=False, # Do not cross filesystem boundaries
-    path_re=None, # Regex that returned relative paths must match
-    skip_path_re=None, # Regex for relative paths to skip
-    skip_dir=None, # Directory glob or globs to prune
-    skip_dir_re=None, # Directory regex used to prune traversal
-    files=True, # Include files in results
-    dirs=False # Include directories in results
-):
-    "Walk a directory and return relative file and/or directory paths."
-    return _core.walk(root, hidden, ignore, max_depth, min_depth, max_filesize, follow_links,
-        same_file_system, path_re, skip_path_re, _listify(skip_dir), skip_dir_re, files, dirs)
-
-
-def fd(
-    root=".", # Directory to walk
-    pattern=None, # Substring that relative paths must contain
-    glob=None, # Include glob or globs; alias for `include`
-    include=None, # Include glob or globs, e.g. `*.py`
-    exclude=None, # Exclude glob or globs, e.g. `test_*.py`
-    ext=None, # Extension or extensions to include, without needing `*.`
-    hidden=False, # Include hidden files and directories
-    ignore=True, # Respect `.gitignore` and other ignore files
-    max_depth=None, # Maximum directory depth to descend
-    min_depth=None, # Minimum depth for returned paths
-    max_filesize=None, # Skip files larger than this many bytes
-    follow_links=False, # Follow symbolic links while walking
-    same_file_system=False, # Do not cross filesystem boundaries
-    path_re=None, # Regex that returned relative paths must match
-    skip_path_re=None, # Regex for relative paths to skip
-    skip_dir=None, # Directory glob or globs to prune
-    skip_dir_re=None, # Directory regex used to prune traversal
-    files=True, # Include files in results
-    dirs=False # Include directories in results
-):
-    "Find paths with fd-style filters and gitignore support."
-    include, exclude = _filters(glob, include, exclude, ext)
-    return _core.find(root, pattern, include, exclude, hidden, ignore, max_depth, min_depth, max_filesize,
-        follow_links, same_file_system, path_re, skip_path_re, _listify(skip_dir), skip_dir_re, files, dirs)
-
-
-def _rg_args(pattern, root, glob, include, exclude, ext, hidden, ignore, max_depth, min_depth, max_filesize,
-    follow_links, same_file_system, path_re, skip_path_re, skip_dir, skip_dir_re, case_sensitive, smart_case,
-    before_context, after_context, context):
-    include, exclude = _filters(glob, include, exclude, ext)
-    before_context, after_context = _context(context, before_context, after_context)
-    return (pattern, root, include, exclude, hidden, ignore, max_depth, min_depth, max_filesize, follow_links, same_file_system,
-        path_re, skip_path_re, _listify(skip_dir), skip_dir_re, case_sensitive, smart_case, before_context, after_context)
-
-
-def rg(
-    pattern, # Regex pattern to search for
-    root=".", # Directory to search
-    glob=None, # Include glob or globs; alias for `include`
-    include=None, # Include glob or globs, e.g. `*.py`
-    exclude=None, # Exclude glob or globs, e.g. `test_*.py`
-    ext=None, # Extension or extensions to include, without needing `*.`
-    hidden=False, # Include hidden files and directories
-    ignore=True, # Respect `.gitignore` and other ignore files
-    max_depth=None, # Maximum directory depth to descend
-    min_depth=None, # Minimum depth for returned/searched files
-    max_filesize=None, # Skip files larger than this many bytes
-    follow_links=False, # Follow symbolic links while walking
-    same_file_system=False, # Do not cross filesystem boundaries
-    path_re=None, # Regex that searched relative paths must match
-    skip_path_re=None, # Regex for relative paths to skip
-    skip_dir=None, # Directory glob or globs to prune
-    skip_dir_re=None, # Directory regex used to prune traversal
-    case_sensitive=None, # True/False forces case; None allows `smart_case`
-    smart_case=False, # Match `rg --smart-case` behavior
-    before_context=0, # Lines of context before each match, like `rg -B`
-    after_context=0, # Lines of context after each match, like `rg -A`
-    context=0, # Sets both before and after context, like `rg -C`
-    paths=False, # Return unique matched paths instead of rows
-    count=False # Return total match span count instead of rows
-):
-    "Search files and return `SearchResults`, matched paths, or a count."
-    assert not (paths and count), "paths and count are mutually exclusive"
-    args = _rg_args(pattern, root, glob, include, exclude, ext, hidden, ignore, max_depth, min_depth, max_filesize,
-        follow_links, same_file_system, path_re, skip_path_re, skip_dir, skip_dir_re, case_sensitive, smart_case,
-        before_context, after_context, context)
-    if paths:
-        seen, res = set(), []
-        for row in _core.rg_iter(*args):
-            if row.kind != "match" or row.path in seen: continue
-            seen.add(row.path)
-            res.append(row.path)
-        return res
-    if count: return sum(len(row.matches) for row in _core.rg_iter(*args) if row.kind == "match")
-    return SearchResults(_core.rg(*args))
-
-
-def rg_iter(
-    pattern, # Regex pattern to search for
-    root=".", # Directory to search
-    glob=None, # Include glob or globs; alias for `include`
-    include=None, # Include glob or globs, e.g. `*.py`
-    exclude=None, # Exclude glob or globs, e.g. `test_*.py`
-    ext=None, # Extension or extensions to include, without needing `*.`
-    hidden=False, # Include hidden files and directories
-    ignore=True, # Respect `.gitignore` and other ignore files
-    max_depth=None, # Maximum directory depth to descend
-    min_depth=None, # Minimum depth for returned/searched files
-    max_filesize=None, # Skip files larger than this many bytes
-    follow_links=False, # Follow symbolic links while walking
-    same_file_system=False, # Do not cross filesystem boundaries
-    path_re=None, # Regex that searched relative paths must match
-    skip_path_re=None, # Regex for relative paths to skip
-    skip_dir=None, # Directory glob or globs to prune
-    skip_dir_re=None, # Directory regex used to prune traversal
-    case_sensitive=None, # True/False forces case; None allows `smart_case`
-    smart_case=False, # Match `rg --smart-case` behavior
-    before_context=0, # Lines of context before each match, like `rg -B`
-    after_context=0, # Lines of context after each match, like `rg -A`
-    context=0 # Sets both before and after context, like `rg -C`
-):
-    "Search files lazily, yielding `SearchLine` rows."
-    args = _rg_args(pattern, root, glob, include, exclude, ext, hidden, ignore, max_depth, min_depth, max_filesize,
-        follow_links, same_file_system, path_re, skip_path_re, skip_dir, skip_dir_re, case_sensitive, smart_case,
-        before_context, after_context, context)
-    return _core.rg_iter(*args)
-
-
-def search_text(
-    matcher, # Compiled `Regex` from `compile()`
-    text, # Text to search
-    path="<text>", # Path label stored in results
-    before_context=0, # Lines of context before each match
-    after_context=0, # Lines of context after each match
-    context=0 # Sets both before and after context, like `rg -C`
-):
-    "Search an in-memory string with a compiled matcher."
-    before_context, after_context = _context(context, before_context, after_context)
-    return SearchResults(_core.search_text(matcher, text, path, before_context, after_context))
-
-
-def search_path(
-    matcher, # Compiled `Regex` from `compile()`
-    path, # File path to search
-    display_path=None, # Path stored in results; defaults to `path`
-    before_context=0, # Lines of context before each match
-    after_context=0, # Lines of context after each match
-    context=0 # Sets both before and after context, like `rg -C`
-):
-    "Search one file with a compiled matcher."
-    before_context, after_context = _context(context, before_context, after_context)
-    return SearchResults(_core.search_path(matcher, path, display_path, before_context, after_context))
-
-
-__all__ = [
-    "Regex",
-    "RgIter",
-    "SearchLine",
-    "SearchResults",
-    "compile",
-    "fd",
-    "rg",
-    "rg_iter",
-    "search_path",
-    "search_text",
-    "walk",
-]

rgapi-0.1.1/tools/build.sh

@@ -1,5 +0,0 @@
-#!/bin/bash
-set -e
-profile=${1:-debug}
-if [ "$profile" = "release" ]; then flags="--release"; else flags=""; fi
-cargo build $flags

rgapi-0.1.1/tools/bump.sh

@@ -1,6 +0,0 @@
-#!/bin/bash
-set -e
-cur=$(grep '^version = ' pyproject.toml | head -1 | sed 's/version = "\(.*\)"/\1/')
-new=$(echo "$cur" | awk -F. '{print $1"."$2"."$3+1}')
-sed -i '' "s/^version = \"$cur\"/version = \"$new\"/" pyproject.toml Cargo.toml
-echo "$cur -> $new"

rgapi-0.1.1/tools/bump2.sh

@@ -1,6 +0,0 @@
-#!/bin/bash
-set -e
-cur=$(grep '^version = ' pyproject.toml | head -1 | sed 's/version = "\(.*\)"/\1/')
-new=$(echo "$cur" | awk -F. '{print $1"."$2+1"."0}')
-sed -i '' "s/^version = \"$cur\"/version = \"$new\"/" pyproject.toml Cargo.toml
-echo "$cur -> $new"

rgapi-0.1.1/tools/release.sh

@@ -1,6 +0,0 @@
-#!/bin/bash
-set -e
-v=$(grep '^version = ' pyproject.toml | head -1 | sed 's/version = "\(.*\)"/\1/')
-git tag "v$v"
-git push origin main --tags
-echo "Released v$v"

rgapi-0.1.1/tools/test.sh

@@ -1,4 +0,0 @@
-#!/bin/bash
-set -e
-cargo test
-pytest -q