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

absfuyu/util/performance.py

@@ -3,8 +3,8 @@ Absfuyu: Performance
 --------------------
 Performance Check
 
-Version: 5.0.0
-Date updated: 13/02/2025 (dd/mm/yyyy)
+Version: 5.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 
 Feature:
 --------
@@ -36,7 +36,7 @@ from functools import wraps
 from inspect import getsource
 from typing import Any, ParamSpec, TypeVar
 
-from absfuyu.core import versionadded, versionchanged
+from absfuyu.core import deprecated, versionadded, versionchanged
 from absfuyu.dxt import ListNoDunder
 
 # Type
@@ -225,7 +225,7 @@ def retry(retries: int, delay: float = 1):
 
 # Class
 # ---------------------------------------------------------------------------
-# TODO: Rewrite this with inspect
+@deprecated("5.1.0", reason="Use `absfuyu.tools.inspector` instead")
 class Checker:
     """
     Check a variable

absfuyu/util/shorten_number.py

@@ -3,8 +3,8 @@ Absfuyu: Shorten number
 -----------------------
 Short number base on suffixes
 
-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
@@ -156,11 +156,28 @@ class Decimal:
     """
     Shorten large number
 
-    :param original_value: Value to shorten
-    :param base: Short by base (must be > 0)
-    :param suffixes: List of suffixes to use (ascending order)
-    :param factory: ``UnitSuffixFactory`` to use (will overwrite ``base`` and ``suffixes``)
-    :param suffix_full_name: Use suffix full name (default: False)
+    Parameters
+    ----------
+    original_value : int | float
+        Value to shorten
+
+    base : int
+        Short by base (must be > 0)
+
+    suffixes : list[str]
+        List of suffixes to use (ascending order)
+
+    factory : UnitSuffixFactory | None
+        ``UnitSuffixFactory`` to use
+        (will overwrite ``base`` and ``suffixes``)
+
+    suffix_full_name : bool
+        Use suffix full name (available with ``UnitSuffixFactory``), by default ``False``
+
+    Returns
+    -------
+    Decimal
+        Decimal instance
     """
 
     original_value: int | float = field(repr=False)
@@ -173,6 +190,7 @@ class Decimal:
     suffix: str = field(init=False)
 
     def __post_init__(self) -> None:
+        self.base = max(1, self.base)  # Make sure that base >= 1
         self._get_factory()
         self.value, self.suffix = self._convert_decimal()
 
@@ -228,9 +246,21 @@ class Decimal:
         """
         Convert to string
 
