danielutils 0.9.62__tar.gz → 1.0.0__tar.gz

danielutils-1.0.0/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include danielutils *.py

{danielutils-0.9.62 → danielutils-1.0.0}/PKG-INFO

@@ -1,9 +1,7 @@
 Metadata-Version: 2.1
 Name: danielutils
-Version: 0.9.62
+Version: 1.0.0
 Summary: A python utils library for things I find useful
-Home-page: https://github.com/danielnachumdev/danielutils
-Author: danielnachumdev
 Author-email: danielnachumdev <danielnachumdev@gmail.com>
 License: MIT License
         
@@ -28,14 +26,13 @@ License: MIT License
         SOFTWARE.
 Project-URL: Homepage, https://github.com/danielnachumdev/danielutils
 Project-URL: Bug Tracker, https://github.com/danielnachumdev/danielutils/issues
-Keywords: functions,decorators,methods,classes,metaclasses
-Platform: All
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: Microsoft :: Windows
-Requires-Python: >=3.8.17
+Requires-Python: >=3.8.0
 Description-Content-Type: text/markdown
+License-File: LICENSE
 
 
 [![Python package](https://github.com/danielnachumdev/danielutils/actions/workflows/python-package.yml/badge.svg)](https://github.com/danielnachumdev/danielutils/actions/workflows/python-package.yml)
@@ -43,12 +40,15 @@ Description-Content-Type: text/markdown
 [![Python 3.10.11](https://img.shields.io/badge/python-3.10.11-blue.svg)](https://www.python.org/downloads/release/python-31011/)
 [![gitleaks](https://github.com/danielnachumdev/danielutils/actions/workflows/gitleaks.yml/badge.svg)](https://github.com/danielnachumdev/danielutils/actions/workflows/gitleaks.yml)
 [![CodeQL](https://github.com/danielnachumdev/danielutils/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/danielnachumdev/danielutils/actions/workflows/github-code-scanning/codeql)
-# danielutils v=0.9.62
+# danielutils v=1.0.0
 A utils library for things that I find useful for my coding workflow.\
 Feel free to use and / or contribute / improve my code :)
 
 THIS PACKAGE IS IN DEVELOPMENT AND SUBJECT TO CHANGE, USE AT YOUR OWN RISK!
 
+**Tested python versions**: `3.8.0`*, `3.9.0`, `3.10.13` 
+
+Versions marked with * are partially working
 # Showcase
 In [this](./READMES/) folder you can check out some more in depth showcase of some of the topics I have covered in this package
 

{danielutils-0.9.62 → danielutils-1.0.0}/README.md

@@ -4,12 +4,15 @@
 [![Python 3.10.11](https://img.shields.io/badge/python-3.10.11-blue.svg)](https://www.python.org/downloads/release/python-31011/)
 [![gitleaks](https://github.com/danielnachumdev/danielutils/actions/workflows/gitleaks.yml/badge.svg)](https://github.com/danielnachumdev/danielutils/actions/workflows/gitleaks.yml)
 [![CodeQL](https://github.com/danielnachumdev/danielutils/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/danielnachumdev/danielutils/actions/workflows/github-code-scanning/codeql)
-# danielutils v=0.9.62
+# danielutils v=1.0.0
 A utils library for things that I find useful for my coding workflow.\
 Feel free to use and / or contribute / improve my code :)
 
 THIS PACKAGE IS IN DEVELOPMENT AND SUBJECT TO CHANGE, USE AT YOUR OWN RISK!
 
+**Tested python versions**: `3.8.0`*, `3.9.0`, `3.10.13` 
+
+Versions marked with * are partially working
 # Showcase
 In [this](./READMES/) folder you can check out some more in depth showcase of some of the topics I have covered in this package
 

{danielutils-0.9.62 → danielutils-1.0.0}/danielutils/Aliases.py

@@ -150,16 +150,15 @@ T = TypeVar("T")
 
 Supplier = Callable[[], T]
 Runnable = Supplier[None]
-
+Consumer = Callable[[T], None]
 UnaryFunction = Callable[[U], T]
-UnaryOperator = UnaryFunction[T, T]
-Predicate = UnaryFunction[T, bool]
-Consumer = UnaryFunction[T, None]
+UnaryOperator = Callable[[T], T]
+Predicate = Callable[[T], bool]
 
 BinaryFunction = Callable[[A, B], T]
-BinaryOperator = BinaryFunction[T, T, T]
-Comparator = BinaryFunction[A, B, int]
-BinaryConsumer = BinaryFunction[T, T, None]
+BinaryOperator = Callable[[T, T], T]
+Comparator = Callable[[A, B], int]
+BinaryConsumer = Callable[[T, T], None]
 
 __all__ = [
     "UnaryFunction",

{danielutils-0.9.62 → danielutils-1.0.0}/danielutils/Colors.py

@@ -1,6 +1,5 @@
 from typing import Optional, IO
-from .decorators.validate import validate
-
+from .decorators import validate
 
 RESET = "\033[0m"
 
@@ -16,15 +15,16 @@ class ColoredText:
         white,
         black
     """
-    @staticmethod
-    @validate
+
+    @staticmethod  # type:ignore
+    @validate  # type:ignore
     def from_rgb(red: int, green: int, blue: int, text: str) -> str:
         """Applies an RGB color to the given text.
 
         Args:
-            r (int): The red component of the color.
-            g (int): The green component of the color.
-            b (int): The blue component of the color.
+            red (int): The red component of the color.
+            green (int): The green component of the color.
+            blue (int): The blue component of the color.
             text (str): The text to apply the color to.
 
         Returns:
@@ -178,7 +178,7 @@ def error(*args, sep: str = " ", end: str = "\n"):
 
 
 def info(*args, sep: str = " ", end: str = "\n"):
-    """print an error message
+    """print an info message
 
     Args:
         sep (str, optional): print separator. Defaults to " ".

{danielutils-0.9.62 → danielutils-1.0.0}/danielutils/Conversions/main_conversions.py

@@ -1,7 +1,7 @@
 from ..decorators import validate
 
 
-@validate
+@validate  # type:ignore
 def char_to_int(c: str) -> int:
     """convert char to its representing int value
 
@@ -14,7 +14,7 @@ def char_to_int(c: str) -> int:
     return ord(c)
 
 
-@validate
+@validate  # type:ignore
 def int_to_char(num: int) -> str:
     """convert int to its corresponding char
 
@@ -27,7 +27,7 @@ def int_to_char(num: int) -> str:
     return chr(num)
 
 
-@validate
+@validate  # type:ignore
 def hex_to_char(h: str) -> str:
     """convert hex number to char
 
@@ -40,7 +40,7 @@ def hex_to_char(h: str) -> str:
     return int_to_char(hex_to_dec(h))
 
 
-@validate
+@validate  # type:ignore
 def hex_to_dec(h: str) -> int:
     """convert hex to dec
 
@@ -53,7 +53,7 @@ def hex_to_dec(h: str) -> int:
     return int(h, 16)
 
 
-@validate
+@validate  # type:ignore
 def char_to_hex(c: str) -> str:
     """convert char to hex
 
@@ -66,7 +66,7 @@ def char_to_hex(c: str) -> str:
     return int_to_hex(char_to_int(c))
 
 
-@validate
+@validate  # type:ignore
 def dec_to_hex(num: int) -> str:
     """convert decimal number to hex
 
@@ -79,7 +79,7 @@ def dec_to_hex(num: int) -> str:
     return int_to_hex(num)
 
 
-@validate
+@validate  # type:ignore
 def int_to_hex(num: int) -> str:
     """converts an int to it's hex representation
 
@@ -92,7 +92,7 @@ def int_to_hex(num: int) -> str:
     return hex(num)
 
 
-@validate
+@validate  # type:ignore
 def bytes_to_str(b: bytes) -> str:
     """decodes bytes to str
 
@@ -105,7 +105,7 @@ def bytes_to_str(b: bytes) -> str:
     return b.decode("utf-8")
 
 
-@validate
+@validate  # type:ignore
 def str_to_bytes(s: str) -> bytes:
     """encodes a string to bytes
 

{danielutils-0.9.62 → danielutils-1.0.0}/danielutils/Conversions/specialized_conversions/to_hex.py

@@ -1,4 +1,4 @@
-from ...metaclasses.OverloadMeta import OverloadMeta
+from ...metaclasses.overload_meta import OverloadMeta
 from ..main_conversions import int_to_hex, char_to_hex
 
 
@@ -8,7 +8,7 @@ def to_hex(v: int) -> str:
     return int_to_hex(v)
 
 
-@to_hex.overload
+@to_hex.overload  # type:ignore
 def to_hex2(v: str) -> str:
     """to_hex has several options:\n
     1. type(v) == int\n

{danielutils-0.9.62 → danielutils-1.0.0}/danielutils/Conversions/specialized_conversions/to_int.py

@@ -1,12 +1,12 @@
 """functions that convert values to int"""
-from typing import Union, List as t_list
+from typing import Union, List as List
 from ..main_conversions import char_to_int
 from ...reflection import get_python_version
 if get_python_version() >= (3, 9):
-    from builtins import list as t_list
+    from builtins import list as List
 
 
-def to_int(value: str) -> Union[int, t_list[int]]:
+def to_int(value: str) -> Union[int, List[int]]:
     """converts a single character or a full string to an int or list of int respectively
     """
     if len(value) == 1:

{danielutils-0.9.62 → danielutils-1.0.0}/danielutils/Decorators/__init__.py

@@ -5,10 +5,13 @@ from .decorate_conditionally import *
 from .limit_recursion import *
 from .memo import *
 from .overload import *
-from .PartiallyImplemented import *
+from .partially_implemented import *
 from .timeout import *
 from .chain_decorators import *
 from .threadify import *
 from .delay_call import *
 from .deprecate import *
 from .processify import *
+from .singleton import *
+from .total_ordering import *
+from .final import *

{danielutils-0.9.62 → danielutils-1.0.0}/danielutils/Decorators/atomic.py

@@ -3,17 +3,14 @@ from typing import Callable, Any, TypeVar
 import threading
 from .validate import validate
 
-from ..reflection import get_python_version
-if get_python_version() < (3, 9):
-    from typing_extensions import ParamSpec
-else:
-    from typing import ParamSpec  # type:ignore # pylint: disable=ungrouped-imports
+from ..versioned_imports import ParamSpec
+
 T = TypeVar("T")
 P = ParamSpec("P")
 FuncT = Callable[P, T]  # type:ignore
 
 
-@validate
+@validate  # type:ignore
 def atomic(func: FuncT) -> FuncT:
     """will make function thread safe by making it
     accessible for only one thread at one time
@@ -26,10 +23,11 @@ def atomic(func: FuncT) -> FuncT:
     """
     lock = threading.Lock()
 
-    @ functools.wraps(func)
+    @functools.wraps(func)
     def wrapper(*args, **kwargs) -> Any:
         with lock:
             return func(*args, **kwargs)
+
     return wrapper
 
 

{danielutils-0.9.62 → danielutils-1.0.0}/danielutils/Decorators/attach.py

@@ -1,18 +1,14 @@
 import functools
 from typing import Callable, Optional, TypeVar
-import platform
 from .validate import validate
-from ..reflection import get_python_version
-if get_python_version() < (3, 9):
-    from typing_extensions import ParamSpec
-else:
-    from typing import ParamSpec  # type:ignore # pylint: disable=ungrouped-imports
+from ..versioned_imports import ParamSpec
+
 T = TypeVar("T")
 P = ParamSpec("P")
 FuncT = Callable[P, T]  # type:ignore
 
 
-@validate(strict=False)
+@validate(strict=False)  # type:ignore
 def attach(before: Optional[Callable] = None, after: Optional[Callable] = None) -> Callable[[FuncT], FuncT]:
     """attaching functions to a function
 
@@ -42,7 +38,9 @@ def attach(before: Optional[Callable] = None, after: Optional[Callable] = None)
             if after is not None:
                 after()
             return res
+
         return wrapper
+
     return attach_deco
 
 

danielutils-1.0.0/danielutils/Decorators/decorate_conditionally.py

@@ -0,0 +1,32 @@
+import functools
+from typing import Callable, Optional, Union
+from .validate import validate
+
+
+@validate(strict=False)  # type:ignore
+def decorate_conditionally(decorator: Callable, predicate: Union[bool, Callable[[], bool]], *,
+                           decorator_args: Optional[list] = None, decorator_kwargs: Optional[dict] = None):
+    """will decorate a function iff the predicate is True or returns True
+
+    Args:
+        decorator (Callable): the decorator to use
+        predicate (bool | Callable[[], bool]): the predicate
+    """
+
+    def deco(func):
+        if (predicate() if callable(predicate) else predicate):
+            nonlocal decorator_args, decorator_kwargs, decorator
+            if decorator_args is None:
+                decorator_args = []
+            if decorator_kwargs is None:
+                decorator_kwargs = {}
+            decorator = functools.wraps(func)(decorator)
+            return decorator(*decorator_args, **decorator_kwargs)(func)
+        return func
+
+    return deco
+
+
+__all__ = [
+    "decorate_conditionally"
+]

{danielutils-0.9.62 → danielutils-1.0.0}/danielutils/Decorators/delay_call.py

@@ -1,15 +1,10 @@
 from typing import Callable, TypeVar, Union
-import platform
 import time
 import functools
 from .decorate_conditionally import decorate_conditionally
 from .threadify import threadify
+from ..versioned_imports import ParamSpec
 
-from ..reflection import get_python_version
-if get_python_version() < (3, 9):
-    from typing_extensions import ParamSpec
-else:
-    from typing import ParamSpec  # type:ignore# pylint: disable=ungrouped-imports
 T = TypeVar("T")
 P = ParamSpec("P")
 FuncT = Callable[P, T]  # type:ignore
@@ -23,13 +18,16 @@ def delay_call(seconds: Union[float, int], blocking: bool = True) -> Callable[[F
         blocking (bool, optional): whether to block the main thread
         when waiting or to wait in a different thread. Defaults to True.
     """
+
     def deco(func: FuncT) -> FuncT:
         @decorate_conditionally(threadify, not blocking)
         @functools.wraps(func)
         def wrapper(*args, **kwargs):
             time.sleep(seconds)
             func(*args, **kwargs)
+
         return wrapper
+
     return deco
 
 

{danielutils-0.9.62 → danielutils-1.0.0}/danielutils/Decorators/deprecate.py

@@ -1,12 +1,7 @@
-import platform
 from typing import Callable, TypeVar
 from ..colors import warning, ColoredText
+from ..versioned_imports import ParamSpec
 
-from ..reflection import get_python_version
-if get_python_version() < (3, 9):
-    from typing_extensions import ParamSpec
-else:
-    from typing import ParamSpec  # type:ignore # pylint: disable=ungrouped-imports
 T = TypeVar("T")
 P = ParamSpec("P")
 FuncT = Callable[P, T]  # type:ignore
@@ -14,13 +9,16 @@ FuncT = Callable[P, T]  # type:ignore
 
 def deprecate_with(replacement_func) -> Callable[[FuncT], FuncT]:
     """will replace a deprecated function with the replacement func and will print a warning"""
+
     def deco(func: FuncT) -> FuncT:
         warning(f"{func.__module__}.{func.__qualname__} is deprecated,"
                 f" using {replacement_func.__module__}.{replacement_func.__qualname__} instead")
 
         def wrapper(*args, **kwargs):
             return replacement_func(*args, **kwargs)
+
         return wrapper
+
     return deco
 
 
@@ -30,12 +28,15 @@ def deprecate(deprecation_message: str) -> Callable[[FuncT], FuncT]:
     Args:
         deprecation_message (str): deprecation message
     """
+
     def deco(func: FuncT) -> FuncT:
         def wrapper(*args, **kwargs):
             print(ColoredText.orange("Deprecation Warning") +
                   ":", deprecation_message)
             return func(*args, **kwargs)
+
         return wrapper
+
     return deco
 
 

danielutils-1.0.0/danielutils/Decorators/final.py

@@ -0,0 +1,37 @@
+def final(cls: type) -> type:
+    """
+    A class Decorator to mark a class as final and add expected behavior
+    Args:
+        cls: the class to mark
+
+    Returns:
+        marked class
+    """
+    def __init__subclass__(*args, **kwargs):
+        raise TypeError(f"'{cls.__qualname__}' is final. Can't create subclasses")
+
+    setattr(cls, "__init_subclass__", __init__subclass__)
+    return cls
+
+
+class Final:
+    """
+    A parent class to make direct child a Final class. will add expected behaviour.
+    """
+    def __new__(cls, *args, **kwargs):
+        if cls is Final:
+            raise TypeError("Can't instantiate 'Final'")
+        return super().__new__(cls, *args, **kwargs)
+
+    @classmethod
+    def __init_subclass__(cls, **kwargs):
+        def __init__subclass__(*args, **kwargs):
+            raise TypeError(f"'{cls.__qualname__}' is final. Can't create subclasses")
+
+        setattr(cls, "__init_subclass__", __init__subclass__)
+
+
+__all__ = [
+    "final",
+    "Final"
+]

{danielutils-0.9.62 → danielutils-1.0.0}/danielutils/Decorators/limit_recursion.py

@@ -1,22 +1,17 @@
 import functools
 import re
 import traceback
-import platform
 from typing import Any, Callable, TypeVar
 from .validate import validate
 from ..colors import warning
+from ..versioned_imports import ParamSpec
 
-from ..reflection import get_python_version
-if get_python_version() < (3, 9):
-    from typing_extensions import ParamSpec
-else:
-    from typing import ParamSpec  # type:ignore # pylint: disable=ungrouped-imports
 T = TypeVar("T")
 P = ParamSpec("P")
 FuncT = Callable[P, T]  # type:ignore
 
 
-@validate
+@validate  # type:ignore
 def limit_recursion(max_depth: int, return_value: Any = None, quiet: bool = True) -> Callable[[FuncT], FuncT]:
     """decorator to limit recursion of functions
 
@@ -28,12 +23,12 @@ def limit_recursion(max_depth: int, return_value: Any = None, quiet: bool = True
     """
 
     def deco(func: FuncT) -> FuncT:
-        @ functools.wraps(func)
+        @functools.wraps(func)
         def wrapper(*args, **kwargs):
             depth = functools.reduce(
                 lambda count, line:
-                    count + 1 if re.search(rf"{func.__name__}\(.*\)$", line)
-                    else count,
+                count + 1 if re.search(rf"{func.__name__}\(.*\)$", line)
+                else count,
                 traceback.format_stack(), 0
             )
             if depth >= max_depth:
@@ -45,7 +40,9 @@ def limit_recursion(max_depth: int, return_value: Any = None, quiet: bool = True
                     return return_value
                 return args, kwargs
             return func(*args, **kwargs)
+
         return wrapper
+
     return deco
 
 

danielutils-1.0.0/danielutils/Decorators/memo.py

@@ -0,0 +1,51 @@
+import functools
+from typing import Callable, Any, TypeVar, Dict, Generator, List, Set, Optional
+from copy import deepcopy
+from .validate import validate
+from ..versioned_imports import ParamSpec
+
+T = TypeVar("T")
+P = ParamSpec("P")
+FuncT = Callable[P, T]  # type:ignore
+
+
+@validate  # type:ignore
+def memo(func: FuncT) -> FuncT:
+    """decorator to memorize function calls in order to improve performance by using more memory
+
+    Args:
+        func (Callable): function to memorize
+    """
+    cache: Dict[tuple, Any] = {}
+
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        if (args, *kwargs.items()) not in cache:
+            cache[(args, *kwargs.items())] = func(*args, **kwargs)
+        return deepcopy(cache[(args, *kwargs.items())])
+
+    return wrapper
+
+
+def memo_generator(func: Callable[P, Generator]) -> Callable[P, Generator]:
+    cache: Dict[tuple, Any] = {}
+
+    @functools.wraps(func)
+    def wrapper(*args: P.args, **kwargs: P.kwargs) -> Generator:
+        args = tuple(args)
+        if (args, *kwargs.items()) not in cache:
+            lst = []
+            for v in func(*args, **kwargs):
+                lst.append(v)
+                yield v
+            cache[(args, *kwargs.items())] = lst
+        else:
+            yield from cache[(args, *kwargs.items())]
+
+    return wrapper
+
+
+__all__ = [
+    "memo",
+    "memo_generator"
+]