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

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

absfuyu/util/shorten_number.py

@@ -1,31 +1,47 @@
 """
 Absfuyu: Shorten number
----------------
+-----------------------
 Short number base on suffixes
 
-Version: 1.0.0
-Last update: 01/02/2025 (dd/mm/yyyy)
+Version: 5.0.0
+Date updated: 18/02/2025 (dd/mm/yyyy)
 """
 
 # Module level
-###########################################################################
-__all__ = ["UnitSuffixFactory", "CommonUnitSuffixesFactory", "Decimal"]
+# ---------------------------------------------------------------------------
+__all__ = [
+    "UnitSuffixFactory",
+    "CommonUnitSuffixesFactory",
+    "Decimal",
+    "shorten_number",
+]
 
 
 # Library
-###########################################################################
+# ---------------------------------------------------------------------------
+from collections.abc import Callable
 from dataclasses import dataclass, field
-from typing import Annotated, NamedTuple, Self
+from functools import wraps
+from typing import Annotated, NamedTuple, ParamSpec, Self, TypeVar
+
+from absfuyu.core import versionadded
+
+# Type
+# ---------------------------------------------------------------------------
+P = ParamSpec("P")  # Parameter type
+N = TypeVar("N", int, float)  # Number type
 
 
 # Class
-###########################################################################
+# ---------------------------------------------------------------------------
+@versionadded("4.1.0")
 class UnitSuffixFactory(NamedTuple):
     base: int
     short_name: list[str]
     full_name: list[str]
 
 