-        :param decimal: Round up to which decimal
-        :param separator: Character between value and suffix, default: ``" "``
-        :param float_only: Returns value as <float> instead of <int> when ``decimal = 0``
+        Parameters
+        ----------
+        decimal : int, optional
+            Round up to which decimal, by default ``2``
+
+        separator : str, optional
+            Character between value and suffix, by default ``" "``
+
+        float_only : bool, optional
+            Returns value as <float> instead of <int> when ``decimal = 0``, by default ``True``
+
+        Returns
+        -------
+        str
+            Decimal string
         """
         val = self.value.__round__(decimal)
         formatted_value = f"{val:,}"

absfuyu/util/text_table.py

@@ -0,0 +1,272 @@
+"""
+Absufyu: Utilities
+------------------
+Text table
+
+Version: 5.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
+"""
+
+# Module level
+# ---------------------------------------------------------------------------
+__all__ = ["OneColumnTableMaker"]
+
+
+# Library
+# ---------------------------------------------------------------------------
+import os
+from collections.abc import Sequence
+from enum import StrEnum
+from textwrap import TextWrapper
+from typing import Literal
+
+from absfuyu.core import BaseClass
+
+
+# Style
+# ---------------------------------------------------------------------------
+class BoxDrawingCharacter(StrEnum):
+    """
+    Box drawing characters - Normal
+
+    Characters reference: https://en.wikipedia.org/wiki/Box-drawing_characters
+    """
+
+    UPPER_LEFT_CORNER = "\u250c"
+    UPPER_RIGHT_CORNER = "\u2510"
+    HORIZONTAL = "\u2500"
+    VERTICAL = "\u2502"
+    LOWER_LEFT_CORNER = "\u2514"
+    LOWER_RIGHT_CORNER = "\u2518"
+    VERTICAL_RIGHT = "\u251c"
+    VERTICAL_LEFT = "\u2524"
+    CROSS = "\u253c"
+    HORIZONTAL_UP = "\u2534"
+    HORIZONTAL_DOWN = "\u252c"
+
+
+class BoxDrawingCharacterBold(StrEnum):
+    """
+    Box drawing characters - Bold
+
+    Characters reference: https://en.wikipedia.org/wiki/Box-drawing_characters
+    """
+
+    UPPER_LEFT_CORNER = "\u250f"
+    UPPER_RIGHT_CORNER = "\u2513"
+    HORIZONTAL = "\u2501"
+    VERTICAL = "\u2503"
+    LOWER_LEFT_CORNER = "\u2517"
+    LOWER_RIGHT_CORNER = "\u251b"
+    VERTICAL_RIGHT = "\u2523"
+    VERTICAL_LEFT = "\u252b"
+    CROSS = "\u254b"
+    HORIZONTAL_UP = "\u253b"
+    HORIZONTAL_DOWN = "\u2533"
+
+
+class BoxDrawingCharacterDashed(StrEnum):
+    """
+    Box drawing characters - Dashed
+
+    Characters reference: https://en.wikipedia.org/wiki/Box-drawing_characters
+    """
+
+    UPPER_LEFT_CORNER = "\u250c"
+    UPPER_RIGHT_CORNER = "\u2510"
+    HORIZONTAL = "\u254c"
+    VERTICAL = "\u254e"
+    LOWER_LEFT_CORNER = "\u2514"
+    LOWER_RIGHT_CORNER = "\u2518"
+    VERTICAL_RIGHT = "\u251c"
+    VERTICAL_LEFT = "\u2524"
+    CROSS = "\u253c"
+    HORIZONTAL_UP = "\u2534"
+    HORIZONTAL_DOWN = "\u252c"
+
+
+class BoxDrawingCharacterDouble(StrEnum):
+    """
+    Box drawing characters - Double
+
+    Characters reference: https://en.wikipedia.org/wiki/Box-drawing_characters
+    """
+
+    UPPER_LEFT_CORNER = "\u2554"
+    UPPER_RIGHT_CORNER = "\u2557"
+    HORIZONTAL = "\u2550"
+    VERTICAL = "\u2551"
+    LOWER_LEFT_CORNER = "\u255a"
+    LOWER_RIGHT_CORNER = "\u255d"
+    VERTICAL_RIGHT = "\u2560"
+    VERTICAL_LEFT = "\u2563"
+    CROSS = "\u256c"
+    HORIZONTAL_UP = "\u2569"
+    HORIZONTAL_DOWN = "\u2566"
+
+
+# Class
+# ---------------------------------------------------------------------------
+class OneColumnTableMaker(BaseClass):
+    """
+    Table Maker instance
+
+    Parameters
+    ----------
+    ncols : int | None, optional
+        Length of the table (include content). Must be >= 5.
+        Set to ``None`` to use maximum length,
+        defaults to ``88`` when failed to use ``os.get_terminal_size()``.
+        By default ``None``
+
+    style : Literal["normal", "bold", "dashed", "double"], optional
+        Style for the table, by default ``"normal"``
+    """
+
+    __slots__ = ("ncols", "_title", "_paragraphs", "_table_char", "_text_wrapper")
+
+    def __init__(
+        self,
+        ncols: int | None = None,
+        style: Literal["normal", "bold", "dashed", "double"] = "normal",
+    ) -> None:
+        """
+        Table Maker instance
+
+        Parameters
+        ----------
+        ncols : int | None, optional
+            Length of the table (include content). Must be >= 5.
+            Set to ``None`` to use maximum length,
+            defaults to ``88`` when failed to use ``os.get_terminal_size()``.
+            By default ``None``
+
+        style : Literal["normal", "bold", "dashed", "double"], optional
+            Style for the table, by default ``"normal"``
+        """
+
+        # Text length
+        if ncols is None:
+            try:
+                self.ncols = os.get_terminal_size().columns
+            except OSError:
+                self.ncols = 88
+        else:
+            self.ncols = max(5, ncols)
+
+        # Title & paragraph
+        self._title = ""
+        self._paragraphs: list[Sequence[str]] = []
+
+        # Style
+        if style == "normal":
+            self._table_char = BoxDrawingCharacter
+        elif style == "bold":
+            self._table_char = BoxDrawingCharacterBold  # type: ignore
+        elif style == "dashed":
+            self._table_char = BoxDrawingCharacterDashed  # type: ignore
+        elif style == "double":
+            self._table_char = BoxDrawingCharacterDouble  # type: ignore
+        else:
+            self._table_char = BoxDrawingCharacter  # type: ignore
+
+        # Text wrapper
+        self._text_wrapper = TextWrapper(
+            width=self.ncols - 4,
+            initial_indent="",
+            subsequent_indent="",
+            tabsize=4,
+            break_long_words=True,
+        )
+
+    def add_title(self, title: str) -> None:
+        """
+        Add title to Table
+
+        Parameters
+        ----------
+        title : str
+            Title to add.
+            When ``len(title) > ncols``: title will not show
+        """
+        max_padding_length = self.ncols - 2
+        if max_padding_length < (len(title) + 2) or len(title) < 1:
+            _title = ""
+        else:
+            _title = f" {title} "
+
+        line = (
+            f"{self._table_char.UPPER_LEFT_CORNER}"
+            f"{_title.center(max_padding_length, self._table_char.HORIZONTAL)}"
+            f"{self._table_char.UPPER_RIGHT_CORNER}"
+        )
+        self._title = line
+
+    def add_paragraph(self, paragraph: Sequence[str]) -> None:
+        """
+        Add paragraph into Table
+
+        Parameters
+        ----------
+        paragraph : Sequence[str]
+            An iterable of str
+        """
+        if isinstance(paragraph, str):
+            self._paragraphs.append([paragraph])
+        else:
+            self._paragraphs.append(paragraph)
+
+    def _make_line(self, option: Literal[0, 1, 2]) -> str:
+        options = (
+            (self._table_char.UPPER_LEFT_CORNER, self._table_char.UPPER_RIGHT_CORNER),
+            (self._table_char.VERTICAL_RIGHT, self._table_char.VERTICAL_LEFT),
+            (self._table_char.LOWER_LEFT_CORNER, self._table_char.LOWER_RIGHT_CORNER),
+        )
+        max_line_length = self.ncols - 2
+        line = (
+            f"{options[option][0]}"
+            f"{''.ljust(max_line_length, self._table_char.HORIZONTAL)}"
+            f"{options[option][1]}"
+        )
+        return line
+
+    def _make_table(self) -> list[str] | None:
+        # Check if empty
+        if len(self._paragraphs) < 1:
+            return None
+        if len(self._paragraphs[0]) < 1:
+            return None
+
+        # Make table
+        max_content_length = self.ncols - 4
+        paragraph_length = len(self._paragraphs)
+
+        # Line prep
+        _first_line = self._make_line(0)
+        _sep_line = self._make_line(1)
+        _last_line = self._make_line(2)
+
+        # Table
+        table: list[str] = [_first_line] if self._title == "" else [self._title]
+        for i, paragraph in enumerate(self._paragraphs, start=1):
+            for line in paragraph:
+                splitted_line = self._text_wrapper.wrap(line) if len(line) > 0 else [""]
+                mod_lines: list[str] = [
+                    f"{self._table_char.VERTICAL} "
+                    f"{line.ljust(max_content_length, ' ')}"
+                    f" {self._table_char.VERTICAL}"
+                    for line in splitted_line
+                ]
+                table.extend(mod_lines)
+
+            if i != paragraph_length:
+                table.append(_sep_line)
+            else:
+                table.append(_last_line)
+        return table
+
+    def make_table(self) -> str:
+        table = self._make_table()
+        if table is None:
+            return ""
+        return "\n".join(table)

absfuyu/util/zipped.py

@@ -3,15 +3,13 @@ Absfuyu: Zipped
 ---------------
 Zipping stuff (deprecated soon, most features already in absfuyu.util.path.Directory)
 
-Version: 1.1.0
-Date updated: 07/01/2025 (dd/mm/yyyy)
+Version: 5.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 """
 
 # Module level
 # ---------------------------------------------------------------------------
