klaatu-python 2.3.0__tar.gz → 2.4.0__tar.gz

{klaatu_python-2.3.0 → klaatu_python-2.4.0}/PKG-INFO

@@ -1,20 +1,15 @@
 Metadata-Version: 2.4
 Name: klaatu-python
-Version: 2.3.0
+Version: 2.4.0
+Author: Robert Huselius
 Author-email: Robert Huselius <robert@huseli.us>
 License-Expression: GPL-3.0-only
+License-File: LICENSE
+Requires-Python: >=3.10
 Project-URL: Homepage, https://github.com/Eboreg/klaatu-python
 Project-URL: Issues, https://github.com/Eboreg/klaatu-python/issues
 Project-URL: Source, https://github.com/Eboreg/klaatu-python
-Requires-Python: >=3.7
 Description-Content-Type: text/markdown
-License-File: LICENSE
-Provides-Extra: dev
-Requires-Dist: ipython; extra == "dev"
-Requires-Dist: ipdb; extra == "dev"
-Requires-Dist: isort; extra == "dev"
-Requires-Dist: pylint; extra == "dev"
-Dynamic: license-file
 
 # klaatu-python
 

klaatu_python-2.4.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["uv_build>=0.9.7,<0.10.0"]
+build-backend = "uv_build"
+
+[project]
+authors = [
+    {name = "Robert Huselius", email = "robert@huseli.us"},
+]
+license = "GPL-3.0-only"
+license-files = ["LICENSE"]
+name = "klaatu-python"
+readme = "README.md"
+requires-python = ">=3.10"
+version = "2.4.0"
+
+[project.urls]
+Homepage = "https://github.com/Eboreg/klaatu-python"
+Issues = "https://github.com/Eboreg/klaatu-python/issues"
+Source = "https://github.com/Eboreg/klaatu-python"
+
+[tool.ruff]
+line-length = 120
+target-version = "py311"
+exclude = [".venv", ".git", ".mypy_cache", "__pycache__", "build", "node_modules"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "B", "I"]
+ignore = ["E722"]
+
+[tool.ruff.lint.isort]
+lines-after-imports = 2
+combine-as-imports = true
+default-section = "third-party"
+section-order = [
+    "future",
+    "standard-library",
+    "third-party",
+    "first-party",
+    "local-folder",
+]
+
+[tool.ruff.format]
+skip-magic-trailing-comma = false
+
+[tool.flake8]
+max-doc-length = 79
+max-line-length = 119

{klaatu_python-2.3.0 → klaatu_python-2.4.0/src}/klaatu_python/case.py

@@ -5,19 +5,19 @@ from abc import abstractmethod
 class CaseType:
     @staticmethod
     @abstractmethod
-    def split(value: str) -> list[str]:
-        ...
+    def split(value: str) -> list[str]: ...
 
     @staticmethod
     @abstractmethod
-    def join(parts: list[str]) -> str:
-        ...
+    def join(parts: list[str]) -> str: ...
 
 
 class CamelCase(CaseType):
+    """camelCase"""
+
     @staticmethod
     def split(value: str) -> list[str]:
-        return [m.group() for m in re.finditer(r"(^[a-z]*)|([A-Z][a-z]*)", value)]
+        return [m.group() for m in re.finditer(r"(^[a-z]+)|([A-Z][a-z]*)", value)]
 
     @staticmethod
     def join(parts: list[str]) -> str:
@@ -27,6 +27,8 @@ class CamelCase(CaseType):
 
 
 class ConstantCase(CaseType):
+    """CONSTANT_CASE"""
+
     @staticmethod
     def split(value: str) -> list[str]:
         return value.split("_")
@@ -37,6 +39,8 @@ class ConstantCase(CaseType):
 
 
 class KebabCase(CaseType):
+    """kebab-case"""
+
     @staticmethod
     def split(value: str) -> list[str]:
         return value.split("-")
@@ -47,9 +51,11 @@ class KebabCase(CaseType):
 
 
 class PascalCase(CaseType):
