djavu-asus/elpy/rpc-venv/lib/python3.11/site-packages/pathspec/__init__.py

   1 """
   2 The *pathspec* package provides pattern matching for file paths. So far
   3 this only includes Git's wildmatch pattern matching (the style used for
   4 ".gitignore" files).
   5
   6 The following classes are imported and made available from the root of
   7 the `pathspec` package:
   8
   9 -       :class:`pathspec.gitignore.GitIgnoreSpec`
  10
  11 -       :class:`pathspec.pathspec.PathSpec`
  12
  13 -       :class:`pathspec.pattern.Pattern`
  14
  15 -       :class:`pathspec.pattern.RegexPattern`
  16
  17 -       :class:`pathspec.util.RecursionError`
  18
  19 The following functions are also imported:
  20
  21 -       :func:`pathspec.util.lookup_pattern`
  22
  23 The following deprecated functions are also imported to maintain
  24 backward compatibility:
  25
  26 -       :func:`pathspec.util.iter_tree` which is an alias for
  27         :func:`pathspec.util.iter_tree_files`.
  28
  29 -       :func:`pathspec.util.match_files`
  30 """
  31
  32 from .gitignore import (
  33         GitIgnoreSpec)
  34 from .pathspec import (
  35         PathSpec)
  36 from .pattern import (
  37         Pattern,
  38         RegexPattern)
  39 from .util import (
  40         RecursionError,
  41         iter_tree,
  42         lookup_pattern,
  43         match_files)
  44
  45 from ._meta import (
  46         __author__,
  47         __copyright__,
  48         __credits__,
  49         __license__,
  50         __version__,
  51 )
  52
  53 # Load pattern implementations.
  54 from . import patterns
  55
  56 # DEPRECATED: Expose the `GitIgnorePattern` class in the root module for
  57 # backward compatibility with v0.4.
  58 from .patterns.gitwildmatch import GitIgnorePattern
  59
  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 ]