77 lines
1.6 KiB
Python
77 lines
1.6 KiB
Python
|
"""
|
||
|
|
The *pathspec* package provides pattern matching for file paths. So far
|
||
|
|
this only includes Git's wildmatch pattern matching (the style used for
|
||
|
|
".gitignore" files).
|
||
|
|
|
||
|
|
The following classes are imported and made available from the root of
|
||
|
|
the `pathspec` package:
|
||
|
|
|
||
|
|
- :class:`pathspec.gitignore.GitIgnoreSpec`
|
||
|
|
|
||
|
|
- :class:`pathspec.pathspec.PathSpec`
|
||
|
|
|
||
|
|
- :class:`pathspec.pattern.Pattern`
|
||
|
|
|
||
|
|
- :class:`pathspec.pattern.RegexPattern`
|
||
|
|
|
||
|
|
- :class:`pathspec.util.RecursionError`
|
||
|
|
|
||
|
|
The following functions are also imported:
|
||
|
|
|
||
|
|
- :func:`pathspec.util.lookup_pattern`
|
||
|
|
|
||
|
|
The following deprecated functions are also imported to maintain
|
||
|
|
backward compatibility:
|
||
|
|
|
||
|
|
- :func:`pathspec.util.iter_tree` which is an alias for
|
||
|
|
:func:`pathspec.util.iter_tree_files`.
|
||
|
|
|
||
|
|
- :func:`pathspec.util.match_files`
|
||
|
|
"""
|
||
|
|
|
||
|
|
from .gitignore import (
|
||
|
|
GitIgnoreSpec)
|
||
|
|
from .pathspec import (
|
||
|
|
PathSpec)
|
||
|
|
from .pattern import (
|
||
|
|
Pattern,
|
||
|
|
RegexPattern)
|
||
|
|
from .util import (
|
||
|
|
RecursionError,
|
||
|
|
iter_tree,
|
||
|
|
lookup_pattern,
|
||
|
|
match_files)
|
||
|
|
|
||
|
|
from ._meta import (
|
||
|
|
__author__,
|
||
|
|
__copyright__,
|
||
|
|
__credits__,
|
||
|
|
__license__,
|
||
|
|
__version__,
|
||
|
|
)
|
||
|
|
|
||
|
|
# Load pattern implementations.
|
||
|
|
from . import patterns
|
||
|
|
|
||
|
|
# DEPRECATED: Expose the `GitIgnorePattern` class in the root module for
|
||
|
|
# backward compatibility with v0.4.
|
||
|
|
from .patterns.gitwildmatch import GitIgnorePattern
|
||
|
|
|
||
|
|
# Declare private imports as part of the public interface. Deprecated
|
||
|
|
# imports are deliberately excluded.
|
||
|
|
__all__ = [
|
||
|
|
'GitIgnoreSpec',
|
||
|
|
'PathSpec',
|
||
|
|
'Pattern',
|
||
|
|
'RecursionError',
|
||
|
|
'RegexPattern',
|
||
|
|
'__author__',
|
||
|
|
'__copyright__',
|
||
|
|
'__credits__',
|
||
|
|
'__license__',
|
||
|
|
'__version__',
|
||
|
|
'iter_tree',
|
||
|
|
'lookup_pattern',
|
||
|
|
'match_files',
|
||
|
|
]
|