absfuyu 3.1.1__py3-none-any.whl → 3.3.3__py3-none-any.whl

absfuyu/config/__init__.py

@@ -3,11 +3,10 @@ Absfuyu: Configuration
 ----------------------
 Package configuration module
 
-Version: 2.0.1
-Date updated: 24/11/2023 (dd/mm/yyyy)
+Version: 2.0.4
+Date updated: 06/04/2024 (dd/mm/yyyy)
 """
 
-
 # Module level
 ###########################################################################
 __all__ = [
@@ -20,28 +19,51 @@ __all__ = [
 # Library
 ###########################################################################
 from pathlib import Path
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, TypedDict
 
 from absfuyu.core import CONFIG_PATH
 from absfuyu.util.json_method import JsonFile
 
-
 # Setting
 ###########################################################################
-_SPACE_REPLACE = "-" # Replace " " character in setting name
+_SPACE_REPLACE = "-"  # Replace " " character in setting name
+
+
+# Type hint
+###########################################################################
+class SettingDictFormat(TypedDict):
+    """
+    Format for the ``setting`` section in ``config``
+
+    :param default: Default value for the setting
+    :param help: Description for the setting
+    :param value: Current value of the setting
+    """
+
+    default: Any
+    help: str
+    value: Any
+
+
+class ConfigFormat(TypedDict):
+    """
+    Config file format
+
+    :param setting: setting section
+    :type setting: dict[str, SettingDictFormat]
+    :param version: version section
+    :type version: VersionDictFormat
+    """
+
+    setting: Dict[str, SettingDictFormat]
 
 
 # Class
 ###########################################################################
 class Setting:
     """Setting"""
-    def __init__(
-            self,
-            name: str,
-            value: Any,
-            default: Any,
-            help_: str = ""
-        ) -> None:
+
+    def __init__(self, name: str, value: Any, default: Any, help_: str = "") -> None:
         """
         :param name: Name of the setting
         :param value: Value of the setting
@@ -52,40 +74,42 @@ class Setting:
         self.value = value
         self.default = default
         self.help = help_
+
     def __str__(self) -> str:
         return f"{self.__class__.__name__}({self.name}: {self.value})"
+
     def __repr__(self) -> str:
         return self.__str__()
-    
+
     @classmethod
-    def from_dict(cls, dict_data: Dict[str, Dict[str, Any]]):
-        """Convert ``dict`` into ``Setting`` (``len==1`` only)"""
-        name = list(dict_data.keys())[0]
-        _val = list(dict_data.values())[0]
-        value: Any = _val.get("value")
-        default: Any = _val.get("default")
-        help_: str = _val.get("help")
+    def from_dict(cls, dict_data: Dict[str, SettingDictFormat]):
+        """
+        Convert ``dict`` into ``Setting`` (``len==1`` only)
+        """
+        name: str = list(dict_data.keys())[0]
+        _val: SettingDictFormat = list(dict_data.values())[0]
+        value: Any = _val["value"]
+        default: Any = _val["default"]
+        help_: str = _val["help"]
         return cls(name, value, default, help_)
-    
+
     def reset(self) -> None:
         """
-        Reset setting to default value 
+        Reset setting to default value
         (``Setting.value = Setting.default``)
         """
         self.value = self.default
-    
+
     def update_value(self, value: Any) -> None:
         """Update current value"""
         self.value = value
 