-__all__ = [
-    "Zipper",
-]
+__all__ = ["Zipper"]
 
 
 # Library
@@ -20,11 +18,13 @@ import shutil
 import zipfile
 from pathlib import Path
 
-from absfuyu.core import BaseClass, versionadded
+from absfuyu.core import BaseClass, deprecated, versionadded
 from absfuyu.logger import logger
 
 
+# Class
 # ---------------------------------------------------------------------------
+@deprecated("5.1.0", reason="Use ``absfuyu.util.path.Directory`` instead")
 class Zipper(BaseClass):
     """Zip file or folder"""
 

absfuyu/version.py

@@ -3,10 +3,12 @@ Absfuyu: Version
 ----------------
 Package versioning module
 
-Version: 2.1.1
-Date updated: 14/04/2024 (dd/mm/yyyy)
+Version: 5.1.0
+Date updated: 10/03/2025 (dd/mm/yyyy)
 """
 
+# Module level
+# ---------------------------------------------------------------------------
 __all__ = [
     # Options
     "ReleaseOption",
@@ -18,42 +20,50 @@ __all__ = [
 ]
 
 
+# Library
+# ---------------------------------------------------------------------------
 import json
 import re
 import subprocess
-from typing import List, Tuple, TypedDict, Union
+from enum import StrEnum
+from typing import Self, TypedDict
 from urllib.error import URLError
 from urllib.request import Request, urlopen
 
+from absfuyu.core import BaseClass
 from absfuyu.logger import logger
 
 
-class ReleaseOption:
+# Class
+# ---------------------------------------------------------------------------
+class ReleaseOption(StrEnum):
     """
     ``MAJOR``, ``MINOR``, ``PATCH``
     """
 
-    MAJOR: str = "major"
-    MINOR: str = "minor"
-    PATCH: str = "patch"
+    MAJOR = "major"
+    MINOR = "minor"
+    PATCH = "patch"
 
-    def all_option() -> List[str]:  # type: ignore
+    @classmethod
+    def all_option(cls) -> list[str]:
         """Return a list of release options"""
-        return [__class__.MAJOR, __class__.MINOR, __class__.PATCH]  # type: ignore
+        return [cls.MAJOR.value, cls.MINOR.value, cls.PATCH.value]
 
 
-class ReleaseLevel:
+class ReleaseLevel(StrEnum):
     """
     ``FINAL``, ``DEV``, ``RC``
     """
 
-    FINAL: str = "final"
-    DEV: str = "dev"
-    RC: str = "rc"  # Release candidate
+    FINAL = "final"
+    DEV = "dev"
+    RC = "rc"  # Release candidate
 
-    def all_level() -> List[str]:  # type: ignore
+    @classmethod
+    def all_level(cls) -> list[str]:
         """Return a list of release levels"""
-        return [__class__.FINAL, __class__.DEV, __class__.RC]  # type: ignore
+        return [cls.FINAL.value, cls.DEV.value, cls.RC.value]
 
 
 class VersionDictFormat(TypedDict):
@@ -74,30 +84,36 @@ class VersionDictFormat(TypedDict):
     serial: int
 
 
-class Version:
+class Version(BaseClass):
     """Version"""
 
     def __init__(
         self,
-        major: Union[int, str],
-        minor: Union[int, str],
-        patch: Union[int, str],
+        major: int | str,
+        minor: int | str,
+        patch: int | str,
         release_level: str = ReleaseLevel.FINAL,
-        serial: Union[int, str] = 0,
+        serial: int | str = 0,
     ) -> None:
         """
         Create ``Version`` instance
 
