pythonwrench 0.4.2__tar.gz → 0.4.3__tar.gz

{pythonwrench-0.4.2/src/pythonwrench.egg-info → pythonwrench-0.4.3}/PKG-INFO

@@ -1,7 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pythonwrench
-Version: 0.4.2
-Summary: Set of tools for Python that could be in the standard library.
+Version: 0.4.3
+Summary: Python library with tools for typing, manipulating collections, and more!
 Author-email: "Étienne Labbé (Labbeti)" <labbeti.pub@gmail.com>
 Maintainer-email: "Étienne Labbé (Labbeti)" <labbeti.pub@gmail.com>
 License: MIT License
@@ -41,13 +41,18 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Scientific/Engineering
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Requires-Python: <3.15,>=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: typing-extensions>=4.10.0
 Provides-Extra: dev
+Dynamic: license-file
 
 # pythonwrench
 
@@ -63,27 +68,67 @@ Provides-Extra: dev
     <img src='https://readthedocs.org/projects/pythonwrench/badge/?version=stable&style=for-the-badge' alt='Documentation Status' />
 </a>
 
-Set of tools for Python that could be in the standard library.
+Python library with tools for typing, manipulating collections, and more!
 
 </center>
 
 
 ## Installation
 
-With pip:
+With uv:
 ```bash
-pip install pythonwrench
+uv add pythonwrench
 ```
 
-With uv:
+With pip:
 ```bash
-uv add pythonwrench
+pip install pythonwrench
 ```
 
-This library has been tested on all Python versions **3.8 - 3.13**, requires only `typing_extensions>=4.10.0`, and runs on **Linux, Mac and Windows** systems.
+This library has been tested on all Python versions **3.8 - 3.14**, requires only `typing_extensions>=4.10.0`, and runs on **Linux, Mac and Windows** systems.
 
 ## Examples
 
+### Typing
+
+Check generic types with ìsinstance_generic` :
+
+```python
+>>> import pythonwrench as pw
+>>>
+>>> # Behaves like builtin isinstance() :
+>>> pw.isinstance_generic({"a": 1, "b": 2}, dict)
+... True
+>>> # But works with generic types !
+>>> pw.isinstance_generic({"a": 1, "b": 2}, dict[str, int])
+... True
+>>> pw.isinstance_generic({"a": 1, "b": 2}, dict[str, str])
+... False
+```
+
+... or check specific methods with protocols classes beginning with `Supports`
+```python
+>>> import pythonwrench as pw
+>>>
+>>> isinstance({"a": 1, "b": 2}, pw.SupportsIterLen)
+... True
+>>> isinstance({"a": 1, "b": 2}, pw.SupportsGetitemLen)
+... True
+```
+
+Finally, you can also force argument type checking with `check_args_types` function :
+
+```python
+>>> import pythonwrench as pw
+
+>>> @pw.check_args_types
+>>> def f(a: int, b: str) -> str:
+>>>     return a * b
+
+>>> f(1, "a")  # pass check
+>>> f(1, 2)  # raises TypeError from decorator
+```
+
 ### Collections
 
 Provides functions to facilitate iterables processing, like `unzip` :
@@ -131,47 +176,6 @@ Easely converts common python structures like list of dicts to dict of lists :
 ... {"a.x": 1, "a.y": 2, "b.x": 3, "b.y": 4}
 ```
 
-### Typing
-
-Check generic types with ìsinstance_generic` :
-
-```python
->>> import pythonwrench as pw
->>>
->>> # Behaves like builtin isinstance() :
->>> pw.isinstance_generic({"a": 1, "b": 2}, dict)
-... True
->>> # But works with generic types !
->>> pw.isinstance_generic({"a": 1, "b": 2}, dict[str, int])
-... True
->>> pw.isinstance_generic({"a": 1, "b": 2}, dict[str, str])
-... False
-```
-
-... or check specific methods with protocols classes beginning with `Supports`
-```python
->>> import pythonwrench as pw
->>>
->>> # Combines Iterable and Sized !
->>> isinstance({"a": 1, "b": 2}, pw.SupportsGetitemLen)
-... True
->>> isinstance({"a": 1, "b": 2}, pw.SupportsIterLen)
-... True
-```
-
-Finally, you can also force argument type checking with `check_args_types` function :
-
-```python
->>> import pythonwrench as pw
-
->>> @pw.check_args_types
->>> def f(a: int, b: str) -> str:
->>>     return a * b
-
->>> f(1, "a")  # pass check
->>> f(1, 2)  # raises TypeError from decorator
-```
-
 ### Disk caching (memoize)
 
 ```python

