absfuyu 5.0.1__py3-none-any.whl → 5.1.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.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 """
 
 # Module level
 # ---------------------------------------------------------------------------
-__all__ = ["PasswordGenerator", "TOTP"]
+__all__ = ["PasswordGenerator", "PasswordHash", "TOTP"]
 
 
 # Library
@@ -21,7 +21,8 @@ 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
@@ -88,6 +89,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 +115,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 +139,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 +166,7 @@ class PasswordGenerator(BaseClass):
         include_special: bool = True,
     ) -> str:
         r"""
-        Generate a random password
+        Generate a random password.
 
         Parameters
         ----------
@@ -141,13 +176,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
         -------
@@ -205,16 +240,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 +290,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 +339,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.1.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.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 """
 
 # Library

absfuyu/util/__init__.py

@@ -3,8 +3,8 @@ Absufyu: Utilities
 ------------------
 Some random utilities
 
-Version: 5.0.0
-Date updated: 25/02/2025 (dd/mm/yyyy)
+Version: 5.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 """
 
 # Library

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.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 """
 
 # Module level

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.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 """
 
 # Module level

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.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 
 Source:
 -------

absfuyu/util/path.py

@@ -3,8 +3,8 @@ Absfuyu: Path
 -------------
 Path related
 
-Version: 5.0.0
-Date updated: 22/02/2025 (dd/mm/yyyy)
+Version: 5.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 
 Feature:
 --------
