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

absfuyu/core/decorator.py

@@ -3,13 +3,17 @@ Absfuyu: Core
 -------------
 Decorator
 
-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 Package
 # ---------------------------------------------------------------------------
-__all__ = ["dummy_decorator", "dummy_decorator_with_args"]
+__all__ = [
+    "dummy_decorator",
+    "dummy_decorator_with_args",
+    "add_subclass_methods_decorator",
+]
 
 
 # Library
@@ -52,8 +56,10 @@ def dummy_decorator_with_args(*args, **kwargs):
 
     @overload
     def decorator(obj: T) -> T: ...
+
     @overload
     def decorator(obj: Callable[P, R]) -> Callable[P, R]: ...
+
     def decorator(obj: Callable[P, R] | T) -> Callable[P, R] | T:
         if isinstance(obj, type):
             return obj
@@ -65,3 +71,63 @@ def dummy_decorator_with_args(*args, **kwargs):
         return wrapper
 
     return decorator
+
+
+def add_subclass_methods_decorator(cls: T) -> T:
+    """
+    Class decorator replace the ``__init_subclass__`` method.
+
+    This method populates a dictionary with subclass names as keys
+    and their available methods as values.
+
+    - Create 2 class attributes: ``_METHOD_INCLUDE`` (bool) and ``SUBCLASS_METHODS`` (dict[str, list[str]])
+    - Automatically add subclass methods to class variable: ``SUBCLASS_METHODS``
+    - Set class attribute ``_METHOD_INCLUDE`` to ``False`` to exclude from ``SUBCLASS_METHODS``
+
+    Example:
+    --------
+    >>> # Normal behavior
+    >>> @add_subclass_methods_decorator
+    >>> class TestParent: ...
+    >>> class TestChild(TestParent):
+    ...     def method1(self): ...
+    >>> TestChild.SUBCLASS_METHODS
+    {'__main__.TestChild': ['method1']}
+
+    >>> # Hidden from ``SUBCLASS_METHODS``
+    >>> @add_subclass_methods_decorator
+    >>> class TestParent: ...
+    >>> class TestChildHidden(TestParent):
+    ...     _METHOD_INCLUDE = False
+    ...     def method1(self): ...
+    >>> TestChildHidden.SUBCLASS_METHODS
+    {}
+    """
+
+    # Check for class
+    if not isinstance(cls, type):
+        raise ValueError("Object is not a class")
+
+    class AutoSubclassMixin:
+        _METHOD_INCLUDE: bool = True  # Include in SUBCLASS_METHODS
+        SUBCLASS_METHODS: dict[str, list[str]] = {}
+
+        def __init_subclass__(cls, *args, **kwargs) -> None:
+            """
+            This create a dictionary with:
+            - key   (str)      : Subclass
+            - value (list[str]): List of available methods
+            """
+            super().__init_subclass__(*args, **kwargs)
+
+            if cls._METHOD_INCLUDE and not any(
+                [x.endswith(cls.__name__) for x in cls.SUBCLASS_METHODS.keys()]
+            ):
+                methods_list: list[str] = [
+                    k for k, v in cls.__dict__.items() if callable(v)
+                ]
+                if len(methods_list) > 0:
+                    name = f"{cls.__module__}.{cls.__name__}"
+                    cls.SUBCLASS_METHODS.update({name: sorted(methods_list)})
+
+    return type("AutoSubclass", (AutoSubclassMixin, cls), {})  # type: ignore[return-value]

absfuyu/core/docstring.py

@@ -3,8 +3,8 @@ Absfuyu: Core
 -------------
 Sphinx docstring decorator
 