-        :param major: Major change
-        :type major: int | str
-        :param minor: Minor change
-        :type minor: int | str
-        :param patch: Patch
-        :type patch: int | str
-        :param release_level: Release level: ``final``|``rc``|``dev``
-        :type release_level: str
-        :param serial: Serial for release level ``rc``|``dev``
-        :type serial: int | str
+        Parameters
+        ----------
+        major : int | str
+            Major change
+
+        minor : int | str
+            Minor change
+
+        patch : int | str
+            Patch
+
+        release_level : str, optional
+            Release level: ``final`` | ``rc`` | ``dev``, by default ``ReleaseLevel.FINAL``
+
+        serial : int | str, optional
+            Serial for release level ``rc`` | ``dev``, by default ``0``
         """
         self.major: int = major if isinstance(major, int) else int(major)
         self.minor: int = minor if isinstance(minor, int) else int(minor)
@@ -108,15 +124,16 @@ class Version:
     def __str__(self) -> str:
         return self.version
 
-    def __repr__(self) -> str:
-        if self.release_level.startswith(ReleaseLevel.FINAL):
-            return f"{self.__class__.__name__}(major={self.major}, minor={self.minor}, patch={self.patch})"
-        else:
-            return (
-                f"{self.__class__.__name__}("
-                f"major={self.major}, minor={self.minor}, patch={self.patch}, "
-                f"release_level={self.release_level}, serial={self.serial})"
-            )
+    # def __repr__(self) -> str:
+    #     cls_name = self.__class__.__name__
+    #     if self.release_level.startswith(ReleaseLevel.FINAL):
+    #         return f"{cls_name}(major={self.major}, minor={self.minor}, patch={self.patch})"
+    #     else:
+    #         return (
+    #             f"{cls_name}("
+    #             f"major={self.major}, minor={self.minor}, patch={self.patch}, "
+    #             f"release_level={self.release_level}, serial={self.serial})"
+    #         )
 
     def __format__(self, format_spec: str) -> str:
         """
