is-admin-user 0.1.0__tar.gz

is_admin_user-0.1.0/LICENSE

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

is_admin_user-0.1.0/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: is-admin-user
+Version: 0.1.0
+Summary: Check whether the current Python process is running as an administrator or root user.
+Author: GGN_2015
+License-Expression: MIT
+Keywords: administrator,admin,root,privileges,windows,linux,macos
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# is-admin-user
+
+Check whether the current Python process is running as an administrator.
+
+`is-admin-user` is a tiny, dependency-free Python package that works across
+Windows, Linux, and macOS. It exposes a programmable function interface for
+checking whether the current process has administrative privileges.
+
+## Installation
+
+```bash
+pip install is-admin-user
+```
+
+For local development:
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+```python
+from is_admin_user import is_admin_user
+
+if is_admin_user():
+    print("Running as administrator/root")
+else:
+    print("Running as a standard user")
+```
+
+You can also use the shorter alias:
+
+```python
+from is_admin_user import is_admin
+
+if is_admin():
+    print("Administrative privileges are available")
+```
+
+## Platform behavior
+
+- Windows: returns `True` when the current process token is running with
+  administrator privileges.
+- Linux: returns `True` when the effective user ID is `0` (`root`).
+- macOS: returns `True` when the effective user ID is `0` (`root`).
+
+On Windows, an account that belongs to the Administrators group may still return
+`False` if the Python process was not started with elevated privileges.
+
+## API
+
+### `is_admin_user() -> bool`
+
+Returns `True` when the current Python process has administrator/root
+privileges, otherwise returns `False`.
+
+### `is_admin() -> bool`
+
+Alias for `is_admin_user()`.
+
+## Development
+
+Run the test suite with:
+
+```bash
+python -m pytest
+```

is_admin_user-0.1.0/README.md

@@ -0,0 +1,68 @@
+# is-admin-user
+
+Check whether the current Python process is running as an administrator.
+
+`is-admin-user` is a tiny, dependency-free Python package that works across
+Windows, Linux, and macOS. It exposes a programmable function interface for
+checking whether the current process has administrative privileges.
+
+## Installation
+
+```bash
+pip install is-admin-user
+```
+
+For local development:
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+```python
+from is_admin_user import is_admin_user
+
+if is_admin_user():
+    print("Running as administrator/root")
+else:
+    print("Running as a standard user")
+```
+
+You can also use the shorter alias:
+
+```python
+from is_admin_user import is_admin
+
+if is_admin():
+    print("Administrative privileges are available")
+```
+
+## Platform behavior
+
+- Windows: returns `True` when the current process token is running with
+  administrator privileges.
+- Linux: returns `True` when the effective user ID is `0` (`root`).
+- macOS: returns `True` when the effective user ID is `0` (`root`).
+
+On Windows, an account that belongs to the Administrators group may still return
+`False` if the Python process was not started with elevated privileges.
+
+## API
+
+### `is_admin_user() -> bool`
+
+Returns `True` when the current Python process has administrator/root
+privileges, otherwise returns `False`.
+
+### `is_admin() -> bool`
+
+Alias for `is_admin_user()`.
+
+## Development
+
+Run the test suite with:
+
+```bash
+python -m pytest
+```

