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

absfuyu/tools/passwordlib.py

@@ -3,13 +3,13 @@ Absfuyu: Passwordlib
 --------------------
 Password library
 
-Version: 5.0.0
-Date updated: 22/02/2025 (dd/mm/yyyy)
+Version: 5.2.0
+Date updated: 15/03/2025 (dd/mm/yyyy)
 """
 
 # Module level
 # ---------------------------------------------------------------------------
-__all__ = ["PasswordGenerator", "TOTP"]
+__all__ = ["PasswordGenerator", "PasswordHash", "TOTP"]
 
 
 # Library
@@ -21,12 +21,12 @@ import re
 from typing import ClassVar, Literal, NamedTuple
 from urllib.parse import quote, urlencode
 
-from absfuyu.core import BaseClass, deprecated, versionadded
+from absfuyu.core.baseclass import BaseClass
+from absfuyu.core.docstring import deprecated, versionadded
 from absfuyu.dxt import DictExt, Text
 from absfuyu.logger import logger
 from absfuyu.pkg_data import DataList, DataLoader
 from absfuyu.tools.generator import Charset, Generator
-from absfuyu.util import set_min
 
 
 # Function
@@ -88,6 +88,18 @@ def _password_check(password: str) -> bool:
 # Class
 # ---------------------------------------------------------------------------
 class PasswordHash(NamedTuple):
+    """
+    Password hash
+
+    Parameters
+    ----------
+    salt : bytes
+        Salt
+
+    key : bytes
+        Key
+    """
+
     salt: bytes
     key: bytes
 
@@ -102,7 +114,17 @@ class PasswordGenerator(BaseClass):
     @staticmethod
     def password_hash(password: str) -> PasswordHash:
         """
-        Generate hash for password
+        Generate hash for password.
+
+        Parameters
+        ----------
+        password : str
+            Password string
+
+        Returns
+        -------
+        PasswordHash
+            Password hash contains salt and key
         """
         salt = os.urandom(32)
         key = hashlib.pbkdf2_hmac(
@@ -116,7 +138,19 @@ class PasswordGenerator(BaseClass):
 
     @staticmethod
     def password_check(password: str) -> dict:
-        """Check password's characteristic"""
+        """
+        Check password's characteristic.
+
+        Parameters
+        ----------
+        password : str
+            Password string
+
+        Returns
+        -------
+        dict
+            Password's characteristic.
+        """
         data = Text(password).analyze()
         data = DictExt(data).apply(lambda x: True if x > 0 else False)  # type: ignore
         data.__setitem__("length", len(password))
@@ -131,7 +165,7 @@ class PasswordGenerator(BaseClass):
         include_special: bool = True,
     ) -> str:
         r"""
-        Generate a random password
+        Generate a random password.
 
         Parameters
         ----------
@@ -141,13 +175,13 @@ class PasswordGenerator(BaseClass):
             | (Default: ``8``)
 
         include_uppercase : bool
-            Include uppercase character in the password (Default: ``True``)
+            Include uppercase character in the password, by default ``True``
 
         include_number : bool
-            Include digit character in the password (Default: ``True``)
+            Include digit character in the password, by default ``True``
 
         include_special : bool
-            Include special character in the password (Default: ``True``)
+            Include special character in the password, by default ``True``
 
         Returns
         -------
@@ -178,7 +212,7 @@ class PasswordGenerator(BaseClass):
         while True:
             pwd = Generator.generate_string(
                 charset=charset,
-                size=set_min(length, min_value=8),  # type: ignore
+                size=max(length, 8),  # type: ignore
                 times=1,
                 string_type_if_1=True,
             )
@@ -205,16 +239,16 @@ class PasswordGenerator(BaseClass):
         Parameters
         ----------
         num_of_blocks : int
-            Number of word used (Default: ``5``)
+            Number of word used, by default ``5``
 
         block_divider : str
-            Character symbol that between each word (Default: ``"-"``)
+            Character symbol that between each word, by default ``"-"``
 
         first_letter_cap : bool
-            Capitalize first character of each word (Default: ``True``)
+            Capitalize first character of each word, by default ``True``
 
         include_number : bool
-            Add number to the end of each word (Default: ``True``)
+            Add number to the end of each word, by default ``True``
 
         custom_word_list : list[str] | None
             Custom word list for passphrase generation, by default uses a list of 360K+ words
@@ -255,6 +289,33 @@ class PasswordGenerator(BaseClass):
 class TOTP(BaseClass):
     """
     A class to represent a Time-based One-Time Password (TOTP) generator.
