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

utilities/tempfile.py

@@ -1,136 +0,0 @@
-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
-
-
-class TemporaryDirectory:
-    """Wrapper around `TemporaryDirectory` with a `Path` attribute."""
-
-    def __init__(
-        self,
-        *,
-        suffix: str | None = None,
-        prefix: str | None = None,
-        dir: PathLike | None = None,  # noqa: A002
-        ignore_cleanup_errors: bool = False,
-        delete: bool = True,
-    ) -> None:
-        super().__init__()
-        self._temp_dir = _TemporaryDirectoryNoResourceWarning(
-            suffix=suffix,
-            prefix=prefix,
-            dir=dir,
-            ignore_cleanup_errors=ignore_cleanup_errors,
-            delete=delete,
-        )
-        self.path = Path(self._temp_dir.name)
-
-    def __enter__(self) -> Path:
-        return Path(self._temp_dir.__enter__())
-
-    def __exit__(
-        self,
-        exc: type[BaseException] | None,
-        val: BaseException | None,
-        tb: TracebackType | None,
-    ) -> None:
-        self._temp_dir.__exit__(exc, val, tb)
-
-
-class _TemporaryDirectoryNoResourceWarning(tempfile.TemporaryDirectory):
-    @classmethod
-    @override
-    def _cleanup(  # pyright: ignore[reportGeneralTypeIssues]
-        cls,
-        name: str,
-        warn_message: str,
-        ignore_errors: bool = False,
-        delete: bool = True,
-    ) -> None:
-        with suppress_warnings(category=ResourceWarning):
-            return super()._cleanup(  # pyright: ignore[reportAttributeAccessIssue]
-                name, warn_message, ignore_errors=ignore_errors, delete=delete
-            )
-
-
-##
-
-
-@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())
-
-
-TEMP_DIR = gettempdir()
-
-
-__all__ = ["TEMP_DIR", "TemporaryDirectory", "TemporaryFile", "gettempdir"]

utilities/tzdata.py

@@ -1,11 +0,0 @@
-from __future__ import annotations
-
-from zoneinfo import ZoneInfo
-
-HongKong = ZoneInfo("Asia/Hong_Kong")
-Tokyo = ZoneInfo("Asia/Tokyo")
-USCentral = ZoneInfo("US/Central")
-USEastern = ZoneInfo("US/Eastern")
-
-
-__all__ = ["HongKong", "Tokyo", "USCentral", "USEastern"]

utilities/tzlocal.py

@@ -1,28 +0,0 @@
-from __future__ import annotations
-
-from logging import getLogger
-from typing import TYPE_CHECKING, cast
-
-from tzlocal import get_localzone
-
-if TYPE_CHECKING:
-    from zoneinfo import ZoneInfo
-
-    from utilities.types import TimeZone
-
-
-def get_local_time_zone() -> ZoneInfo:
-    """Get the local time zone, with the logging disabled."""
-    logger = getLogger("tzlocal")  # avoid import cycle
-    init_disabled = logger.disabled
-    logger.disabled = True
-    time_zone = get_localzone()
-    logger.disabled = init_disabled
-    return time_zone
-
-
-LOCAL_TIME_ZONE = get_local_time_zone()
-LOCAL_TIME_ZONE_NAME = cast("TimeZone", LOCAL_TIME_ZONE.key)
-
-
-__all__ = ["LOCAL_TIME_ZONE", "LOCAL_TIME_ZONE_NAME", "get_local_time_zone"]

utilities/warnings.py

@@ -1,65 +0,0 @@
-from __future__ import annotations
-
-from contextlib import ExitStack, contextmanager
-from typing import TYPE_CHECKING, Literal, TypedDict
-from warnings import catch_warnings, filterwarnings
-
-if TYPE_CHECKING:
-    from collections.abc import Iterator
-
-    from utilities.types import TypeLike
-
-
-@contextmanager
-def catch_warnings_as_errors(
-    *, message: str = "", category: TypeLike[Warning] | None = None
-) -> Iterator[None]:
-    """Catch warnings as errors."""
-    with _handle_warnings("error", message=message, category=category):
-        yield
-
-
-@contextmanager
-def suppress_warnings(
-    *, message: str = "", category: TypeLike[Warning] | None = None
-) -> Iterator[None]:
-    """Suppress warnings."""
-    with _handle_warnings("ignore", message=message, category=category):
-        yield
-
-
-_ActionKind = Literal["error", "ignore"]
-
-
-def _handle_warnings(
-    action: _ActionKind,
-    /,
-    *,
-    message: str = "",
-    category: TypeLike[Warning] | None = None,
-) -> ExitStack:
-    """Handle a set of warnings."""
-    stack = ExitStack()
-    categories = category if isinstance(category, tuple) else [category]
-    for cat in categories:
-        cm = _handle_warnings_1(action, message=message, category=cat)
-        stack.enter_context(cm)
-    return stack
-
-
-@contextmanager
-def _handle_warnings_1(
-    action: _ActionKind, /, *, message: str = "", category: type[Warning] | None = None
-) -> Iterator[None]:
-    """Handle one set of warnings."""
-
-    class Kwargs(TypedDict, total=False):
-        category: type[Warning]
-
-    with catch_warnings():
-        kwargs: Kwargs = {} if category is None else {"category": category}
-        filterwarnings(action, message=message, **kwargs)
-        yield
-
-
-__all__ = ["catch_warnings_as_errors", "suppress_warnings"]

