rgapi 0.1.1__tar.gz → 0.1.2__tar.gz

{rgapi-0.1.1 → rgapi-0.1.2}/.github/workflows/ci.yml

@@ -26,7 +26,8 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python }}
-      - run: tools/build.sh release
+      - run: pip install fastship
+      - run: ship-rs-prep --release
       - uses: PyO3/maturin-action@v1
         with:
           command: build

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

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

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

@@ -306,7 +306,7 @@ checksum = "d6f6ff9a378485b298a5286656da665ba74413d36db0979633275d2e708145d4"
 
 [[package]]
 name = "rgapi"
-version = "0.1.1"
+version = "0.1.2"
 dependencies = [
  "globset",
  "grep-matcher",

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

@@ -1,6 +1,6 @@
 [package]
 name = "rgapi"
-version = "0.1.1"
+version = "0.1.2"
 edition = "2021"
 license = "MIT OR Apache-2.0"
 description = "Python API for ripgrep-style file walking and searching"

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rgapi
-Version: 0.1.1
+Version: 0.1.2
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Summary: Python API for ripgrep-style file walking and searching
@@ -54,6 +54,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 +74,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.2}/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.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "maturin"
 
 [project]
 name = "rgapi"
-version = "0.1.1"
+version = "0.1.2"
 description = "Python API for ripgrep-style file walking and searching"
 license = {text = "MIT OR Apache-2.0"}
 requires-python = ">=3.10"
@@ -24,3 +24,9 @@ Issues = "https://github.com/AnswerDotAI/rgapi/issues"
 features = ["extension-module"]
 python-source = "python"
 module-name = "rgapi._core"
+
+[tool.fastship]
+branch = "main"
+
+[tool.fastship.rs]
+bins = []

rgapi-0.1.2/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.2}/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/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