xulbux 1.6.0__py3-none-any.whl → 1.6.2__py3-none-any.whl

xulbux/xx_system.py

@@ -1,12 +1,29 @@
 import subprocess as _subprocess
 import platform as _platform
+import ctypes as _ctypes
 import time as _time
 import sys as _sys
 import os as _os
 
 
+class ProcessNotFoundError(Exception):
+    pass
+
+
 class System:
 
+    @staticmethod
+    def is_elevated() -> bool:
+        """Returns `True` if the current user is an admin and `False` otherwise."""
+        try:
+            if _os.name == "nt":
+                return _ctypes.windll.shell32.IsUserAnAdmin() != 0
+            elif _os.name == "posix":
+                return _os.geteuid() == 0
+        except:
+            pass
+        return False
+
     @staticmethod
     def restart(
         prompt: object = None,
@@ -14,12 +31,11 @@ class System:
         continue_program: bool = False,
         force: bool = False,
     ) -> None:
-        """Starts a system restart:<br>
-        `prompt` is the message to be displayed in the systems restart notification.<br>
-        `wait` is the time to wait until restarting in seconds.<br>
-        `continue_program` is whether to continue the current Python program after calling this function.<br>
-        `force` is whether to force a restart even if other processes are still running.
-        """
+        """Starts a system restart:
+        - `prompt` is the message to be displayed in the systems restart notification.
+        - `wait` is the time to wait until restarting in seconds.
+        - `continue_program` is whether to continue the current Python program after calling this function.
+        - `force` is whether to force a restart even if other processes are still running."""
         system = _platform.system().lower()
         if system == "windows":
             if not force:
@@ -61,8 +77,8 @@ class System:
     ) -> None | list[str]:
         """Checks if the given list of libraries are installed. If not:
         - If `install_missing` is `False` the missing libraries will be returned as a list.
-        - If `install_missing` is `True` the missing libraries will be installed. If `confirm_install` is `True` the user will first be asked if they want to install the missing libraries.
-        """
+        - If `install_missing` is `True` the missing libraries will be installed.
+        - If `confirm_install` is `True` the user will first be asked if they want to install the missing libraries."""
         missing = []
         for lib in lib_names:
             try:
@@ -84,3 +100,38 @@ class System:
             return None
         except _subprocess.CalledProcessError:
             return missing
+
+    @staticmethod
+    def elevate(win_title: str | None = None, args: list | None = None) -> bool:
+        """Attempts to start a new process with elevated privileges.\n
+        ---------------------------------------------------------------------------------
+        The param `win_title` is window the title of the elevated process.
+        The param `args` is the arguments to be passed to the elevated process.\n
+        After the elevated process started, the original process will exit.
+        This means, that this method has to be run at the beginning of the program or
+        will have to continue in a new window after elevation.\n
+        ---------------------------------------------------------------------------------
+        Returns `True` if the current process already has elevated privileges and raises
+        a `PermissionError` if the user denied the elevation or the elevation failed."""
+        if System.is_elevated():
+            return True
+        if _os.name == "nt":  # WINDOWS
+            if win_title:
+                args_str = f'-c "import ctypes; ctypes.windll.kernel32.SetConsoleTitleW(\\"{win_title}\\"); exec(open(\\"{_sys.argv[0]}\\").read())" {" ".join(args)}"'
+            else:
+                args_str = f'-c "exec(open(\\"{_sys.argv[0]}\\").read())" {" ".join(args)}'
+            result = _ctypes.windll.shell32.ShellExecuteW(None, "runas", _sys.executable, args_str, None, 1)
+            if result <= 32:
+                raise PermissionError("Failed to launch elevated process.")
+            else:
+                _sys.exit(0)
+        else:  # POSIX
+            cmd = ["pkexec"]
+            if win_title:
+                cmd.extend(["--description", win_title])
+            cmd.extend([_sys.executable] + _sys.argv[1:] + ([] if args is None else args))
+            proc = _subprocess.Popen(cmd)
+            proc.wait()
+            if proc.returncode != 0:
+                raise PermissionError("Process elevation was denied.")
+            _sys.exit(0)

{xulbux-1.6.0.dist-info → xulbux-1.6.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: xulbux
-Version: 1.6.0
+Version: 1.6.2
 Summary: A library which includes a lot of really helpful functions.
 Author-email: XulbuX <xulbux.real@gmail.com>
 License: MIT License
@@ -95,7 +95,7 @@ from xulbux import rgba, hsla, hexa
 | <h3>[`xx_console`](https://github.com/XulbuX-dev/PythonLibraryXulbuX/wiki/xx_console)</h3>   | advanced actions related to the console (*pretty logging, advanced inputs, ...*)                   |
 | <h3>[`xx_data`](https://github.com/XulbuX-dev/PythonLibraryXulbuX/wiki/xx_data)</h3>         | advanced operations with data structures (*compare, generate path ID's, pretty print/format, ...*) |
 | <h3>[`xx_env_path`](https://github.com/XulbuX-dev/PythonLibraryXulbuX/wiki/xx_env_path)</h3> | getting and editing the PATH variable (*get paths, check for paths, add paths, ...*)               |
-| <h3>`xx_file`</h3>                                                                           | advanced working with files (*create files, rename file-extensions, ...*)                          |
+| <h3>[`xx_file`](https://github.com/XulbuX-dev/PythonLibraryXulbuX/wiki/xx_file)</h3>         | advanced working with files (*create files, rename file-extensions, ...*)                          |
 | <h3>`xx_format_codes`</h3>                                                                   | easy pretty printing with custom format codes (*print, inputs, custom format codes to ANSI, ...*)  |
 | <h3>`xx_json`</h3>                                                                           | advanced working with json files (*read, create, update, ...*)                                     |
 | <h3>`xx_path`</h3>                                                                           | advanced path operations (*get paths, smart-extend relative paths, delete paths, ...*)             |

xulbux-1.6.2.dist-info/RECORD

@@ -0,0 +1,21 @@
+xulbux/__init__.py,sha256=fxqdXSxUa_iDtV2MWdq4aBXV3B0pQWgz2xHpLnm84zw,1658
+xulbux/_cli_.py,sha256=U25ZrtpQgpKXtvOSTBBbh7-AJ_WTeZ95A66DQARAqzo,3558
+xulbux/_consts_.py,sha256=qAkg6ZwTKhQFcpHpfXjF4QEao8hpDEECRGqrv8oxkCo,4572
+xulbux/xx_code.py,sha256=yBP5WxCxNxjBiS6nVAmUBJpD0hX6fgnh5RWq-NmrnaY,5222
+xulbux/xx_color.py,sha256=cDlgrekH88ZEBj8leIIlJbYzsf1RdS8RW3oGvuUfvC0,45129
+xulbux/xx_console.py,sha256=rd31686X9eXB8__lcLaV7unWzIdXGM2yMOt9zNCsGbs,15079
+xulbux/xx_data.py,sha256=OEKLbI1XeNTrittdz3s3mvQk8YrBoSovj9O1H-b7ArY,25844
+xulbux/xx_env_path.py,sha256=iv3Jw0TsNDbbL_NySnazvIP9Iv9swymhiJIr2B3EG8k,4388
+xulbux/xx_file.py,sha256=-58YnqKvrs5idIF91UzEki7o7qnskFvnQYkBaRrp7Vw,3122
+xulbux/xx_format_codes.py,sha256=hTQBowcFX0gyAtjsYvgrEZK2EQ83b0W-IyqIUTkJAig,16986
+xulbux/xx_json.py,sha256=q60lOj8Xg8c4L9cBu6SBZdJzFC7QbjDfFwcKKzBKj5w,5173
+xulbux/xx_path.py,sha256=_xkH9cowPdi3nHw2q_TvN_i_5oG6GJut-QwPBLxnrAQ,4519
+xulbux/xx_regex.py,sha256=zyxkS1bLlrSq26ErhO4UtrimIhW71_a7kox6ArCoK58,7670
+xulbux/xx_string.py,sha256=Wa3qHxnk7AIpAVAn1vI_GBtkfYFwy4F_Xtj83ojEPKc,7168
+xulbux/xx_system.py,sha256=uBpB1eKbR-bddO87jbWdoi5NScLnrxJONbyqU49LmCs,6426
+xulbux-1.6.2.dist-info/LICENSE,sha256=6NflEcvzFEe8_JFVNCPVwZBwBhlLLd4vqQi8WiX_Xk4,1084
+xulbux-1.6.2.dist-info/METADATA,sha256=PyPr14LhmMVg952AQ-5uxp5jd3GSFRVCOxjPfsQ7ebo,6836
+xulbux-1.6.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+xulbux-1.6.2.dist-info/entry_points.txt,sha256=a3womfLIMZKnOFiyy-xnVb4g2qkZsHR5FbKKkljcGns,94
+xulbux-1.6.2.dist-info/top_level.txt,sha256=FkK4EZajwfP36fnlrPaR98OrEvZpvdEOdW1T5zTj6og,7
+xulbux-1.6.2.dist-info/RECORD,,

{xulbux-1.6.0.dist-info → xulbux-1.6.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.7.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

xulbux-1.6.0.dist-info/RECORD

@@ -1,21 +0,0 @@
-xulbux/__init__.py,sha256=atWR3hKxFB9Jq182TOrwhLHIEaYW5go9F6xosD76dog,1658
-xulbux/_cli_.py,sha256=U25ZrtpQgpKXtvOSTBBbh7-AJ_WTeZ95A66DQARAqzo,3558
-xulbux/_consts_.py,sha256=2-swueg8B5retfsAQqmR8nFNc06tqAwpL__TOv3V4kw,4882
-xulbux/xx_code.py,sha256=dAksTh2Fw6-XTIGn8eEJVUlvJOsrWbctDZJDk4cs8FQ,5137
-xulbux/xx_color.py,sha256=AqMqPCwDQZVQwkQUM0IOO47GzKNhKapoCwDifs-ewI8,44906
-xulbux/xx_console.py,sha256=Xzl73_LTyt9AW09KAV9tsGdEdiltxPJwJq9nZChWrUQ,15482
-xulbux/xx_data.py,sha256=cwjJeQHwf-b9yE6UTI0DO7US-hWtgTmIdvwKH5KKtmI,25969
-xulbux/xx_env_path.py,sha256=ITdJ4DKh1zAvZrV5kph1z0jUDBhwEtOP4u1OKW0hMts,4309
-xulbux/xx_file.py,sha256=nO2FtxqlBaW84L-qiTcQf16Im2xD-ZKPAytJDG4RCRw,2618
-xulbux/xx_format_codes.py,sha256=NIleZ9TrXdF0i9UMCZP7ZI_k1ChJjYlHCFAcHZHHq2c,14891
-xulbux/xx_json.py,sha256=1xAYBmpb4o8hOS_TaMQW2E5pZdE1YqbUdSJm-53wm-s,5054
-xulbux/xx_path.py,sha256=KB1HGYCxFB3_T97RVACajy3-QiksbviZVIW9-iQcr4s,4558
-xulbux/xx_regex.py,sha256=-dU1x4GDhFKEg0uQPT6uw9Yyo0vo7f98TtlicG9uBJo,7872
-xulbux/xx_string.py,sha256=21gV3ozegkimLbCk4PMDD_ObxYElREABxuZ0p1Ga2HY,7090
-xulbux/xx_system.py,sha256=yehO57ggWDRJbeFoTE1VisW4QrbkqZzAyjKoL3xHx9k,3935
-xulbux-1.6.0.dist-info/LICENSE,sha256=6NflEcvzFEe8_JFVNCPVwZBwBhlLLd4vqQi8WiX_Xk4,1084
-xulbux-1.6.0.dist-info/METADATA,sha256=ZGzDhbqYvTl-dg68I0WFesKfkvlG_Vm-2iJL8-DVRyg,6836
-xulbux-1.6.0.dist-info/WHEEL,sha256=A3WOREP4zgxI0fKrHUG8DC8013e3dK3n7a6HDbcEIwE,91
-xulbux-1.6.0.dist-info/entry_points.txt,sha256=a3womfLIMZKnOFiyy-xnVb4g2qkZsHR5FbKKkljcGns,94
-xulbux-1.6.0.dist-info/top_level.txt,sha256=FkK4EZajwfP36fnlrPaR98OrEvZpvdEOdW1T5zTj6og,7
-xulbux-1.6.0.dist-info/RECORD,,