-Version: 5.0.0
-Date updated: 13/02/2025 (dd/mm/yyyy)
+Version: 5.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 """
 
 # Module Package
@@ -28,9 +28,9 @@ from typing import ClassVar, ParamSpec, TypeVar, overload
 
 # Type
 # ---------------------------------------------------------------------------
-P = ParamSpec("P")  # Parameter type
-R = TypeVar("R")  # Return type - Can be anything
-T = TypeVar("T", bound=type)  # Type type - Can be any subtype of `type`
+_P = ParamSpec("_P")  # Parameter type
+_R = TypeVar("_R")  # Return type - Can be anything
+_T = TypeVar("_T", bound=type)  # Type type - Can be any subtype of `type`
 
 _SPHINX_DOCS_TEMPLATE = Template("$line_break*$mode in version $version$reason*")
 
@@ -88,10 +88,13 @@ class SphinxDocstring:
         self.mode = mode
 
     @overload
-    def __call__(self, obj: T) -> T: ...  # Class overload
+    def __call__(self, obj: _T) -> _T: ...  # Class overload
+
     @overload
-    def __call__(self, obj: Callable[P, R]) -> Callable[P, R]: ...  # Function overload
-    def __call__(self, obj: T | Callable[P, R]) -> T | Callable[P, R]:
+    def __call__(
+        self, obj: Callable[_P, _R]
+    ) -> Callable[_P, _R]: ...  # Function overload
+    def __call__(self, obj: _T | Callable[_P, _R]) -> _T | Callable[_P, _R]:
         # Class wrapper
         if isinstance(obj, type):  # if inspect.isclass(obj):
             obj.__doc__ = (obj.__doc__ or "") + self._generate_version_note(
@@ -101,7 +104,7 @@ class SphinxDocstring:
 
         # Function wrapper
         @wraps(obj)
-        def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
+        def wrapper(*args: _P.args, **kwargs: _P.kwargs) -> _R:
             return obj(*args, **kwargs)
 
         # Add docstring
@@ -127,19 +130,19 @@ class SphinxDocstring:
         if docs is None:
             return res
 
-        # # Index of the last whitespaces
-        # # https://stackoverflow.com/a/13649118
-        # res = next((i for i, c in enumerate(docs) if not c.isspace()), 0)
-        # return res if res % 2 == 0 else res - 1
-
-        # Alternative solution
-        for char in docs:
-            if char == " ":
-                res += 1
-            if char == "\t":
-                res += 4
-            if not char.isspace():
-                break
+        try:
+            # Replace tabs with space and split line
+            lines = docs.expandtabs(4).splitlines()
+        except UnicodeError:
+            return res
+        else:
+            # Get indentation of each line and unique it
+            indent_set = {len(line) - len(line.lstrip()) for line in lines[1:]}
+            # Drop 0
+            res_list = sorted([x for x in indent_set if x > 0])
+
+        if res_list:
+            return res_list[0]
         return res
 
     def _generate_version_note(self, num_of_white_spaces: int) -> str:

absfuyu/core/dummy_cli.py

@@ -3,8 +3,8 @@ Absfuyu: Core
 -------------
 Dummy cli
 
-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 Package

absfuyu/core/dummy_func.py

@@ -3,8 +3,8 @@ Absfuyu: Core
 -------------
 Dummy functions when other libraries are unvailable
 
-Version: 5.0.0
-Date updated: 14/02/2025 (dd/mm/yyyy)
+Version: 5.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 """
 
 # Module Package
@@ -12,6 +12,7 @@ Date updated: 14/02/2025 (dd/mm/yyyy)
 __all__ = [
     "tqdm",
     "unidecode",
+    "dummy_function",
 ]
 
 
@@ -23,8 +24,9 @@ from importlib import import_module
 # ---------------------------------------------------------------------------
 # tqdm wrapper
 try:
-    tqdm = import_module("tqdm").tqdm
-except ModuleNotFoundError:
+    _tqdm = import_module("tqdm")
+    tqdm = getattr(_tqdm, "tqdm")  # noqa
+except (ModuleNotFoundError, AttributeError):
 
     def tqdm(iterable, *args, **kwargs):
         """
@@ -36,8 +38,9 @@ except ModuleNotFoundError:
 
 # unidecode wrapper
 try:
-    unidecode = import_module("unidecode").unidecode
-except ModuleNotFoundError:
+    _unidecode = import_module("unidecode")
+    unidecode = getattr(_unidecode, "unidecode")  # noqa
+except (ModuleNotFoundError, AttributeError):
 
     def unidecode(*args, **kwargs):
         """
