absfuyu 2.8.1__py3-none-any.whl → 3.1.0__py3-none-any.whl

absfuyu/util/performance.py

@@ -1,11 +1,10 @@
-# -*- coding: utf-8 -*-
 """
 Absfuyu: Performance
 --------------------
 Performance Check
 
-Version: 1.0.1
-Date updated: 24/11/2023 (dd/mm/yyyy)
+Version: 1.1.0
+Date updated: 11/12/2023 (dd/mm/yyyy)
 
 Feature:
 --------
@@ -21,16 +20,20 @@ __all__ = [
     # Wrapper
     "measure_performance",
     # Functions
-    "var_check", "source_this"
+    "var_check",
+    "source_this",
 ]
 
 
 # Library
 ###########################################################################
 from functools import wraps as __wraps
-from inspect import getsource as __source
+from inspect import getsource
 from time import perf_counter as __perf_counter
 import tracemalloc as __tracemalloc
+from typing import Any, Callable, List, Optional, Tuple, Union
+
+from absfuyu.general.data_extension import ListNoDunder
 
 
 # Function
@@ -47,7 +50,7 @@ def measure_performance(func):
     --------
     >>> @measure_performance
     >>> def test():
-    >>>     return 1 + 1
+    ...     return 1 + 1
     >>> test()
         ----------------------------------------
         Function: test
@@ -104,10 +107,20 @@ def measure_performance(func):
     return wrapper
 
 
-def var_check(variable):
+def var_check(variable: Any, full: bool = False):
     """
     Check a variable
-    
+
+    Parameters
+    ----------
+    variable : Any
+        Variable that needed to check
+
+    full : bool
+        | ``True``: Shows full detail
+        | ``False``: Hides ``dir`` and ``docstring``
+
+
     Example:
     --------
     >>> test = "test"
@@ -140,14 +153,22 @@ def var_check(variable):
             dict,
             set, frozenset,
             bool,
-            bytes,bytearray, memoryview,
-            type(None)
+            bytes, bytearray, memoryview,
+            type(None),
         ]
         if type(variable) in lc:
             pass
         else:
             docs = variable.__doc__
-            output["docstring"] = docs
+            if full:
+                output["docstring"] = docs
+    except:
+        pass
+
+    # Dir
+    try:
+        if full:
+            output["dir"] = ListNoDunder(variable.__dir__())
     except:
         pass
 
@@ -155,7 +176,7 @@ def var_check(variable):
     return output
 
 
-def source_this(function) -> str:
+def source_this(function: Callable) -> str:
     """
     Show the source code of a function
 
@@ -169,10 +190,76 @@ def source_this(function) -> str:
     str
         Source code
     """
-    return __source(function)
+    return getsource(function)
+
+
+# Class
+###########################################################################
+class Checker:
+    """Check a variable"""
+    def __init__(self, checker: Any) -> None:
+        self.item_to_check = checker
+    def __str__(self) -> str:
+        return self.item_to_check.__str__()
+    def __repr__(self) -> str:
+        return f"{self.__class__.__name__}({self.item_to_check})"
+
+    @property
+    def name(self) -> Union[Any, None]:
+        try:
+            return self.item_to_check.__name__
+        except:
+            return None
+
+    @property
+    def value(self) -> Any:
+        return self.item_to_check
+
+    @property
+    def docstring(self) -> Union[str, None]:
+        """:returns: ``self.item_to_check.__doc__``"""
+        return self.item_to_check.__doc__
+
+    @property
+    def class_(self) -> Any:
+        return type(self.item_to_check)
+
+    @property
+    def id_(self) -> int:
+        return id(self.item_to_check)
+
+    @property
+    def dir_(self) -> List[str]:
+        """:returns: ``dir(self.item_to_check)``"""
+        # return self.item_to_check.__dir__()
+        return ListNoDunder(self.item_to_check.__dir__())
+    
+    @property
+    def source(self) -> Union[str, None]:
+        """:returns: Source code"""
+        try:
+            return getsource(self.item_to_check)
+        except:
+            return None
+
+    def check(self, full: bool = False):
+        """
+        Check
+        """
+        out = {
+            "name": self.name,
+            "value": self.value,
+            "class": self.class_,
+            "id": self.id_,
+        }
+        if full:
+            out["dir"] = self.dir_
+            out["docs"] = self.docstring
+            out["source"] = self.source
+        return out
 
 
 # Run
 ###########################################################################
 if __name__ == "__main__":