@@ -16,8 +16,15 @@ Feature:
 # ---------------------------------------------------------------------------
 __all__ = [
     # Main
+    "DirectoryBase",
     "Directory",
     "SaveFileAs",
+    # Mixin
+    "DirectoryInfoMixin",
+    "DirectoryBasicOperationMixin",
+    "DirectoryArchiverMixin",
+    "DirectoryOrganizerMixin",
+    "DirectoryTreeMixin",
     # Support
     "FileOrFolderWithModificationTime",
     "DirectoryInfo",
@@ -32,9 +39,11 @@ import shutil
 from datetime import datetime
 from functools import partial
 from pathlib import Path
-from typing import Any, Literal, NamedTuple
+from typing import Any, ClassVar, Literal, NamedTuple
 
-from absfuyu.core import versionadded
+from absfuyu.core.baseclass import BaseClass
+from absfuyu.core.decorator import add_subclass_methods_decorator
+from absfuyu.core.docstring import deprecated, versionadded, versionchanged
 from absfuyu.logger import logger
 
 
@@ -53,21 +62,40 @@ class FileOrFolderWithModificationTime(NamedTuple):
     modification_time: datetime
 
 
+@deprecated(
+    "5.1.0", reason="Support for ``DirectoryInfoMixin`` which is also deprecated"
+)
 @versionadded("3.3.0")
 class DirectoryInfo(NamedTuple):
     """
     Information of a directory
     """
 
-    files: int
-    folders: int
     creation_time: datetime
     modification_time: datetime
 
 
-# Class - Directory | version 3.4.0: Remake Directory into modular class
+# Class - Directory
 # ---------------------------------------------------------------------------
-class DirectoryBase:
+@add_subclass_methods_decorator
+class DirectoryBase(BaseClass):
+    """
+    Directory - Base
+
+    Parameters
+    ----------
+    source_path : str | Path
+        Source folder
+
+    create_if_not_exist : bool
+        Create directory when not exist,
+        by default ``False``
+    """
+
+    # Custom attribute
+    _METHOD_INCLUDE: ClassVar[bool] = True  # Include in DIR_METHODS
+    SUBCLASS_METHODS: ClassVar[dict[str, list[str]]] = {}
+
     def __init__(
         self,
         source_path: str | Path,
@@ -80,80 +108,53 @@ class DirectoryBase:
             Source folder
 
         create_if_not_exist : bool
-            Create directory when not exist
-            (Default: ``False``)
+            Create directory when not exist,
+            by default ``False``
         """
         self.source_path = Path(source_path)
-        if create_if_not_exist:
-            if not self.source_path.exists():
+        if not self.source_path.exists():
+            if create_if_not_exist:
                 self.source_path.mkdir(exist_ok=True, parents=True)
+            else:
+                raise FileNotFoundError("Directory not existed")
 
-    def __str__(self) -> str:
-        return self.source_path.__str__()
-
-    def __repr__(self) -> str:
-        return f"{self.__class__.__name__}({self.source_path})"
-
-    def __format__(self, __format_spec: str) -> str:
-        """
-        Change format of an object.
-        Avaiable option: ``info``
-
-        Usage
-        -----
-        >>> print(f"{<object>:<format_spec>}")
-        >>> print(<object>.__format__(<format_spec>))
-        >>> print(format(<object>, <format_spec>))
-        """
-        # Show quick info
-        if __format_spec.lower().startswith("info"):
-            return self.quick_info().__repr__()
-
-        # No format spec
-        return self.__repr__()
 
-    # Everything
-    @property
-    @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("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())
+class DirectoryInfoMixin(DirectoryBase):
+    """
+    Directory - Info
 
-    @versionadded("3.3.0")
-    def _every_file(self) -> list[Path]:
-        """
-        Every folders in this Directory
-        """
-        return list(x for x in self.source_path.glob("**/*") if x.is_file())
+    - Quick info
+    """
 
-    # Quick information
+    @deprecated("5.1.0", reason="Not efficient")
     @versionadded("3.3.0")
     def quick_info(self) -> DirectoryInfo:
         """
         Quick information about this Directory
 
-        :rtype: DirectoryInfo
+        Returns
+        -------
+        DirectoryInfo
+            DirectoryInfo
         """
         source_stat: os.stat_result = self.source_path.stat()
         out = DirectoryInfo(
-            files=len(self._every_file()),
-            folders=len(self._every_folder()),
             creation_time=datetime.fromtimestamp(source_stat.st_ctime),
             modification_time=datetime.fromtimestamp(source_stat.st_mtime),
         )
         return out
 
 
-class DirectoryBasicOperation(DirectoryBase):
+class DirectoryBasicOperationMixin(DirectoryBase):
+    """
+    Directory - Basic operation
+
+    - Rename
+    - Copy
+    - Move
+    - Delete
+    """
+
     # Rename
     def rename(self, new_name: str) -> None:
         """
@@ -214,7 +215,7 @@ class DirectoryBasicOperation(DirectoryBase):
                 shutil.move(self.source_path, Path(dst))
             logger.debug(f"Moving to {dst}...DONE")
 
-        except shutil.Error as e:  # File already exists
+        except OSError as e:  # File already exists
             logger.error(e)
             logger.debug("Overwriting file...")
             if content_only:
@@ -316,31 +317,54 @@ class DirectoryBasicOperation(DirectoryBase):
         except Exception as e:
             logger.error(f"Removing {self.source_path}...FAILED\n{e}")
 
-    # Zip
+
+class DirectoryArchiverMixin(DirectoryBase):
+    """
+    Directory - Archiver/Compress
+
+    - Compress
+    - Decompress
+    - Register extra zip format <staticmethod>
+    """
+
+    @versionchanged("5.1.0", reason="Update funcionality (new parameter)")
     def compress(
-        self, *, format: Literal["zip", "tar", "gztar", "bztar", "xztar"] = "zip"
+        self,
+        format: Literal["zip", "tar", "gztar", "bztar", "xztar"] = "zip",
+        delete_after_compress: bool = False,
+        move_inside: bool = True,
     ) -> Path | None:
         """
         Compress the directory (Default: Create ``.zip`` file)
 
         Parameters
         ----------
-        format : Literal["zip", "tar", "gztar", "bztar", "xztar"]
+        format : Literal["zip", "tar", "gztar", "bztar", "xztar"], optional
+            By default ``"zip"``
             - ``zip``: ZIP file (if the ``zlib`` module is available).
             - ``tar``: Uncompressed tar file. Uses POSIX.1-2001 pax format for new archives.
             - ``gztar``: gzip'ed tar-file (if the ``zlib`` module is available).
             - ``bztar``: bzip2'ed tar-file (if the ``bz2`` module is available).
             - ``xztar``: xz'ed tar-file (if the ``lzma`` module is available).
 
+        delete_after_compress : bool, optional
+            Delete directory after compress, by default ``False``
+
+        move_inside : bool, optional
+            Move the commpressed file inside the directory,
+            by default ``True``
+
         Returns
         -------
         Path
             Compressed path
+
         None
             When fail to compress
         """
         logger.debug(f"Zipping {self.source_path}...")
         try:
+            # Zip
             # zip_name = self.source_path.parent.joinpath(self.source_path.name).__str__()
             # shutil.make_archive(zip_name, format=format, root_dir=self.source_path)
             zip_path = shutil.make_archive(
@@ -348,26 +372,85 @@ class DirectoryBasicOperation(DirectoryBase):
             )
             logger.debug(f"Zipping {self.source_path}...DONE")
             logger.debug(f"Path: {zip_path}")
+
+            # Del
+            if delete_after_compress:
+                move_inside = False
+                shutil.rmtree(self.source_path)
+
+            # Move
+            if move_inside:
+                zf = Path(zip_path)
+                _move_path = self.source_path.joinpath(zf.name)
+                if _move_path.exists():
+                    _move_path.unlink(missing_ok=True)
+                _move = zf.rename(_move_path)
+                return _move
+
             return Path(zip_path)
-        except Exception as e:
+        except (FileExistsError, OSError) as e:
             logger.error(f"Zipping {self.source_path}...FAILED\n{e}")
             return None
 
+    @staticmethod
+    @versionadded("5.1.0")
+    def register_extra_zip_format() -> None:
+        """This register extra extension for zipfile"""
+        extra_extension = [".zip", ".cbz"]
+        shutil.unregister_unpack_format("zip")
+        shutil.register_unpack_format(
+            "zip",
+            extra_extension,
+            shutil._unpack_zipfile,  # type: ignore
+            description="ZIP file",
+        )
 
-class DirectoryTree(DirectoryBase):
-    pass
+    @versionadded("5.1.0")
+    def decompress(
+        self,
+        format: Literal["zip", "tar", "gztar", "bztar", "xztar"] | None = None,
+        delete_after_done: bool = False,
+    ) -> None:
+        """
+        Decompress compressed file in directory (first level only)
+
+        Parameters
+        ----------
+        format : Literal["zip", "tar", "gztar", "bztar", "xztar"] | None, optional
+            By default ``None``
+            - ``zip``: ZIP file (if the ``zlib`` module is available).
+            - ``tar``: Uncompressed tar file. Uses POSIX.1-2001 pax format for new archives.
+            - ``gztar``: gzip'ed tar-file (if the ``zlib`` module is available).
+            - ``bztar``: bzip2'ed tar-file (if the ``bz2`` module is available).
+            - ``xztar``: xz'ed tar-file (if the ``lzma`` module is available).
 
+        delete_after_done : bool, optional
+            Delete compressed file when extracted, by default ``False``
+        """
+        # Register extra extension
+        self.register_extra_zip_format()
+
+        # Decompress first level only
+        for path in self.source_path.glob("*"):
+            try:
+                shutil.unpack_archive(
+                    path, path.parent.joinpath(path.stem), format=format
+                )
+                if delete_after_done and path.is_file():
+                    path.unlink(missing_ok=True)
+            except OSError:
+                continue
 
-class Directory(DirectoryBasicOperation, DirectoryTree):
-    """
-    Some shortcuts for directory
 
-    - list_structure
-    - delete, rename, copy, move
-    - zip
-    - quick_info
+class DirectoryOrganizerMixin(DirectoryBase):
     """
+    Directory - File organizer - SOON
+    """
+
+    pass
 
+
+class DirectoryTreeMixin(DirectoryBase):
     # Directory structure
     def _list_dir(self, *ignore: str) -> list[Path]:
         """
@@ -504,10 +587,41 @@ class Directory(DirectoryBasicOperation, DirectoryTree):
         return self.list_structure("__pycache__", ".pyc")
 
 
+class Directory(
+    DirectoryTreeMixin,
+    DirectoryOrganizerMixin,
+    DirectoryArchiverMixin,
+    DirectoryBasicOperationMixin,
+    DirectoryInfoMixin,
+):
+    """
+    Some shortcuts for directory
+
+    Parameters
+    ----------
+    source_path : str | Path
+        Source folder
+
+    create_if_not_exist : bool
+        Create directory when not exist,
+        by default ``False``
+
+
+    Example:
+    --------
+    >>> # For a list of method
+    >>> Directory.SUBCLASS_METHODS
+    """
+
+    pass
+
+
 # Class - SaveFileAs
 # ---------------------------------------------------------------------------
 class SaveFileAs:
-    """File as multiple file type"""
+    """
+    File as multiple file type
+    """
 
     def __init__(self, data: Any, *, encoding: str | None = "utf-8") -> None:
         """
@@ -552,9 +666,3 @@ class SaveFileAs:
     #     from absfuyu.util.json_method import JsonFile
     #     temp = JsonFile(path, sort_keys=False)
     #     temp.save_json()
-
-
-# Dev and Test new feature before get added to the main class
-# ---------------------------------------------------------------------------
-class _NewDirFeature(Directory):
-    pass