absfuyu 5.1.0__py3-none-any.whl → 5.3.0__py3-none-any.whl

absfuyu/util/json_method.py

@@ -3,8 +3,8 @@ Absfuyu: Json Method
 --------------------
 ``.json`` file handling
 
-Version: 5.1.0
-Date updated: 10/03/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,7 +4,7 @@ Absfuyu: Lunar calendar
 -----------------------
 Convert to lunar calendar
 
-Version: 5.1.0
+Version: 5.2.0
 Date updated: 10/03/2025 (dd/mm/yyyy)
 
 Source:

absfuyu/util/path.py

@@ -3,8 +3,8 @@ Absfuyu: Path
 -------------
 Path related
 
-Version: 5.1.0
-Date updated: 10/03/2025 (dd/mm/yyyy)
+Version: 5.2.0
+Date updated: 14/03/2025 (dd/mm/yyyy)
 
 Feature:
 --------
@@ -46,6 +46,128 @@ from absfuyu.core.decorator import add_subclass_methods_decorator
 from absfuyu.core.docstring import deprecated, versionadded, versionchanged
 from absfuyu.logger import logger
 
+# Template
+# ---------------------------------------------------------------------------
+ORGANIZE_TEMPLATE: dict[str, list[str]] = {
+    "Code": [".ps1", ".py", ".rs", ".js", ".c", ".h", ".cpp", ".r", ".cmd", ".bat"],
+    "Comic": [".cbz", ".cbr", ".cb7", ".cbt", ".cba"],
+    "Compressed": [
+        ".7z",
+        ".zip",
+        ".rar",
+        ".apk",
+        ".cab",
+        ".tar",
+        ".tgz",
+        ".txz",
+        ".bz2",
+        ".gz",
+        ".lz",
+        ".lz4",
+        ".lzma",
+        ".xz",
+        ".zipx",
+        ".zst",
+    ],
+    "Documents": [".docx", ".doc", ".xls", ".xlsx", ".ppt", ".pptx", ".pdf", ".txt"],
+    "Ebook": [
+        ".epub",
+        ".mobi",
+        ".prc",
+        ".lrf",
+        ".lrx",
+        ".pdb",
+        ".azw",
+        ".azw3",
+        ".kf8",
+        ".kfx",
+        ".opf",
+    ],
+    "Music": [".mp3", ".flac", ".wav", ".m4a", ".wma", ".aac", ".alac", ".aiff"],
+    "OS": [".iso", ".dmg", ".wim"],
+    "Pictures": [
+        ".jpg",
+        ".jpeg",
+        ".png",
+        ".apng",
+        ".avif",
+        ".bmp",
+        ".gif",
+        ".jfif",
+        ".pjpeg",
+        ".pjp",
+        ".svg",
+        ".ico",
+        ".cur",
+        ".tif",
+        ".tiff",
+        ".webp",
+    ],
+    "Programs": [".exe", ".msi"],
+    "Video": [
+        ".3g2",
+        ".3gp",
+        ".avi",
+        ".flv",
+        ".m2ts",
+        ".m4v",
+        ".mkv",
+        ".mov",
+        ".mp4",
+        ".mpeg",
+        ".mpv",
+        ".mts",
+        ".ts",
+        ".vob",
+        ".webm",
+    ],
+    "Raw pictures": [
+        ".3fr",
+        ".ari",
+        ".arw",
+        ".bay",
+        ".braw",
+        ".crw",
+        ".cr2",
+        ".cr3",
+        ".cap",
+        ".data",
+        ".dcs",
+        ".dcr",
+        ".dng",
+        ".drf",
+        ".eip",
+        ".erf",
+        ".fff",
+        ".gpr",
+        ".iiq",
+        ".k25",
+        ".kdc",
+        ".mdc",
+        ".mef",
+        ".mos",
+        ".mrw",
+        ".nef",
+        ".nrw",
+        ".obm",
+        ".orf",
+        ".pef",
+        ".ptx",
+        ".pxn",
+        ".r3d",
+        ".raf",
+        ".raw",
+        ".rwl",
+        ".rw2",
+        ".rwz",
+        ".sr2",
+        ".srf",
+        ".srw",
+        ".tif",
+        ".x3f",
+    ],
+}
+
 
 # Support Class
 # ---------------------------------------------------------------------------
@@ -444,10 +566,42 @@ class DirectoryArchiverMixin(DirectoryBase):
 
 class DirectoryOrganizerMixin(DirectoryBase):
     """
-    Directory - File organizer - SOON
+    Directory - File organizer
+
+    - Organize
     """
 
-    pass
+    @versionadded("5.3.0")
+    def organize(self, dirtemplate: dict[str, list[str]] | None = None) -> None:
+        """
+        Organize a directory.
+
+        Parameters
+        ----------
+        dirtemplate : dict[str, Collection[str]] | None, optional
+            | Template to move file to, by default ``None``.
+            | Example: {"Documents": [".txt", ".pdf", ...]}
+        """
+        if dirtemplate is None:
+            template = ORGANIZE_TEMPLATE
+        else:
+            template = dirtemplate
+
+        other_dir = self.source_path.joinpath("Others")
+        other_dir.mkdir(parents=True, exist_ok=True)
+
+        for path in self.source_path.iterdir():
+            if path.is_dir():
+                continue
+
+            for dir_name, suffixes in template.items():
+                if path.suffix.lower() in suffixes:
+                    move_path = self.source_path.joinpath(dir_name)
+                    move_path.mkdir(parents=True, exist_ok=True)
+                    path.rename(move_path.joinpath(path.name))
+                    break
+            else:
+                path.rename(other_dir.joinpath(path.name))
 
 
 class DirectoryTreeMixin(DirectoryBase):

absfuyu/util/performance.py