@@ -45,3 +48,13 @@ except ModuleNotFoundError:
         install package ``unidecode`` to fully use this feature
         """
         return args[0]
+
+
+# dummy
+def dummy_function(*args, **kwargs):
+    """This is a dummy function"""
+    if args:
+        return args[0]
+    if kwargs:
+        return kwargs[list(kwargs)[0]]
+    return None

absfuyu/core/typings.py

@@ -0,0 +1,40 @@
+"""
+Absfuyu: Core
+-------------
+Pre-defined typing
+
+Version: 5.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
+"""
+
+# Module Package
+# ---------------------------------------------------------------------------
+__all__ = ["_T", "_P", "_R", "_CALLABLE", "_CT", "_N", "_Number", "override"]
+
+
+# Library
+# ---------------------------------------------------------------------------
+from collections.abc import Callable
+from typing import ParamSpec, TypeVar
+
+try:
+    from typing import override  # type: ignore
+except ImportError:
+    from absfuyu.core.decorator import dummy_decorator as override
+
+
+# Type
+# ---------------------------------------------------------------------------
+_T = TypeVar("_T")  # Type
+
+# 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)
+_Number = int | float

absfuyu/dxt/__init__.py

@@ -3,8 +3,8 @@ Absfuyu: Data Extension
 -----------------------
 Extension for data type such as ``list``, ``str``, ``dict``, ...
 
-Version: 5.0.0
-Date updated: 11/01/2025 (dd/mm/yyyy)
+Version: 5.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 
 Features:
 ---------

absfuyu/dxt/dictext.py

@@ -3,8 +3,8 @@ Absfuyu: Data Extension
 -----------------------
 dict extension
 
-Version: 5.0.0
-Date updated: 14/02/2025 (dd/mm/yyyy)
+Version: 5.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 """
 
 # Module Package

absfuyu/dxt/dxt_support.py

@@ -3,8 +3,8 @@ Absfuyu: Data Extension
 -----------------------
 Support classes
 
-Version: 5.0.0
-Date updated: 11/02/2025 (dd/mm/yyyy)
+Version: 5.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 """
 
 # Module Package

absfuyu/dxt/intext.py

@@ -3,8 +3,8 @@ Absfuyu: Data Extension
 -----------------------
 int extension
 
-Version: 5.0.0
-Date updated: 11/02/2025 (dd/mm/yyyy)
+Version: 5.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 """
 
 # Module Package
@@ -18,7 +18,7 @@ import math
 from collections import Counter
 from typing import Any, Self
 
-from absfuyu.core import ShowAllMethodsMixin, versionchanged
+from absfuyu.core import ShowAllMethodsMixin, versionadded, versionchanged
 from absfuyu.dxt.dxt_support import DictBoolTrue
 
 
@@ -584,3 +584,31 @@ class IntExt(ShowAllMethodsMixin, int):
 
         output["characteristic"] = characteristic
         return output  # type: ignore
+
+    @versionadded("5.1.0")
+    def split(self, parts: int) -> list[int]:
+        """
+        Evenly split the number into ``parts`` parts
+
+        Parameters
+        ----------
+        parts : int
+            Split by how many parts
+
+        Returns
+        -------
+        list[int]
+            List of evenly splitted numbers
+
+
+        Example:
+        --------
+        >>> IntExt(10).split(4)
+        [2, 2, 3, 3]
+        """
+        p = max(1, parts)
+        if p == 1:
+            return [int(self)]
+
+        quotient, remainder = divmod(self, p)
+        return [quotient + (i >= (p - remainder)) for i in range(p)]

absfuyu/dxt/listext.py

@@ -3,8 +3,8 @@ Absfuyu: Data Extension
 -----------------------
 list extension
 
