absfuyu 4.2.0__py3-none-any.whl → 5.0.1__py3-none-any.whl

absfuyu/tools/shutdownizer.py

@@ -3,17 +3,17 @@ Absfuyu: Shutdownizer
 ---------------------
 This shutdowns
 
-Version: 1.0.0
-Date updated: 07/02/2025 (dd/mm/yyyy)
+Version: 5.0.0
+Date updated: 23/02/2025 (dd/mm/yyyy)
 """
 
 # Module level
-###########################################################################
+# ---------------------------------------------------------------------------
 __all__ = ["ShutDownizer", "ShutdownEngine"]
 
 
 # Library
-###########################################################################
+# ---------------------------------------------------------------------------
 import os
 import subprocess
 import sys
@@ -22,20 +22,29 @@ from datetime import datetime, time, timedelta
 from pathlib import Path
 from typing import Annotated
 
+try:
+    from typing import override  # type: ignore
+except ImportError:
+    from absfuyu.core.decorator import dummy_decorator as override
+
+from absfuyu.core import BaseClass, versionadded, versionchanged
 from absfuyu.logger import logger
 
 # TODO: Schedule shutdown, random time shutdown, test
 
 
 # Class
-###########################################################################
-class ShutDownizer:
+# ---------------------------------------------------------------------------
+@versionadded("4.2.0")
+class ShutDownizer(BaseClass):
     """
     ShutDownizer
 
     Shutdown tool because why not
     """
 
+    __slots__ = ("os", "engine")
+
     def __init__(self) -> None:
         self.os: str = sys.platform
         logger.debug(f"Current OS: {self.os}")
@@ -52,23 +61,20 @@ class ShutDownizer:
     def __str__(self) -> str:
         return f"{self.__class__.__name__}({self.os})"
 
-    def __repr__(self) -> str:
-        return self.__str__()
-
-    def shutdown(self) -> None:
+    def shutdown(self, *args, **kwargs) -> None:
         """Shutdown"""
-        self.engine.shutdown()
+        self.engine.shutdown(*args, **kwargs)
 
-    def restart(self) -> None:
+    def restart(self, *args, **kwargs) -> None:
         """Restart"""
-        self.engine.restart()
+        self.engine.restart(*args, **kwargs)
 
     def cancel(self) -> None:
         """Cancel"""
         self.engine.cancel()
 
 
-class ShutdownEngine(ABC):
+class ShutdownEngine(ABC, BaseClass):
     """
     Abstract shutdown class for different type of OS
     """
@@ -76,9 +82,6 @@ class ShutdownEngine(ABC):
     def __str__(self) -> str:
         return f"{self.__class__.__name__}()"
 
-    def __repr__(self) -> str:
-        return self.__str__()
-
     def _execute_cmd(self, cmd: str | list) -> None:
         """Execute the cmd"""
         try:
@@ -86,8 +89,8 @@ class ShutdownEngine(ABC):
                 subprocess.run(cmd.split())
             elif isinstance(cmd, list):
                 subprocess.run(cmd)
-        except Exception:
-            logger.error(f'"{cmd}" failed to run')
+        except (FileNotFoundError, Exception) as e:
+            logger.error(f'"{cmd}" failed to run: {e}')
             raise ValueError(f'"{cmd}" failed to run')  # noqa
 
     def _execute_multiple_cmds(self, cmds: list) -> None:
@@ -98,21 +101,21 @@ class ShutdownEngine(ABC):
                 logger.debug(f"Executing: {cmd}")
                 self._execute_cmd(cmd)
                 break
-            except Exception:
-                logger.error(f'"{cmd}" failed to run')
+            except Exception as e:
+                logger.error(f'"{cmd}" failed to run: {e}')
 
     @abstractmethod
-    def shutdown(self) -> None:
+    def shutdown(self, *args, **kwargs) -> None:
         """Shutdown"""
         pass
 
     @abstractmethod
-    def restart(self) -> None:
+    def restart(self, *args, **kwargs) -> None:
         """Restart"""
         pass
 
     @abstractmethod
-    def sleep(self) -> None:
+    def sleep(self, *args, **kwargs) -> None:
         """Sleep"""
         pass
 
@@ -131,24 +134,29 @@ class ShutdownEngine(ABC):
         m: Annotated[int, "positive"] = 0,
         aggregate: bool = True,
     ) -> int:
-        """This calculate time for schedule shutdown
+        """
+        Calculate time for scheduled shutdown.
 
         Parameters
         ----------
         h : int, optional
-            Hours to add (24h format), by default 0
+            Hours to add (24h format), by default ``0``
+
         m : int, optional
-            Minutes to add (24h format), by default 0
+            Minutes to add (24h format), by default ``0``
+
         aggregate : bool, optional
-            | This add hours and and minutes to `time.now()`, by default ``True``
-            | - ``True`` : Add hours and minutes to current time
-            | - ``False``: Use ``h`` and ``m`` as fixed time point to shutdown
+            This add hours and and minutes to `time.now()`, by default ``True``
+            - ``True`` : Add hours and minutes to current time
+            - ``False``: Use ``h`` and ``m`` as fixed time point to shutdown
 
         Returns
         -------
         int
-            Seconds left to shutdown
+            Seconds left until shutdown.
         """