@@ -3,8 +3,8 @@ Absfuyu: Performance
 --------------------
 Performance Check
 
-Version: 5.1.0
-Date updated: 10/03/2025 (dd/mm/yyyy)
+Version: 5.2.0
+Date updated: 15/03/2025 (dd/mm/yyyy)
 
 Feature:
 --------
@@ -20,6 +20,7 @@ Feature:
 __all__ = [
     # Wrapper
     "function_debug",
+    "function_benchmark",
     "measure_performance",
     "retry",
     # Class
@@ -32,12 +33,12 @@ __all__ = [
 import time
 import tracemalloc
 from collections.abc import Callable
+from dataclasses import dataclass
 from functools import wraps
 from inspect import getsource
-from typing import Any, ParamSpec, TypeVar
+from typing import Any, Literal, ParamSpec, TypeVar, overload
 
 from absfuyu.core import deprecated, versionadded, versionchanged
-from absfuyu.dxt import ListNoDunder
 
 # Type
 # ---------------------------------------------------------------------------
@@ -45,6 +46,30 @@ P = ParamSpec("P")  # Parameter type
 R = TypeVar("R")  # Return type
 
 
+# Support
+# ---------------------------------------------------------------------------
+@dataclass
+class BenchmarkResult:
+    """
+    Use ``format(BenchmarkResult(...), "seconds")`` to view result in seconds.
+    """
+
+    min_: float
+    max_: float
+    avg: float
+
+    def __format__(self, format_spec: str) -> str:
+        clsname = self.__class__.__name__
+        if format_spec.lower().strip().startswith("seconds"):
+            fields = [f"{x}={getattr(self, x):,.6f}s" for x in self._get_fields()]
+            return f"{clsname}({', '.join(fields)})"
+        return repr(self)
+
+    @classmethod
+    def _get_fields(cls) -> tuple[str, ...]:
+        return tuple(cls.__dataclass_fields__)
+
+
 # Function
 # ---------------------------------------------------------------------------
 @versionchanged("3.2.0", reason="Updated functionality")
@@ -108,6 +133,96 @@ def measure_performance(f: Callable[P, R]) -> Callable[P, R]:
     return wrapper
 
 
+@overload
+def function_benchmark(func: Callable[P, R], /) -> Callable[P, R]: ...
+@overload
+def function_benchmark(*, n: int = 1) -> Callable[[Callable[P, R]], Callable[P, R]]: ...
+@overload
+def function_benchmark(
+    *, n: int = 1, result_only: Literal[False] = False
+) -> Callable[[Callable[P, R]], Callable[P, R]]: ...
+@overload
+def function_benchmark(
+    *, n: int = 1, result_only: Literal[True] = ...
+) -> Callable[[Callable[P, R]], Callable[P, BenchmarkResult]]: ...
+
+
+@versionadded("5.2.0")
+def function_benchmark(
+    func: Callable[P, R] | None = None, /, *, n: int = 1, result_only: bool = False
+):
+    """
+    This run function for ``n`` times and calculate min, max, average runtime.
+
+    Parameters
+    ----------
+    func : Callable[P, R] | None, optional
+        Callable with parameter **P and returns R, by default ``None``
+
+    n : int, optional
+        Run how many times, by default ``1``
+
+    result_only : bool, optional
+        Returns BenchmarkResult instead of ``func`` result, by default ``False``
+
+
+    Usage
+    -----
+    Use this as a decorator (``@function_benchmark``)
+
+    Example:
+    --------
+    >>> @function_benchmark
+    >>> def test():
+    ...     return 1 + 1
+    >>> test()
+    BenchmarkResult(min_=0.000000s, max_=0.000000s, avg=0.000000s)
+    2
+
+    >>> @function_benchmark(n=1)
+    >>> def test():
+    ...     return 1 + 1
+    >>> test()
+    BenchmarkResult(min_=0.000000s, max_=0.000000s, avg=0.000000s)
+    2
+    """
+
+    times = max(n, 1)
+
+    def decorator(f: Callable[P, R]) -> Callable[P, R | BenchmarkResult]:
+        @wraps(f)
+        def wrapper(*args: P.args, **kwargs: P.kwargs) -> R | BenchmarkResult:
+            output = f(*args, **kwargs)  # Run function and save result into a variable
+
+            def _run() -> float:
+                # Performance check
+                start_time = time.perf_counter()  # Start time measure
+                f(*args, **kwargs)
+                finish_time = time.perf_counter()  # Get finished time
+                return finish_time - start_time
+
+            # run = (_run() for _ in range(times))
+            run = [_run() for _ in range(times)]
+            try:
+                avg_runtime = sum(run) / len(run)
+            except ZeroDivisionError:
+                avg_runtime = min(run)
+            result = BenchmarkResult(min(run), max(run), avg_runtime)
+
+            if result_only:
+                return result
+
+            print(format(result, "seconds"))
+
+            return output
+
+        return wrapper
+
+    if func is None:
+        return decorator
+    return decorator(func)
+
+
 @versionadded("3.2.0")
 def function_debug(f: Callable[P, R]) -> Callable[P, R]:
     """
@@ -284,7 +399,7 @@ class Checker:
     def dir_(self) -> list[str]:
         """``dir()`` of variable"""
         # return self.item_to_check.__dir__()
-        return ListNoDunder(self.item_to_check.__dir__())
+        return [x for x in dir(self.item_to_check) if not x.startswith("__")]
 
     @property
     def source(self) -> str | None:

absfuyu/util/shorten_number.py

@@ -3,7 +3,7 @@ Absfuyu: Shorten number
 -----------------------
 Short number base on suffixes
 
-Version: 5.1.0
+Version: 5.2.0
 Date updated: 10/03/2025 (dd/mm/yyyy)
 """