-    def to_dict(self) -> Dict[str, Dict[str, Any]]:
-        """Convert ``Setting`` into ``dict``"""
-        output = {
-            self.name: {
-                "default": self.default,
-                "help": self.help,
-                "value": self.value
-            }
+    def to_dict(self) -> Dict[str, SettingDictFormat]:
+        """
+        Convert ``Setting`` into ``dict``
+        """
+        output: Dict[str, SettingDictFormat] = {
+            self.name: {"default": self.default, "help": self.help, "value": self.value}
         }
         return output
 
@@ -94,12 +118,13 @@ class Config:
     """
     Config handling
     """
+
     def __init__(self, config_file: Path, name: Optional[str] = None) -> None:
         """
         config_file: Path to `.json` config file
         """
-        self.config_path = config_file
-        self.json_engine = JsonFile(self.config_path)
+        self.config_path: Path = config_file
+        self.json_engine: JsonFile = JsonFile(self.config_path)
 
         if name:
             self.name = name
@@ -107,62 +132,60 @@ class Config:
             self.name = self.config_path.name
 
         # Data
-        self.settings: List[Setting] = None
-        self.version: dict = None
-        self._fetch_data() # Load data
+        self.settings: List[Setting] = None  # type: ignore
+        self._fetch_data()  # Load data
 
     def __str__(self) -> str:
         return f"{self.__class__.__name__}({self.config_path.name})"
+
     def __repr__(self) -> str:
         return self.__str__()
-    
+
     # Data prepare and export
     def _fetch_data(self) -> None:
         """Load data from ``self.config_file`` file"""
-        data = self.json_engine.load_json()
-        settings: dict = data.get("setting")
+        data: dict = self.json_engine.load_json()
+        settings: Dict[str, SettingDictFormat] = data.get("setting")  # type: ignore
         self.settings = [Setting.from_dict({k: v}) for k, v in settings.items()]
-        self.version = data.get("version")
-    
-    def _prepare_data(self) -> Dict[str, dict]:
+
+    def _prepare_data(self) -> ConfigFormat:
         """Prepare data to save config"""
         settings = dict()
-        for x in self.settings:
-            settings.update(x.to_dict())
+        for setting in self.settings:
+            settings.update(setting.to_dict())
 
-        out = {
-            "setting": settings,
-            "version": self.version
-        }
+        out: ConfigFormat = {"setting": settings}
         return out
-    
+
     def save(self) -> None:
         """Save config to ``.json`` file"""
-        self.json_engine.update_data(
-            self._prepare_data()
-        )
+        self.json_engine.update_data(self._prepare_data())  # type: ignore
         self.json_engine.save_json()
 
     # Setting method
+    @property
+    def setting_list(self) -> List[str]:
+        """List of name of available settings"""
+        return [setting.name for setting in self.settings]
+
     def _get_setting(self, name: str):
         """Get setting"""
         name = name.strip().lower().replace(" ", _SPACE_REPLACE)
-        setting_list = [x.name for x in self.settings]
-        if name in setting_list:
-            for x in self.settings:
-                if x.name.startswith(name):
-                    return x
+        if name in self.setting_list:
+            for setting in self.settings:
+                if setting.name.startswith(name):
+                    return setting
         else:
-            raise ValueError(f"Setting list: {setting_list}")
-    
+            raise ValueError(f"Setting list: {self.setting_list}")
+
     def reset_config(self) -> None:
         """Reset all settings to default value"""
-        [x.reset() for x in self.settings]
+        [setting.reset() for setting in self.settings]  # type: ignore
         self.save()
-    
-    def show_settings(self) -> None:
+
+    def show_settings(self) -> List[Setting]:
         """
-        Print a list of available settings 
+        Returns a list of available settings
         (wrapper for ``Config.settings``)
         """
         return self.settings
@@ -170,29 +193,28 @@ class Config:
     def change_setting(self, name: str, value: Any) -> None:
         """
         Change ``Setting`` (if available)
-        
+
         Parameters
         ----------
         name : str
             Name of the setting
-        
+
         value : Any
             Value of the setting
         """
         name = name.strip().lower().replace(" ", _SPACE_REPLACE)
-        setting_list = [x.name for x in self.settings]
-        if name in setting_list:
-            for x in self.settings:
-                if x.name.startswith(name):
-                    x.update_value(value)
+        if name in self.setting_list:
+            for setting in self.settings:
+                if setting.name.startswith(name):
+                    setting.update_value(value)
                     break
         else:
-            raise ValueError(f"Setting list: {setting_list}")
+            raise ValueError(f"Setting list: {self.setting_list}")
         self.save()
-    
+
     def toggle_setting(self, name: str) -> None:
         """
-        Special ``change_setting()`` method. 
+        Special ``change_setting()`` method.
         Turn on/off if ``type(<setting>) is bool``
 
         Parameters
@@ -207,13 +229,13 @@ class Config:
         # Change value
         try:
             self.change_setting(name, not setting_value)
-        except:
-            raise SystemExit("This setting is not type: bool")
-    
+        except Exception:
+            raise SystemExit("This setting is not type: bool")  # noqa: B904
+
     def add_setting(self, name: str, value: Any, default: Any, help_: str = "") -> None:
         """
         Add ``Setting`` if not exist
-        
+
         Parameters
         ----------
         name : str
@@ -226,51 +248,46 @@ class Config:
             Default value of the setting
 
         help_ : str
-            Description of the setting (Default: None)
+            Description of the setting (Default: ``None``)
         """
         name = name.strip().lower().replace(" ", _SPACE_REPLACE)
         new_setting = Setting(name, value, default, help_)
         if new_setting not in self.settings:
             self.settings.append(new_setting)
         self.save()
-    
+
     def del_setting(self, name: str) -> None:
         """
         Delete ``Setting``
-        
+
         Parameters
         ----------
         name : str
             Name of the setting
         """
         name = name.strip().lower().replace(" ", _SPACE_REPLACE)
-        self.settings = [x for x in self.settings if not x.name == name]
+        self.settings = [x for x in self.settings if x.name != name]
         self.save()
 
     def welcome(self) -> None:
         """Run first-run script (if any)"""
         self.change_setting("first-run", False)
 
-    # Version
-    def update_version(self, version_data: Dict[str, Union[str, int]]):
-        """
-        Update version
-
-        Parameters
-        ----------
-        version_data : dict[str, str | int]
-            Version data
-        """
-        self.version = version_data
-        self.save()
-
 
 # Init
 ###########################################################################
 ABSFUYU_CONFIG = Config(CONFIG_PATH)
 
-
-# Run
-###########################################################################
-if __name__ == "__main__":
-    pass
+# TODO: Create a config file when not available [W.I.P]
+# _settings = [
+#     Setting(
+#         "auto-install-extra", False, False, "Automatically install required packages"
+#     ),
+#     Setting("first-run", True, True, "Check if this package has ever been run"),
+#     Setting(
+#         "luckgod-mode",
+#         False,
+#         False,
+#         "A chance that the machine will be randomly shutdown",
+#     ),
+# ]

absfuyu/config/config.json

@@ -20,12 +20,5 @@
             "help": "Test",
             "value": false
         }
-    },
-    "version": {
-        "major": 3,
-        "minor": 1,
-        "patch": 1,
-        "release_level": "final",
-        "serial": 0
     }
 }

absfuyu/core.py

@@ -3,19 +3,14 @@ Absfuyu: Core
 -------------
 Contain type hints and other stuffs
 
-Version: 2.1.9
-Date updated: 27/11/2023 (dd/mm/yyyy)
+Version: 2.2.0
+Date updated: 14/04/2024 (dd/mm/yyyy)
 """
 
-
 # Module Package
 ###########################################################################
 __all__ = [
-    # module
-    "ModulePackage",
-    "ModuleList",
     # color
-    "Color",
     "CLITextColor",
     # path
     "CORE_PATH",
@@ -23,25 +18,13 @@ __all__ = [
     "DATA_PATH",
 ]
 
-ModulePackage = ["all", "cli", "beautiful", "extra", "res", "full", "dev"]
-ModuleList = [
-    "config",
-    "extensions",
-    "fun",
-    "game",
-    "general",
-    "pkg_data",
-    "sort",
-    "tools",
-    "util",
-    "version",
-]
+__package_feature__ = ["beautiful", "extra", "res", "full", "dev"]
 
 
-# Library
-###########################################################################
 from pathlib import Path
+
 # import sys
+# from sys import version_info as _python_version
 
 # if sys.version_info.minor >= 10:
 #     from importlib.resources import files
@@ -52,41 +35,6 @@ from pathlib import Path
 #         raise ImportError("Please install importlib-resources")
 
 
-try:
-    import colorama as __colorama
-except ImportError:
-    __colorama = None
-
-
-# Color - colorama
-###########################################################################
-if __colorama is not None:
-    # __colorama.init(autoreset=True)
-    Color = {
-        "green": __colorama.Fore.LIGHTGREEN_EX,
-        "GREEN": __colorama.Fore.GREEN,
-        "blue": __colorama.Fore.LIGHTCYAN_EX,
-        "BLUE": __colorama.Fore.CYAN,
-        "red": __colorama.Fore.LIGHTRED_EX,
-        "RED": __colorama.Fore.RED,
-        "yellow": __colorama.Fore.LIGHTYELLOW_EX,
-        "YELLOW": __colorama.Fore.YELLOW,
-        "reset": __colorama.Fore.RESET,
-    }
-else:
-    Color = {
-        "green": "",
-        "GREEN": "",
-        "blue": "",
-        "BLUE": "",
-        "red": "",
-        "RED": "",
-        "yellow": "",
-        "YELLOW": "",
-        "reset": "",
-    }
-
-
 class CLITextColor:
     """Color code for text in terminal"""
 
@@ -102,16 +50,7 @@ class CLITextColor:
     RESET = "\x1b[39m"
 
 
-# Path
-###########################################################################
-# CORE_PATH = Path(os.path.abspath(os.path.dirname(__file__)))
 CORE_PATH = Path(__file__).parent.absolute()
 # CORE_PATH = files("absfuyu")
 CONFIG_PATH = CORE_PATH.joinpath("config", "config.json")
 DATA_PATH = CORE_PATH.joinpath("pkg_data")
-
-
-# Run
-###########################################################################
-if __name__ == "__main__":
-    print(CORE_PATH)

absfuyu/everything.py

@@ -1,3 +1,4 @@
+# flake8: noqa
 """
 Absfuyu: Everything
 -------------------
@@ -11,23 +12,20 @@ Usage:
 >>> from absfuyu import everything as ab
 """
 
-
 # Library
 ###########################################################################
-from absfuyu.core import *
 from absfuyu.config import *
+from absfuyu.core import *
+from absfuyu.extensions import *
 from absfuyu.fun import *
-from absfuyu.pkg_data import *
+from absfuyu.game import *
+from absfuyu.general import *
 from absfuyu.logger import *
+from absfuyu.pkg_data import *
 from absfuyu.sort import *
-from absfuyu.version import *
-
-from absfuyu.general import *
-from absfuyu.extensions import *
-from absfuyu.game import *
 from absfuyu.tools import *
 from absfuyu.util import *
-
+from absfuyu.version import *
 
 # Is loaded
 ###########################################################################

absfuyu/extensions/beautiful.py

@@ -1,3 +1,4 @@
+# type: ignore
 """
 Absfuyu: Beautiful
 ------------------
@@ -7,15 +8,15 @@ Version: 1.0.2
 Date updated: 24/11/2023 (dd/mm/yyyy)
 """
 
-
 # Module level
 ###########################################################################
 __all__ = [
-    "beautiful_output", "print", "demo",
+    "beautiful_output",
+    "print",
+    "demo",
 ]
 
 
-
 # Library
 ###########################################################################
 from functools import wraps as __wraps
@@ -33,24 +34,25 @@ try:
     from rich.text import Text as __Text
 except ImportError:
     from absfuyu.config import ABSFUYU_CONFIG
+
     if ABSFUYU_CONFIG._get_setting("auto-install-extra").value:
         __cmd: str = "python -m pip install -U absfuyu[beautiful]".split()
         from subprocess import run as __run
+
         __run(__cmd)
     else:
-        raise SystemExit("This feature is in absfuyu[beautiful] package")
+        raise SystemExit("This feature is in absfuyu[beautiful] package")  # noqa: B904
 else:
     BEAUTIFUL_MODE = True
 
 
-
 # Function
 ###########################################################################
 def beautiful_output(
-        layout_option: int = 2,
-        header_visible: __Optional[bool] = True,
-        footer_visible: __Optional[bool] = False,
-    ):
+    layout_option: int = 2,
+    header_visible: __Optional[bool] = True,
+    footer_visible: __Optional[bool] = False,
+):
     """
     Beautify function output
 
@@ -62,21 +64,19 @@ def beautiful_output(
     footer_visible : True | False | None
         Show footer
     """
-    
+
     if not BEAUTIFUL_MODE:
         raise SystemExit("This feature is in absfuyu[beautiful] package")
 
     def decorator(func):
-
         @__wraps(func)
         def wrapper(*args, **kwargs):
-            
             # Measure performance
             start_time = __perf()
             f = func(*args, **kwargs)
             finished_time = __perf()
             elapsed = f"Time elapsed: {finished_time - start_time:,.6f} s"
-            
+
             # Make header
             header_table = __Table.grid(expand=True)
             header_table.add_row(
@@ -94,11 +94,11 @@ def beautiful_output(
                     style="white on blue",
                 ),
             )
-            
+
             # Make output table
             out_table = __Table.grid(expand=True)
-            out_table.add_column(ratio=2) # result
-            out_table.add_column() # performance
+            out_table.add_column(ratio=2)  # result
+            out_table.add_column()  # performance
             r_txt = __Text(
                 str(f),
                 overflow="fold",
@@ -132,16 +132,21 @@ def beautiful_output(
                 True: header_table,
                 False: line,
                 None: __Text(),
-            } # header[header_visible]
+            }  # header[header_visible]
             footer = {
                 True: footer_table,
                 False: line,
                 None: __Text(),
-            } # footer[footer_visible]
+            }  # footer[footer_visible]
             layout = {
                 1: __Group(header[header_visible], out_table, footer[footer_visible]),
-                2: __Group(header[header_visible], result_panel, performance_panel, footer[footer_visible]),
-                3: __Group(result_panel)
+                2: __Group(
+                    header[header_visible],
+                    result_panel,
+                    performance_panel,
+                    footer[footer_visible],
+                ),
+                3: __Group(result_panel),
             }
             if layout_option in layout:
                 return layout[layout_option]
@@ -150,7 +155,7 @@ def beautiful_output(
             # return layout[3]
 
         return wrapper
-    
+
     return decorator
 
 
@@ -162,7 +167,7 @@ if BEAUTIFUL_MODE:
 # demo
 @beautiful_output()
 def __demo_decorator(x: any = None):
-    code="""\
+    code = """\
 # demo
 from absfuyu.extensions import beautiful as bu
 @bu.beautiful_output()
@@ -174,8 +179,10 @@ bu.print(testcode())"""
         x = code
     return x
 
+
 def demo(x: any = None):
     print(__demo_decorator(x))
 
+
 if __name__ == "__main__":
-    demo()
+    demo()