+    """PascalCase"""
+
     @staticmethod
     def split(value: str) -> list[str]:
-        return [m.group() for m in re.finditer(r"(^[a-z]*)|([A-Z][a-z]*)", value)]
+        return [m.group() for m in re.finditer(r"(^[a-z]+)|([A-Z][a-z]*)", value)]
 
     @staticmethod
     def join(parts: list[str]) -> str:
@@ -57,6 +63,8 @@ class PascalCase(CaseType):
 
 
 class SnakeCase(CaseType):
+    """snake_case"""
+
     @staticmethod
     def split(value: str) -> list[str]:
         return value.split("_")

{klaatu_python-2.3.0 → klaatu_python-2.4.0/src}/klaatu_python/lock.py

@@ -2,12 +2,12 @@ import functools
 import os
 
 
-class LockException(Exception):
-    ...
+class LockException(Exception): ...
 
 
 class Lock:
     """Does the same as `lock`, but as a context manager."""
+
     def __init__(self, lockfile: str):
         self.lockfile = lockfile
 
@@ -26,6 +26,7 @@ class Lock:
 
 def lock(lockfile: str):
     """Primitive mechanism to avoid concurrent execution of a function."""
+
     def decorator(func):
         @functools.wraps(func)
         def wrapper(*args, **kwargs):
@@ -44,5 +45,7 @@ def lock(lockfile: str):
                 remote_attempts += 1
 
             return result
+
         return wrapper
+
     return decorator

{klaatu_python-2.3.0 → klaatu_python-2.4.0/src}/klaatu_python/utils.py

@@ -1,16 +1,20 @@
+import itertools
 import re
+from collections.abc import Callable, Hashable, Iterable, Iterator, Sequence
 from datetime import date, timedelta
 from locale import format_string, localeconv
 from math import ceil, floor, log10
-from typing import Any, Callable, Iterable, Iterator, Literal, Sequence, TypeVar, overload
+from pathlib import Path
+from typing import Any, Literal, TypeVar, overload
 from urllib.parse import parse_qs, urlencode, urlsplit, urlunsplit
 
 
 _T = TypeVar("_T")
 _NT = TypeVar("_NT", int, float)