is_admin_user-0.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "is-admin-user"
+version = "0.1.0"
+description = "Check whether the current Python process is running as an administrator or root user."
+readme = "README.md"
+requires-python = ">=3.8"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [
+    { name = "GGN_2015" }
+]
+keywords = [
+    "administrator",
+    "admin",
+    "root",
+    "privileges",
+    "windows",
+    "linux",
+    "macos"
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Typing :: Typed"
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

is_admin_user-0.1.0/setup.cfg

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

is_admin_user-0.1.0/src/is_admin_user/__init__.py

@@ -0,0 +1,5 @@
+"""Public API for checking administrator/root privileges."""
+
+from ._core import is_admin, is_admin_user
+
+__all__ = ["is_admin", "is_admin_user"]

is_admin_user-0.1.0/src/is_admin_user/_core.py

@@ -0,0 +1,44 @@
+"""Cross-platform administrator/root privilege checks."""
+
+from __future__ import annotations
+
+import ctypes
+import os
+import sys
+
+
+def is_admin_user() -> bool:
+    """Return whether the current Python process has administrator privileges.
+
+    On Windows, this checks the current process token for administrator
+    privileges. On Linux and macOS, this checks whether the effective user ID is
+    0, which is the root user.
+    """
+    if sys.platform == "win32":
+        return _is_windows_admin()
+
+    return _is_posix_root()
+
+
+def is_admin() -> bool:
+    """Return whether the current Python process has administrator privileges."""
+    return is_admin_user()
+
+
+def _is_windows_admin() -> bool:
+    try:
+        return bool(ctypes.windll.shell32.IsUserAnAdmin())
+    except (AttributeError, OSError, ValueError):
+        return False
+
+
+def _is_posix_root() -> bool:
+    geteuid = getattr(os, "geteuid", None)
+    if callable(geteuid):
+        return geteuid() == 0
+
+    getuid = getattr(os, "getuid", None)
+    if callable(getuid):
+        return getuid() == 0
+
+    return False

is_admin_user-0.1.0/src/is_admin_user/py.typed

@@ -0,0 +1 @@
+

is_admin_user-0.1.0/src/is_admin_user.egg-info/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: is-admin-user
+Version: 0.1.0
+Summary: Check whether the current Python process is running as an administrator or root user.
+Author: GGN_2015
+License-Expression: MIT
+Keywords: administrator,admin,root,privileges,windows,linux,macos
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# is-admin-user
+
+Check whether the current Python process is running as an administrator.
+
+`is-admin-user` is a tiny, dependency-free Python package that works across
+Windows, Linux, and macOS. It exposes a programmable function interface for
+checking whether the current process has administrative privileges.
+
+## Installation
+
+```bash
+pip install is-admin-user
+```
+
+For local development:
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+```python
+from is_admin_user import is_admin_user
+
+if is_admin_user():
+    print("Running as administrator/root")
+else:
+    print("Running as a standard user")
+```
+
+You can also use the shorter alias:
+
+```python
+from is_admin_user import is_admin
+
+if is_admin():
+    print("Administrative privileges are available")
+```
+
+## Platform behavior
+
+- Windows: returns `True` when the current process token is running with
+  administrator privileges.
+- Linux: returns `True` when the effective user ID is `0` (`root`).
+- macOS: returns `True` when the effective user ID is `0` (`root`).
+
+On Windows, an account that belongs to the Administrators group may still return
+`False` if the Python process was not started with elevated privileges.
+
+## API
+
+### `is_admin_user() -> bool`
+
+Returns `True` when the current Python process has administrator/root
+privileges, otherwise returns `False`.
+
+### `is_admin() -> bool`
+
+Alias for `is_admin_user()`.
+
+## Development
+
+Run the test suite with:
+
+```bash
+python -m pytest
+```

is_admin_user-0.1.0/src/is_admin_user.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+src/is_admin_user/__init__.py
+src/is_admin_user/_core.py
+src/is_admin_user/py.typed
+src/is_admin_user.egg-info/PKG-INFO
+src/is_admin_user.egg-info/SOURCES.txt
+src/is_admin_user.egg-info/dependency_links.txt
+src/is_admin_user.egg-info/top_level.txt
+tests/test_is_admin_user.py

is_admin_user-0.1.0/src/is_admin_user.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

is_admin_user-0.1.0/src/is_admin_user.egg-info/top_level.txt

@@ -0,0 +1 @@
+is_admin_user

is_admin_user-0.1.0/tests/test_is_admin_user.py

@@ -0,0 +1,77 @@
+from __future__ import annotations
+
+from is_admin_user import is_admin, is_admin_user
+from is_admin_user import _core
+
+
+class _FakeShell32:
+    def __init__(self, result: int) -> None:
+        self._result = result
+
+    def IsUserAnAdmin(self) -> int:
+        return self._result
+
+
+class _FailingShell32:
+    def IsUserAnAdmin(self) -> int:
+        raise OSError("administrator check failed")
+
+
+class _FakeWindll:
+    def __init__(self, result: int) -> None:
+        self.shell32 = _FakeShell32(result)
+
+
+def test_returns_true_for_windows_admin(monkeypatch):
+    monkeypatch.setattr(_core.sys, "platform", "win32")
+    monkeypatch.setattr(_core.ctypes, "windll", _FakeWindll(1), raising=False)
+
+    assert is_admin_user() is True
+
+
+def test_returns_false_for_windows_standard_user(monkeypatch):
+    monkeypatch.setattr(_core.sys, "platform", "win32")
+    monkeypatch.setattr(_core.ctypes, "windll", _FakeWindll(0), raising=False)
+
+    assert is_admin_user() is False
+
+
+def test_returns_false_when_windows_check_fails(monkeypatch):
+    monkeypatch.setattr(_core.sys, "platform", "win32")
+    monkeypatch.setattr(
+        _core.ctypes,
+        "windll",
+        type("_FailingWindll", (), {"shell32": _FailingShell32()})(),
+        raising=False,
+    )
+
+    assert is_admin_user() is False
+
+
+def test_returns_true_for_posix_root(monkeypatch):
+    monkeypatch.setattr(_core.sys, "platform", "linux")
+    monkeypatch.setattr(_core.os, "geteuid", lambda: 0, raising=False)
+
+    assert is_admin_user() is True
+
+
+def test_returns_false_for_posix_standard_user(monkeypatch):
+    monkeypatch.setattr(_core.sys, "platform", "darwin")
+    monkeypatch.setattr(_core.os, "geteuid", lambda: 501, raising=False)
+
+    assert is_admin_user() is False
+
+
+def test_posix_falls_back_to_real_user_id(monkeypatch):
+    monkeypatch.setattr(_core.sys, "platform", "linux")
+    monkeypatch.delattr(_core.os, "geteuid", raising=False)
+    monkeypatch.setattr(_core.os, "getuid", lambda: 0, raising=False)
+
+    assert is_admin_user() is True
+
+
+def test_is_admin_alias(monkeypatch):
+    monkeypatch.setattr(_core.sys, "platform", "linux")
+    monkeypatch.setattr(_core.os, "geteuid", lambda: 0, raising=False)
+
+    assert is_admin() is True