+@versionadded("4.1.0")
 class CommonUnitSuffixesFactory:
     NUMBER = UnitSuffixFactory(
         1000,
@@ -135,6 +151,7 @@ class CommonUnitSuffixesFactory:
 
 
 @dataclass
+@versionadded("4.1.0")
 class Decimal:
     """
     Shorten large number
@@ -160,7 +177,7 @@ class Decimal:
         self.value, self.suffix = self._convert_decimal()
 
     def __str__(self) -> str:
-        return self.to_text()
+        return self.to_text().strip()
 
     @classmethod
     def number(cls, value: int | float, suffix_full_name: bool = False) -> Self:
@@ -186,7 +203,7 @@ class Decimal:
         return f"{value:.2e}"
 
     def _get_factory(self) -> None:
-        if self.factory:
+        if self.factory is not None:
             self.base = self.factory.base
             self.suffixes = (
                 self.factory.full_name
@@ -222,7 +239,41 @@ class Decimal:
         return f"{formatted_value}{separator}{self.suffix}"
 
 
-# Run
-###########################################################################
-if __name__ == "__main__":
-    pass
+# Decorator
+# ---------------------------------------------------------------------------
+@versionadded("5.0.0")
+def shorten_number(f: Callable[P, N]) -> Callable[P, Decimal]:
+    """
+    Shorten the number value by name
+
+    Parameters
+    ----------
+    f : Callable[P, N]
+        Function that return ``int`` or ``float``
+
+    Returns
+    -------
+    Callable[P, Decimal]
+        Function that return ``Decimal``
+
+
+    Usage
+    -----
+    Use this as a decorator (``@shorten_number``)
+
+    Example:
+    --------
+    >>> import random
+    >>> @shorten_number
+    >>> def big_num() -> int:
+    ...     random.randint(100000000, 10000000000)
+    >>> big_num()
+    4.20 B
+    """
+
+    @wraps(f)
+    def wrapper(*args: P.args, **kwargs: P.kwargs) -> Decimal:
+        value = Decimal.number(f(*args, **kwargs))
+        return value
+
+    return wrapper

absfuyu/util/zipped.py

@@ -8,21 +8,24 @@ Date updated: 07/01/2025 (dd/mm/yyyy)
 """
 
 # Module level
-###########################################################################
-__all__ = ["Zipper"]
+# ---------------------------------------------------------------------------
+__all__ = [
+    "Zipper",
+]
 
 
 # Library
-###########################################################################
+# ---------------------------------------------------------------------------
 import shutil
 import zipfile
 from pathlib import Path
 
+from absfuyu.core import BaseClass, versionadded
 from absfuyu.logger import logger
 
 
-###########################################################################
-class Zipper:
+# ---------------------------------------------------------------------------
+class Zipper(BaseClass):
     """Zip file or folder"""
 
     def __init__(self, path_to_zip: str | Path, name: str | None = None) -> None:
@@ -40,9 +43,6 @@ class Zipper:
     def __str__(self) -> str:
         return f"{self.__class__.__name__}({self.name})"
 
-    def __repr__(self) -> str:
-        return self.__str__()
-
     def zip_stuff(self, delete_after_zip: bool = False) -> None:
         """
         Zip file/folder
@@ -74,7 +74,7 @@ class Zipper:
             except OSError as e:
                 logger.error(f"Error: {e.filename} - {e.strerror}.")
 
-    # Added in version 4.0.0
+    @versionadded("4.0.0")
     def unzip(self):
         """
         Unzip every archive files in directory
@@ -88,9 +88,3 @@ class Zipper:
                     shutil.unpack_archive(temp, temp.parent.joinpath(temp.stem))
                 else:
                     shutil.unpack_archive(x, x.parent.joinpath(x.stem))
-
-
-# Run
-###########################################################################
-if __name__ == "__main__":
-    logger.setLevel(10)

{absfuyu-4.2.0.dist-info → absfuyu-5.0.0.dist-info}/METADATA

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: absfuyu
-Version: 4.2.0
+Version: 5.0.0
 Summary: A small collection of code
 Project-URL: Homepage, https://github.com/AbsoluteWinter/absfuyu-public
 Project-URL: Documentation, https://absolutewinter.github.io/absfuyu-docs/
 Project-URL: Repository, https://github.com/AbsoluteWinter/absfuyu-public
 Project-URL: Issues, https://github.com/AbsoluteWinter/absfuyu-public/issues
 Author: somewhatcold (AbsoluteWinter)
-License: MIT License
+License-Expression: MIT
 License-File: LICENSE
 Keywords: utilities
 Classifier: Development Status :: 5 - Production/Stable
@@ -28,16 +28,16 @@ Requires-Python: <4,>=3.11
 Requires-Dist: bs4
 Requires-Dist: click>=8.0.0
 Requires-Dist: colorama
-Requires-Dist: deprecated
-Requires-Dist: python-dateutil
 Requires-Dist: requests
-Requires-Dist: typing-extensions>=4.5.0; python_version < '3.12'
-Requires-Dist: unidecode
 Provides-Extra: beautiful
 Requires-Dist: rich; extra == 'beautiful'
 Provides-Extra: dev
 Requires-Dist: hatch; extra == 'dev'
 Requires-Dist: pytest; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: numpy; extra == 'docs'
+Requires-Dist: pandas; extra == 'docs'
+Requires-Dist: rich; extra == 'docs'
 Provides-Extra: extra
 Requires-Dist: numpy; extra == 'extra'
 Requires-Dist: pandas; extra == 'extra'
@@ -46,6 +46,7 @@ Requires-Dist: numpy; extra == 'full'
 Requires-Dist: pandas; extra == 'full'
 Requires-Dist: rich; extra == 'full'
 Requires-Dist: tqdm; extra == 'full'
+Requires-Dist: unidecode; extra == 'full'
 Description-Content-Type: text/markdown
 
 <div align="center">
@@ -66,10 +67,12 @@ Description-Content-Type: text/markdown
 
 ## **SUMMARY:**
 
-*TL;DR: A collection of code*
+This project is a collection of code primarily developed as a personal hobby. It aims to provide practical experience and enhance my coding skills while exploring potential future applications.
 
 ## **INSTALLATION:**
 
+To install the package, run the following command:
+
 ```bash
 pip install -U absfuyu
 ```
@@ -81,31 +84,55 @@ import absfuyu
 help(absfuyu)
 ```
 
+### Notable features
+
+**absfuyu.core**: Provides foundational components for additional functionalities.
+
+```python
+# Decorators that adds info to __doc__
+from absfuyu.core.docstring import versionadded, versionchanged, deprecated
+
+# Class mixins for enhanced functionality
+from absfuyu.core.baseclass import AutoREPRMixin, ShowAllMethodsMixin
+```
+
+**absfuyu.dxt**: Extension for `list`, `str`, `dict`, `int`.
+
+```python
+from absfuyu.dxt import DictExt, IntExt, ListExt, Text
+for x in [DictExt, IntExt, ListExt, Text]:
+    x.show_all_methods(print_result=1)
+```
+
+There are many additional features available to explore.
+
 ## **DOCUMENTATION:**
 
-> [here](https://absolutewinter.github.io/absfuyu/)
+For more detailed information about the project, please refer to the documentation available at the following link:
+
+> [Project Documentation](https://absolutewinter.github.io/absfuyu/)
 
-## **DEV SETUP**
+## **DEVELOPMENT SETUP**
 
-1. Create virtual environment
+1. Create a Virtual Environment
 
 ```bash
 python -m venv env
 ```
 
-Note: Might need to run this in powershell (windows)
+Note: You may need to execute this command in PowerShell on Windows:
 
 ```powershell
 Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser
 ```
 
-2. Install required packages
+2. Install Required Packages
 
 ```bash
 python -m pip install -e .[full,dev]
 ```
 
-3. Getting info of dev environment
+3. Acquire Information About the Development Environment Configuration
 
 ```bash
 hatch env show
@@ -113,4 +140,4 @@ hatch env show
 
 ## **LICENSE:**
 
-MIT License
+This project is licensed under the MIT License.