+_HashableT = TypeVar("_HashableT", bound=Hashable)
 
 
-def append_query_to_url(url: str, params: dict, conditional_params: dict | None = None, safe: str = '') -> str:
+def append_query_to_url(url: str, params: dict, conditional_params: dict | None = None, safe: str = "") -> str:
     """
     Adds GET query from `params` to `url`, or appends it if there already is
     one.
@@ -66,6 +70,31 @@ def daterange(start_date: date, end_date: date) -> Iterator[date]:
         yield start_date + timedelta(days=n)
 
 
+def deepest_common_path(path1: Path, *paths: Path) -> Path:
+    """
+    Finds and returns the deepest (as in "deep in the directory structure")
+    path that all parameters have in common.
+
+    Example:
+    >>> deepest_common_path(Path("/usr/local/bin/"), Path("/usr/share/"))
+    PosixPath('/usr')
+    """
+    path1 = path1.resolve()
+    paths = tuple(p.resolve() for p in paths)
+
+    # Returned iterator will contain None unless all paths are identical:
+    if all(itertools.accumulate([path1, *paths], lambda p1, p2: p1 if p1 == p2 else None)):
+        return path1
+
+    paths_parts = [[p, *p.parents] for p in paths]
+
+    for part in [path1, *path1.parents]:
+        if all(part in parts for parts in paths_parts):
+            return part
+
+    raise ValueError("No common paths")
+
+
 def filter_values_not_null(d: dict) -> dict:
     return {k: v for k, v in d.items() if v is not None}
 
@@ -226,9 +255,8 @@ def int_to_string(value: int | None, locale: str, nbsp: bool = False) -> str:
     # 5. Re-reverse the digits in each group & join them with separator string
     # 6. Re-reverse the order of the groups
     # 7. Add minus sign if value was negative
-    return (
-        ("-" if value < 0 else "") +
-        separator.join([v[::-1] for v in re.split(r"(\d{3})", str(abs(value))[::-1]) if v][::-1])
+    return ("-" if value < 0 else "") + separator.join(
+        [v[::-1] for v in re.split(r"(\d{3})", str(abs(value))[::-1]) if v][::-1]
     )
 
 
@@ -271,6 +299,27 @@ def localize_float(
     return ret
 
 
+def most_common(values: Iterable[_HashableT]) -> tuple[_HashableT | None, int]:
+    """
+    Given a non-empty iterable, this will return a 2-tuple with the most
+    commonly occurring value in said iterable, and the number of such
+    occurances.
+
+    Given an _empty_ iterable, it will return `(None, 0)`.
+    """
+    occurrences: dict[_HashableT, int] = {}
+
+    for value in values:
+        if value not in occurrences:
+            occurrences[value] = 0
+        occurrences[value] += 1
+
+    if not occurrences:
+        return None, 0
+
+    return max(occurrences.items(), key=lambda tup: tup[1])
+
+
 def nonulls(items: Iterable[_T | None]) -> list[_T]:
     """Just filters away None values from `items`."""
     return [item for item in items if item is not None]
@@ -280,7 +329,7 @@ def partition(items: Sequence[_T], length: int) -> Iterator[Sequence[_T]]:
     """Simply splits `items` into subsequences of max `length` items."""
     offset = 0
     while offset == 0 or offset < len(items):
-        yield items[offset:offset + length]
+        yield items[offset : offset + length]
         offset += length
 
 
@@ -290,6 +339,37 @@ def percent_rounded(part: int | float, whole: int | float) -> int:
     return round(part / whole * 100)
 
 
+def roman(n: int):
+    if n % 1:
+        raise ValueError("roman(): fractions not allowed")
+    if n >= 4000 or n < 0:
+        raise ValueError("roman(): value must be >= 0 and < 4000")
+
+    m = {
+        1000: "M",
+        900: "CM",
+        500: "D",
+        400: "CD",
+        100: "C",
+        90: "XC",
+        50: "L",
+        40: "XL",
+        10: "X",
+        9: "IX",
+        5: "V",
+        4: "IV",
+        1: "I",
+    }
+    r = ""
+
+    for k, v in m.items():
+        while n >= k:
+            r += v
+            n -= k
+
+    return r
+
+
 def round_to_n(x: int | float, n: int) -> int | float:
     """
     Rounds x to n significant digits. If the result is a whole number, it is
@@ -322,7 +402,7 @@ def rounded_percentage(part: int | float, whole: int | float, digits=3) -> int |
 def strip_url_query(url: str) -> str:
     """Just returns `url` stripped of any GET parameters."""
     parts = urlsplit(url)
-    return urlunsplit((parts.scheme, parts.netloc, parts.path, '', parts.fragment))
+    return urlunsplit((parts.scheme, parts.netloc, parts.path, "", parts.fragment))
 
 
 def to_int(value: Any, default: int | None = None) -> int | None:
@@ -341,7 +421,7 @@ def zip_dicts(*dicts: dict) -> dict:
     return {k: v for d in dicts for k, v in d.items()}
 
 
-def zip_dict_lists(dict_lists: Sequence[Sequence[dict]]) -> Iterator[dict]:
+def zip_dict_lists(dict_lists: Sequence[Sequence[dict]], strict: bool = False) -> Iterator[dict]:
     """
     Zips a list of dict lists and combines them into single dicts.
     I.e. given dict_lists = [
@@ -352,5 +432,5 @@ def zip_dict_lists(dict_lists: Sequence[Sequence[dict]]) -> Iterator[dict]:
     {a1: 1, a2: 2, a3: 5, a4: 6}
     {b1: 3, b2: 4, b3: 7, b4: 8}
     """
-    for dicts in zip(*dict_lists):
+    for dicts in zip(*dict_lists, strict=strict):
         yield zip_dicts(*dicts)

klaatu_python-2.3.0/klaatu_python.egg-info/PKG-INFO