-    pass
+    pass

absfuyu/version.py

@@ -3,18 +3,23 @@ Absfuyu: Version
 ----------------
 Package versioning module
 
-Version: 2.0.3
-Date updated: 24/11/2023 (dd/mm/yyyy)
+Version: 2.0.4
+Date updated: 25/11/2023 (dd/mm/yyyy)
 """
 
 
 # Module level
 ###########################################################################
 __all__ = [
+    # Version
     "__version__",
-    "ReleaseOption", "ReleaseLevel",
-    "Version", "Bumper",
-    "PkgVersion"
+    # Options
+    "ReleaseOption",
+    "ReleaseLevel",
+    # Class
+    "Version",
+    "Bumper",
+    "PkgVersion",
 ]
 
 # Library
@@ -36,6 +41,7 @@ class ReleaseOption:
     """
     ``MAJOR``, ``MINOR``, ``PATCH``
     """
+
     MAJOR: str = "major"
     MINOR: str = "minor"
     PATCH: str = "patch"
@@ -45,13 +51,15 @@ class ReleaseOption:
         """Return a list of release options"""
         return [__class__.MAJOR, __class__.MINOR, __class__.PATCH]
 
+
 class ReleaseLevel:
     """
     ``FINAL``, ``DEV``, ``RC``
     """
+
     FINAL: str = "final"
     DEV: str = "dev"
-    RC: str = "rc" # Release candidate
+    RC: str = "rc"  # Release candidate
 
     # @staticmethod
     def all_level() -> List[str]:
@@ -61,14 +69,15 @@ class ReleaseLevel:
 
 class Version:
     """Version"""
+
     def __init__(
-            self,
-            major: int,
-            minor: int,
-            patch: int,
-            release_level: str = ReleaseLevel.FINAL,
-            serial: int = 0,
-        ) -> None:
+        self,
+        major: int,
+        minor: int,
+        patch: int,
+        release_level: str = ReleaseLevel.FINAL,
+        serial: int = 0,
+    ) -> None:
         """
         Create ``Version`` instance
 
@@ -88,15 +97,16 @@ class Version:
         self.patch: int = patch
         self.release_level: str = release_level
         self.serial: int = serial
-    
+
     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__}(major={self.major}, minor={self.minor}, patch={self.patch}, release_level={self.release_level}, serial={self.serial})"
-    
+
     @property
     def version(self) -> str:
         """
@@ -118,12 +128,12 @@ class Version:
             return f"{self.major}.{self.minor}.{self.patch}"
         else:
             return f"{self.major}.{self.minor}.{self.patch}.{self.release_level}{self.serial}"
-    
+
     @classmethod
     def from_tuple(cls, iterable: tuple):
         """
         Convert to ``Version`` from a ``tuple``
-        
+
         Returns
         -------
         Version
@@ -137,9 +147,11 @@ class Version:
         1.0.0
         """
         if len(iterable) == 5:
-            return cls(iterable[0], iterable[1], iterable[2], iterable[3], iterable[4]) # Full
+            return cls(
+                iterable[0], iterable[1], iterable[2], iterable[3], iterable[4]
+            )  # Full
         elif len(iterable) == 3:
-            return cls(iterable[0], iterable[1], iterable[2]) # major.minor.patch only
+            return cls(iterable[0], iterable[1], iterable[2])  # major.minor.patch only
         else:
             raise ValueError("iterable must have len of 5 or 3")
 
@@ -167,12 +179,13 @@ class Version:
             "minor": self.minor,
             "patch": self.patch,
             "release_level": self.release_level,
-            "serial": self.serial
+            "serial": self.serial,
         }
 
 
 class Bumper(Version):
     """Version bumper"""
+
     def _bump_ver(self, release_option: str) -> None:
         """
         Bumping major, minor, patch
