pythonwrench 0.1.0__tar.gz

pythonwrench-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Labbeti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pythonwrench-0.1.0/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: pythonwrench
+Version: 0.1.0
+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>
+License: MIT License
+        
+        Copyright (c) 2025 Labbeti
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://pypi.org/project/pythonwrench/
+Project-URL: Documentation, https://pythonwrench.readthedocs.io/
+Project-URL: Repository, https://github.com/Labbeti/pythonwrench.git
+Project-URL: Changelog, https://github.com/Labbeti/pythonwrench/blob/main/CHANGELOG.md
+Project-URL: Tracker, https://github.com/Labbeti/pythonwrench/issues
+Keywords: python,tools,utilities
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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: Topic :: Scientific/Engineering
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typing-extensions>=4.10.0
+Dynamic: license-file
+
+# pythonwrench
+
+<center>
+
+<a href="https://www.python.org/">
+    <img alt="Python" src="https://img.shields.io/badge/-Python 3.9+-blue?style=for-the-badge&logo=python&logoColor=white">
+</a>
+<a href="https://github.com/Labbeti/pythonwrench/actions">
+    <img alt="Build" src="https://img.shields.io/github/actions/workflow/status/Labbeti/pythonwrench/test.yaml?branch=main&style=for-the-badge&logo=github">
+</a>
+<a href='https://pythonwrench.readthedocs.io/en/stable/?badge=stable'>
+    <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.
+
+</center>
+
+
+## Installation
+
+With pip:
+```bash
+pip install pythonwrench
+```
+
+With uv:
+```bash
+uv add pythonwrench
+```
+
+This library works on all Python versions **>=3.9**, requires only `typing_extensions>=4.10.0`, and runs on **Linux, Mac and Windows** systems.
+
+## Examples
+
+### Collections
+
+Provides functions to facilitate iterables processing, like `unzip` :
+
+```python
+>>> import pythonwrench as pw
+>>>
+>>> list_of_tuples = [(1, "a"), (2, "b"), (3, "c"), (4, "d")]
+>>> pw.unzip(list_of_tuples)
+... [1, 2, 3, 4], ["a", "b", "c", "d"]
+>>> pw.flatten(list_of_tuples)
+... [1, "a", 2, "b", 3, "c", 4, "d"]
+```
+
+... or mathematical functions like `prod` or `argmax` :
+
+```python
+>>> import pythonwrench as pw
+>>>
+>>> values = [3, 1, 6, 4]
+>>> pw.prod(values)
+... 72
+>>> pw.argmax(values)
+... 2
+>>> pw.is_sorted(values)
+... False
+```
+
+Easely converts common python structures like list of dicts to dict of lists :
+
+```python
+>>> import pythonwrench as pw
+>>>
+>>> list_of_dicts = [{"a": 1, "b": 2}, {"a": 3, "b": 4}]
+>>> pw.list_dict_to_dict_list(list_of_dicts)
+... {"a": [1, 3], "b": [2, 4]}
+```
+
+... or dict of dicts :
+```python
+>>> import pythonwrench as pw
+>>>
+>>> dict_of_dicts = {"a": {"x": 1, "y": 2}, "b": {"x": 3, "y": 4}}
+>>> pw.flat_dict_of_dict(dict_of_dicts)
+... {"a.x": 1, "a.y": 2, "b.x": 3, "b.y": 4}
+```
+
+### Typing
+
+```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
+```
+
+```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
+```
+
+### Disk caching (memoize)
+
+```python
+>>> import pythonwrench as pw
+>>>
+>>> @pw.disk_cache_decorator
+>>> def heavy_processing():
+>>>     # Lot of stuff here
+>>>     ...
+>>>
+>>> data1 = heavy_processing()  # first call function is called and the result is stored on disk
+>>> data2 = heavy_processing()  # second call result is loaded from disk directly
+```
+
+### Semantic versionning parsing
+
+```python
+>>> import pythonwrench as pw
+>>> version = pw.Version("1.12.2")
+>>> version.to_tuple()
+... (1, 12, 2)
+>>> version = pw.Version("0.5.1-beta+linux")
+>>> version.to_tuple()
+... (0, 5, 1, "beta", "linux")
+```
+
+### Serialization
+
+```python
+>>> import pythonwrench as pw
+>>>
+>>> list_of_dicts = [{"a": 1, "b": 2}, {"a": 3, "b": 4}]
+>>> pw.dump_csv(list_of_dicts, "data.csv")
+>>> pw.dump_json(list_of_dicts, "data.json")
+>>> pw.load_json("data.json") == list_of_dicts
+... True
+```
+
+## Contact
+Maintainer:
+- [Étienne Labbé](https://labbeti.github.io/) "Labbeti": labbeti.pub@gmail.com

pythonwrench-0.1.0/README.md

@@ -0,0 +1,148 @@
+# pythonwrench
+
+<center>
+
+<a href="https://www.python.org/">
+    <img alt="Python" src="https://img.shields.io/badge/-Python 3.9+-blue?style=for-the-badge&logo=python&logoColor=white">
+</a>
+<a href="https://github.com/Labbeti/pythonwrench/actions">
+    <img alt="Build" src="https://img.shields.io/github/actions/workflow/status/Labbeti/pythonwrench/test.yaml?branch=main&style=for-the-badge&logo=github">
+</a>
+<a href='https://pythonwrench.readthedocs.io/en/stable/?badge=stable'>
+    <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.
+
+</center>
+
+
+## Installation
+
+With pip:
+```bash
+pip install pythonwrench
+```
+
+With uv:
+```bash
+uv add pythonwrench
+```
+
+This library works on all Python versions **>=3.9**, requires only `typing_extensions>=4.10.0`, and runs on **Linux, Mac and Windows** systems.
+
+## Examples
+
+### Collections
+
+Provides functions to facilitate iterables processing, like `unzip` :
+
+```python
+>>> import pythonwrench as pw
+>>>
+>>> list_of_tuples = [(1, "a"), (2, "b"), (3, "c"), (4, "d")]
+>>> pw.unzip(list_of_tuples)
+... [1, 2, 3, 4], ["a", "b", "c", "d"]
+>>> pw.flatten(list_of_tuples)
+... [1, "a", 2, "b", 3, "c", 4, "d"]
+```
+
+... or mathematical functions like `prod` or `argmax` :
+
+```python
+>>> import pythonwrench as pw
+>>>
+>>> values = [3, 1, 6, 4]
+>>> pw.prod(values)
+... 72
+>>> pw.argmax(values)
+... 2
+>>> pw.is_sorted(values)
+... False
+```
+
+Easely converts common python structures like list of dicts to dict of lists :
+
+```python
+>>> import pythonwrench as pw
+>>>
+>>> list_of_dicts = [{"a": 1, "b": 2}, {"a": 3, "b": 4}]
+>>> pw.list_dict_to_dict_list(list_of_dicts)
+... {"a": [1, 3], "b": [2, 4]}
+```
+
+... or dict of dicts :
+```python
+>>> import pythonwrench as pw
+>>>
+>>> dict_of_dicts = {"a": {"x": 1, "y": 2}, "b": {"x": 3, "y": 4}}
+>>> pw.flat_dict_of_dict(dict_of_dicts)
+... {"a.x": 1, "a.y": 2, "b.x": 3, "b.y": 4}
+```
+
+### Typing
+
+```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
+```
+
+```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
+```
+
+### Disk caching (memoize)
+
+```python
+>>> import pythonwrench as pw
+>>>
+>>> @pw.disk_cache_decorator
+>>> def heavy_processing():
+>>>     # Lot of stuff here
+>>>     ...
+>>>
+>>> data1 = heavy_processing()  # first call function is called and the result is stored on disk
+>>> data2 = heavy_processing()  # second call result is loaded from disk directly
+```
+
+### Semantic versionning parsing
+
+```python
+>>> import pythonwrench as pw
+>>> version = pw.Version("1.12.2")
+>>> version.to_tuple()
+... (1, 12, 2)
+>>> version = pw.Version("0.5.1-beta+linux")
+>>> version.to_tuple()
+... (0, 5, 1, "beta", "linux")
+```
+
+### Serialization
+
+```python
+>>> import pythonwrench as pw
+>>>
+>>> list_of_dicts = [{"a": 1, "b": 2}, {"a": 3, "b": 4}]
+>>> pw.dump_csv(list_of_dicts, "data.csv")
+>>> pw.dump_json(list_of_dicts, "data.json")
+>>> pw.load_json("data.json") == list_of_dicts
+... True
+```
+
+## Contact
+Maintainer:
+- [Étienne Labbé](https://labbeti.github.io/) "Labbeti": labbeti.pub@gmail.com

pythonwrench-0.1.0/pyproject.toml

@@ -0,0 +1,87 @@
+[project]
+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."
+readme = "README.md"
+requires-python = ">=3.9"
+keywords = ["python", "tools", "utilities"]
+license = {file = "LICENSE"}
+classifiers = [
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering",
+    "Operating System :: OS Independent",
+]
+maintainers = [
+    {name = "Étienne Labbé (Labbeti)", email = "labbeti.pub@gmail.com"},
+]
+dynamic = ["version"]
+dependencies = [
+    "typing-extensions>=4.10.0",
+]
+
+[project.urls]
+Homepage = "https://pypi.org/project/pythonwrench/"
+Documentation = "https://pythonwrench.readthedocs.io/"
+Repository = "https://github.com/Labbeti/pythonwrench.git"
+Changelog = "https://github.com/Labbeti/pythonwrench/blob/main/CHANGELOG.md"
+Tracker = "https://github.com/Labbeti/pythonwrench/issues"
+
+[project.scripts]
+pythonwrench-info = "pythonwrench.entries:print_install_info"
+pythonwrench-tree = "pythonwrench.entries:main_tree"
+pythonwrench-safe-rmdir = "pythonwrench.entries:main_safe_rmdir"
+
+[build-system]
+requires = ["setuptools >= 61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]  # list of folders that contain the packages (["."] by default)
+# package names should match these glob patterns (["*"] by default)
+# note: star after package names is required to work
+include = ["pythonwrench*"]
+
+[tool.setuptools.dynamic]
+version = {attr = "pythonwrench.__version__"}
+
+[tool.pyright]
+include = ["src"]
+exclude = ["**/__pycache__"]
+pythonVersion = "3.9"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.coverage.run]
+source = ["src"]
+
+[tool.ruff.lint.extend-per-file-ignores]
+"__init__.py" = ["F401", "F403"]
+
+[tool.uv.sources]
+pythonwrench = { workspace = true }
+
+[dependency-groups]
+dev = [
+    "coverage[toml]>=7.9.1",
+    "flake8>=7.2.0",
+    "ipykernel>=6.29.5",
+    "ipython>=8.18.1",
+    "pre-commit>=4.2.0",
+    "pytest>=8.4.1",
+    "pythonwrench",
+    "ruff>=0.12.0",
+    "setuptools>=80.9.0",
+    "sphinx>=7.4.7",
+    "sphinx-press-theme>=0.8.0",
+    "twine>=6.1.0",
+]

pythonwrench-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pythonwrench-0.1.0/setup.py

@@ -0,0 +1,7 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from setuptools import setup
+
+if __name__ == "__main__":
+    setup()

pythonwrench-0.1.0/src/pythonwrench/__init__.py

@@ -0,0 +1,174 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""Set of tools for Python that could be in the standard library."""
+
+__name__ = "pythonwrench"
+__author__ = "Étienne Labbé (Labbeti)"
+__author_email__ = "labbeti.pub@gmail.com"
+__license__ = "MIT"
+__maintainer__ = "Étienne Labbé (Labbeti)"
+__status__ = "Development"
+__version__ = "0.1.0"
+
+
+# Re-import for language servers
+from . import abc as abc
+from . import argparse as argparse
+from . import collections as collections
+from . import csv as csv
+from . import dataclasses as dataclasses
+from . import datetime as datetime
+from . import difflib as difflib
+from . import entries as entries
+from . import enum as enum
+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 logging as logging
+from . import math as math
+from . import os as os
+from . import pickle as pickle
+from . import random as random
+from . import re as re
+from . import semver as semver
+from . import warnings as warnings
+
+# Global library imports
+from .abc import Singleton
+from .argparse import (
+    str_to_bool,
+    str_to_optional_bool,
+    str_to_optional_float,
+    str_to_optional_int,
+    str_to_optional_str,
+)
+from .checksum import checksum_any, register_checksum_fn
+from .collections import (
+    all_eq,
+    all_ne,
+    contained,
+    dict_list_to_list_dict,
+    dump_dict,
+    filter_iterable,
+    find,
+    flat_dict_of_dict,
+    flat_list_of_list,
+    flatten,
+    intersect,
+    intersect_lists,
+    is_full,
+    is_sorted,
+    is_unique,
+    list_dict_to_dict_list,
+    prod,
+    recursive_generator,
+    reduce_add,
+    reduce_and,
+    reduce_mul,
+    reduce_or,
+    shuffled,
+    sorted_dict,
+    sum,
+    unflat_dict_of_dict,
+    unflat_list_of_list,
+    union,
+    union_dicts,
+    union_lists,
+    unzip,
+)
+from .csv import dump_csv, load_csv
+from .dataclasses import get_defaults_values
+from .datetime import get_now, get_now_iso8601
+from .difflib import find_closest_in_list, sequence_matcher_ratio
+from .enum import StrEnum
+from .functools import (
+    Compose,
+    compose,
+    disk_cache_call,
+    disk_cache_decorator,
+    filter_and_call,
+    function_alias,
+    get_argnames,
+    identity,
+)
+from .hashlib import hash_file
+from .importlib import (
+    is_available_package,
+    is_editable_package,
+    reload_editable_packages,
+    reload_submodules,
+    search_submodules,
+)
+from .inspect import get_current_fn_name, get_fullname
+from .json import dump_json, load_json
+from .logging import (
+    VERBOSE_DEBUG,
+    VERBOSE_ERROR,
+    VERBOSE_INFO,
+    VERBOSE_WARNING,
+    MkdirFileHandler,
+    get_current_file_logger,
+    get_ipython_name,
+    get_null_logger,
+    log_once,
+    running_on_interpreter,
+    running_on_notebook,
+    running_on_terminal,
+    setup_logging_level,
+    setup_logging_verbose,
+)
+from .math import argmax, argmin, argsort, clamp, clip
+from .os import get_num_cpus_available, safe_rmdir, tree_iter
+from .pickle import dump_pickle, load_pickle
+from .random import randstr
+from .re import (
+    PatternLike,
+    PatternListLike,
+    compile_patterns,
+    find_patterns,
+    get_key_fn,
+    match_patterns,
+    sort_with_patterns,
+)
+from .semver import Version
+from .typing import (
+    BuiltinCollection,
+    BuiltinNumber,
+    BuiltinScalar,
+    DataclassInstance,
+    EllipsisType,
+    NamedTupleInstance,
+    NoneType,
+    SupportsAdd,
+    SupportsAnd,
+    SupportsBool,
+    SupportsGetitemIterLen,
+    SupportsGetitemLen,
+    SupportsIterLen,
+    SupportsMul,
+    SupportsOr,
+    T_BuiltinNumber,
+    T_BuiltinScalar,
+    is_builtin_number,
+    is_builtin_obj,
+    is_builtin_scalar,
+    is_dataclass_instance,
+    is_iterable_bool,
+    is_iterable_bytes_or_list,
+    is_iterable_float,
+    is_iterable_int,
+    is_iterable_integral,
+    is_iterable_str,
+    is_namedtuple_instance,
+    is_sequence_str,
+    is_typed_dict,
+    isinstance_generic,
+)
+from .warnings import deprecated_alias, deprecated_function, warn_once
+
+version = __version__
+version_info = Version(__version__)

pythonwrench-0.1.0/src/pythonwrench/__main__.py

@@ -0,0 +1,7 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from .entries import print_install_info
+
+if __name__ == "__main__":
+    print_install_info()

pythonwrench-0.1.0/src/pythonwrench/_core.py

@@ -0,0 +1,42 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from functools import wraps
+from typing import Any, Callable, Optional, TypeVar
+
+from typing_extensions import ParamSpec
+
+P = ParamSpec("P")
+T = TypeVar("T")
+U = TypeVar("U")
+
+
+def return_none(*args, **kwargs) -> None:
+    """Return None function placeholder."""
+    return None
+
+
+def _decorator_factory(
+    inner_fn: Optional[Callable[P, U]],
+    *,
+    pre_fn: Callable[..., Any] = return_none,
+    post_fn: Callable[..., Any] = return_none,
+) -> Callable[..., Callable[P, U]]:
+    """Deprecated decorator for function aliases."""
+
+    def wrapper_factory(fn: Callable[P, U]) -> Callable[P, U]:
+        if inner_fn is None:
+            _inner_fn = fn
+        else:
+            _inner_fn = inner_fn
+
+        @wraps(_inner_fn)
+        def wrapped(*args: P.args, **kwargs: P.kwargs) -> U:
+            pre_fn(fn, *args, **kwargs)
+            result = _inner_fn(*args, **kwargs)
+            post_fn(fn, *args, **kwargs)
+            return result
+
+        return wrapped
+
+    return wrapper_factory