Changelog¶
For the authoritative changelog, see CHANGELOG.md in the repository.
0.1.0 (2026-01-12)¶
Initial release.
Added¶
Core features¶
SearchPathclass for ordered directory searching with scope names- Module-level convenience functions:
first(),match(),all(),matches() Matchdataclass with provenance information (path,scope,source,relative)Entrytype alias for flexible directory specification
Pattern matching¶
PathMatcherprotocol for pluggable pattern matchingGlobMatcherwith glob-style patterns (default)RegexMatcherwith Python regular expressionsGitignoreMatcherwith full gitignore compatibility (requires pathspec)
Filtering¶
- Include/exclude patterns for filtering results
include_from/exclude_fromfor loading patterns from filesinclude_from_ancestors/exclude_from_ancestorsfor hierarchical pattern cascades
Options¶
kindparameter for matching files, directories, or bothdedupeparameter for deduplication by relative pathfollow_symlinksparameter for symlink handling
Exception hierarchy¶
SearchPathErrorbase exceptionPatternErrorfor pattern-related errorsPatternSyntaxErrorfor invalid pattern syntaxPatternFileErrorfor pattern file read errorsConfigurationErrorfor invalid configuration
Python version support¶
- Python 3.10, 3.11, 3.12, 3.13, 3.14, and 3.14t (free-threaded)