+
+    Parameters
+    ----------
+    secret : str
+        The shared secret key used to generate the TOTP.
+
+    name : str, optional
+        | The name associated with the TOTP.
+        | If not provided, by default ``"None"``.
+
+    issuer : str, optional
+        The issuer of the TOTP.
+
+    algorithm : Literal["SHA1", "SHA256", "SHA512"], optional
+        | The hashing algorithm used to generate the TOTP.
+        | Must be one of ``"SHA1"``, ``"SHA256"``, or ``"SHA512"``.
+        | By default ``"SHA1"``.
+
+    digit : int, optional
+        | The number of digits in the generated TOTP.
+        | Must be greater than 0.
+        | By default ``6``.
+
+    period : int, optional
+        | The time step in seconds for TOTP generation.
+        | Must be greater than 0.
+        | by default ``30``.
     """
 
     URL_SCHEME: ClassVar[str] = "otpauth://totp/"
@@ -277,23 +338,26 @@ class TOTP(BaseClass):
             The shared secret key used to generate the TOTP.
 
         name : str, optional
-            The name associated with the TOTP. If not provided, defaults to ``"None"``.
+            | The name associated with the TOTP.
+            | If not provided, by default ``"None"``.
 
         issuer : str, optional
             The issuer of the TOTP.
 
         algorithm : Literal["SHA1", "SHA256", "SHA512"], optional
-            The hashing algorithm used to generate the TOTP.
-            Must be one of ``"SHA1"``, ``"SHA256"``, or ``"SHA512"``.
-            Defaults to ``"SHA1"``.
+            | The hashing algorithm used to generate the TOTP.
+            | Must be one of ``"SHA1"``, ``"SHA256"``, or ``"SHA512"``.
+            | By default ``"SHA1"``.
 
         digit : int, optional
-            The number of digits in the generated TOTP. Must be greater than 0.
-            Defaults to ``6``.
+            | The number of digits in the generated TOTP.
+            | Must be greater than 0.
+            | By default ``6``.
 
         period : int, optional
-            The time step in seconds for TOTP generation. Must be greater than 0.
-            Defaults to ``30``.
+            | The time step in seconds for TOTP generation.
+            | Must be greater than 0.
+            | by default ``30``.
         """
         self.secret = secret.upper()
         self.name = name if name else "None"

absfuyu/tools/shutdownizer.py

@@ -3,8 +3,8 @@ Absfuyu: Shutdownizer
 ---------------------
 This shutdowns
 
-Version: 5.0.0
-Date updated: 23/02/2025 (dd/mm/yyyy)
+Version: 5.2.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 """
 
 # Module level

absfuyu/tools/web.py

@@ -3,8 +3,8 @@ Absfuyu: Web
 ------------
 Web, ``request``, ``BeautifulSoup`` stuff
 
-Version: 5.0.0
-Date updated: 22/02/2025 (dd/mm/yyyy)
+Version: 5.2.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 """
 
 # Library

absfuyu/typings.py

