pythonwrench 0.4.1__tar.gz → 0.4.2__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pythonwrench
-Version: 0.4.1
+Version: 0.4.2
 Summary: Set of tools for Python that could be in the standard library.
 Author-email: "Étienne Labbé (Labbeti)" <labbeti.pub@gmail.com>
 Maintainer-email: "Étienne Labbé (Labbeti)" <labbeti.pub@gmail.com>
@@ -47,6 +47,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: typing-extensions>=4.10.0
+Provides-Extra: dev
 
 # pythonwrench
 

pythonwrench-0.4.2/docs/requirements.txt

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+
+sphinx-immaterial>=0.11.14

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

@@ -45,6 +45,9 @@ pyw-info = "pythonwrench.entries:print_install_info"
 pyw-tree = "pythonwrench.entries:main_tree"
 pyw-safe-rmdir = "pythonwrench.entries:main_safe_rmdir"
 
+[project.optional-dependencies]
+dev = []
+
 [build-system]
 requires = ["setuptools >= 61.0"]
 build-backend = "setuptools.build_meta"
@@ -87,6 +90,6 @@ dev = [
     "ruff>=0.12.0",
     "setuptools",
     "sphinx",
-    "sphinx-press-theme",
+    "sphinx-immaterial>=0.11.14",
     "twine",
 ]

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

@@ -9,7 +9,7 @@ __author_email__ = "labbeti.pub@gmail.com"
 __license__ = "MIT"
 __maintainer__ = "Étienne Labbé (Labbeti)"
 __status__ = "Development"
-__version__ = "0.4.1"
+__version__ = "0.4.2"
 
 
 # Re-import for language servers
@@ -29,7 +29,6 @@ from . import functools as functools
 from . import hashlib as hashlib
 from . import importlib as importlib
 from . import inspect as inspect
-from . import io as io
 from . import json as json
 from . import jsonl as jsonl
 from . import logging as logging

{pythonwrench-0.4.1 → pythonwrench-0.4.2}/src/pythonwrench/_core.py

@@ -1,7 +1,10 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+import os
 from functools import wraps
