absfuyu 4.1.1__py3-none-any.whl → 5.0.0__py3-none-any.whl

absfuyu/util/__init__.py

@@ -8,15 +8,16 @@ Date updated: 25/11/2024 (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: 13/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

@@ -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

absfuyu/util/path.py

@@ -3,8 +3,8 @@ Absfuyu: Path
 -------------
 Path related
 
-Version: 1.6.7
-Date updated: 06/01/2025 (dd/mm/yyyy)
+Version: 5.0.0
+Date updated: 13/02/2025 (dd/mm/yyyy)
 
 Feature:
 --------
@@ -13,7 +13,7 @@ Feature:
 """
 
 # Module level
-###########################################################################
+# ---------------------------------------------------------------------------
 __all__ = [
     # Main
     "Directory",
@@ -25,7 +25,7 @@ __all__ = [
 
 
 # Library
-###########################################################################
+# ---------------------------------------------------------------------------
 import os
 import re
 import shutil
@@ -34,14 +34,13 @@ from functools import partial
 from pathlib import Path
 from typing import Any, Literal, NamedTuple
 
-from deprecated.sphinx import versionadded
-
-from absfuyu.logger import LogLevel, logger
+from absfuyu.core import versionadded
+from absfuyu.logger import logger
 
 
 # Support Class
-###########################################################################
-@versionadded(version="3.3.0")
+# ---------------------------------------------------------------------------
+@versionadded("3.3.0")
 class FileOrFolderWithModificationTime(NamedTuple):
     """
     File or Folder with modification time
@@ -54,9 +53,11 @@ class FileOrFolderWithModificationTime(NamedTuple):
     modification_time: datetime
 
 
-@versionadded(version="3.3.0")
+@versionadded("3.3.0")
 class DirectoryInfo(NamedTuple):
-    """Information of a directory"""
+    """
+    Information of a directory
+    """
 
     files: int
     folders: int
@@ -65,7 +66,7 @@ class DirectoryInfo(NamedTuple):
 
 
 # Class - Directory | version 3.4.0: Remake Directory into modular class
-###########################################################################
+# ---------------------------------------------------------------------------
 class DirectoryBase:
     def __init__(
         self,
@@ -113,21 +114,21 @@ class DirectoryBase:
 
     # Everything
     @property
-    @versionadded(version="3.3.0")
+    @versionadded("3.3.0")
     def everything(self) -> list[Path]:
         """
         Every folders and files in this Directory
         """
         return list(x for x in self.source_path.glob("**/*"))
 
-    @versionadded(version="3.3.0")
+    @versionadded("3.3.0")
     def _every_folder(self) -> list[Path]:
         """
         Every folders in this Directory
         """
         return list(x for x in self.source_path.glob("**/*") if x.is_dir())
 
-    @versionadded(version="3.3.0")
+    @versionadded("3.3.0")
     def _every_file(self) -> list[Path]:
         """
         Every folders in this Directory
@@ -135,7 +136,7 @@ class DirectoryBase:
         return list(x for x in self.source_path.glob("**/*") if x.is_file())
 
     # Quick information
-    @versionadded(version="3.3.0")
+    @versionadded("3.3.0")
     def quick_info(self) -> DirectoryInfo:
         """
         Quick information about this Directory
@@ -396,7 +397,7 @@ class Directory(DirectoryBasicOperation, DirectoryTree):
         ]
 
     @staticmethod
-    @versionadded(version="3.3.0")
+    @versionadded("3.3.0")
     def _split_dir(list_of_path: list[Path]) -> list[list[str]]:
         """
         Split pathname by ``os.sep``
@@ -450,9 +451,9 @@ class Directory(DirectoryBasicOperation, DirectoryTree):
             Folder structure ready to print
         """
         # Check for tab and sub-dir symbol
-        if not tab_symbol:
+        if tab_symbol is None:
             tab_symbol = "\t"
-        if not sub_dir_symbol:
+        if sub_dir_symbol is None:
             sub_dir_symbol = "|-- "
 
         temp: list[list[str]] = self._split_dir(list_of_path)
@@ -504,7 +505,7 @@ class Directory(DirectoryBasicOperation, DirectoryTree):
 
 
 # Class - SaveFileAs
-###########################################################################
+# ---------------------------------------------------------------------------
 class SaveFileAs:
     """File as multiple file type"""
 
@@ -554,12 +555,6 @@ class SaveFileAs:
 
 
 # Dev and Test new feature before get added to the main class
-###########################################################################
+# ---------------------------------------------------------------------------
 class _NewDirFeature(Directory):
     pass
-
-
-# Run
-###########################################################################
-if __name__ == "__main__":
-    logger.setLevel(LogLevel.DEBUG)

absfuyu/util/performance.py

@@ -3,8 +3,8 @@ Absfuyu: Performance
 --------------------
 Performance Check
 
-Version: 1.2.4
-Date updated: 15/11/2024 (dd/mm/yyyy)
+Version: 5.0.0
+Date updated: 13/02/2025 (dd/mm/yyyy)
 
 Feature:
 --------
@@ -16,7 +16,7 @@ Feature:
 """
 
 # Module level
-###########################################################################
+# ---------------------------------------------------------------------------
 __all__ = [
     # Wrapper
     "function_debug",
@@ -28,36 +28,39 @@ __all__ = [
 
 
 # Library
-###########################################################################
+# ---------------------------------------------------------------------------
 import time
 import tracemalloc
+from collections.abc import Callable
 from functools import wraps
 from inspect import getsource
-from typing import Any, Callable
+from typing import Any, ParamSpec, TypeVar
 
-from deprecated.sphinx import versionadded, versionchanged
+from absfuyu.core import versionadded, versionchanged
+from absfuyu.dxt import ListNoDunder
 
-from absfuyu.general.data_extension import ListNoDunder
-
-# from absfuyu.logger import logger, LogLevel
+# Type
+# ---------------------------------------------------------------------------
+P = ParamSpec("P")  # Parameter type
+R = TypeVar("R")  # Return type
 
 
 # Function
-###########################################################################
-@versionchanged(version="3.2.0", reason="Clean up code")
-def measure_performance(func: Callable) -> Callable:  # type: ignore
+# ---------------------------------------------------------------------------
+@versionchanged("3.2.0", reason="Updated functionality")
+def measure_performance(f: Callable[P, R]) -> Callable[P, R]:
     r"""
     Measure performance of a function
 
     Parameters
     ----------
-    func : Callable
-        A callable function
+    f : Callable [P, R]
+        Function to measure
 
     Returns
     -------
     Callable
-        A callable function
+        A decorated function
 
 
     Usage
@@ -76,14 +79,15 @@ def measure_performance(func: Callable) -> Callable:  # type: ignore
         Peak memory usage:	 0.000000 MB
         Time elapsed (seconds):	 0.000002
         --------------------------------------
+
     """
 
-    @wraps(func)
-    def wrapper(*args, **kwargs) -> Any:
+    @wraps(f)
+    def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
         # Performance check
         tracemalloc.start()  # Start memory measure
         start_time = time.perf_counter()  # Start time measure
-        output = func(*args, **kwargs)  # Run function and save result into a variable
+        output = f(*args, **kwargs)  # Run function and save result into a variable
         current, peak = tracemalloc.get_traced_memory()  # Get memory stats
         finish_time = time.perf_counter()  # Get finished time
         tracemalloc.stop()  # End memory measure
@@ -91,7 +95,7 @@ def measure_performance(func: Callable) -> Callable:  # type: ignore
         # Print output
         print(
             f"{'-' * 38}\n"
-            f"Function: {func.__name__}\n"
+            f"Function: {f.__name__}\n"
             f"Memory usage:\t\t {current / 10**6:,.6f} MB\n"
             f"Peak memory usage:\t {peak / 10**6:,.6f} MB\n"
             f"Time elapsed (seconds):\t {finish_time - start_time:,.6f}\n"
@@ -104,20 +108,20 @@ def measure_performance(func: Callable) -> Callable:  # type: ignore
     return wrapper
 
 
-@versionadded(version="3.2.0")
-def function_debug(func: Callable) -> Callable:  # type: ignore
+@versionadded("3.2.0")
+def function_debug(f: Callable[P, R]) -> Callable[P, R]:
     """
     Print the function signature and return value
 
     Parameters
     ----------
     func : Callable
-        A callable function
+        Function to debug
 
     Returns
     -------
     Callable
-        A callable function
+        A decorated function
 
 
     Usage
@@ -134,26 +138,26 @@ def function_debug(func: Callable) -> Callable:  # type: ignore
     test() returned 14
     """
 
-    @wraps(func)
-    def wrapper(*args, **kwargs) -> Any:
+    @wraps(f)
+    def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
         # Get all parameters inputed
         args_repr = [repr(a) for a in args]
         kwargs_repr = [f"{k}={repr(v)}" for k, v in kwargs.items()]
         signature = ", ".join(args_repr + kwargs_repr)
 
         # Output
-        print(f"Calling {func.__name__}({signature})")
+        print(f"Calling {f.__name__}({signature})")
         # logger.debug(f"Calling {func.__name__}({signature})")
-        value = func(*args, **kwargs)
-        print(f"{func.__name__}() returned {repr(value)}")
+        value = f(*args, **kwargs)
+        print(f"{f.__name__}() returned {repr(value)}")
         # logger.debug(f"{func.__name__}() returned {repr(value)}")
         return value
 
     return wrapper
 
 
-@versionadded(version="3.2.0")
-def retry(retries: int = 3, delay: float = 1) -> Callable:  # type: ignore
+@versionadded("3.2.0")
+def retry(retries: int, delay: float = 1):
     """
     Attempt to call a function, if it fails, try again with a specified delay.
 
@@ -168,7 +172,7 @@ def retry(retries: int = 3, delay: float = 1) -> Callable:  # type: ignore
     Returns
     -------
     Callable
-        A callable function
+        A decorated function
 
 
     Usage
@@ -195,18 +199,18 @@ def retry(retries: int = 3, delay: float = 1) -> Callable:  # type: ignore
     if retries < 1 or delay <= 0:
         raise ValueError("retries must be >= 1, delay must be >= 0")
 
-    def decorator(func: Callable) -> Callable:  # type: ignore
-        @wraps(func)
-        def wrapper(*args, **kwargs) -> Any:
+    def decorator(f: Callable[P, R]) -> Callable[P, R]:
+        @wraps(f)
+        def wrapper(*args: P.args, **kwargs: P.kwargs):
             for i in range(1, retries + 1):
                 try:
-                    print(f"Running ({i}): {func.__name__}()")
-                    return func(*args, **kwargs)
+                    print(f"Running ({i}): {f.__name__}()")
+                    return f(*args, **kwargs)
                 except Exception as e:
                     # Break out of the loop if the max amount of retries is exceeded
                     if i == retries:
                         print(f"Error: {repr(e)}.")
-                        print(f'"{func.__name__}()" failed after {retries} retries.')
+                        print(f'"{f.__name__}()" failed after {retries} retries.')
                         break
                     else:
                         print(f"Error: {repr(e)} -> Retrying...")
@@ -219,31 +223,9 @@ def retry(retries: int = 3, delay: float = 1) -> Callable:  # type: ignore
     return decorator
 
 
-def _deprecated_warning(func: Callable):  # type: ignore
-    """
-    Notice that the function is deprecated and should not be used
-
-    Parameters
-    ----------
-    func : Callable
-        A callable function
-
-    Usage
-    -----
-    Use this as the decorator (``@deprecated_warning``)
-    """
-
-    @wraps(func)
-    def wrapper(*args, **kwargs) -> Any:
-        print(f"[WARNING] {func.__name__}() is deprecated")
-        value = func(*args, **kwargs)
-        return value
-
-    return wrapper
-
-
 # Class
-###########################################################################
+# ---------------------------------------------------------------------------
+# TODO: Rewrite this with inspect
 class Checker:
     """
     Check a variable
@@ -339,9 +321,3 @@ class Checker:
             out["docs"] = self.docstring
             out["source"] = self.source
         return out
-
-
-# Run
-###########################################################################
-if __name__ == "__main__":
-    pass