@@ -166,8 +183,8 @@ class Version:
 
     @classmethod
     def from_tuple(
-        cls, iterable: Union[Tuple[int, int, int], Tuple[int, int, int, str, int]]
-    ):
+        cls, iterable: tuple[int, int, int] | tuple[int, int, int, str, int]
+    ) -> Self:
         """
         Convert to ``Version`` from a ``tuple``
 
@@ -203,7 +220,7 @@ class Version:
             raise ValueError("iterable must have len of 5 or 3")
 
     @classmethod
-    def from_str(cls, version_string: str):
+    def from_str(cls, version_string: str) -> Self:
         """
         Convert to ``Version`` from a ``str``
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: absfuyu
-Version: 5.0.0
+Version: 5.1.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/
@@ -86,7 +86,7 @@ help(absfuyu)
 
 ### Notable features
 
-**absfuyu.core**: Provides foundational components for additional functionalities.
+**absfuyu.core**: Provides base components for additional functionalities.
 
 ```python
 # Decorators that adds info to __doc__
@@ -104,13 +104,20 @@ for x in [DictExt, IntExt, ListExt, Text]:
     x.show_all_methods(print_result=1)
 ```
 
+**absfuyu.tools.Inspector**: An object inspector
+
+```python
+from absfuyu.tools import Inspector
+print(Inspector(Inspector))
+```
+
 There are many additional features available to explore.
 
 ## **DOCUMENTATION:**
 
 For more detailed information about the project, please refer to the documentation available at the following link:
 
-> [Project Documentation](https://absolutewinter.github.io/absfuyu/)
+> [Project Documentation](https://absolutewinter.github.io/absfuyu-docs/)
 
 ## **DEVELOPMENT SETUP**