dycw-utilities 0.131.8__py3-none-any.whl → 0.131.9__py3-none-any.whl

{dycw_utilities-0.131.8.dist-info → dycw_utilities-0.131.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.131.8
+Version: 0.131.9
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12

{dycw_utilities-0.131.8.dist-info → dycw_utilities-0.131.9.dist-info}/RECORD

@@ -1,4 +1,4 @@
-utilities/__init__.py,sha256=7GFnOq-ksc-RNtwI9lMII4eofdNt78J6EbkJmHRGm6E,60
+utilities/__init__.py,sha256=OQKoBd8NcREzug1yqBz40CfEPg5mv9S_IlwEwGMga6c,60
 utilities/aiolimiter.py,sha256=mD0wEiqMgwpty4XTbawFpnkkmJS6R4JRsVXFUaoitSU,628
 utilities/altair.py,sha256=HeZBVUocjkrTNwwKrClppsIqgNFF-ykv05HfZSoHYno,9104
 utilities/asyncio.py,sha256=yfKvAIDCRrWdyQMVZMo4DJQx4nVrXoAcqwhNuF95Ryo,38186
@@ -61,7 +61,7 @@ utilities/pytest.py,sha256=zP4CWKXpRVk4aRDRxolUAvqQwX7wgDO8lzmkQfuZaZo,7832
 utilities/pytest_regressions.py,sha256=YI55B7EtLjhz7zPJZ6NK9bWrxrKCKabWZJe1cwcbA5o,5082
 utilities/python_dotenv.py,sha256=edXsvHZhZnYeqfMfrsRRpj7_9eJI6uizh3xLx8Q9B3w,3228
 utilities/random.py,sha256=lYdjgxB7GCfU_fwFVl5U-BIM_HV3q6_urL9byjrwDM8,4157
-utilities/re.py,sha256=5J4d8VwIPFVrX2Eb8zfoxImDv7IwiN_U7mJ07wR2Wvs,3958
+utilities/re.py,sha256=J7pJOn-Zn5nJ6rvWwMeJWP86EtMk_klhBexnoSaQiZA,4610
 utilities/redis.py,sha256=IceT5EjgrebVkGL8X3M35xlqjI2c7zFbyV1P4dExN4M,36037
 utilities/reprlib.py,sha256=ssYTcBW-TeRh3fhCJv57sopTZHF5FrPyyUg9yp5XBlo,3953
 utilities/scipy.py,sha256=wZJM7fEgBAkLSYYvSmsg5ac-QuwAI0BGqHVetw1_Hb0,947
@@ -80,7 +80,7 @@ utilities/text.py,sha256=ymBFlP_cA8OgNnZRVNs7FAh7OG8HxE6YkiLEMZv5g_A,11297
 utilities/threading.py,sha256=GvBOp4CyhHfN90wGXZuA2VKe9fGzMaEa7oCl4f3nnPU,1009
 utilities/timer.py,sha256=VeSl3ot8-f4D1d3HjjSsgKvjxHJGXd_sW4KcTExOR64,2475
 utilities/traceback.py,sha256=l9onlqDdW5GCSIFbU_-htBE7KlsvsJdNtGrK6-k0RCQ,8759
-utilities/types.py,sha256=gP04CcCOyFrG7BgblVCsrrChiuO2x842NDVW-GF7odo,18370
+utilities/types.py,sha256=Ubd3VBiqZ71eS71WSemHEM4oRF-5fnwd3PnMAm8IZaI,18461
 utilities/typing.py,sha256=kQWywPcRbFBKmvQBELmgbiqSHsnlo_D0ru53vl6KDeY,13846
 utilities/tzdata.py,sha256=yCf70NICwAeazN3_JcXhWvRqCy06XJNQ42j7r6gw3HY,1217
 utilities/tzlocal.py,sha256=P5BjqTiYskeCwjE7i9zycCFXO4MWdZgYCh4jut-LpzA,1042
@@ -91,7 +91,7 @@ utilities/whenever.py,sha256=jS31ZAY5OMxFxLja_Yo5Fidi87Pd-GoVZ7Vi_teqVDA,16743
 utilities/whenever2.py,sha256=JHixGl6KibK8GUF13GeBjvWMYsFHRDSXixSo0xMSJFM,5437
 utilities/zipfile.py,sha256=24lQc9ATcJxHXBPc_tBDiJk48pWyRrlxO2fIsFxU0A8,699
 utilities/zoneinfo.py,sha256=tvcgu3QzDxe2suTexi2QzRGpin7VK1TjHa0JYYxT69I,1862
-dycw_utilities-0.131.8.dist-info/METADATA,sha256=R5VRnHIlEDPgRLMdPF6PWrQ7VwJmzeWBUNpSVIrPTqA,1584
-dycw_utilities-0.131.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dycw_utilities-0.131.8.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
-dycw_utilities-0.131.8.dist-info/RECORD,,
+dycw_utilities-0.131.9.dist-info/METADATA,sha256=Ot-6Wm0MCFNJh_vmaEvMVM89IHtiCDBrKiq267xA9bQ,1584
+dycw_utilities-0.131.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dycw_utilities-0.131.9.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
+dycw_utilities-0.131.9.dist-info/RECORD,,

utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.131.8"
+__version__ = "0.131.9"

utilities/re.py

@@ -2,37 +2,59 @@ from __future__ import annotations
 
 import re
 from dataclasses import dataclass
-from typing import override
+from re import Pattern
+from typing import TYPE_CHECKING, assert_never, override
 
 from utilities.iterables import OneEmptyError, OneNonUniqueError, one
 
+if TYPE_CHECKING:
+    from utilities.types import PatternLike
 
-def extract_group(pattern: str, text: str, /, *, flags: int = 0) -> str:
+
+def ensure_pattern(pattern: PatternLike, /, *, flags: int = 0) -> Pattern[str]:
+    """Ensure a pattern is returned."""
+    match pattern:
+        case Pattern():
+            return pattern
+        case str():
+            return re.compile(pattern, flags=flags)
+        case _ as never:
+            assert_never(never)
+
+
+##
+
+
+def extract_group(pattern: PatternLike, text: str, /, *, flags: int = 0) -> str:
     """Extract a group.
 
     The regex must have 1 capture group, and this must match exactly once.
     """
-    compiled = re.compile(pattern, flags=flags)
-    match compiled.groups:
+    pattern_use = ensure_pattern(pattern, flags=flags)
+    match pattern_use.groups:
         case 0:
-            raise _ExtractGroupNoCaptureGroupsError(pattern=pattern, text=text)
+            raise _ExtractGroupNoCaptureGroupsError(pattern=pattern_use, text=text)
         case 1:
-            matches: list[str] = compiled.findall(text)
+            matches: list[str] = pattern_use.findall(text)
             try:
                 return one(matches)
             except OneEmptyError:
-                raise _ExtractGroupNoMatchesError(pattern=pattern, text=text) from None
+                raise _ExtractGroupNoMatchesError(
+                    pattern=pattern_use, text=text
+                ) from None
             except OneNonUniqueError:
                 raise _ExtractGroupMultipleMatchesError(
-                    pattern=pattern, text=text, matches=matches
+                    pattern=pattern_use, text=text, matches=matches
                 ) from None
         case _:
-            raise _ExtractGroupMultipleCaptureGroupsError(pattern=pattern, text=text)
+            raise _ExtractGroupMultipleCaptureGroupsError(
+                pattern=pattern_use, text=text
+            )
 
 
 @dataclass(kw_only=True, slots=True)
 class ExtractGroupError(Exception):
-    pattern: str
+    pattern: Pattern[str]
     text: str
 
 
@@ -68,32 +90,35 @@ class _ExtractGroupNoMatchesError(ExtractGroupError):
         return f"Pattern {self.pattern} must match against {self.text}"
 
 
-def extract_groups(pattern: str, text: str, /, *, flags: int = 0) -> list[str]:
+##
+
+
+def extract_groups(pattern: PatternLike, text: str, /, *, flags: int = 0) -> list[str]:
     """Extract multiple groups.
 
     The regex may have any number of capture groups, and they must collectively
     match exactly once.
     """
-    compiled = re.compile(pattern, flags=flags)
-    if (n_groups := compiled.groups) == 0:
-        raise _ExtractGroupsNoCaptureGroupsError(pattern=pattern, text=text)
-    matches: list[str] = compiled.findall(text)
+    pattern_use = ensure_pattern(pattern, flags=flags)
+    if (n_groups := pattern_use.groups) == 0:
+        raise _ExtractGroupsNoCaptureGroupsError(pattern=pattern_use, text=text)
+    matches: list[str] = pattern_use.findall(text)
     match len(matches), n_groups:
         case 0, _:
-            raise _ExtractGroupsNoMatchesError(pattern=pattern, text=text)
+            raise _ExtractGroupsNoMatchesError(pattern=pattern_use, text=text)
         case 1, 1:
             return matches
         case 1, _:
             return list(one(matches))
         case _:
             raise _ExtractGroupsMultipleMatchesError(
-                pattern=pattern, text=text, matches=matches
+                pattern=pattern_use, text=text, matches=matches
             )
 
 
 @dataclass(kw_only=True, slots=True)
 class ExtractGroupsError(Exception):
-    pattern: str
+    pattern: Pattern[str]
     text: str
 
 
@@ -108,7 +133,7 @@ class _ExtractGroupsMultipleMatchesError(ExtractGroupsError):
 
 @dataclass(kw_only=True, slots=True)
 class _ExtractGroupsNoCaptureGroupsError(ExtractGroupsError):
-    pattern: str
+    pattern: Pattern[str]
     text: str
 
     @override
@@ -123,4 +148,10 @@ class _ExtractGroupsNoMatchesError(ExtractGroupsError):
         return f"Pattern {self.pattern} must match against {self.text}"
 
 
-__all__ = ["ExtractGroupError", "ExtractGroupsError", "extract_group", "extract_groups"]
+__all__ = [
+    "ExtractGroupError",
+    "ExtractGroupsError",
+    "ensure_pattern",
+    "extract_group",
+    "extract_groups",
+]

utilities/types.py

@@ -7,6 +7,7 @@ from enum import Enum
 from logging import Logger
 from pathlib import Path
 from random import Random
+from re import Pattern
 from types import TracebackType
 from typing import (
     Any,
@@ -249,6 +250,10 @@ type PathLike = MaybeStr[Path]
 type Seed = int | float | str | bytes | bytearray | Random
 
 
+# re
+type PatternLike = MaybeStr[Pattern[str]]
+
+
 # traceback
 type ExcInfo = tuple[type[BaseException], BaseException, TracebackType]
 type OptExcInfo = ExcInfo | tuple[None, None, None]
@@ -294,6 +299,7 @@ __all__ = [
     "Parallelism",
     "ParseObjectExtra",
     "PathLike",
+    "PatternLike",
     "RoundMode",
     "Seed",
     "SerializeObjectExtra",