Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.11/site-packages/pathspec/__init__.py: 100%
Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1"""
2The *pathspec* package provides pattern matching for file paths. So far
3this only includes Git's wildmatch pattern matching (the style used for
4".gitignore" files).
6The following classes are imported and made available from the root of
7the `pathspec` package:
9- :class:`pathspec.gitignore.GitIgnoreSpec`
11- :class:`pathspec.pathspec.PathSpec`
13- :class:`pathspec.pattern.Pattern`
15- :class:`pathspec.pattern.RegexPattern`
17- :class:`pathspec.util.RecursionError`
19The following functions are also imported:
21- :func:`pathspec.util.lookup_pattern`
23The following deprecated functions are also imported to maintain
24backward compatibility:
26- :func:`pathspec.util.iter_tree` which is an alias for
27 :func:`pathspec.util.iter_tree_files`.
29- :func:`pathspec.util.match_files`
30"""
32from .gitignore import (
33 GitIgnoreSpec)
34from .pathspec import (
35 PathSpec)
36from .pattern import (
37 Pattern,
38 RegexPattern)
39from .util import (
40 RecursionError,
41 iter_tree,
42 lookup_pattern,
43 match_files)
45from ._meta import (
46 __author__,
47 __copyright__,
48 __credits__,
49 __license__,
50 __version__,
51)
53# Load pattern implementations.
54from . import patterns
56# DEPRECATED: Expose the `GitIgnorePattern` class in the root module for
57# backward compatibility with v0.4.
58from .patterns.gitwildmatch import GitIgnorePattern
60# Declare private imports as part of the public interface. Deprecated
61# imports are deliberately excluded.
62__all__ = [
63 'GitIgnoreSpec',
64 'PathSpec',
65 'Pattern',
66 'RecursionError',
67 'RegexPattern',
68 '__author__',
69 '__copyright__',
70 '__credits__',
71 '__license__',
72 '__version__',
73 'iter_tree',
74 'lookup_pattern',
75 'match_files',
76]