@@ -188,15 +201,12 @@ class Bumper(Version):
             self.patch = 0
         else:
             self.patch += 1
-        
+
         logger.debug(f"After: {self.version}")
 
     def bump(
-            self,
-            *,
-            option: str = ReleaseOption.PATCH, 
-            channel: str = ReleaseLevel.FINAL
-        ) -> None:
+        self, *, option: str = ReleaseOption.PATCH, channel: str = ReleaseLevel.FINAL
+    ) -> None:
         """
         Bump current version (internally)
 
@@ -205,11 +215,11 @@ class Bumper(Version):
         option : str
             Release option
             (Default: ``"patch"``)
-        
+
         channel : str
             Release channel
             (Default: ``"final"``)
-        
+
 
         Example:
         --------
@@ -228,31 +238,36 @@ class Bumper(Version):
             logger.debug(ReleaseLevel.all_level())
             channel = ReleaseLevel.FINAL
         logger.debug(f"Target: {option} {channel}")
-        
+
         # Bump ver
-        if channel.startswith(ReleaseLevel.FINAL): # Final release level
-            if self.release_level in [ReleaseLevel.RC, ReleaseLevel.DEV]: # current release channel is dev or rc
+        if channel.startswith(ReleaseLevel.FINAL):  # Final release level
+            if self.release_level in [
+                ReleaseLevel.RC,
+                ReleaseLevel.DEV,
+            ]:  # current release channel is dev or rc
                 self.release_level = ReleaseLevel.FINAL
                 self.serial = 0
             else:
-                self.serial = 0 # final channel does not need serial
+                self.serial = 0  # final channel does not need serial
                 self._bump_ver(option)
-        
-        elif channel.startswith(ReleaseLevel.RC): # release candidate release level
-            if self.release_level.startswith(ReleaseLevel.DEV): # current release channel is dev
+
+        elif channel.startswith(ReleaseLevel.RC):  # release candidate release level
+            if self.release_level.startswith(
+                ReleaseLevel.DEV
+            ):  # current release channel is dev
                 self.release_level = ReleaseLevel.RC
-                self.serial = 0 # reset serial
-            elif channel == self.release_level: # current release channel is rc
+                self.serial = 0  # reset serial
+            elif channel == self.release_level:  # current release channel is rc
                 self.serial += 1
-            else: # current release channel is final
+            else:  # current release channel is final
                 self.release_level = channel
-                self.serial = 0 # reset serial
+                self.serial = 0  # reset serial
                 self._bump_ver(option)
-        
-        else: # dev release level
-            if channel == self.release_level: # current release channel is dev
+
+        else:  # dev release level
+            if channel == self.release_level:  # current release channel is dev
                 self.serial += 1
-            else: # current release channel is final or rc
+            else:  # current release channel is final or rc
                 self.release_level = channel
                 self.serial = 0
                 self._bump_ver(option)
@@ -262,16 +277,13 @@ class PkgVersion(Bumper):
     """
     Versioning module
     """
-    def __init__(
-            self,
-            package_name: str,
-            config_file_handler: Config
-        ) -> None:
+
+    def __init__(self, package_name: str, config_file_handler: Config) -> None:
         """
         package_name: Name of the package
         config_file_handler: Config file handler
         """
-        
+
         # Get config
         try:
             self.config_file = config_file_handler
@@ -303,7 +315,7 @@ class PkgVersion(Bumper):
                 logger.error("Failed to reach server.")
                 logger.error("Reason: ", e.reason)
             elif hasattr(e, "code"):
-                logger.error("The server couldn\'t fulfill the request.")
+                logger.error("The server couldn't fulfill the request.")
                 logger.error("Error code: ", e.code)
         except:
             logger.error("Fetch failed!")
@@ -316,8 +328,8 @@ class PkgVersion(Bumper):
         """
         rss = f"https://pypi.org/rss/project/{self.package_name}/releases.xml"
         xml_file: str = self._fetch_data_from_server(rss)
