dycw-utilities 0.166.30__py3-none-any.whl → 0.175.17__py3-none-any.whl

utilities/tempfile.py

@@ -1,13 +1,17 @@
 from __future__ import annotations
 
 import tempfile
+from contextlib import contextmanager
 from pathlib import Path
+from shutil import move
+from tempfile import NamedTemporaryFile as _NamedTemporaryFile
 from tempfile import gettempdir as _gettempdir
 from typing import TYPE_CHECKING, override
 
 from utilities.warnings import suppress_warnings
 
 if TYPE_CHECKING:
+    from collections.abc import Iterator
     from types import TracebackType
 
     from utilities.types import PathLike
@@ -66,6 +70,61 @@ class _TemporaryDirectoryNoResourceWarning(tempfile.TemporaryDirectory):
 ##
 
 
+@contextmanager
+def TemporaryFile(  # noqa: N802
+    *,
+    suffix: str | None = None,
+    prefix: str | None = None,
+    dir: PathLike | None = None,  # noqa: A002
+    ignore_cleanup_errors: bool = False,
+    delete: bool = True,
+    name: str | None = None,
+    text: str | None = None,
+) -> Iterator[Path]:
+    """Yield a temporary file."""
+    with _temporary_file_inner(
+        suffix=suffix,
+        prefix=prefix,
+        dir=dir,
+        ignore_cleanup_errors=ignore_cleanup_errors,
+        delete=delete,
+        name=name,
+    ) as temp:
+        if text is not None:
+            _ = temp.write_text(text)
+        yield temp
+
+
+@contextmanager
+def _temporary_file_inner(
+    *,
+    suffix: str | None = None,
+    prefix: str | None = None,
+    dir: PathLike | None = None,  # noqa: A002
+    ignore_cleanup_errors: bool = False,
+    delete: bool = True,
+    name: str | None = None,
+) -> Iterator[Path]:
+    with TemporaryDirectory(
+        suffix=suffix,
+        prefix=prefix,
+        dir=dir,
+        ignore_cleanup_errors=ignore_cleanup_errors,
+        delete=delete,
+    ) as temp_dir:
+        temp_file = _NamedTemporaryFile(  # noqa: SIM115
+            dir=temp_dir, delete=delete, delete_on_close=False
+        )
+        if name is None:
+            yield temp_dir / temp_file.name
+        else:
+            _ = move(temp_dir / temp_file.name, temp_dir / name)
+            yield temp_dir / name
+
+
+##
+
+
 def gettempdir() -> Path:
     """Get the name of the directory used for temporary files."""
     return Path(_gettempdir())
@@ -74,4 +133,4 @@ def gettempdir() -> Path:
 TEMP_DIR = gettempdir()
 
 
-__all__ = ["TEMP_DIR", "TemporaryDirectory", "gettempdir"]
+__all__ = ["TEMP_DIR", "TemporaryDirectory", "TemporaryFile", "gettempdir"]

utilities/text.py

@@ -31,7 +31,15 @@ if TYPE_CHECKING:
     from utilities.types import MaybeCallableBoolLike, MaybeCallableStr, StrStrMapping
 
 
-DEFAULT_SEPARATOR = ","
+_DEFAULT_SEPARATOR = ","
+
+
+##
+
+
+def kebab_case(text: str, /) -> str:
+    """Convert text into kebab case."""
+    return _kebab_snake_case(text, "-")
 
 
 ##
@@ -110,27 +118,13 @@ def repr_encode(obj: Any, /) -> bytes:
 
 def snake_case(text: str, /) -> str:
     """Convert text into snake case."""
-    leading = bool(search(r"^_", text))
-    trailing = bool(search(r"_$", text))
-    parts = _SPLIT_TEXT.findall(text)
-    parts = (p for p in parts if len(p) >= 1)
-    parts = chain([""] if leading else [], parts, [""] if trailing else [])
-    return "_".join(parts).lower()
+    return _kebab_snake_case(text, "_")
 
 
-_SPLIT_TEXT = re.compile(
-    r"""
-    [A-Z]+(?=[A-Z][a-z0-9]) | # all caps followed by Upper+lower or digit (API in APIResponse2)
-    [A-Z]?[a-z]+[0-9]*      | # normal words with optional trailing digits (Text123)
-    [A-Z]+[0-9]*            | # consecutive caps with optional trailing digits (ID2)
-    """,
-    flags=VERBOSE,
-)
-
 ##
 
 
