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"""
2This module provides private data for the base implementation for the
3:module:`hyperscan` library.
5WARNING: The *pathspec._backends.hyperscan* package is not part of the public
6API. Its contents and structure are likely to change.
7"""
8from __future__ import annotations
10from dataclasses import (
11 dataclass)
12from typing import (
13 Union) # Replaced by `X | Y` in 3.10.
15try:
16 import hyperscan
17except ModuleNotFoundError:
18 hyperscan = None
19 HS_FLAGS = 0
20else:
21 HS_FLAGS = hyperscan.HS_FLAG_SINGLEMATCH | hyperscan.HS_FLAG_UTF8
23HS_FLAGS: int
24"""
25The hyperscan flags to use:
27- HS_FLAG_SINGLEMATCH is needed to ensure the partial patterns only match once.
29- HS_FLAG_UTF8 is required to support unicode paths.
30"""
33@dataclass(frozen=True)
34class HyperscanExprDat(object):
35 """
36 The :class:`HyperscanExprDat` class is used to store data related to an
37 expression.
38 """
40 # The slots argument is not supported until Python 3.10.
41 __slots__ = [
42 'include',
43 'index',
44 'is_dir_pattern',
45 ]
47 include: bool
48 """
49 *include* (:class:`bool`) is whether is whether the matched files should be
50 included (:data:`True`), or excluded (:data:`False`).
51 """
53 index: int
54 """
55 *index* (:class:`int`) is the pattern index.
56 """
58 is_dir_pattern: bool
59 """
60 *is_dir_pattern* (:class:`bool`) is whether the pattern is a directory
61 pattern for gitignore.
62 """
65@dataclass(frozen=True)
66class HyperscanExprDebug(HyperscanExprDat):
67 """
68 The :class:`HyperscanExprDebug` class stores additional debug information
69 related to an expression.
70 """
72 # The slots argument is not supported until Python 3.10.
73 __slots__ = ['regex']
75 regex: Union[str, bytes]
76 """
77 *regex* (:class:`str` or :class:`bytes`) is the regular expression.
78 """