{pythonwrench-0.4.2 → pythonwrench-0.4.3}/README.md

@@ -12,27 +12,67 @@
     <img src='https://readthedocs.org/projects/pythonwrench/badge/?version=stable&style=for-the-badge' alt='Documentation Status' />
 </a>
 
-Set of tools for Python that could be in the standard library.
+Python library with tools for typing, manipulating collections, and more!
 
 </center>
 
 
 ## Installation
 
-With pip:
+With uv:
 ```bash
-pip install pythonwrench
+uv add pythonwrench
 ```
 
-With uv:
+With pip:
 ```bash
-uv add pythonwrench
+pip install pythonwrench
 ```
 
-This library has been tested on all Python versions **3.8 - 3.13**, requires only `typing_extensions>=4.10.0`, and runs on **Linux, Mac and Windows** systems.
+This library has been tested on all Python versions **3.8 - 3.14**, requires only `typing_extensions>=4.10.0`, and runs on **Linux, Mac and Windows** systems.
 
 ## Examples
 
+### Typing
+
+Check generic types with ìsinstance_generic` :
+
+```python
+>>> import pythonwrench as pw
+>>>
+>>> # Behaves like builtin isinstance() :
+>>> pw.isinstance_generic({"a": 1, "b": 2}, dict)
+... True
+>>> # But works with generic types !
+>>> pw.isinstance_generic({"a": 1, "b": 2}, dict[str, int])
+... True
+>>> pw.isinstance_generic({"a": 1, "b": 2}, dict[str, str])
+... False
+```
+
+... or check specific methods with protocols classes beginning with `Supports`
+```python
+>>> import pythonwrench as pw
+>>>
+>>> isinstance({"a": 1, "b": 2}, pw.SupportsIterLen)
+... True
+>>> isinstance({"a": 1, "b": 2}, pw.SupportsGetitemLen)
+... True
+```
+
+Finally, you can also force argument type checking with `check_args_types` function :
+
+```python
+>>> import pythonwrench as pw
+
+>>> @pw.check_args_types
+>>> def f(a: int, b: str) -> str:
+>>>     return a * b
+
+>>> f(1, "a")  # pass check
+>>> f(1, 2)  # raises TypeError from decorator
+```
+
 ### Collections
 
 Provides functions to facilitate iterables processing, like `unzip` :
@@ -80,47 +120,6 @@ Easely converts common python structures like list of dicts to dict of lists :
 ... {"a.x": 1, "a.y": 2, "b.x": 3, "b.y": 4}
 ```
 
-### Typing
-
-Check generic types with ìsinstance_generic` :
-
-```python
->>> import pythonwrench as pw
->>>
->>> # Behaves like builtin isinstance() :
->>> pw.isinstance_generic({"a": 1, "b": 2}, dict)
-... True
->>> # But works with generic types !
->>> pw.isinstance_generic({"a": 1, "b": 2}, dict[str, int])
-... True
->>> pw.isinstance_generic({"a": 1, "b": 2}, dict[str, str])
-... False
-```
-
-... or check specific methods with protocols classes beginning with `Supports`
-```python
->>> import pythonwrench as pw
->>>
->>> # Combines Iterable and Sized !
->>> isinstance({"a": 1, "b": 2}, pw.SupportsGetitemLen)
-... True
->>> isinstance({"a": 1, "b": 2}, pw.SupportsIterLen)
-... True
-```
-
-Finally, you can also force argument type checking with `check_args_types` function :
-
-```python
->>> import pythonwrench as pw
-
->>> @pw.check_args_types
->>> def f(a: int, b: str) -> str:
->>>     return a * b
-
->>> f(1, "a")  # pass check
->>> f(1, 2)  # raises TypeError from decorator
-```
-
 ### Disk caching (memoize)
 
 ```python

{pythonwrench-0.4.2 → pythonwrench-0.4.3}/pyproject.toml

@@ -3,9 +3,9 @@ name = "pythonwrench"
 authors = [
     {name = "Étienne Labbé (Labbeti)", email = "labbeti.pub@gmail.com"},
 ]
-description = "Set of tools for Python that could be in the standard library."
+description = "Python library with tools for typing, manipulating collections, and more!"
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.8,<3.15"
 keywords = ["python", "tools", "utilities"]
 license = {file = "LICENSE"}
 # license-files = ["LICENSE"]  # unsupported by python 3.8, but will be required in 2026