+        h = max(0, h)  # Force >= 0
+        m = max(0, m)
         now = datetime.now()
         if aggregate:
             delta = timedelta(hours=h, minutes=m)
@@ -163,18 +171,29 @@ class ShutdownEngine(ABC):
 class ShutdownEngineWin(ShutdownEngine):
     """ShutDownizer - Windows"""
 
-    def shutdown(self) -> None:
-        cmds = ["shutdown -f -s -t 0"]
+    @override
+    @versionchanged("5.0.0", "Scheduled shutdown")
+    def shutdown(
+        self,
+        h: Annotated[int, "positive"] = 0,
+        m: Annotated[int, "positive"] = 0,
+        aggregate: bool = True,
+    ) -> None:
+        time_until_sd = self._calculate_time(h=h, m=m, aggregate=aggregate)
+        cmds = [f"shutdown -f -s -t {time_until_sd}"]
         self._execute_multiple_cmds(cmds)
 
-    def restart(self) -> None:
+    @override
+    def restart(self, *args, **kwargs) -> None:
         cmds = ["shutdown -r"]
         self._execute_multiple_cmds(cmds)
 
-    def sleep(self) -> None:
+    @override
+    def sleep(self, *args, **kwargs) -> None:
         cmds = ["rundll32.exe powrprof.dll,SetSuspendState 0,1,0"]
         self._execute_multiple_cmds(cmds)
 
+    @override
     def abort(self) -> None:
         cmds = ["shutdown -a"]
         self._execute_multiple_cmds(cmds)
@@ -196,7 +215,8 @@ class ShutdownEngineWin(ShutdownEngine):
 class ShutdownEngineMac(ShutdownEngine):
     """ShutDownizer - MacOS"""
 
-    def shutdown(self) -> None:
+    @override
+    def shutdown(self, *args, **kwargs) -> None:
         cmds = [
             ["osascript", "-e", 'tell application "System Events" to shut down'],
             "pmset sleepnow",
@@ -205,7 +225,8 @@ class ShutdownEngineMac(ShutdownEngine):
         ]
         self._execute_multiple_cmds(cmds)
 
-    def restart(self) -> None:
+    @override
+    def restart(self, *args, **kwargs) -> None:
         cmds = [
             ["osascript", "-e", 'tell application "System Events" to restart'],
             "shutdown -r now",
@@ -213,7 +234,8 @@ class ShutdownEngineMac(ShutdownEngine):
         ]
         self._execute_multiple_cmds(cmds)
 
-    def sleep(self) -> None:
+    @override
+    def sleep(self, *args, **kwargs) -> None:
         cmds = [
             ["osascript", "-e", 'tell application "System Events" to sleep'],
             "pmset sleepnow",
@@ -222,6 +244,7 @@ class ShutdownEngineMac(ShutdownEngine):
         ]
         self._execute_multiple_cmds(cmds)
 