-Version: 5.0.0
-Date updated: 11/02/2025 (dd/mm/yyyy)
+Version: 5.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 """
 
 # Module Package
@@ -22,6 +22,7 @@ from itertools import accumulate, chain, groupby
 from typing import Any, Self
 
 from absfuyu.core import ShowAllMethodsMixin, deprecated
+from absfuyu.core.docstring import versionadded
 from absfuyu.util import set_min, set_min_max
 
 
@@ -323,7 +324,7 @@ class ListExt(ShowAllMethodsMixin, list):
         # logger.debug(out)
         return out
 
-    def apply(self, func: Callable) -> Self:
+    def apply(self, func: Callable[[Any], Any]) -> Self:
         """
         Apply function to each entry
 
@@ -490,6 +491,30 @@ class ListExt(ShowAllMethodsMixin, list):
         start = int(set_min(start, min_value=0))
         return self.__class__(enumerate(self, start=start))
 
+    @versionadded("5.1.0")  # no test case yet
+    def split_chunk(self, chunk_size: int) -> list[list]:
+        """
+        Split list into smaller chunks
+
+        Parameters
+        ----------
+        chunk_size : int
+            Chunk size, minimum: ``1``
+
+        Returns
+        -------
+        list[list]
+            List of chunk
+
+
+        Example:
+        --------
+        >>> ListExt([1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1]).split_chunk(5)
+        [[1, 1, 1, 1, 1], [1, 1, 1, 1, 1], [1, 1, 1, 1, 1], [1, 1]]
+        """
+        slice_points = list(range(0, len(self), max(chunk_size, 1)))[1:]
+        return self.slice_points(slice_points)
+
     @staticmethod
     @deprecated("5.0.0")
     def _group_by_unique(iterable: list) -> list[list]:

absfuyu/dxt/strext.py

@@ -3,8 +3,8 @@ Absfuyu: Data Extension
 -----------------------
 str extension
 
-Version: 5.0.0
-Date updated: 11/02/2025 (dd/mm/yyyy)
+Version: 5.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 """
 
 # Module Package
@@ -18,8 +18,8 @@ import random
 from typing import NotRequired, Self, TypedDict
 
 from absfuyu.core import ShowAllMethodsMixin, deprecated, versionadded, versionchanged
-from absfuyu.general.generator import Charset, Generator
 from absfuyu.logger import logger
+from absfuyu.tools.generator import Charset, Generator
 from absfuyu.util import set_min_max
 
 

absfuyu/extra/__init__.py

@@ -3,8 +3,8 @@ Absfuyu: Extra
 --------------
 Features that require additional libraries
 
-Version: 1.0.1
-Date updated: 24/11/2023 (dd/mm/yyyy)
+Version: 5.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 """
 
 

absfuyu/extra/beautiful.py

@@ -3,8 +3,8 @@ Absfuyu: Beautiful
 ------------------
 A decorator that makes output more beautiful
 
-Version: 5.0.0
-Date updated: 18/02/2025 (dd/mm/yyyy)
+Version: 5.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 """
 
 # Module level
@@ -77,6 +77,7 @@ class PerformanceOutput(NamedTuple):
         return out
 
 
+# TODO: header and footer layout to 1,2,3 instead of true false
 class BeautifulOutput:
     """A decorator that makes output more beautiful"""
 

absfuyu/extra/da/__init__.py

@@ -0,0 +1,36 @@
+"""
+Absfuyu: Data Analysis
+----------------------
+Data Analyst
+
+Version: 5.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
+"""
+
+# Module level
+# ---------------------------------------------------------------------------
+__all__ = ["MatplotlibFormatString", "DADF"]
+
+
+# Library
+# ---------------------------------------------------------------------------
+DA_MODE = False
+
+try:
+    import numpy as np
+    import pandas as pd
+except ImportError:
+    from subprocess import run
+
+    from absfuyu.config import ABSFUYU_CONFIG
+
+    if ABSFUYU_CONFIG._get_setting("auto-install-extra").value:
+        cmd = "python -m pip install -U absfuyu[full]".split()
+        run(cmd)
+    else:
+        raise SystemExit("This feature is in absfuyu[full] package")  # noqa: B904
+else:
+    DA_MODE = True
+
+from absfuyu.extra.da.dadf import DADF
+from absfuyu.extra.da.mplt import MatplotlibFormatString