dycw-utilities 0.168.7__tar.gz → 0.168.8__tar.gz

{dycw_utilities-0.168.7 → dycw_utilities-0.168.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.168.7
+Version: 0.168.8
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12

{dycw_utilities-0.168.7 → dycw_utilities-0.168.8}/pyproject.toml

@@ -52,7 +52,7 @@ dev = [
   "pytest-timeout >=2.4.0, <2.5",
 ]
 fastapi = [
-  "fastapi >=0.118.0, <0.119",
+  "fastapi >=0.118.2, <0.119",
 ]
 fastapi-test = [
   "httpx",
@@ -249,7 +249,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.168.7"
+version = "0.168.8"
 
 [project.entry-points.pytest11]
 pytest-randomly = "utilities.pytest_plugins.pytest_randomly"
@@ -282,7 +282,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.168.7"
+current_version = "0.168.8"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

dycw_utilities-0.168.8/src/tests/test_grp.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from typing import assert_never
+
+from pytest import mark, param
+
+from utilities.grp import EFFECTIVE_GROUP_NAME, ROOT_GROUP_NAME, get_gid_name
+from utilities.platform import SYSTEM
+
+
+class TestGroupName:
+    def test_function(self) -> None:
+        group = get_gid_name(0)
+        assert isinstance(group, str) or (group is None)
+
+    @mark.parametrize("group", [param(ROOT_GROUP_NAME), param(EFFECTIVE_GROUP_NAME)])
+    def test_constant(self, *, group: str | None) -> None:
+        match SYSTEM:
+            case "windows":
+                assert group is None
+            case "mac" | "linux":
+                assert isinstance(group, str)
+            case never:
+                assert_never(never)

{dycw_utilities-0.168.7 → dycw_utilities-0.168.8}/src/tests/test_os.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from os import getenv
+from typing import TYPE_CHECKING
 
 from hypothesis import given
 from hypothesis.strategies import (
@@ -16,10 +17,14 @@ from pytest import mark, param, raises
 from utilities.hypothesis import text_ascii
 from utilities.os import (
     CPU_COUNT,
+    EFFECTIVE_GROUP_ID,
+    EFFECTIVE_USER_ID,
     GetCPUUseError,
     GetEnvVarError,
     get_cpu_count,
     get_cpu_use,
+    get_effective_group_id,
+    get_effective_user_id,
     get_env_var,
     is_debug,
     is_pytest,
@@ -27,6 +32,9 @@ from utilities.os import (
 )
 from utilities.pytest import skipif_windows
 
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
 text = text_ascii(min_size=1, max_size=10)
 
 
@@ -59,6 +67,19 @@ class TestGetCPUUse:
             _ = get_cpu_use(n=n)
 
 
+class TestGetEffectiveIDs:
+    @mark.parametrize(
+        "func", [param(get_effective_user_id), param(get_effective_group_id)]
+    )
+    def test_function(self, *, func: Callable[[], int | None]) -> None:
+        id_ = func()
+        assert isinstance(id_, int) or (id_ is None)
+
+    @mark.parametrize("id_", [param(EFFECTIVE_USER_ID), param(EFFECTIVE_GROUP_ID)])
+    def test_constant(self, *, id_: int | None) -> None:
+        assert isinstance(id_, int) or (id_ is None)
+
+
 class TestGetEnvVar:
     @given(
         key=text.map(_prefix), value=text, default=text | none(), nullable=booleans()

{dycw_utilities-0.168.7 → dycw_utilities-0.168.8}/src/tests/test_pathlib.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 from dataclasses import dataclass, field
 from pathlib import Path
 from shutil import copytree
-from typing import TYPE_CHECKING, Self
+from typing import TYPE_CHECKING, Self, assert_never
 
 from hypothesis import HealthCheck, given, settings
 from hypothesis.strategies import integers, sets
@@ -22,6 +22,8 @@ from utilities.pathlib import (
     _GetTailNonUniqueError,
     ensure_suffix,
     expand_path,
+    get_file_group,
+    get_file_owner,
     get_package_root,
     get_repo_root,
     get_root,
@@ -32,6 +34,7 @@ from utilities.pathlib import (
     temp_cwd,
     to_path,
 )
+from utilities.platform import SYSTEM
 from utilities.sentinel import Sentinel, sentinel
 from utilities.tempfile import TemporaryDirectory
 
@@ -77,6 +80,27 @@ class TestExpandPath:
         assert result == expected
 
 
+class TestFileOwnerAndGroup:
+    def test_owner(self, *, tmp_path: Path) -> None:
+        path = tmp_path.joinpath("file.txt")
+        path.touch()
+        self._assert(get_file_owner(path))
+
+    def test_group(self, *, tmp_path: Path) -> None:
+        path = tmp_path.joinpath("file.txt")
+        path.touch()
+        self._assert(get_file_group(path))
+
+    def _assert(self, value: str | None, /) -> None:
+        match SYSTEM:
+            case "windows":
+                assert value is None
+            case "mac" | "linux":
+                assert isinstance(value, str)
+            case never:
+                assert_never(never)
+
+
 class TestGetPackageRoot:
     @given(tail=paths())
     @settings(

dycw_utilities-0.168.8/src/tests/test_pwd.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from typing import assert_never
+
+from pytest import mark, param
+
+from utilities.platform import SYSTEM
+from utilities.pwd import EFFECTIVE_USER_NAME, ROOT_USER_NAME, get_uid_name
+
+
+class TestUserName:
+    def test_function(self) -> None:
+        user = get_uid_name(0)
+        assert isinstance(user, str) or (user is None)
+
+    @mark.parametrize("user", [param(ROOT_USER_NAME), param(EFFECTIVE_USER_NAME)])
+    def test_constant(self, *, user: str | None) -> None:
+        match SYSTEM:
+            case "windows":
+                assert user is None
+            case "mac" | "linux":
+                assert isinstance(user, str)
+            case never:
+                assert_never(never)

{dycw_utilities-0.168.7 → dycw_utilities-0.168.8}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.168.7"
+__version__ = "0.168.8"

dycw_utilities-0.168.8/src/utilities/grp.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+from typing import assert_never
+
+from utilities.os import EFFECTIVE_GROUP_ID
+from utilities.platform import SYSTEM
+
+
+def get_gid_name(gid: int, /) -> str | None:
+    """Get the name of a group."""
+    match SYSTEM:
+        case "windows":  # skipif-not-windows
+            return None
+        case "mac" | "linux":  # skipif-windows
+            from grp import getgrgid
+
+            return getgrgid(gid).gr_name
+        case never:
+            assert_never(never)
+
+
+ROOT_GROUP_NAME = get_gid_name(0)
+EFFECTIVE_GROUP_NAME = (
+    None if EFFECTIVE_GROUP_ID is None else get_gid_name(EFFECTIVE_GROUP_ID)
+)
+
+
+__all__ = ["EFFECTIVE_GROUP_NAME", "ROOT_GROUP_NAME", "get_gid_name"]

{dycw_utilities-0.168.7 → dycw_utilities-0.168.8}/src/utilities/os.py

@@ -7,6 +7,7 @@ from typing import TYPE_CHECKING, Literal, assert_never, overload, override
 
 from utilities.contextlib import enhanced_context_manager
 from utilities.iterables import OneStrEmptyError, one_str
+from utilities.platform import SYSTEM
 
 if TYPE_CHECKING:
     from collections.abc import Iterator, Mapping
@@ -124,6 +125,39 @@ class GetEnvVarError(Exception):
 ##
 
 
+def get_effective_group_id() -> int | None:
+    """Get the effective group ID."""
+    match SYSTEM:
+        case "windows":  # skipif-not-windows
+            return None
+        case "mac" | "linux":  # skipif-windows
+            from os import getegid
+
+            return getegid()
+        case never:
+            assert_never(never)
+
+
+def get_effective_user_id() -> int | None:
+    """Get the effective user ID."""
+    match SYSTEM:
+        case "windows":  # skipif-not-windows
+            return None
+        case "mac" | "linux":  # skipif-windows
+            from os import geteuid
+
+            return geteuid()
+        case never:
+            assert_never(never)
+
+
+EFFECTIVE_USER_ID = get_effective_user_id()
+EFFECTIVE_GROUP_ID = get_effective_group_id()
+
+
+##
+
+
 def is_debug() -> bool:
     """Check if we are in `DEBUG` mode."""
     return get_env_var("DEBUG", nullable=True) is not None
@@ -165,11 +199,15 @@ def temp_environ(
 
 __all__ = [
     "CPU_COUNT",
+    "EFFECTIVE_GROUP_ID",
+    "EFFECTIVE_USER_ID",
     "GetCPUCountError",
     "GetCPUUseError",
     "IntOrAll",
     "get_cpu_count",
     "get_cpu_use",
+    "get_effective_group_id",
+    "get_effective_user_id",
     "get_env_var",
     "is_debug",
     "is_pytest",

{dycw_utilities-0.168.7 → dycw_utilities-0.168.8}/src/utilities/pathlib.py

@@ -12,6 +12,8 @@ from typing import TYPE_CHECKING, Literal, assert_never, overload, override
 
 from utilities.contextlib import enhanced_context_manager
 from utilities.errors import ImpossibleCaseError
+from utilities.grp import get_gid_name
+from utilities.pwd import get_uid_name
 from utilities.sentinel import Sentinel
 
 if TYPE_CHECKING:
@@ -52,6 +54,19 @@ def expand_path(path: PathLike, /) -> Path:
 ##
 
 
+def get_file_group(path: PathLike, /) -> str | None:
+    """Get the group of a file."""
+    return get_gid_name(to_path(path).stat().st_gid)
+
+
+def get_file_owner(path: PathLike, /) -> str | None:
+    """Get the owner of a file."""
+    return get_uid_name(to_path(path).stat().st_uid)
+
+
+##
+
+
 def get_package_root(path: MaybeCallablePathLike = Path.cwd, /) -> Path:
     """Get the package root."""
     path = to_path(path)
@@ -327,6 +342,8 @@ __all__ = [
     "GetTailError",
     "ensure_suffix",
     "expand_path",
+    "get_file_group",
+    "get_file_owner",
     "get_package_root",
     "get_repo_root",
     "get_tail",

dycw_utilities-0.168.8/src/utilities/pwd.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+from typing import assert_never
+
+from utilities.os import EFFECTIVE_USER_ID
+from utilities.platform import SYSTEM
+
+
+def get_uid_name(uid: int, /) -> str | None:
+    """Get the name of a user ID."""
+    match SYSTEM:
+        case "windows":  # skipif-not-windows
+            return None
+        case "mac" | "linux":  # skipif-windows
+            from pwd import getpwuid
+
+            return getpwuid(uid).pw_name
+        case never:
+            assert_never(never)
+
+
+ROOT_USER_NAME = get_uid_name(0)
+EFFECTIVE_USER_NAME = (
+    None if EFFECTIVE_USER_ID is None else get_uid_name(EFFECTIVE_USER_ID)
+)
+
+
+__all__ = ["EFFECTIVE_USER_NAME", "ROOT_USER_NAME", "get_uid_name"]