+    @override
     def abort(self) -> None:
         cmds = [
             ["osascript", "-e", 'tell application "System Events" to cancel shutdown'],
@@ -235,7 +258,8 @@ class ShutdownEngineMac(ShutdownEngine):
 class ShutdownEngineLinux(ShutdownEngine):
     """ShutDownizer - Linux"""
 
-    def shutdown(self) -> None:
+    @override
+    def shutdown(self, *args, **kwargs) -> None:
         cmds = [
             "gnome-session-quit --power-off",
             "systemctl --user poweroff",
@@ -243,7 +267,8 @@ class ShutdownEngineLinux(ShutdownEngine):
         ]
         self._execute_multiple_cmds(cmds)
 
-    def restart(self) -> None:
+    @override
+    def restart(self, *args, **kwargs) -> None:
         cmds = [
             "gnome-session-quit --reboot",
             "systemctl reboot",
@@ -251,16 +276,12 @@ class ShutdownEngineLinux(ShutdownEngine):
         ]
         self._execute_multiple_cmds(cmds)
 
-    def sleep(self) -> None:
+    @override
+    def sleep(self, *args, **kwargs) -> None:
         cmds = ["systemctl suspend", "sudo shutdown -s now"]
         self._execute_multiple_cmds(cmds)
 
+    @override
     def abort(self) -> None:
         cmds = ["sudo shutdown -c"]
         self._execute_multiple_cmds(cmds)
-
-
-# Run
-###########################################################################
-if __name__ == "__main__":
-    pass

absfuyu/tools/web.py

@@ -3,12 +3,12 @@ Absfuyu: Web
 ------------
 Web, ``request``, ``BeautifulSoup`` stuff
 
-Version: 1.0.2
-Date updated: 05/04/2024 (dd/mm/yyyy)
+Version: 5.0.0
+Date updated: 22/02/2025 (dd/mm/yyyy)
 """
 
 # Library
-###########################################################################
+# ---------------------------------------------------------------------------
 import requests
 from bs4 import BeautifulSoup
 
@@ -16,7 +16,7 @@ from absfuyu.logger import logger
 
 
 # Function
-###########################################################################
+# ---------------------------------------------------------------------------
 def soup_link(link: str) -> BeautifulSoup:
     """
     ``BeautifulSoup`` the link
@@ -53,10 +53,3 @@ def gen_random_commit_msg() -> str:
     out = soup_link("https://whatthecommit.com/").get_text()[34:-20]
     logger.debug(out)
     return out  # type: ignore
-
-
-# Run
-###########################################################################
-if __name__ == "__main__":
-    logger.setLevel(10)
-    gen_random_commit_msg()

absfuyu/util/__init__.py

@@ -3,20 +3,21 @@ Absufyu: Utilities
 ------------------
 Some random utilities
 
-Version: 1.5.2
-Date updated: 25/11/2024 (dd/mm/yyyy)
+Version: 5.0.0
+Date updated: 25/02/2025 (dd/mm/yyyy)
 """
 
 # Library
-###########################################################################
+# ---------------------------------------------------------------------------
 import pkgutil
 from datetime import datetime
 
-from absfuyu.logger import logger
+from absfuyu.core import deprecated, versionadded, versionchanged
 
 
 # Function
-###########################################################################
+# ---------------------------------------------------------------------------
+@versionchanged("2.7.1", reason="Use ``pkgutil`` lib")
 def get_installed_package():
     """
     Return a list of installed packages
@@ -32,6 +33,7 @@ def get_installed_package():
     return sorted(iter_modules)
 
 
+@deprecated("5.0.0")
 def set_min(
     current_value: int | float,
     *,
@@ -60,11 +62,13 @@ def set_min(
     >>> set_min(-1)
     0
     """
-    if current_value < min_value:
-        current_value = min_value
-    return current_value
+    # if current_value < min_value:
+    #     current_value = min_value
+    # return current_value
+    return max(min_value, current_value)
 
 
+@deprecated("5.0.0")
 def set_max(
     current_value: int | float,
     *,
@@ -93,9 +97,10 @@ def set_max(
     >>> set_max(101)
     100
     """
-    if current_value > max_value:
-        current_value = max_value
-    return current_value
+    # if current_value > max_value:
+    #     current_value = max_value
+    # return current_value
+    return min(max_value, current_value)
 
 
 def set_min_max(
@@ -137,6 +142,7 @@ def set_min_max(
     return current_value
 
 
+@versionadded("3.2.0")
 def stop_after_day(
     year: int | None = None, month: int | None = None, day: int | None = None
 ) -> None:
@@ -172,9 +178,3 @@ def stop_after_day(
     result = end_date - now
     if result.days < 0:
         raise SystemExit("End of time")
-
-
-# Run
-###########################################################################
-if __name__ == "__main__":
-    logger.setLevel(10)

absfuyu/util/api.py

@@ -3,12 +3,12 @@ Absufyu: API
 ------------
 Fetch data stuff
 
-Version: 1.2.1
-Date updated: 15/11/2024 (dd/mm/yyyy)
+Version: 5.0.0
+Date updated: 22/02/2025 (dd/mm/yyyy)
 """
 
 # Module level
-###########################################################################
+# ---------------------------------------------------------------------------
 __all__ = [
     "APIRequest",
     "ping_windows",
@@ -16,7 +16,7 @@ __all__ = [
 
 
 # Library
-###########################################################################
+# ---------------------------------------------------------------------------
 import json
 import re
 import subprocess
@@ -24,13 +24,13 @@ from pathlib import Path
 from typing import NamedTuple
 
 import requests
-from deprecated.sphinx import versionchanged
 
+from absfuyu.core import versionadded, versionchanged
 from absfuyu.logger import logger
 
 
 # Function
-###########################################################################
+# ---------------------------------------------------------------------------
 class PingResult(NamedTuple):
     """
     :param host: Host name/IP
@@ -41,7 +41,8 @@ class PingResult(NamedTuple):
     result: str
 
 
-@versionchanged(version="3.4.0", reason="Change function's return")
+@versionchanged("3.4.0", reason="Updated functionality")
+@versionadded("2.5.0")
 def ping_windows(host: list[str], ping_count: int = 3) -> list[PingResult]:
     """
     Ping web
@@ -88,7 +89,7 @@ def ping_windows(host: list[str], ping_count: int = 3) -> list[PingResult]:
 
 
 # Class
-###########################################################################
+# ---------------------------------------------------------------------------
 class APIRequest:
     """API data with cache feature"""
 
@@ -143,7 +144,7 @@ class APIRequest:
                 logger.debug(f"No local cache found... ({e})")
                 json_data = None
 
-        if not json_data:
+        if json_data is None:
             logger.debug("Fetching new json data... (Creating local cache)")
             try:
                 json_data = requests.get(self.url).json()
@@ -164,9 +165,3 @@ class APIRequest:
             ``requests.Response``
         """
         return requests.get(self.url)
-
-
-# Run
-###########################################################################
-if __name__ == "__main__":
-    logger.setLevel(10)

absfuyu/util/json_method.py

@@ -3,35 +3,27 @@ Absfuyu: Json Method
 --------------------
 ``.json`` file handling
 
-Version: 1.1.4
-Date updated: 15/11/2024 (dd/mm/yyyy)
+Version: 5.0.0
+Date updated: 25/02/2025 (dd/mm/yyyy)
 """
 
 # Module level
-###########################################################################
+# ---------------------------------------------------------------------------
 __all__ = ["JsonFile"]
 
 
 # Library
-###########################################################################
+# ---------------------------------------------------------------------------
 import json
 from pathlib import Path
 from typing import Any
 
-
-# Function
-###########################################################################
-def load_json(json_file_location: Path):  # Deprecated
-    """Load JSON file"""
-    print("This function is deprecated as of version 3.0.0")
-    with open(Path(json_file_location), "r") as json_file:
-        data = json.load(json_file)
-    return data
+from absfuyu.core import BaseClass
 
 
 # Class
-###########################################################################
-class JsonFile:
+# ---------------------------------------------------------------------------
+class JsonFile(BaseClass):
     """
     ``.json`` file handling
     """
@@ -59,9 +51,6 @@ class JsonFile:
     def __str__(self) -> str:
         return f"{self.__class__.__name__}({self.json_file_location.name})"
 
-    def __repr__(self) -> str:
-        return self.__str__()
-
     def load_json(self) -> dict[Any, Any]:
         """
         Load ``.json`` file
@@ -87,9 +76,3 @@ class JsonFile:
         :type data: dict
         """
         self.data = data
-
-
-# Run
-###########################################################################
-if __name__ == "__main__":
-    pass

absfuyu/util/lunar.py

@@ -4,8 +4,8 @@ Absfuyu: Lunar calendar
 -----------------------
 Convert to lunar calendar
 
-Version: 1.0.3
-Date updated: 15/11/2024 (dd/mm/yyyy)
+Version: 5.0.0
+Date updated: 22/02/2025 (dd/mm/yyyy)
 
 Source:
 -------
@@ -14,18 +14,18 @@ https://www.informatik.uni-leipzig.de/~duc/amlich/AL.py
 """
 
 # Module level
-###########################################################################
+# ---------------------------------------------------------------------------
 __all__ = ["LunarCalendar"]
 
 
 # Library
-###########################################################################
+# ---------------------------------------------------------------------------
 import math
 from datetime import date, datetime
 
 
 # Class
-###########################################################################
+# ---------------------------------------------------------------------------
 class LunarCalendar:
     """Lunar Calendar"""
 
@@ -400,9 +400,3 @@ class LunarCalendar:
         """
         today = datetime.now().date()
         return cls(today.year, today.month, today.day).to_lunar()
-
-
-# Run
-###########################################################################
-if __name__ == "__main__":
-    pass