-        ver = xml_file[xml_file.find("<item>"):xml_file.find("</item>")] # First item
-        version = ver[ver.find("<title>")+len("<title>"):ver.find("</title>")]
+        ver = xml_file[xml_file.find("<item>") : xml_file.find("</item>")]  # First item
+        version = ver[ver.find("<title>") + len("<title>") : ver.find("</title>")]
         return version
 
     def _load_data_from_json(self, json_link: str) -> dict:
@@ -344,24 +356,24 @@ class PkgVersion(Bumper):
         return subprocess.run(cmd)
 
     def check_for_update(
-            self,
-            *,
-            force_update: bool = False,
-        ) -> None:
+        self,
+        *,
+        force_update: bool = False,
+    ) -> None:
         """
         Check for latest update
 
         :param force_update: Auto update the package when run (Default: ``False``)
         :type force_update: bool
         """
-        
+
         try:
             latest = self._get_latest_version()
         except:
             latest = self._get_latest_version_legacy()
         current = __version__
         logger.debug(f"Current: {current} | Lastest: {latest}")
-        
+
         if current == latest:
             print(f"You are using the latest version ({latest})")
         else:
@@ -370,21 +382,22 @@ class PkgVersion(Bumper):
                 try:
                     self._get_update()
                 except:
-                    print(f"""
+                    print(
+                        f"""
                     Unable to perform update.
                     Please update manually with:
                     pip install -U {self.package_name}=={latest}
-                    """)
+                    """
+                    )
             else:
-                print(f"Newer version ({latest}) available. Upgrade with:\npip install -U {self.package_name}=={latest}")
-
+                print(
+                    f"Newer version ({latest}) available. Upgrade with:\npip install -U {self.package_name}=={latest}"
+                )
 
     # Bump version
     def bump_version(
-            self,
-            option: str = ReleaseOption.PATCH, 
-            channel: str = ReleaseLevel.FINAL
-        ) -> str:
+        self, option: str = ReleaseOption.PATCH, channel: str = ReleaseLevel.FINAL
+    ) -> str:
         """
         Bump current version and save
 
@@ -393,50 +406,46 @@ class PkgVersion(Bumper):
         option : str
             Release option
             (Default: ``"patch"``)
-        
+
         channel : str
             Release channel
             (Default: ``"final"``)
-        
+
         Returns
         -------
         str
             Bumped version string
         """
-        self.bump(option=option, channel=channel) # Bump
-        self.config_file.update_version(self.to_dict()) # Save to config
+        self.bump(option=option, channel=channel)  # Bump
+        self.config_file.update_version(self.to_dict())  # Save to config
         return self.version
 
-
     # Release package
     def _release_to_pypi(
-            self,
-            option: str = ReleaseOption.PATCH,
-            channel: str = ReleaseLevel.FINAL,
-            safety_lock_off: bool = False,
-        ) -> None:
+        self,
+        option: str = ReleaseOption.PATCH,
+        channel: str = ReleaseLevel.FINAL,
+        safety_lock_off: bool = False,
+    ) -> None:
         """
         Developer only! Not intended for end-user
-        
+
         option: ReleaseOption
         channel: ReleaseLevel
         safety_lock_off: Set to `True` to execute this function
         """
         if not safety_lock_off:
             return None
-        
+
         logger.debug("Bumping version...")
-        
+
         self.bump_version(option=option, channel=channel)
 
         logger.debug(f"Version bumped. Current verion: {self.version}")
         logger.debug("Building package...")
-        
+
         try:
-            cmds = [
-                "python -m build".split(),
-                "twine upload dist/*".split()
-            ]
+            cmds = ["python -m build".split(), "twine upload dist/*".split()]
             for cmd in cmds:
                 subprocess.run(cmd)
             logger.debug("Release published!")