@@ -0,0 +1,136 @@
+"""
+Absfuyu: Core
+-------------
+Pre-defined typing
+
+Version: 5.2.0
+Date updated: 14/03/2025 (dd/mm/yyyy)
+"""
+
+# Module Package
+# ---------------------------------------------------------------------------
+__all__ = [
+    # Type
+    "T",
+    "T_co",
+    "T_contra",
+    "P",
+    "R",
+    "_CALLABLE",
+    "CT",
+    "N",
+    "_Number",
+    "override",
+    # Protocol
+    "SupportsShowMethods",
+]
+
+
+# Library
+# ---------------------------------------------------------------------------
+from collections.abc import Callable
+from typing import Any, ParamSpec, Protocol, TypeVar, overload
+
+try:
+    from typing import override  # type: ignore
+except ImportError:
+    from absfuyu.core.decorator import dummy_decorator as override
+
+
+# Type
+# ---------------------------------------------------------------------------
+# Types where neither is possible are invariant
+T = TypeVar("T")  # Type invariant
+# Type variables that are covariant can be substituted
+# with a more specific type without causing errors
+T_co = TypeVar("T_co", covariant=True)  # Type covariant
+# Type variables that are contravariant can be substituted
+# with a more general type without causing errors
+T_contra = TypeVar("T_contra", contravariant=True)  # Type contravariant
+
+# Callable
+P = ParamSpec("P")  # Parameter type
+R = TypeVar("R")  # Return type - Can be anything
+_CALLABLE = Callable[P, R]
+
+# Class type - Can be any subtype of `type`
+CT = TypeVar("CT", bound=type)
+
+# Number type
+N = TypeVar("N", int, float)  # Must be int or float
+_Number = int | float
+
+
+# Protocol
+# ---------------------------------------------------------------------------
+class SupportsShowMethods(Protocol):
+    """
+    Support class with ``show_all_methods()``
+    and ``show_all_properties()`` method
+    from ``absfuyu.core.basclass.ShowAllMethodsMixin``
+    """
+
+    @overload
+    @classmethod
+    def show_all_methods(cls) -> dict[str, list[str]]: ...
+
+    @overload
+    @classmethod
+    def show_all_methods(
+        cls,
+        print_result: bool = False,
+        include_classmethod: bool = True,
+        classmethod_indicator: str = "<classmethod>",
+        include_staticmethod: bool = True,
+        staticmethod_indicator: str = "<staticmethod>",
+        include_private_method: bool = False,
+    ) -> dict[str, list[str]]: ...
+
+    @classmethod
+    def show_all_methods(cls, *args, **kwargs) -> Any: ...
+
+    @overload
+    @classmethod
+    def show_all_properties(cls) -> dict[str, list[str]]: ...
+
+    @overload
+    @classmethod
+    def show_all_properties(
+        cls, print_result: bool = False
+    ) -> dict[str, list[str]]: ...
+
+    @classmethod
+    def show_all_properties(cls, *args, **kwargs) -> Any: ...
+
+
+# Note
+# ---------------------------------------------------------------------------
+# Iterable                               : __iter__
+# Iterator(Iterable)                     : __next__, __iter__
+# Reversible(Iterable)                   : __reversed__, __iter__
+# Sized                                  : __len__
+# Container                              : __contains__
+# Collection(Sized, Iterable, Container) : __len__, __iter__, __contains__
+# Set(Collection)                        : __contains__, __iter__, __len__
+# MutableSet(Set)                        : __contains__, __iter__, __len__
+# Mapping(Collection)                    : __getitem__, __iter__, and __len__
+# MutableMapping(Mapping)                : __getitem__, __setitem__, __delitem__,__iter__, __len__
+# Sequence(Reversible, Collection)       : __reversed__, __len__, __iter__, __contains__
+# MutableSequence(Sequence)              : __getitem__, __setitem__, __delitem__, __reversed__, __len__, __iter__, __contains__
+
+# Iterable                               : str, dict, list, tuple, set
+# Iterator(Iterable)                     : Generator
+# Reversible(Iterable)                   : str, dict, list, tuple
+# Sized                                  : str, dict, list, tuple, set
+# Container                              : str, dict, list, tuple, set
+# Collection(Sized, Iterable, Container) : str, dict, list, tuple, set
+# Set(Collection)                        : set
+# MutableSet(Set)                        : set
+# Mapping(Collection)                    : dict
+# MutableMapping(Mapping)                : dict
+# Sequence(Reversible, Collection)       : str, list, tuple
+# MutableSequence(Sequence)              : list
+
+# __iter__: for <...> in <...>
+# __len__: len(<...>)
+# __contains__: if <...> in <...>

absfuyu/util/__init__.py

@@ -3,10 +3,20 @@ Absufyu: Utilities
 ------------------
 Some random utilities
 
-Version: 5.0.0
-Date updated: 25/02/2025 (dd/mm/yyyy)
+Version: 5.2.0
+Date updated: 12/03/2025 (dd/mm/yyyy)
 """
 
+# Module Package
+# ---------------------------------------------------------------------------
+__all__ = [
+    "get_installed_package",
+    "set_min",
+    "set_max",
+    "set_min_max",
+    "stop_after_day",
+]
+
 # Library
 # ---------------------------------------------------------------------------
 import pkgutil
@@ -137,8 +147,12 @@ def set_min_max(
     >>> set_min_max(808)
     100
     """
-    current_value = set_min(current_value, min_value=min_value)
-    current_value = set_max(current_value, max_value=max_value)
+    # Set min
+    # current_value = set_min(current_value, min_value=min_value)
+    current_value = max(current_value, min_value)
+    # Set max
+    # current_value = set_max(current_value, max_value=max_value)
+    current_value = min(current_value, max_value)
     return current_value
 
 

absfuyu/util/api.py

@@ -3,8 +3,8 @@ Absufyu: API
 ------------
 Fetch data stuff
 
-Version: 5.0.0
-Date updated: 22/02/2025 (dd/mm/yyyy)
+Version: 5.2.0
+Date updated: 12/03/2025 (dd/mm/yyyy)
 """
 
 # Module level
@@ -25,7 +25,8 @@ from typing import NamedTuple
 
 import requests
 
-from absfuyu.core import versionadded, versionchanged
+from absfuyu.core.baseclass import BaseClass
+from absfuyu.core.docstring import versionadded, versionchanged
 from absfuyu.logger import logger
 
 
@@ -33,8 +34,15 @@ from absfuyu.logger import logger
 # ---------------------------------------------------------------------------
 class PingResult(NamedTuple):
     """