@@ -19,8 +19,12 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Topic :: Scientific/Engineering",
     "Operating System :: OS Independent",
+    "Operating System :: MacOS :: MacOS X",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX",
 ]
 maintainers = [
     {name = "Étienne Labbé (Labbeti)", email = "labbeti.pub@gmail.com"},

{pythonwrench-0.4.2 → pythonwrench-0.4.3}/src/pythonwrench/__init__.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-"""Set of tools for Python that could be in the standard library."""
+"""Python library with tools for typing, manipulating collections, and more!"""
 
 __name__ = "pythonwrench"
 __author__ = "Étienne Labbé (Labbeti)"
@@ -9,7 +9,7 @@ __author_email__ = "labbeti.pub@gmail.com"
 __license__ = "MIT"
 __maintainer__ = "Étienne Labbé (Labbeti)"
 __status__ = "Development"
-__version__ = "0.4.2"
+__version__ = "0.4.3"
 
 
 # Re-import for language servers
@@ -52,7 +52,7 @@ from .argparse import (
     str_to_optional_str,
     str_to_type,
 )
-from .cast import as_builtin
+from .cast import as_builtin, register_as_builtin_fn
 from .checksum import checksum_any, register_checksum_fn
 from .collections import (
     all_eq,
@@ -151,6 +151,7 @@ from .re import (
     PatternLike,
     PatternListLike,
     compile_patterns,
+    filter_with_patterns,
     find_patterns,
     get_key_fn,
     match_patterns,

{pythonwrench-0.4.2 → pythonwrench-0.4.3}/src/pythonwrench/cast.py

@@ -4,6 +4,7 @@
 from argparse import Namespace
 from collections import Counter
 from dataclasses import asdict
+from datetime import date
 from enum import Enum
 from functools import partial
 from pathlib import Path
@@ -81,105 +82,128 @@ def register_as_builtin_fn(
 
 
 _AS_BUILTIN_REGISTRY.register(
-    identity, custom_predicate=partial(is_builtin_scalar, strict=True)
+    identity,
+    custom_predicate=partial(is_builtin_scalar, strict=True),
 )
 
 
 @register_as_builtin_fn(Counter)
-def _counter_to_builtin(x: Counter) -> Dict[Any, int]:
+def _counter_to_builtin(x: Counter, **kwargs) -> Dict[Any, int]:
     return dict(x)
 
 
+@register_as_builtin_fn(date)
+def _date_to_builtin(x: date, **kwargs) -> str:
+    return str(x)
+
+
 @register_as_builtin_fn(Path)
-def _path_to_builtin(x: Path) -> str:
+def _path_to_builtin(x: Path, **kwargs) -> str:
     return str(x)
 
 
 @register_as_builtin_fn(Enum)
-def _enum_to_builtin(x: Enum) -> str:
+def _enum_to_builtin(x: Enum, **kwargs) -> str:
     return x.name
 
 
 @register_as_builtin_fn(Pattern)
-def _pattern_to_builtin(x: Pattern) -> str:
+def _pattern_to_builtin(x: Pattern, **kwargs) -> str:
     return x.pattern
 
 
 @register_as_builtin_fn(Namespace)
-def _namespace_to_builtin(x: Namespace) -> Any:
-    return as_builtin(x.__dict__)
+def _namespace_to_builtin(x: Namespace, **kwargs) -> Any:
+    return as_builtin(x.__dict__, **kwargs)
 
 
 @register_as_builtin_fn(DataclassInstance)
-def _dataclass_to_builtin(x: DataclassInstance) -> Any:
-    return as_builtin(asdict(x))
+def _dataclass_to_builtin(x: DataclassInstance, **kwargs) -> Any:
+    return as_builtin(asdict(x), **kwargs)
 
 
 @register_as_builtin_fn(NamedTupleInstance)
-def _namedtuple_to_builtin(x: NamedTupleInstance) -> Any:
-    return as_builtin(x._asdict())
+def _namedtuple_to_builtin(x: NamedTupleInstance, **kwargs) -> Any:
+    return as_builtin(x._asdict(), **kwargs)
 
 
 @register_as_builtin_fn(Mapping, priority=-100)
-def _mapping_to_builtin(x: Mapping) -> Any:
-    return {as_builtin(k): as_builtin(v) for k, v in x.items()}
+def _mapping_to_builtin(x: Mapping, **kwargs) -> Any:
+    return {as_builtin(k, **kwargs): as_builtin(v, **kwargs) for k, v in x.items()}
 
 
 @register_as_builtin_fn(Iterable, priority=-200)
-def _iterable_to_builtin(x: Iterable) -> Any:
-    return [as_builtin(xi) for xi in x]
+def _iterable_to_builtin(x: Iterable, **kwargs) -> Any:
+    return [as_builtin(xi, **kwargs) for xi in x]
 
 
 @overload
-def as_builtin(x: Counter) -> Dict[Any, int]: ...
+def as_builtin(x: Counter, **kwargs) -> Dict[Any, int]: ...
 
 
 @overload
-def as_builtin(x: Enum) -> str: ...
+def as_builtin(x: date, **kwargs) -> str: ...
 
 
 @overload
-def as_builtin(x: Path) -> str: ...
+def as_builtin(x: Enum, **kwargs) -> str: ...
 
 
 @overload
-def as_builtin(x: Pattern) -> str: ...
+def as_builtin(x: Path, **kwargs) -> str: ...
 
 
 @overload
-def as_builtin(x: Namespace) -> Dict[str, Any]: ...
+def as_builtin(x: Pattern, **kwargs) -> str: ...
 
 
 @overload
-def as_builtin(x: Mapping[K, V]) -> Dict[K, V]: ...
+def as_builtin(x: Namespace, **kwargs) -> Dict[str, Any]: ...
 
 
 @overload
-def as_builtin(x: DataclassInstance) -> Dict[str, Any]: ...
+def as_builtin(x: Mapping[K, V], **kwargs) -> Dict[K, V]: ...
 
 
 @overload
-def as_builtin(x: NamedTupleInstance) -> Dict[str, Any]: ...
+def as_builtin(x: DataclassInstance, **kwargs) -> Dict[str, Any]: ...
 
 
 @overload
-def as_builtin(x: T_BuiltinScalar) -> T_BuiltinScalar: ...
+def as_builtin(x: NamedTupleInstance, **kwargs) -> Dict[str, Any]: ...
 
 
 @overload
-def as_builtin(x: Any) -> Any: ...
+def as_builtin(x: T_BuiltinScalar, **kwargs) -> T_BuiltinScalar: ...
 
 
-def as_builtin(x: Any) -> Any:
+@overload
+def as_builtin(x: Any, **kwargs) -> Any: ...
+
+
+def as_builtin(x: Any, **kwargs) -> Any:
     """Convert an object to a sanitized python builtin equivalent.
 
     This function can be used to sanitize data before saving to a JSON, YAML or CSV file.
 
     Additional objects to convert can be added dynamically with `pythonwrench.register_as_builtin_fn` function decorator.
 
+    Here is the list of default objects converted to built-in:
+    - tuple -> list
+    - collections.Counter -> dict
+    - datetime.date -> str
+    - argparse.Namespace -> dict
+    - re.Pattern -> str
+    - pathlib.Path -> str
+    - enum.Enum -> str
+    - Mapping -> dict
+    - Iterable -> list
+    - Dataclass -> dict
+    - NamedTuple -> dict
+
     Note: By default, tuple objects are converted to list.
 
     Args:
         x: Object to convert to built-in equivalent.
     """
-    return _AS_BUILTIN_REGISTRY.apply(x)
+    return _AS_BUILTIN_REGISTRY.apply(x, **kwargs)

{pythonwrench-0.4.2 → pythonwrench-0.4.3}/src/pythonwrench/collections/__init__.py

@@ -34,6 +34,7 @@ from .reducers import (
     prod,
     reduce_add,
     reduce_and,
+    reduce_matmul,
     reduce_mul,
     reduce_or,
     sum,

{pythonwrench-0.4.2 → pythonwrench-0.4.3}/src/pythonwrench/collections/reducers.py

@@ -19,6 +19,7 @@ from pythonwrench.typing.checks import isinstance_generic
 from pythonwrench.typing.classes import (
     SupportsAdd,
     SupportsAnd,
+    SupportsMatmul,
     SupportsMul,
     SupportsOr,
 )
@@ -28,6 +29,7 @@ T_SupportsAdd = TypeVar("T_SupportsAdd", bound=SupportsAdd)
 T_SupportsAnd = TypeVar("T_SupportsAnd", bound=SupportsAnd)
 T_SupportsMul = TypeVar("T_SupportsMul", bound=SupportsMul)
 T_SupportsOr = TypeVar("T_SupportsOr", bound=SupportsOr)
+T_SupportsMatmul = TypeVar("T_SupportsMatmul", bound=SupportsMatmul)
 
 
 @overload
@@ -90,6 +92,36 @@ def reduce_and(*args, start=None):
     return _reduce(*args, start=start, op_fn=operator.and_, type_=SupportsAnd)
 
 
+@overload
+def reduce_matmul(
+    args: Iterable[T_SupportsMatmul],
+    /,
+    *,
+    start: T_SupportsMatmul,
+) -> T_SupportsMatmul: ...
+
+
+@overload
+def reduce_matmul(
+    *args: T_SupportsMatmul,
+    start: T_SupportsMatmul,
+) -> T_SupportsMatmul: ...
+
+
+@overload
+def reduce_matmul(
+    arg0: T_SupportsMatmul,
+    /,
+    *args: T_SupportsMatmul,
+    start: Optional[T_SupportsMatmul] = None,
+) -> T_SupportsMatmul: ...
+
+
+def reduce_matmul(*args, start=None):
+    """Reduce elements using "mul" operator (*)."""
+    return _reduce(*args, start=start, op_fn=operator.matmul, type_=SupportsMatmul)
+
+
 @overload
 def reduce_mul(
     args: Iterable[T_SupportsMul],
@@ -168,14 +200,15 @@ def _reduce(
 
     if isinstance(start, type_):
         accumulator = start
-    elif start is None:
+    elif start is None or start is ...:
         try:
             accumulator = next(it)
         except StopIteration:
-            msg = f"Invalid combinaison of arguments {args=} and {start=}. (expected at least 1 non-empty argument or start that supports or operator.)"
+            msg = f"Invalid combinaison of arguments {args=} and {start=}. (expected at least 1 non-empty argument or start object that supports operator.)"
             raise ValueError(msg)
     else:
-        raise TypeError(f"Invalid argument type {type(start)}.")
+        msg = f"Invalid argument type {type(start)}."
+        raise TypeError(msg)
 
     for arg in it:
         accumulator = op_fn(accumulator, arg)

pythonwrench-0.4.3/src/pythonwrench/concurrent.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import logging
+from concurrent.futures import Future, ThreadPoolExecutor
+from typing import Callable, Generic, List, Optional, TypeVar
+
+from typing_extensions import ParamSpec
+
+logger = logging.getLogger(__name__)
+
+
+P = ParamSpec("P")
+T = TypeVar("T")
+
+
+class ThreadPoolExecutorHelper(Generic[P, T]):
+    def __init__(self, fn: Callable[P, T], **default_kwargs) -> None:
+        super().__init__()
+        self.fn = fn
+        self.default_kwargs = default_kwargs
+        self.executor: Optional[ThreadPoolExecutor] = None
+        self.futures: list[Future[T]] = []
+
+    def submit(self, *args: P.args, **kwargs: P.kwargs) -> Future[T]:
+        if self.executor is None:
+            self.executor = ThreadPoolExecutor()
+
+        kwargs = self.default_kwargs | kwargs  # type: ignore
+        future = self.executor.submit(self.fn, *args, **kwargs)
+        self.futures.append(future)
+        return future
+
+    def wait_all(self, shutdown: bool = True, verbose: bool = True) -> List[T]:
+        futures = self.futures
+        if verbose:
+            try:
+                import tqdm  # type: ignore
+
+                futures = tqdm.tqdm(futures, disable=not verbose)
+            except ImportError:
+                logger.warning(
+                    "Cannot display verbose bar because tqdm is not installed."
+                )
+
+        results = [future.result() for future in futures]
+        self.futures.clear()
+        if shutdown and self.executor is not None:
+            self.executor.shutdown()
+            self.executor = None
+        return results

{pythonwrench-0.4.2 → pythonwrench-0.4.3}/src/pythonwrench/dataclasses.py

@@ -2,11 +2,13 @@
 # -*- coding: utf-8 -*-
 
 from dataclasses import MISSING
-from typing import Any, Dict
+from typing import Any, Dict, TypeVar
 
 from pythonwrench.typing.checks import is_dataclass_instance  # noqa: F401
 from pythonwrench.typing.classes import DataclassInstance
 
+T = TypeVar("T")
+
 
 def get_defaults_values(obj: DataclassInstance) -> Dict[str, Any]:
     defaults = {}