utilities/zipfile.py

@@ -1,25 +0,0 @@
-from __future__ import annotations
-
-from contextlib import contextmanager
-from typing import TYPE_CHECKING
-from zipfile import ZipFile
-
-from utilities.tempfile import TemporaryDirectory
-
-if TYPE_CHECKING:
-    from collections.abc import Iterator
-    from pathlib import Path
-
-    from utilities.types import PathLike
-
-
-@contextmanager
-def yield_zip_file_contents(path: PathLike, /) -> Iterator[list[Path]]:
-    """Yield the contents of a zipfile in a temporary directory."""
-    with ZipFile(path) as zf, TemporaryDirectory() as temp:
-        zf.extractall(path=temp)
-        yield list(temp.iterdir())
-    _ = zf  # make coverage understand this is returned
-
-
-__all__ = ["yield_zip_file_contents"]

utilities/zoneinfo.py

@@ -1,133 +0,0 @@
-from __future__ import annotations
-
-import datetime as dt
-from dataclasses import dataclass
-from typing import TYPE_CHECKING, assert_never, cast, override
-from zoneinfo import ZoneInfo
-
-from whenever import ZonedDateTime
-
-from utilities.types import TIME_ZONES
-from utilities.tzlocal import LOCAL_TIME_ZONE, LOCAL_TIME_ZONE_NAME
-
-if TYPE_CHECKING:
-    from utilities.types import TimeZone, TimeZoneLike
-
-
-UTC = ZoneInfo("UTC")
-
-
-##
-
-
-def to_zone_info(obj: TimeZoneLike, /) -> ZoneInfo:
-    """Convert to a time-zone."""
-    match obj:
-        case ZoneInfo() as zone_info:
-            return zone_info
-        case ZonedDateTime() as date_time:
-            return ZoneInfo(date_time.tz)
-        case "local" | "localtime":
-            return LOCAL_TIME_ZONE
-        case str() as key:
-            return ZoneInfo(key)
-        case dt.tzinfo() as tzinfo:
-            if tzinfo is dt.UTC:
-                return UTC
-            raise _ToZoneInfoInvalidTZInfoError(time_zone=obj)
-        case dt.datetime() as date_time:
-            if date_time.tzinfo is None:
-                raise _ToZoneInfoPlainDateTimeError(date_time=date_time)
-            return to_zone_info(date_time.tzinfo)
-        case never:
-            assert_never(never)
-
-
-@dataclass(kw_only=True, slots=True)
-class ToTimeZoneError(Exception): ...
-
-
-@dataclass(kw_only=True, slots=True)
-class _ToZoneInfoInvalidTZInfoError(ToTimeZoneError):
-    time_zone: dt.tzinfo
-
-    @override
-    def __str__(self) -> str:
-        return f"Invalid time-zone: {self.time_zone}"
-
-
-@dataclass(kw_only=True, slots=True)
-class _ToZoneInfoPlainDateTimeError(ToTimeZoneError):
-    date_time: dt.datetime
-
-    @override
-    def __str__(self) -> str:
-        return f"Plain date-time: {self.date_time}"
-
-
-##
-
-
-def to_time_zone_name(obj: TimeZoneLike, /) -> TimeZone:
-    """Convert to a time zone name."""
-    match obj:
-        case ZoneInfo() as zone_info:
-            return cast("TimeZone", zone_info.key)
-        case ZonedDateTime() as date_time:
-            return cast("TimeZone", date_time.tz)
-        case "local" | "localtime":
-            return LOCAL_TIME_ZONE_NAME
-        case str() as time_zone:
-            if time_zone in TIME_ZONES:
-                return time_zone
-            raise _ToTimeZoneNameInvalidKeyError(time_zone=time_zone)
-        case dt.tzinfo() as tzinfo:
-            if tzinfo is dt.UTC:
-                return cast("TimeZone", UTC.key)
-            raise _ToTimeZoneNameInvalidTZInfoError(time_zone=obj)
-        case dt.datetime() as date_time:
-            if date_time.tzinfo is None:
-                raise _ToTimeZoneNamePlainDateTimeError(date_time=date_time)
-            return to_time_zone_name(date_time.tzinfo)
-        case never:
-            assert_never(never)
-
-
-@dataclass(kw_only=True, slots=True)
-class ToTimeZoneNameError(Exception): ...
-
-
-@dataclass(kw_only=True, slots=True)
-class _ToTimeZoneNameInvalidKeyError(ToTimeZoneNameError):
-    time_zone: str
-
-    @override
-    def __str__(self) -> str:
-        return f"Invalid time-zone: {self.time_zone!r}"
-
-
-@dataclass(kw_only=True, slots=True)
-class _ToTimeZoneNameInvalidTZInfoError(ToTimeZoneNameError):
-    time_zone: dt.tzinfo
-
-    @override
-    def __str__(self) -> str:
-        return f"Invalid time-zone: {self.time_zone}"
-
-
-@dataclass(kw_only=True, slots=True)
-class _ToTimeZoneNamePlainDateTimeError(ToTimeZoneNameError):
-    date_time: dt.datetime
-
-    @override
-    def __str__(self) -> str:
-        return f"Plain date-time: {self.date_time}"
-
-
-__all__ = [
-    "UTC",
-    "ToTimeZoneError",
-    "ToTimeZoneNameError",
-    "to_time_zone_name",
-    "to_zone_info",
-]