-    :param host: Host name/IP
-    :param result: Ping result in ms
+    Ping result
+
+    Parameters
+    ----------
+    host : str
+        Host name/IP
+
+    result : str
+        Ping result in ms
     """
 
     host: str
@@ -90,28 +98,40 @@ def ping_windows(host: list[str], ping_count: int = 3) -> list[PingResult]:
 
 # Class
 # ---------------------------------------------------------------------------
-class APIRequest:
-    """API data with cache feature"""
+class APIRequest(BaseClass):
+    """
+    API data with cache feature
+
+    Parameters
+    ----------
+    api_url : str
+        API link
+
+    encoding : str | None, optional
+        Data encoding, by default ``"utf-8"``
+    """
 
     def __init__(
         self,
         api_url: str,
-        *,  # Use "*" to force using keyword in function parameter | Example: APIRequest(url, encoding="utf-8")
+        *,
         encoding: str | None = "utf-8",
     ) -> None:
         """
-        :param api_url: api link
-        :param encoding: data encoding (Default: utf-8)
+        Create APIRequest instance
+
+        Parameters
+        ----------
+        api_url : str
+            API link
+
+        encoding : str | None, optional
+            Data encoding, by default ``"utf-8"``
         """
+
         self.url = api_url
         self.encoding = encoding
 
-    def __str__(self) -> str:
-        return f"{self.__class__.__name__}({self.url})"
-
-    def __repr__(self) -> str:
-        return self.__str__()
-
     def fetch_data(self, *, update: bool = False, json_cache: str | Path):
         """
         Fetch data from an API then cache it for later use

absfuyu/util/json_method.py

@@ -3,8 +3,8 @@ Absfuyu: Json Method
 --------------------
 ``.json`` file handling
 
-Version: 5.0.0
-Date updated: 25/02/2025 (dd/mm/yyyy)
+Version: 5.2.0
+Date updated: 12/03/2025 (dd/mm/yyyy)
 """
 
 # Module level
@@ -16,7 +16,6 @@ __all__ = ["JsonFile"]
 # ---------------------------------------------------------------------------
 import json
 from pathlib import Path
-from typing import Any
 
 from absfuyu.core import BaseClass
 
@@ -26,6 +25,20 @@ from absfuyu.core import BaseClass
 class JsonFile(BaseClass):
     """
     ``.json`` file handling
+
+    Parameters
+    ----------
+    json_file_location : str | Path
+        .json file location
+
+    encoding : str | None, optional
+        Data encoding, by default ``"utf-8"``
+
+    indent : int | str | None, optional
+        Indentation when export to json file, by default ``4``
+
+    sort_keys : bool, optional
+        Sort the keys before export to json file, by default ``True``
     """
 
     def __init__(
@@ -37,26 +50,40 @@ class JsonFile(BaseClass):
         sort_keys: bool = True,
     ) -> None:
         """
-        json_file_location: json file location
-        encoding: data encoding (Default: utf-8)
-        indent: indentation when export to json file
-        sort_keys: sort the keys before export to json file
+        ``.json`` file handling
+
+        Parameters
+        ----------
+        json_file_location : str | Path
+            .json file location
+
+        encoding : str | None, optional
+            Data encoding, by default ``"utf-8"``
+
+        indent : int | str | None, optional
+            Indentation when export to json file, by default ``4``
+
+        sort_keys : bool, optional
+            Sort the keys before export to json file, by default ``True``
         """
+
         self.json_file_location = Path(json_file_location)
         self.encoding = encoding
         self.indent = indent
         self.sort_keys = sort_keys
-        self.data: dict[Any, Any] = {}
+        self.data: dict = {}
 
     def __str__(self) -> str:
         return f"{self.__class__.__name__}({self.json_file_location.name})"
 
-    def load_json(self) -> dict[Any, Any]:
+    def load_json(self) -> dict:
         """
         Load ``.json`` file
 
-        :returns: ``.json`` data
-        :rtype: dict
+        Returns
+        -------
+        dict
+            ``.json`` data
         """
         with open(self.json_file_location, "r", encoding=self.encoding) as file:
             self.data = json.load(file)
@@ -68,11 +95,13 @@ class JsonFile(BaseClass):
         with open(self.json_file_location, "w", encoding=self.encoding) as file:
             file.writelines(json_data)
 
-    def update_data(self, data: dict[Any, Any]) -> None:
+    def update_data(self, data: dict) -> None:
         """
         Update ``.json`` data without save
 
-        :param data: ``.json`` data
-        :type data: dict
+        Parameters
+        ----------
+        data : dict
+            ``.json`` data
         """
         self.data = data

absfuyu/util/lunar.py

@@ -4,8 +4,8 @@ Absfuyu: Lunar calendar
 -----------------------
 Convert to lunar calendar
 
-Version: 5.0.0
-Date updated: 22/02/2025 (dd/mm/yyyy)
+Version: 5.2.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 
 Source:
 -------