-LIST_SEPARATOR = DEFAULT_SEPARATOR
+LIST_SEPARATOR = _DEFAULT_SEPARATOR
 PAIR_SEPARATOR = "="
 BRACKETS = [("(", ")"), ("[", "]"), ("{", "}")]
 
@@ -140,7 +134,7 @@ def split_key_value_pairs(
     text: str,
     /,
     *,
-    list_separator: str = DEFAULT_SEPARATOR,
+    list_separator: str = _DEFAULT_SEPARATOR,
     pair_separator: str = PAIR_SEPARATOR,
     brackets: Iterable[tuple[str, str]] | None = BRACKETS,
     mapping: Literal[True],
@@ -150,7 +144,7 @@ def split_key_value_pairs(
     text: str,
     /,
     *,
-    list_separator: str = DEFAULT_SEPARATOR,
+    list_separator: str = _DEFAULT_SEPARATOR,
     pair_separator: str = PAIR_SEPARATOR,
     brackets: Iterable[tuple[str, str]] | None = BRACKETS,
     mapping: Literal[False] = False,
@@ -160,7 +154,7 @@ def split_key_value_pairs(
     text: str,
     /,
     *,
-    list_separator: str = DEFAULT_SEPARATOR,
+    list_separator: str = _DEFAULT_SEPARATOR,
     pair_separator: str = PAIR_SEPARATOR,
     brackets: Iterable[tuple[str, str]] | None = BRACKETS,
     mapping: bool = False,
@@ -169,7 +163,7 @@ def split_key_value_pairs(
     text: str,
     /,
     *,
-    list_separator: str = DEFAULT_SEPARATOR,
+    list_separator: str = _DEFAULT_SEPARATOR,
     pair_separator: str = PAIR_SEPARATOR,
     brackets: Iterable[tuple[str, str]] | None = BRACKETS,
     mapping: bool = False,
@@ -228,7 +222,7 @@ def split_str(
     text: str,
     /,
     *,
-    separator: str = DEFAULT_SEPARATOR,
+    separator: str = _DEFAULT_SEPARATOR,
     brackets: Iterable[tuple[str, str]] | None = None,
     n: Literal[1],
 ) -> tuple[str]: ...
@@ -237,7 +231,7 @@ def split_str(
     text: str,
     /,
     *,
-    separator: str = DEFAULT_SEPARATOR,
+    separator: str = _DEFAULT_SEPARATOR,
     brackets: Iterable[tuple[str, str]] | None = None,
     n: Literal[2],
 ) -> tuple[str, str]: ...
@@ -246,7 +240,7 @@ def split_str(
     text: str,
     /,
     *,
-    separator: str = DEFAULT_SEPARATOR,
+    separator: str = _DEFAULT_SEPARATOR,
     brackets: Iterable[tuple[str, str]] | None = None,
     n: Literal[3],
 ) -> tuple[str, str, str]: ...
@@ -255,7 +249,7 @@ def split_str(
     text: str,
     /,
     *,
-    separator: str = DEFAULT_SEPARATOR,
+    separator: str = _DEFAULT_SEPARATOR,
     brackets: Iterable[tuple[str, str]] | None = None,
     n: Literal[4],
 ) -> tuple[str, str, str, str]: ...
@@ -264,7 +258,7 @@ def split_str(
     text: str,
     /,
     *,
-    separator: str = DEFAULT_SEPARATOR,
+    separator: str = _DEFAULT_SEPARATOR,
     brackets: Iterable[tuple[str, str]] | None = None,
     n: Literal[5],
 ) -> tuple[str, str, str, str, str]: ...
@@ -273,7 +267,7 @@ def split_str(
     text: str,
     /,
     *,
-    separator: str = DEFAULT_SEPARATOR,
+    separator: str = _DEFAULT_SEPARATOR,
     brackets: Iterable[tuple[str, str]] | None = None,
     n: int | None = None,
 ) -> tuple[str, ...]: ...
@@ -281,7 +275,7 @@ def split_str(
     text: str,
     /,
     *,
-    separator: str = DEFAULT_SEPARATOR,
+    separator: str = _DEFAULT_SEPARATOR,
     brackets: Iterable[tuple[str, str]] | None = None,
     n: int | None = None,
 ) -> tuple[str, ...]:
@@ -306,7 +300,7 @@ def _split_str_brackets(
     brackets: Iterable[tuple[str, str]],
     /,
     *,
-    separator: str = DEFAULT_SEPARATOR,
+    separator: str = _DEFAULT_SEPARATOR,
 ) -> list[str]:
     brackets = list(brackets)
     opens, closes = transpose(brackets)
@@ -397,7 +391,7 @@ class _SplitStrOpeningBracketUnmatchedError(SplitStrError):
 
 
 def join_strs(
-    texts: Iterable[str], /, *, sort: bool = False, separator: str = DEFAULT_SEPARATOR
+    texts: Iterable[str], /, *, sort: bool = False, separator: str = _DEFAULT_SEPARATOR
 ) -> str:
     """Join a collection of strings, with a special provision for the empty list."""
     texts = list(texts)
@@ -410,7 +404,7 @@ def join_strs(
     return separator.join(texts)
 
 
-def _escape_separator(*, separator: str = DEFAULT_SEPARATOR) -> str:
+def _escape_separator(*, separator: str = _DEFAULT_SEPARATOR) -> str:
     return f"\\{separator}"
 
 
@@ -513,9 +507,30 @@ def unique_str() -> str:
     return f"{now}_{pid}_{ident}_{key}"
 
 
+##
+
+
+def _kebab_snake_case(text: str, separator: str, /) -> str:
+    """Convert text into kebab/snake case."""
+    leading = bool(search(r"^_", text))
+    trailing = bool(search(r"_$", text))
+    parts = _SPLIT_TEXT.findall(text)
+    parts = (p for p in parts if len(p) >= 1)
+    parts = chain([""] if leading else [], parts, [""] if trailing else [])
+    return separator.join(parts).lower()
+
+
+_SPLIT_TEXT = re.compile(
+    r"""
+    [A-Z]+(?=[A-Z][a-z0-9]) | # all caps followed by Upper+lower or digit (API in APIResponse2)
+    [A-Z]?[a-z]+[0-9]*      | # normal words with optional trailing digits (Text123)
+    [A-Z]+[0-9]*            | # consecutive caps with optional trailing digits (ID2)
+    """,
+    flags=VERBOSE,
+)
+
 __all__ = [
     "BRACKETS",
-    "DEFAULT_SEPARATOR",
     "LIST_SEPARATOR",
     "PAIR_SEPARATOR",
     "ParseBoolError",
@@ -523,6 +538,7 @@ __all__ = [
     "SplitKeyValuePairsError",
     "SplitStrError",
     "join_strs",
+    "kebab_case",
     "parse_bool",
     "parse_none",
     "pascal_case",

utilities/timer.py

@@ -56,11 +56,11 @@ class Timer:
 
     @override
     def __repr__(self) -> str:
-        return self.timedelta.format_common_iso()
+        return self.timedelta.format_iso()
 
     @override
     def __str__(self) -> str:
-        return self.timedelta.format_common_iso()
+        return self.timedelta.format_iso()
 
     # comparison
 

utilities/traceback.py

@@ -98,7 +98,7 @@ def _yield_header_lines(
     yield f"Date/time  | {format_compact(now)}"
     start_use = to_zoned_date_time(start).to_tz(LOCAL_TIME_ZONE_NAME)
     yield f"Started    | {format_compact(start_use)}"
-    yield f"Duration   | {(now - start_use).format_common_iso()}"
+    yield f"Duration   | {(now - start_use).format_iso()}"
     yield f"User       | {getuser()}"
     yield f"Host       | {gethostname()}"
     yield f"Process ID | {getpid()}"

utilities/types.py

@@ -231,6 +231,10 @@ type Seed = int | float | str | bytes | bytearray | Random
 type PatternLike = MaybeStr[Pattern[str]]
 
 
+# retry
+type Retry = tuple[int, Delta | None]
+
+
 # text
 type MaybeCallableStr = MaybeCallable[str]
 
@@ -332,6 +336,7 @@ __all__ = [
     "PathLike",
     "PatternLike",
     "PlainDateTimeLike",
+    "Retry",
     "Seed",
     "SequenceStr",
     "SerializeObjectExtra",

utilities/typing.py

@@ -42,7 +42,13 @@ from whenever import (
 
 from utilities.iterables import unique_everseen
 from utilities.sentinel import Sentinel
-from utilities.types import Dataclass, StrMapping, TupleOrStrMapping, TypeLike
+from utilities.types import (
+    Dataclass,
+    StrMapping,
+    StrStrMapping,
+    TupleOrStrMapping,
+    TypeLike,
+)
 
 
 def get_args(obj: Any, /, *, optional_drop_none: bool = False) -> tuple[Any, ...]:
@@ -58,7 +64,7 @@ def get_args(obj: Any, /, *, optional_drop_none: bool = False) -> tuple[Any, ...
 ##
 
 
-def get_forward_ref_args(obj: Any, /) -> Mapping[str, str]:
+def get_forward_ref_args(obj: Any, /) -> StrStrMapping:
     """Get the forward args."""
     return {
         k: v.__forward_arg__

utilities/whenever.py

@@ -433,6 +433,36 @@ TODAY_LOCAL = get_today_local()
 ##
 
 
+def is_weekend(
+    date_time: ZonedDateTime,
+    /,
+    *,
+    start: tuple[Weekday, Time] = (Weekday.SATURDAY, Time.MIN),
+    end: tuple[Weekday, Time] = (Weekday.SUNDAY, Time.MAX),
+) -> bool:
+    """Check if a datetime is in the weekend."""
+    weekday, time = date_time.date().day_of_week(), date_time.time()
+    start_weekday, start_time = start
+    end_weekday, end_time = end
+    if start_weekday.value == end_weekday.value:
+        return start_time <= time <= end_time
+    if start_weekday.value < end_weekday.value:
+        return (
+            ((weekday == start_weekday) and (time >= start_time))
+            or (start_weekday.value < weekday.value < end_weekday.value)
+            or ((weekday == end_weekday) and (time <= end_time))
+        )
+    return (
+        ((weekday == start_weekday) and (time >= start_time))
+        or (weekday.value > start_weekday.value)
+        or (weekday.value < end_weekday.value)
+        or ((weekday == end_weekday) and (time <= end_time))
+    )
+
+
+##
+
+
 def mean_datetime(
     datetimes: Iterable[ZonedDateTime],
     /,
@@ -892,7 +922,7 @@ def to_date(
         case None:
             return get_today(time_zone)
         case str():
-            return Date.parse_common_iso(date)
+            return Date.parse_iso(date)
         case dt.date():
             return Date.from_py_date(date)
         case Callable() as func:
@@ -1475,7 +1505,7 @@ def to_time(
         case None:
             return get_time(time_zone)
         case str():
-            return Time.parse_common_iso(time)
+            return Time.parse_iso(time)
         case dt.time():
             return Time.from_py_time(time)
         case Callable() as func:
@@ -1703,7 +1733,7 @@ def to_zoned_date_time(
         case None:
             return get_now(UTC if time_zone is None else time_zone)
         case str() as text:
-            date_time_use = ZonedDateTime.parse_common_iso(text.replace("~", "/"))
+            date_time_use = ZonedDateTime.parse_iso(text.replace("~", "/"))
         case dt.datetime() as py_date_time:
             if isinstance(date_time.tzinfo, ZoneInfo):
                 py_date_time_use = py_date_time
@@ -1767,7 +1797,7 @@ class WheneverLogRecord(LogRecord):
             name, level, pathname, lineno, msg, args, exc_info, func, sinfo
         )
         length = self._get_length()
-        plain = format(get_now_local().to_plain().format_common_iso(), f"{length}s")
+        plain = format(get_now_local().to_plain().format_iso(), f"{length}s")
         self.zoned_datetime = f"{plain}[{LOCAL_TIME_ZONE_NAME}]"
 
     @classmethod
@@ -1775,7 +1805,7 @@ class WheneverLogRecord(LogRecord):
     def _get_length(cls) -> int:
         """Get maximum length of a formatted string."""
         now = get_now_local().replace(nanosecond=1000).to_plain()
-        return len(now.format_common_iso())
+        return len(now.format_iso())
 
 
 ##
@@ -2033,6 +2063,7 @@ __all__ = [
     "get_time_local",
     "get_today",
     "get_today_local",
+    "is_weekend",
     "mean_datetime",
     "min_max_date",
     "round_date_or_date_time",

dycw_utilities-0.166.30.dist-info/METADATA

@@ -1,41 +0,0 @@
-Metadata-Version: 2.4
-Name: dycw-utilities
-Version: 0.166.30
-Author-email: Derek Wan <d.wan@icloud.com>
-License-File: LICENSE
-Requires-Python: >=3.12
-Requires-Dist: atomicwrites<1.5,>=1.4.1
-Requires-Dist: typing-extensions<4.16,>=4.15.0
-Requires-Dist: tzlocal<5.4,>=5.3.1
-Requires-Dist: whenever<0.9,>=0.8.8
-Provides-Extra: logging
-Requires-Dist: coloredlogs<15.1,>=15.0.1; extra == 'logging'
-Provides-Extra: test
-Requires-Dist: dycw-pytest-only<2.2,>=2.1.1; extra == 'test'
-Requires-Dist: hypothesis<6.139,>=6.138.16; extra == 'test'
-Requires-Dist: pytest-asyncio<1.3,>=1.2.0; extra == 'test'
-Requires-Dist: pytest-cov<7.1,>=7.0.0; extra == 'test'
-Requires-Dist: pytest-instafail<0.6,>=0.5.0; extra == 'test'
-Requires-Dist: pytest-lazy-fixtures<1.4,>=1.3.4; extra == 'test'
-Requires-Dist: pytest-randomly<4.1,>=4.0.1; extra == 'test'
-Requires-Dist: pytest-regressions<2.9,>=2.8.3; extra == 'test'
-Requires-Dist: pytest-repeat<0.10,>=0.9.4; extra == 'test'
-Requires-Dist: pytest-rerunfailures<16.1,>=16.0.1; extra == 'test'
-Requires-Dist: pytest-rng<1.1,>=1.0.0; extra == 'test'
-Requires-Dist: pytest-timeout<2.5,>=2.4.0; extra == 'test'
-Requires-Dist: pytest-xdist<3.9,>=3.8.0; extra == 'test'
-Requires-Dist: pytest<8.5,>=8.4.2; extra == 'test'
-Requires-Dist: testbook<0.5,>=0.4.2; extra == 'test'
-Description-Content-Type: text/markdown
-
-[![PyPI version](https://badge.fury.io/py/dycw-utilities.svg)](https://badge.fury.io/py/dycw-utilities)
-
-# `dycw-utilities`
-
-[All the Python functions I don't want to write twice.](https://github.com/nvim-lua/plenary.nvim)
-
-## Installation
-
-- `pip install dycw-utilities`
-
-or with [extras](https://github.com/dycw/python-utilities/blob/master/pyproject.toml).

dycw_utilities-0.166.30.dist-info/WHEEL

@@ -1,4 +0,0 @@
-Wheel-Version: 1.0
-Generator: hatchling 1.27.0
-Root-Is-Purelib: true
-Tag: py3-none-any

dycw_utilities-0.166.30.dist-info/licenses/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Derek Wan
-
-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.