.config/coc/extensions/coc-python-data/languageServer.0.5.59/Typeshed/stdlib/3/re.pyi

   1 # Stubs for re\r
   2 # Ron Murawski <ron@horizonchess.com>\r
   3 # 'bytes' support added by Jukka Lehtosalo\r
   4 \r
   5 # based on: http://docs.python.org/3.2/library/re.html\r
   6 # and http://hg.python.org/cpython/file/618ea5612e83/Lib/re.py\r
   7 \r
   8 import sys\r
   9 from typing import (\r
  10     List, Iterator, overload, Callable, Tuple, Sequence, Dict,\r
  11     Generic, AnyStr, Match, Pattern, Any, Optional, Union\r
  12 )\r
  13 \r
  14 # ----- re variables and constants -----\r
  15 if sys.version_info >= (3, 6):\r
  16     import enum\r
  17     class RegexFlag(enum.IntFlag):\r
  18         A = 0\r
  19         ASCII = 0\r
  20         DEBUG = 0\r
  21         I = 0\r
  22         IGNORECASE = 0\r
  23         L = 0\r
  24         LOCALE = 0\r
  25         M = 0\r
  26         MULTILINE = 0\r
  27         S = 0\r
  28         DOTALL = 0\r
  29         X = 0\r
  30         VERBOSE = 0\r
  31         U = 0\r
  32         UNICODE = 0\r
  33         T = 0\r
  34         TEMPLATE = 0\r
  35 \r
  36     A = RegexFlag.A\r
  37     ASCII = RegexFlag.ASCII\r
  38     DEBUG = RegexFlag.DEBUG\r
  39     I = RegexFlag.I\r
  40     IGNORECASE = RegexFlag.IGNORECASE\r
  41     L = RegexFlag.L\r
  42     LOCALE = RegexFlag.LOCALE\r
  43     M = RegexFlag.M\r
  44     MULTILINE = RegexFlag.MULTILINE\r
  45     S = RegexFlag.S\r
  46     DOTALL = RegexFlag.DOTALL\r
  47     X = RegexFlag.X\r
  48     VERBOSE = RegexFlag.VERBOSE\r
  49     U = RegexFlag.U\r
  50     UNICODE = RegexFlag.UNICODE\r
  51     T = RegexFlag.T\r
  52     TEMPLATE = RegexFlag.TEMPLATE\r
  53     _FlagsType = Union[int, RegexFlag]\r
  54 else:\r
  55     A = 0\r
  56     ASCII = 0\r
  57     DEBUG = 0\r
  58     I = 0\r
  59     IGNORECASE = 0\r
  60     L = 0\r
  61     LOCALE = 0\r
  62     M = 0\r
  63     MULTILINE = 0\r
  64     S = 0\r
  65     DOTALL = 0\r
  66     X = 0\r
  67     VERBOSE = 0\r
  68     U = 0\r
  69     UNICODE = 0\r
  70     T = 0\r
  71     TEMPLATE = 0\r
  72     _FlagsType = int\r
  73 \r
  74 class error(Exception): ...\r
  75 \r
  76 @overload\r
  77 def compile(pattern: AnyStr, flags: _FlagsType = ...) -> Pattern[AnyStr]: ...\r
  78 @overload\r
  79 def compile(pattern: Pattern[AnyStr], flags: _FlagsType = ...) -> Pattern[AnyStr]: ...\r
  80 \r
  81 @overload\r
  82 def search(pattern: AnyStr, string: AnyStr, flags: _FlagsType = ...) -> Optional[Match[AnyStr]]: ...\r
  83 @overload\r
  84 def search(pattern: Pattern[AnyStr], string: AnyStr, flags: _FlagsType = ...) -> Optional[Match[AnyStr]]: ...\r
  85 \r
  86 @overload\r
  87 def match(pattern: AnyStr, string: AnyStr, flags: _FlagsType = ...) -> Optional[Match[AnyStr]]: ...\r
  88 @overload\r
  89 def match(pattern: Pattern[AnyStr], string: AnyStr, flags: _FlagsType = ...) -> Optional[Match[AnyStr]]: ...\r
  90 \r
  91 # New in Python 3.4\r
  92 @overload\r
  93 def fullmatch(pattern: AnyStr, string: AnyStr, flags: _FlagsType = ...) -> Optional[Match[AnyStr]]: ...\r
  94 @overload\r
  95 def fullmatch(pattern: Pattern[AnyStr], string: AnyStr, flags: _FlagsType = ...) -> Optional[Match[AnyStr]]: ...\r
  96 \r
  97 @overload\r
  98 def split(pattern: AnyStr, string: AnyStr,\r
  99           maxsplit: int = ..., flags: _FlagsType = ...) -> List[AnyStr]: ...\r
 100 @overload\r
 101 def split(pattern: Pattern[AnyStr], string: AnyStr,\r
 102           maxsplit: int = ..., flags: _FlagsType = ...) -> List[AnyStr]: ...\r
 103 \r
 104 @overload\r
 105 def findall(pattern: AnyStr, string: AnyStr, flags: _FlagsType = ...) -> List[Any]: ...\r
 106 @overload\r
 107 def findall(pattern: Pattern[AnyStr], string: AnyStr, flags: _FlagsType = ...) -> List[Any]: ...\r
 108 \r
 109 # Return an iterator yielding match objects over all non-overlapping matches\r
 110 # for the RE pattern in string. The string is scanned left-to-right, and\r
 111 # matches are returned in the order found. Empty matches are included in the\r
 112 # result unless they touch the beginning of another match.\r
 113 @overload\r
 114 def finditer(pattern: AnyStr, string: AnyStr,\r
 115              flags: _FlagsType = ...) -> Iterator[Match[AnyStr]]: ...\r
 116 @overload\r
 117 def finditer(pattern: Pattern[AnyStr], string: AnyStr,\r
 118              flags: _FlagsType = ...) -> Iterator[Match[AnyStr]]: ...\r
 119 \r
 120 @overload\r
 121 def sub(pattern: AnyStr, repl: AnyStr, string: AnyStr, count: int = ...,\r
 122         flags: _FlagsType = ...) -> AnyStr: ...\r
 123 @overload\r
 124 def sub(pattern: AnyStr, repl: Callable[[Match[AnyStr]], AnyStr],\r
 125         string: AnyStr, count: int = ..., flags: _FlagsType = ...) -> AnyStr: ...\r
 126 @overload\r
 127 def sub(pattern: Pattern[AnyStr], repl: AnyStr, string: AnyStr, count: int = ...,\r
 128         flags: _FlagsType = ...) -> AnyStr: ...\r
 129 @overload\r
 130 def sub(pattern: Pattern[AnyStr], repl: Callable[[Match[AnyStr]], AnyStr],\r
 131         string: AnyStr, count: int = ..., flags: _FlagsType = ...) -> AnyStr: ...\r
 132 \r
 133 @overload\r
 134 def subn(pattern: AnyStr, repl: AnyStr, string: AnyStr, count: int = ...,\r
 135          flags: _FlagsType = ...) -> Tuple[AnyStr, int]: ...\r
 136 @overload\r
 137 def subn(pattern: AnyStr, repl: Callable[[Match[AnyStr]], AnyStr],\r
 138          string: AnyStr, count: int = ...,\r
 139          flags: _FlagsType = ...) -> Tuple[AnyStr, int]: ...\r
 140 @overload\r
 141 def subn(pattern: Pattern[AnyStr], repl: AnyStr, string: AnyStr, count: int = ...,\r
 142          flags: _FlagsType = ...) -> Tuple[AnyStr, int]: ...\r
 143 @overload\r
 144 def subn(pattern: Pattern[AnyStr], repl: Callable[[Match[AnyStr]], AnyStr],\r
 145          string: AnyStr, count: int = ...,\r
 146          flags: _FlagsType = ...) -> Tuple[AnyStr, int]: ...\r
 147 \r
 148 def escape(string: AnyStr) -> AnyStr: ...\r
 149 \r
 150 def purge() -> None: ...\r
 151 def template(pattern: Union[AnyStr, Pattern[AnyStr]], flags: _FlagsType = ...) -> Pattern[AnyStr]: ...\r