dycw-utilities 0.174.8__tar.gz → 0.174.9__tar.gz

{dycw_utilities-0.174.8 → dycw_utilities-0.174.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dycw-utilities
-Version: 0.174.8
+Version: 0.174.9
 Author: Derek Wan
 Author-email: Derek Wan <d.wan@icloud.com>
 Requires-Dist: atomicwrites>=1.4.1,<1.5

{dycw_utilities-0.174.8 → dycw_utilities-0.174.9}/pyproject.toml

@@ -101,7 +101,7 @@
   name = "dycw-utilities"
   readme = "README.md"
   requires-python = ">= 3.12"
-  version = "0.174.8"
+  version = "0.174.9"
 
   [project.entry-points.pytest11]
     pytest-randomly = "utilities.pytest_plugins.pytest_randomly"
@@ -135,7 +135,7 @@
   # bump-my-version
   [tool.bumpversion]
     allow_dirty = true
-    current_version = "0.174.8"
+    current_version = "0.174.9"
 
     [[tool.bumpversion.files]]
       filename = "src/utilities/__init__.py"

{dycw_utilities-0.174.8 → dycw_utilities-0.174.9}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.174.8"
+__version__ = "0.174.9"

{dycw_utilities-0.174.8 → dycw_utilities-0.174.9}/src/utilities/hypothesis.py

@@ -77,6 +77,7 @@ from utilities.math import (
 )
 from utilities.os import get_env_var
 from utilities.pathlib import module_path, temp_cwd
+from utilities.permissions import Permissions
 from utilities.platform import IS_LINUX
 from utilities.sentinel import Sentinel, is_sentinel, sentinel
 from utilities.tempfile import TEMP_DIR, TemporaryDirectory
@@ -864,6 +865,38 @@ def _path_parts(draw: DrawFn, /) -> str:
 ##
 
 
+@composite
+def permissions(
+    draw: DrawFn,
+    /,
+    *,
+    user_read: MaybeSearchStrategy[bool | None] = None,
+    user_write: MaybeSearchStrategy[bool | None] = None,
+    user_execute: MaybeSearchStrategy[bool | None] = None,
+    group_read: MaybeSearchStrategy[bool | None] = None,
+    group_write: MaybeSearchStrategy[bool | None] = None,
+    group_execute: MaybeSearchStrategy[bool | None] = None,
+    others_read: MaybeSearchStrategy[bool | None] = None,
+    others_write: MaybeSearchStrategy[bool | None] = None,
+    others_execute: MaybeSearchStrategy[bool | None] = None,
+) -> Permissions:
+    """Strategy for generating `Permissions`."""
+    return Permissions(
+        user_read=draw2(draw, user_read, booleans()),
+        user_write=draw2(draw, user_write, booleans()),
+        user_execute=draw2(draw, user_execute, booleans()),
+        group_read=draw2(draw, group_read, booleans()),
+        group_write=draw2(draw, group_write, booleans()),
+        group_execute=draw2(draw, group_execute, booleans()),
+        others_read=draw2(draw, others_read, booleans()),
+        others_write=draw2(draw, others_write, booleans()),
+        others_execute=draw2(draw, others_execute, booleans()),
+    )
+
+
+##
+
+
 @composite
 def plain_date_times(
     draw: DrawFn,
@@ -1611,6 +1644,7 @@ __all__ = [
     "numbers",
     "pairs",
     "paths",
+    "permissions",
     "plain_date_times",
     "py_datetimes",
     "quadruples",

dycw_utilities-0.174.9/src/utilities/permissions.py

@@ -0,0 +1,297 @@
+from __future__ import annotations
+
+from contextlib import suppress
+from dataclasses import dataclass
+from functools import reduce
+from operator import or_
+from stat import (
+    S_IRGRP,
+    S_IROTH,
+    S_IRUSR,
+    S_IWGRP,
+    S_IWOTH,
+    S_IWUSR,
+    S_IXGRP,
+    S_IXOTH,
+    S_IXUSR,
+)
+from typing import Literal, Self, override
+
+from utilities.dataclasses import replace_non_sentinel
+from utilities.functions import ensure_member
+from utilities.re import (
+    ExtractGroupError,
+    ExtractGroupsError,
+    extract_group,
+    extract_groups,
+)
+from utilities.sentinel import Sentinel, sentinel
+from utilities.typing import get_args
+
+_MIN_INT = 0o0
+_MAX_INT = 0o777
+type _ZeroToSeven = Literal[0, 1, 2, 3, 4, 5, 6, 7]
+_ZERO_TO_SEVEN: list[_ZeroToSeven] = list(get_args(_ZeroToSeven.__value__))
+
+
+@dataclass(order=True, unsafe_hash=True, kw_only=True, slots=True)
+class Permissions:
+    user_read: bool = False
+    user_write: bool = False
+    user_execute: bool = False
+    group_read: bool = False
+    group_write: bool = False
+    group_execute: bool = False
+    others_read: bool = False
+    others_write: bool = False
+    others_execute: bool = False
+
+    def __int__(self) -> int:
+        return (
+            100
+            * self._int(
+                read=self.user_read, write=self.user_write, execute=self.user_execute
+            )
+            + 10
+            * self._int(
+                read=self.group_read, write=self.group_write, execute=self.group_execute
+            )
+            + self._int(
+                read=self.others_read,
+                write=self.others_write,
+                execute=self.others_execute,
+            )
+        )
+
+    def _int(
+        self, *, read: bool = False, write: bool = False, execute: bool = False
+    ) -> _ZeroToSeven:
+        return (4 if read else 0) + (2 if write else 0) + (1 if execute else 0)
+
+    @override
+    def __repr__(self) -> str:
+        return ",".join([
+            self._repr_parts(
+                "u",
+                read=self.user_read,
+                write=self.user_write,
+                execute=self.user_execute,
+            ),
+            self._repr_parts(
+                "g",
+                read=self.group_read,
+                write=self.group_write,
+                execute=self.group_execute,
+            ),
+            self._repr_parts(
+                "o",
+                read=self.others_read,
+                write=self.others_write,
+                execute=self.others_execute,
+            ),
+        ])
+
+    def _repr_parts(
+        self,
+        prefix: Literal["u", "g", "o"],
+        /,
+        *,
+        read: bool = False,
+        write: bool = False,
+        execute: bool = False,
+    ) -> str:
+        parts: list[str] = []
+        if read:
+            parts.append("r")
+        if write:
+            parts.append("w")
+        if execute:
+            parts.append("x")
+        return f"{prefix}={''.join(parts)}"
+
+    @override
+    def __str__(self) -> str:
+        return repr(self)
+
+    @classmethod
+    def from_int(cls, n: int, /) -> Self:
+        with suppress(ExtractGroupsError):
+            user, group, others = extract_groups(r"^([0-7])([0-7])([0-7])$", str(n))
+            user_read, user_write, user_execute = cls._from_int(
+                ensure_member(int(user), _ZERO_TO_SEVEN)
+            )
+            group_read, group_write, group_execute = cls._from_int(
+                ensure_member(int(group), _ZERO_TO_SEVEN)
+            )
+            others_read, others_write, others_execute = cls._from_int(
+                ensure_member(int(others), _ZERO_TO_SEVEN)
+            )
+            return cls(
+                user_read=user_read,
+                user_write=user_write,
+                user_execute=user_execute,
+                group_read=group_read,
+                group_write=group_write,
+                group_execute=group_execute,
+                others_read=others_read,
+                others_write=others_write,
+                others_execute=others_execute,
+            )
+        with suppress(ExtractGroupsError):
+            group, others = extract_groups(r"^([0-7])([0-7])$", str(n))
+            group_read, group_write, group_execute = cls._from_int(
+                ensure_member(int(group), _ZERO_TO_SEVEN)
+            )
+            others_read, others_write, others_execute = cls._from_int(
+                ensure_member(int(others), _ZERO_TO_SEVEN)
+            )
+            return cls(
+                group_read=group_read,
+                group_write=group_write,
+                group_execute=group_execute,
+                others_read=others_read,
+                others_write=others_write,
+                others_execute=others_execute,
+            )
+        with suppress(ExtractGroupError):
+            others = extract_group(r"^([0-7])$", str(n))
+            others_read, others_write, others_execute = cls._from_int(
+                ensure_member(int(others), _ZERO_TO_SEVEN)
+            )
+            return cls(
+                others_read=others_read,
+                others_write=others_write,
+                others_execute=others_execute,
+            )
+        if n == 0:
+            return cls()
+        raise PermissionsFromIntError(n=n)
+
+    @classmethod
+    def _from_int(cls, n: _ZeroToSeven, /) -> tuple[bool, bool, bool]:
+        return bool(4 & n), bool(2 & n), bool(1 & n)
+
+    @classmethod
+    def from_octal(cls, n: int, /) -> Self:
+        if _MIN_INT <= n <= _MAX_INT:
+            return cls(
+                user_read=bool(n & S_IRUSR),
+                user_write=bool(n & S_IWUSR),
+                user_execute=bool(n & S_IXUSR),
+                group_read=bool(n & S_IRGRP),
+                group_write=bool(n & S_IWGRP),
+                group_execute=bool(n & S_IXGRP),
+                others_read=bool(n & S_IROTH),
+                others_write=bool(n & S_IWOTH),
+                others_execute=bool(n & S_IXOTH),
+            )
+        raise PermissionsFromOctalError(n=n)
+
+    @classmethod
+    def from_text(cls, text: str, /) -> Self:
+        try:
+            user, group, others = extract_groups(
+                r"^u=(r?w?x?),g=(r?w?x?),o=(r?w?x?)$", text
+            )
+        except ExtractGroupsError:
+            raise PermissionsFromTextError(text=text) from None
+        user_read, user_write, user_execute = cls._from_text_part(user)
+        group_read, group_write, group_execute = cls._from_text_part(group)
+        others_read, others_write, others_execute = cls._from_text_part(others)
+        return cls(
+            user_read=user_read,
+            user_write=user_write,
+            user_execute=user_execute,
+            group_read=group_read,
+            group_write=group_write,
+            group_execute=group_execute,
+            others_read=others_read,
+            others_write=others_write,
+            others_execute=others_execute,
+        )
+
+    @classmethod
+    def _from_text_part(cls, text: str, /) -> tuple[bool, bool, bool]:
+        read, write, execute = extract_groups("^(r?)(w?)(x?)$", text)
+        return read != "", write != "", execute != ""
+
+    @property
+    def octal(self) -> int:
+        flags: list[int] = [
+            S_IRUSR if self.user_read else 0,
+            S_IWUSR if self.user_write else 0,
+            S_IXUSR if self.user_execute else 0,
+            S_IRGRP if self.group_read else 0,
+            S_IWGRP if self.group_write else 0,
+            S_IXGRP if self.group_execute else 0,
+            S_IROTH if self.others_read else 0,
+            S_IWOTH if self.others_write else 0,
+            S_IXOTH if self.others_execute else 0,
+        ]
+        return reduce(or_, flags)
+
+    def replace(
+        self,
+        *,
+        user_read: bool | Sentinel = sentinel,
+        user_write: bool | Sentinel = sentinel,
+        user_execute: bool | Sentinel = sentinel,
+        group_read: bool | Sentinel = sentinel,
+        group_write: bool | Sentinel = sentinel,
+        group_execute: bool | Sentinel = sentinel,
+        others_read: bool | Sentinel = sentinel,
+        others_write: bool | Sentinel = sentinel,
+        others_execute: bool | Sentinel = sentinel,
+    ) -> Self:
+        return replace_non_sentinel(
+            self,
+            user_read=user_read,
+            user_write=user_write,
+            user_execute=user_execute,
+            group_read=group_read,
+            group_write=group_write,
+            group_execute=group_execute,
+            others_read=others_read,
+            others_write=others_write,
+            others_execute=others_execute,
+        )
+
+
+@dataclass(kw_only=True, slots=True)
+class PermissionsError(Exception): ...
+
+
+@dataclass(kw_only=True, slots=True)
+class PermissionsFromIntError(PermissionsError):
+    n: int
+
+    @override
+    def __str__(self) -> str:
+        return f"Invalid integer for permissions; got {self.n}"
+
+
+@dataclass(kw_only=True, slots=True)
+class PermissionsFromOctalError(PermissionsError):
+    n: int
+
+    @override
+    def __str__(self) -> str:
+        return f"Invalid octal for permissions; got {oct(self.n)}"
+
+
+@dataclass(kw_only=True, slots=True)
+class PermissionsFromTextError(PermissionsError):
+    text: str
+
+    @override
+    def __str__(self) -> str:
+        return f"Invalid string for permissions; got {self.text!r}"
+
+
+__all__ = [
+    "Permissions",
+    "PermissionsError",
+    "PermissionsFromIntError",
+    "PermissionsFromOctalError",
+    "PermissionsFromTextError",
+]