@@ -1,40 +0,0 @@
-Metadata-Version: 2.4
-Name: klaatu-python
-Version: 2.3.0
-Author-email: Robert Huselius <robert@huseli.us>
-License-Expression: GPL-3.0-only
-Project-URL: Homepage, https://github.com/Eboreg/klaatu-python
-Project-URL: Issues, https://github.com/Eboreg/klaatu-python/issues
-Project-URL: Source, https://github.com/Eboreg/klaatu-python
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Provides-Extra: dev
-Requires-Dist: ipython; extra == "dev"
-Requires-Dist: ipdb; extra == "dev"
-Requires-Dist: isort; extra == "dev"
-Requires-Dist: pylint; extra == "dev"
-Dynamic: license-file
-
-# klaatu-python
-
-A bunch of more or less useful Python utils without any 3rd party dependencies.
-
-## Development install
-
-```shell
-python3 -m venv .venv
-source .venv/bin/activate
-pip install -e .[dev]
-```
-
-## Inclusion in projects
-
-In `pyproject.toml`:
-```
-[project]
-dependencies = [
-    "klaatu-python",
-    ...
-]
-```

klaatu_python-2.3.0/klaatu_python.egg-info/SOURCES.txt

@@ -1,12 +0,0 @@
-LICENSE
-README.md
-pyproject.toml
-klaatu_python/__init__.py
-klaatu_python/case.py
-klaatu_python/lock.py
-klaatu_python/utils.py
-klaatu_python.egg-info/PKG-INFO
-klaatu_python.egg-info/SOURCES.txt
-klaatu_python.egg-info/dependency_links.txt
-klaatu_python.egg-info/requires.txt
-klaatu_python.egg-info/top_level.txt

klaatu_python-2.3.0/klaatu_python.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

klaatu_python-2.3.0/klaatu_python.egg-info/requires.txt

@@ -1,6 +0,0 @@
-
-[dev]
-ipython
-ipdb
-isort
-pylint

klaatu_python-2.3.0/klaatu_python.egg-info/top_level.txt

@@ -1 +0,0 @@
-klaatu_python

klaatu_python-2.3.0/pyproject.toml

@@ -1,62 +0,0 @@
-[build-system]
-build-backend = "setuptools.build_meta"
-requires = ["setuptools"]
-
-[project]
-authors = [
-    {name = "Robert Huselius", email = "robert@huseli.us"},
-]
-license = "GPL-3.0-only"
-license-files = ["LICENSE"]
-name = "klaatu-python"
-readme = "README.md"
-requires-python = ">=3.7"
-version = "2.3.0"
-
-[project.optional-dependencies]
-dev = [
-    "ipython",
-    "ipdb",
-    "isort",
-    "pylint",
-]
-
-[project.urls]
-Homepage = "https://github.com/Eboreg/klaatu-python"
-Issues = "https://github.com/Eboreg/klaatu-python/issues"
-Source = "https://github.com/Eboreg/klaatu-python"
-
-[tool.isort]
-combine_as_imports = true
-default_section = "THIRDPARTY"
-include_trailing_comma = true
-known_self = "klaatu_python"
-line_length = 119
-lines_after_imports = 2
-multi_line_output = 3
-sections = ["FUTURE", "STDLIB", "THIRDPARTY", "FIRSTPARTY", "SELF", "LOCALFOLDER"]
-skip = [".venv"]
-
-[tool.pylint.main]
-disable = [
-    "broad-exception-caught",
-    "invalid-name",
-    "missing-class-docstring",
-    "missing-function-docstring",
-    "missing-module-docstring",
-    "too-many-arguments",
-    "unnecessary-lambda-assignment",
-    "unspecified-encoding",
-]
-ignore = [".venv", ".git", "__pycache__"]
-max-line-length = 119
-
-[tool.mypy]
-check_untyped_defs = true
-files = "klaatu_python"
-ignore_missing_imports = true
-show_error_codes = true
-
-[tool.flake8]
-max-doc-length = 79
-max-line-length = 119

klaatu_python-2.3.0/setup.cfg

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