+from io import TextIOWrapper
+from pathlib import Path
 from typing import (
     Any,
     Callable,
@@ -13,13 +16,14 @@ from typing import (
     Tuple,
     Union,
     get_args,
+    overload,
 )
 
 from typing_extensions import ParamSpec, TypeVar
 
 P = ParamSpec("P")
-T = TypeVar("T")
-U = TypeVar("U")
+T = TypeVar("T", covariant=True)
+U = TypeVar("U", covariant=True)
 T_Output = TypeVar("T_Output")
 T_Any = TypeVar("T_Any", contravariant=True, default=Any)
 
@@ -165,3 +169,53 @@ class _FunctionRegistry(Generic[T_Output]):
         else:
             msg = f"Invalid argument {unk_mode=}. (expected one of {get_args(UnkMode)})"
             raise ValueError(msg)
+
+
+@overload
+def _setup_output_fpath(
+    fpath: Union[str, Path, os.PathLike],
+    overwrite: bool,
+    make_parents: bool,
+    absolute: bool = True,
+) -> Path: ...
+
+
+@overload
+def _setup_output_fpath(
+    fpath: TextIOWrapper,
+    overwrite: bool,
+    make_parents: bool,
+    absolute: bool = True,
+) -> TextIOWrapper: ...
+
+
+@overload
+def _setup_output_fpath(
+    fpath: None,
+    overwrite: bool,
+    make_parents: bool,
+    absolute: bool = True,
+) -> None: ...
+
+
+def _setup_output_fpath(
+    fpath: Union[str, Path, os.PathLike, TextIOWrapper, None],
+    overwrite: bool,
+    make_parents: bool,
+    absolute: bool = True,
+) -> Union[Path, None, TextIOWrapper]:
+    """Resolve path, expand path and create intermediate parents."""
+    if not isinstance(fpath, (str, Path, os.PathLike)):
+        return fpath
+
+    fpath = Path(fpath)
+    if absolute:
+        fpath = fpath.resolve().expanduser()
+
+    if not overwrite and fpath.exists():
+        msg = f"File {fpath} already exists."
+        raise FileExistsError(msg)
+    elif make_parents:
+        fpath.parent.mkdir(parents=True, exist_ok=True)
+
+    return fpath

{pythonwrench-0.4.1 → pythonwrench-0.4.2}/src/pythonwrench/abc.py

@@ -7,14 +7,15 @@ from typing import Any, ClassVar, Dict, Type
 class Singleton(type):
     """Singleton metaclass.
 
-    To use it, just inherit from metaclass:
-    ```
+    To use it, just inherit from metaclass.
+
+    Example
+    -------
     >>> class MyClass(metaclass=Singleton):
     >>>     pass
     >>> a1 = MyClass()
     >>> a2 = MyClass()
     >>> # a1 and a2 are exactly the same instance, i.e. id(a1) == id(a2)
-    ```
     """
 
     _instances: ClassVar[Dict[Type, Any]] = {}

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

@@ -63,16 +63,15 @@ def register_as_builtin_fn(
     priority: int = 0,
 ) -> Callable:
     """Decorator to add an as_builtin function.
-    ```
-    >>> import numpy as np
 
+    Example
+    -------
+    >>> import numpy as np
     >>> @register_as_builtin_fn(np.ndarray)
     >>> def my_checksum_for_numpy(x: np.ndarray):
     >>>     return x.tolist()
-
     >>> pw.as_builtin([np.array([1, 2]), [3, 4]])
     ... [[1, 2], [3, 4]]
-    ```
     """
     return _AS_BUILTIN_REGISTRY.register_decorator(
         class_or_tuple,

{pythonwrench-0.4.1 → pythonwrench-0.4.2}/src/pythonwrench/checksum.py

@@ -60,15 +60,14 @@ def register_checksum_fn(
     priority: int = 0,
 ) -> Callable:
     """Decorator to add a checksum function.
-    ```
-    >>> import numpy as np
 
+    Example
+    -------
+    >>> import numpy as np
     >>> @register_checksum_fn(np.ndarray)
     >>> def my_checksum_for_numpy(x: np.ndarray):
     >>>     return int(x.sum())
-
     >>> pw.checksum_any(np.array([1, 2]))  # calls my_checksum_for_numpy internally, even if array in nested inside a list, dict, etc.
-    ```
     """
     return _CHECKSUM_REGISTRY.register_decorator(
         class_or_tuple,

{pythonwrench-0.4.1 → pythonwrench-0.4.2}/src/pythonwrench/collections/collections.py

@@ -95,20 +95,16 @@ def dict_list_to_list_dict(
     """Convert dict of lists with same sizes to list of dicts.
 
     Example 1
-    ----------
-    ```
+    ---------
     >>> dic = {"a": [1, 2], "b": [3, 4]}
     >>> dict_list_to_list_dict(dic)
     ... [{"a": 1, "b": 3}, {"a": 2, "b": 4}]
-    ```
 
     Example 2
-    ----------
-    ```
+    ---------
     >>> dic = {"a": [1, 2, 3], "b": [4], "c": [5, 6]}
     >>> dict_list_to_list_dict(dic, key_mode="union", default=-1)
     ... [{"a": 1, "b": 4, "c": 5}, {"a": 2, "b": -1, "c": 6}, {"a": 3, "b": -1, "c": -1}]
-    ```
     """
     if len(dic) == 0:
         return []
@@ -151,11 +147,9 @@ def dump_dict(
 
     Example 1:
     ----------
-    ```
     >>> d = {"a": 1, "b": 2}
     >>> dump_dict(d)
     ... 'a=1, b=2'
-    ```
     """
     if dic is None:
         dic = {}
@@ -360,7 +354,6 @@ def flat_dict_of_dict(
 
     Example 1
     ---------
-    ```
     >>> dic = {
     ...     "a": 1,
     ...     "b": {
@@ -370,15 +363,12 @@ def flat_dict_of_dict(
     ... }
     >>> flat_dict_of_dict(dic)
     ... {"a": 1, "b.a": 2, "b.b": 10}
-    ```
 
     Example 2
     ---------
-    ```
     >>> dic = {"a": ["hello", "world"], "b": 3}
     >>> flat_dict_of_dict(dic, flat_iterables=True)
     ... {"a.0": "hello", "a.1": "world", "b": 3}
-    ```
 
     Args:
         nested_dic: Nested mapping containing sub-mappings or iterables.
@@ -508,10 +498,11 @@ def list_dict_to_dict_list(
 
     Args:
         lst: The list of dict to merge.
-        key_mode: Can be "same" or "intersect".
-            If "same", all the dictionaries must contains the same keys otherwise a ValueError will be raised.
-            If "intersect", only the intersection of all keys will be used in output.
-            If "union", the output dict will contains the union of all keys, and the missing value will use the argument default_val.
+        key_mode: Can be "same" or "intersect". \
+            - If "same", all the dictionaries must contains the same keys otherwise a ValueError will be raised. \
+            - If "intersect", only the intersection of all keys will be used in output. \
+            - If "union", the output dict will contains the union of all keys, and the missing value will use the argument default_val. \
+            - If an iterable of elements, use them as keys for output dict.
         default_val: Default value of an element when key_mode is "union". defaults to None.
         default_val_fn: Function to return the default value according to a specific key. defaults to None.
         list_fn: Optional function to build the values. defaults to identity.
@@ -622,7 +613,6 @@ def unflat_dict_of_dict(dic: Mapping[str, Any], *, sep: str = ".") -> Dict[str,
 
     Example 1
     ----------
-    ```
     >>> dic = {
         "a.a": 1,
         "b.a": 2,
@@ -631,7 +621,6 @@ def unflat_dict_of_dict(dic: Mapping[str, Any], *, sep: str = ".") -> Dict[str,
     }
     >>> unflat_dict_of_dict(dic)
     ... {"a": {"a": 1}, "b": {"a": 2, "b": 3}, "c": 4}
-    ```
     """
     output = {}
     for k, v in dic.items():
@@ -671,6 +660,7 @@ def unflat_list_of_list(
 
 
 def union_dicts(dicts: Iterable[Dict[K, V]]) -> Dict[K, V]:
+    """Performs union of dictionaries."""
     if Version.python() >= Version("3.9.0"):
         return reduce_or(*dicts)
 
@@ -721,19 +711,24 @@ def unzip(
 ) -> Tuple[List[T], List[U], List[V], List[W], List[X]]: ...
 
 
+@overload
+def unzip(
+    lst: Iterable[Tuple[T, ...]],
+) -> Tuple[List[T], ...]: ...
+
+
 def unzip(lst):
     """Invert function of builtin zip().
 
-    .. code-block:: python
-        :caption:  Example
-
-        >>> lst1 = [1, 2, 3, 4]
-        >>> lst2 = [5, 6, 7, 8]
-        >>> lst_zipped = list(zip(lst1, lst2))
-        >>> lst_zipped
-        ... [(1, 5), (2, 6), (3, 7), (4, 8)]
-        >>> unzip(lst_zipped)
-        ... [1, 2, 3, 4], [5, 6, 7, 8]
+    Example
+    -------
+    >>> lst1 = [1, 2, 3, 4]
+    >>> lst2 = [5, 6, 7, 8]
+    >>> zipped_list = list(zip(lst1, lst2))
+    >>> zipped_list
+    ... [(1, 5), (2, 6), (3, 7), (4, 8)]
+    >>> unzip(zipped_list)
+    ... [1, 2, 3, 4], [5, 6, 7, 8]
     """
     return tuple(map(list, zip(*lst)))
 
@@ -741,8 +736,8 @@ def unzip(lst):
 def duplicate_list(lst: List[T], sizes: List[int]) -> List[T]:
     """Duplicate elements elements of a list with the corresponding sizes.
 
-    Example 1
-    ----------
+    Example
+    -------
     >>> lst = ["a", "b", "c", "d", "e"]
     >>> sizes = [1, 0, 2, 1, 3]
     >>> duplicate_list(lst, sizes)

{pythonwrench-0.4.1 → pythonwrench-0.4.2}/src/pythonwrench/csv.py

@@ -21,10 +21,10 @@ from typing import (
     overload,
 )
 
+from pythonwrench._core import _setup_output_fpath
 from pythonwrench.cast import as_builtin
 from pythonwrench.collections import dict_list_to_list_dict, list_dict_to_dict_list
 from pythonwrench.functools import function_alias
-from pythonwrench.io import _setup_output_fpath
 from pythonwrench.typing import isinstance_generic
 
 T = TypeVar("T")
@@ -48,7 +48,7 @@ def dump_csv(
     replace_newline_by: Optional[str] = "\\n",
     **csv_writer_kwds,
 ) -> str:
-    """Dump content to CSV format into string and/or file.
+    r"""Dump content to CSV format into string and/or file.
 
     Args:
         data: Data to serialize. Can be a list of dicts, dicts of lists or list of lists.
@@ -59,7 +59,7 @@ def dump_csv(
         header: Indicates if CSV must have header. If "auto", an header is added when a dict of list or list of dicts is passed. defaults to "auto".
         align_content: If True, center content at the middle of each row for better visualization. defaults to False.
         replace_newline_by: Replace newline character to avoid newline in CSV content. defaults to "\\n".
-        **csv_writer_kwds: Others optional arguments passed to CSV writer object.
+        \*\*csv_writer_kwds: Others optional arguments passed to CSV writer object.
 
     Returns:
         Dumped content as string.
@@ -98,7 +98,7 @@ def dumps_csv(
     replace_newline_by: Optional[str] = "\\n",
     **csv_writer_kwds,
 ) -> str:
-    """Dump content to CSV format into string.
+    r"""Dump content to CSV format into string.
 
     Args:
         data: Data to serialize. Can be a list of dicts, dicts of lists or list of lists.
@@ -108,7 +108,7 @@ def dumps_csv(
         header: Indicates if CSV must have header. If "auto", an header is added when a dict of list or list of dicts is passed. defaults to "auto".
         align_content: If True, center content at the middle of each row for better visualization. defaults to False.
         replace_newline_by: Replace newline character to avoid newline in CSV content. defaults to "\\n".
-        **csv_writer_kwds: Others optional arguments passed to CSV writer object.
+        \*\*csv_writer_kwds: Others optional arguments passed to CSV writer object.
 
     Returns:
         Dumped content as string.
@@ -140,7 +140,7 @@ def save_csv(
     replace_newline_by: Optional[str] = "\\n",
     **csv_writer_kwds,
 ) -> None:
-    """Save content to CSV format into a file or buffer.
+    r"""Save content to CSV format into a file or buffer.
 
     Args:
         data: Data to serialize. Can be a list of dicts, dicts of lists or list of lists.
@@ -150,7 +150,7 @@ def save_csv(
         header: Indicates if CSV must have header. If "auto", an header is added when a dict of list or list of dicts is passed. defaults to "auto".
         align_content: If True, center content at the middle of each row for better visualization. defaults to False.
         replace_newline_by: Replace newline character to avoid newline in CSV content. defaults to "\\n".
-        **csv_writer_kwds: Others optional arguments passed to CSV writer object.
+        \*\*csv_writer_kwds: Others optional arguments passed to CSV writer object.
     """
     if isinstance(file, (str, Path, PathLike)):
         file = _setup_output_fpath(file, overwrite=overwrite, make_parents=make_parents)
@@ -320,14 +320,14 @@ def load_csv(
     delimiter: Optional[str] = ",",
     **csv_reader_kwds,
 ) -> Union[List[Dict[str, Any]], Dict[str, List[Any]]]:
-    """Load content from csv filepath.
+    r"""Load content from csv filepath.
 
     Args:
         orient: Orientation of the output value. Can be "list" or "dict". defaults to "list".
         header: Specify if CSV has header column. defaults to True.
         comment_start: If this string is not None and a line starts with this string, the line will be ignored. defaults to None.
         delimiter: Value delimiter. defaults to ",".
-        **csv_reader_kwds: Other optional csv arguments.
+        \*\*csv_reader_kwds: Other optional csv arguments.
 
     Returns:
         The loaded values as dict of lists, list of dicts or list of lists.

{pythonwrench-0.4.1 → pythonwrench-0.4.2}/src/pythonwrench/disk_cache.py

@@ -37,7 +37,7 @@ SavingBackend = Literal["csv", "json", "pickle"]
 StoreMode = Literal["outputs_only", "outputs_metadata", "outputs_metadata_inputs"]
 
 
-class CacheMeta(TypedDict):
+class _CacheMeta(TypedDict):
     datetime: str
     duration: float
     checksum: int
@@ -52,49 +52,6 @@ _DEFAULT_CACHE_DPATH = Path.home().joinpath(".cache", "disk_cache")
 logger = logging.getLogger(__name__)
 
 
-def disk_cache_call(
-    fn: Callable[..., T],
-    *args,
-    cache_dpath: Union[str, Path, None] = None,
-    cache_force: bool = False,
-    cache_verbose: int = 0,
-    cache_checksum_fn: ChecksumFn = checksum_any,
-    cache_saving_backend: Optional[SavingBackend] = "pickle",
-    cache_fname_fmt: str = "{fn_name}_{csum}{suffix}",
-    cache_dump_fn: Optional[Callable[[Any, Path], Any]] = None,
-    cache_load_fn: Optional[Callable[[Path], Any]] = None,
-    cache_enable: bool = True,
-    cache_store_mode: StoreMode = "outputs_metadata",
-    **kwargs,
-) -> T:
-    """Call function and store output in a cache file.
-
-    Cache file is identified by the checksum of the function arguments, and stored by default in `~/.cache/disk_cache/<Function_name>/` directory.
-
-    ```python
-    >>> import pythonwrench as pw
-    >>> def heavy_processing():
-    >>>     # Lot of stuff here
-    >>>     ...
-    >>> outputs = pw.disk_cache_call(heavy_processing)  # first time function is called
-    >>> outputs = pw.disk_cache_call(heavy_processing)  # second time outputs is loaded from disk
-    ```
-    """
-    wrapped_fn = _disk_cache_impl(
-        cache_dpath=cache_dpath,
-        cache_force=cache_force,
-        cache_verbose=cache_verbose,
-        cache_checksum_fn=cache_checksum_fn,
-        cache_saving_backend=cache_saving_backend,
-        cache_fname_fmt=cache_fname_fmt,
-        cache_dump_fn=cache_dump_fn,
-        cache_load_fn=cache_load_fn,
-        cache_enable=cache_enable,
-        cache_store_mode=cache_store_mode,
-    )
-    return wrapped_fn(fn)(*args, **kwargs)
-
-
 @overload
 def disk_cache_decorator(
     fn: None = None,
@@ -145,9 +102,10 @@ def disk_cache_decorator(
 ) -> Callable:
     """Decorator to store function output in a cache file.
 
-    Cache file is identified by the checksum of the function arguments, and stored by default in `~/.cache/disk_cache/<Function_name>/` directory.
+    Cache file is identified by the checksum of the function arguments, and stored by default in `"~/.cache/disk_cache/<Function_name>/"` directory.
 
-    ```python
+    Example
+    -------
     >>> import pythonwrench as pw
     >>> @pw.disk_cache_decorator
     >>> def heavy_processing():
@@ -155,7 +113,19 @@ def disk_cache_decorator(
     >>>     ...
     >>> outputs = heavy_processing()  # first time function is called
     >>> outputs = heavy_processing()  # second time outputs is loaded from disk
-    ```
+
+    Args:
+        fn: Function to store its output. By default, it must be a callable that returns a pickable object.
+        cache_dpath: Cache directory path. defaults to `"~/.cache/disk_cache"`.
+        cache_force: Force function call and overwrite cache. defaults to False.
+        cache_verbose: Set verbose logging level. Higher means more verbose. defaults to 0.
+        cache_checksum_fn: Checksum function to identify input arguments. defaults to ``pythonwrench.checksum_any``.
+        cache_saving_backend: Optional saving backend. Can be one of ('csv', 'json', 'pickle'). defaults to 'pickle'.
+        cache_fname_fmt: Cache filename format. defaults to "{fn_name}_{csum}{suffix}".
+        cache_dump_fn: Dump/save function to store outputs and overwrite saving backend. defaults to None.
+        cache_load_fn: Load function to store outputs and overwrite saving backend. defaults to None.
+        cache_enable: Enable disk cache. If False, the function has no effect. defaults to True.
+        cache_store_mode: Disk cache storage mode. By default, it store function output and saved date into the cache file. defaults to 'outputs_metadata'.
     """
     impl_fn = _disk_cache_impl(
         cache_dpath=cache_dpath,
@@ -175,6 +145,64 @@ def disk_cache_decorator(
         return impl_fn
 
 
+def disk_cache_call(
+    fn: Callable[..., T],
+    *args,
+    cache_dpath: Union[str, Path, None] = None,
+    cache_force: bool = False,
+    cache_verbose: int = 0,
+    cache_checksum_fn: ChecksumFn = checksum_any,
+    cache_saving_backend: Optional[SavingBackend] = "pickle",
+    cache_fname_fmt: str = "{fn_name}_{csum}{suffix}",
+    cache_dump_fn: Optional[Callable[[Any, Path], Any]] = None,
+    cache_load_fn: Optional[Callable[[Path], Any]] = None,
+    cache_enable: bool = True,
+    cache_store_mode: StoreMode = "outputs_metadata",
+    **kwargs,
+) -> T:
+    r"""Call function and store output in a cache file.
+
+    Cache file is identified by the checksum of the function arguments, and stored by default in '~/.cache/disk_cache/<Function_name>/' directory.
+
+    Example
+    -------
+    >>> import pythonwrench as pw
+    >>> def heavy_processing():
+    >>>     # Lot of stuff here
+    >>>     ...
+    >>> outputs = pw.disk_cache_call(heavy_processing)  # first time function is called
+    >>> outputs = pw.disk_cache_call(heavy_processing)  # second time outputs is loaded from disk
+
+    Args:
+        fn: Function to store its output. By default, it must be a callable that returns a pickable object.
+        cache_dpath: Cache directory path. defaults to '~/.cache/disk_cache'.
+        cache_force: Force function call and overwrite cache. defaults to False.
+        cache_verbose: Set verbose logging level. Higher means more verbose. defaults to 0.
+        cache_checksum_fn: Checksum function to identify input arguments. defaults to ``pythonwrench.checksum_any``.
+        cache_saving_backend: Optional saving backend. Can be one of ('csv', 'json', 'pickle'). defaults to 'pickle'.
+        cache_fname_fmt: Cache filename format. defaults to '{fn_name}_{csum}{suffix}'.
+        cache_dump_fn: Dump/save function to store outputs and overwrite saving backend. defaults to None.
+        cache_load_fn: Load function to store outputs and overwrite saving backend. defaults to None.
+        cache_enable: Enable disk cache. If False, the function has no effect. defaults to True.
+        cache_store_mode: Disk cache storage mode. By default, it store function output and saved date into the cache file. defaults to 'outputs_metadata'.
+        \*args: Positional arguments passed to the function.
+        \*\*kwargs: Keywords arguments passed to the function.
+    """
+    wrapped_fn = _disk_cache_impl(
+        cache_dpath=cache_dpath,
+        cache_force=cache_force,
+        cache_verbose=cache_verbose,
+        cache_checksum_fn=cache_checksum_fn,
+        cache_saving_backend=cache_saving_backend,
+        cache_fname_fmt=cache_fname_fmt,
+        cache_dump_fn=cache_dump_fn,
+        cache_load_fn=cache_load_fn,
+        cache_enable=cache_enable,
+        cache_store_mode=cache_store_mode,
+    )
+    return wrapped_fn(fn)(*args, **kwargs)
+
+
 def _disk_cache_impl(
     *,
     cache_dpath: Union[str, Path, None] = None,
@@ -336,6 +364,7 @@ def _disk_cache_impl(
 
 
 def get_cache_dpath(cache_dpath: Union[str, Path, None] = None) -> Path:
+    """Returns defaults disk cache directory path, which is `~/.cache/disk_cache`."""
     if cache_dpath is None:
         cache_dpath = _DEFAULT_CACHE_DPATH
     else:
@@ -348,6 +377,7 @@ def remove_fn_cache(
     *,
     cache_dpath: Union[str, Path, None] = None,
 ) -> None:
+    """Removes all caches for a specific function."""
     cache_fn_dpath = _get_fn_cache_dpath(fn, cache_dpath=cache_dpath)
     if cache_fn_dpath.is_dir():
         shutil.rmtree(cache_fn_dpath)

{pythonwrench-0.4.1 → pythonwrench-0.4.2}/src/pythonwrench/functools.py

@@ -14,7 +14,7 @@ from typing import (
 from typing_extensions import ParamSpec
 
 from pythonwrench._core import _decorator_factory, return_none  # noqa: F401
-from pythonwrench.inspect import get_argnames
+from pythonwrench.inspect import _get_code_and_start, get_argnames
 from pythonwrench.typing import isinstance_generic
 
 T = TypeVar("T")
@@ -111,30 +111,45 @@ compose = Compose  # type: ignore
 
 
 def filter_and_call(fn: Callable[..., T], **kwargs: Any) -> T:
-    """Filter kwargs with function arg names and call function."""
+    """Call object only with the valid keyword arguments. Non-valid arguments are ignored.
+
+    Examples
+    --------
+    >>> def f(x, y):
+    >>>     return x + y
+    >>> filter_and_call(f, y=2, x=1)
+    ... 3
+    >>> filter_and_call(f, y=2, x=1, z=0)  # z is ignored
+    ... 3
+    """
     argnames = get_argnames(fn)
-    kwargs_filtered = {
-        name: value for name, value in kwargs.items() if name in argnames
+    code, start = _get_code_and_start(fn)
+
+    pos_argnames = argnames[: code.co_posonlyargcount]
+    other_argnames = argnames[code.co_posonlyargcount :]
+
+    posonly_args = [value for name, value in kwargs.items() if name in pos_argnames]
+    other_kwds = {
+        name: value for name, value in kwargs.items() if name in other_argnames
     }
-    return fn(**kwargs_filtered)
+    result = fn(*posonly_args, **other_kwds)
+    return result
 
 
 def function_alias(alternative: Callable[P, U]) -> Callable[..., Callable[P, U]]:
     """Decorator to wrap function aliases.
 
-    Usage:
-    ```
+    Example
+    -------
     >>> def f(a: int, b: str) -> str:
     >>>    return a * b
-
     >>> @function_alias(f)
     >>> def g(*args, **kwargs): ...
-
     >>> f(2, "a")
     ... "aa"
     >>> g(3, "b")  # calls function f() internally.
     ... "bbb"
-    ```
+
     """
     return _decorator_factory(alternative)
 

{pythonwrench-0.4.1 → pythonwrench-0.4.2}/src/pythonwrench/importlib.py

@@ -181,12 +181,12 @@ def requires_packages(
 ) -> Callable[[Callable[P, T]], Callable[P, T]]:
     """Decorator to wrap a function and raises an error if the function is called.
 
-    ```
+    Example
+    -------
     >>> @requires_packages("pandas")
     >>> def f(x):
     >>>     return x
     >>> f(1)  # raises ImportError if pandas is not installed
-    ```
     """
     if isinstance(arg0, str):
         packages = [arg0] + list(args)