aletk 0.1.5__py3-none-any.whl → 0.1.7__py3-none-any.whl

aletk/ResultMonad.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass
 from logging import Logger
-from typing import Any, Callable, NamedTuple
+from typing import Callable
 from functools import wraps
 
 
@@ -29,10 +29,16 @@ class Err:
         A message describing the error.
     code : int
         A code that can be used to handle different error cases.
+    error_type : str, optional
+        A string describing the type of error that occurred.
+    error_trace : str, optional
+        A string describing the trace of the error that occurred.
     """
 
     message: str
     code: int
+    error_type: str | None = None
+    error_trace: str | None = None
 
 
 type TResult[T] = Ok[T] | Err
@@ -141,15 +147,15 @@ def runwrap_or[T](result: TResult[T], default: T) -> T:
             return default
 
 
-def try_except_wrapper[T](logger: Logger) -> Callable[[Callable[..., T]], Callable[..., TResult[T]]]:
+def try_except_wrapper[T, **P](logger: Logger) -> Callable[[Callable[P, T]], Callable[P, TResult[T]]]:
     """
     Decorator that wraps a function in a try-except block, logging any errors that occur. The wrapped function will then always return a Ok[T] or Err as output.
 
     """
 
-    def decorator(func: Callable[..., T]) -> Callable[..., TResult[T]]:
+    def decorator(func: Callable[P, T]) -> Callable[P, TResult[T]]:
         @wraps(func)
-        def wrapper(*args: Any, **kwargs: Any) -> TResult[T]:
+        def wrapper(*args: P.args, **kwargs: P.kwargs) -> TResult[T]:
             try:
                 # logger.debug(f"Calling function '{func.__name__}' with args: {args} and kwargs: {kwargs}")
                 result = func(*args, **kwargs)
@@ -207,12 +213,12 @@ def runwrap_soft[T](result: TResult[T]) -> T | Err:
             return Err(message=msg, code=code)
 
 
-def funwrap[T](func: Callable[..., TResult[T]]) -> Callable[..., T | Err]:
+def funwrap[T, **P](func: Callable[P, TResult[T]]) -> Callable[P, T | Err]:
     """
     Wrap a function that returns a Result in a function that returns the data inside the Result.
     """
 
-    def wrapper(*args: Any, **kwargs: Any) -> T | Err:
+    def wrapper(*args: P.args, **kwargs: P.kwargs) -> T | Err:
         result = func(*args, **kwargs)
         match result:
             case Ok(out=data):
@@ -225,14 +231,14 @@ def funwrap[T](func: Callable[..., TResult[T]]) -> Callable[..., T | Err]:
     return wrapper
 
 
-def main_try_except_wrapper[T](logger: Logger) -> Callable[[Callable[..., T]], Callable[..., TResult[T]]]:
+def main_try_except_wrapper[T, **P](logger: Logger) -> Callable[[Callable[P, T]], Callable[P, TResult[T]]]:
     """
     Decorator that wraps a function in a try-except block, logging any errors that occur. The wrapped function will then always return a Ok[T] or Err as output.
     """
 
-    def decorator(func: Callable[..., T]) -> Callable[..., TResult[T]]:
+    def decorator(func: Callable[P, T]) -> Callable[P, TResult[T]]:
         @wraps(func)
-        def wrapper(*args: Any, **kwargs: Any) -> TResult[T]:
+        def wrapper(*args: P.args, **kwargs: P.kwargs) -> TResult[T]:
             try:
                 result = func(*args, **kwargs)
 
@@ -256,14 +262,14 @@ def main_try_except_wrapper[T](logger: Logger) -> Callable[[Callable[..., T]], C
     return decorator
 
 
-def light_error_handler[T](debug: bool = False) -> Callable[[Callable[..., T]], Callable[..., T]]:
+def light_error_handler[T, **P](debug: bool = False) -> Callable[[Callable[P, T]], Callable[P, T]]:
     """
     Decorator that wraps a function in a try-except block, and returns a better error message if an exception is raised.
     """
 
-    def decorator(func: Callable[..., T]) -> Callable[..., T]:
+    def decorator(func: Callable[P, T]) -> Callable[P, T]:
         @wraps(func)
-        def wrapper(*args: Any, **kwargs: Any) -> T:
+        def wrapper(*args: P.args, **kwargs: P.kwargs) -> T:
             try:
                 return func(*args, **kwargs)
 

aletk/_version.py

@@ -1,16 +1,34 @@
-# file generated by setuptools_scm
+# file generated by setuptools-scm
 # don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
 TYPE_CHECKING = False
 if TYPE_CHECKING:
-    from typing import Tuple, Union
+    from typing import Tuple
+    from typing import Union
+
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.1.7'
+__version_tuple__ = version_tuple = (0, 1, 7)
 
-__version__ = version = '0.1.5'
-__version_tuple__ = version_tuple = (0, 1, 5)
+__commit_id__ = commit_id = None

aletk/utils.py

@@ -14,8 +14,8 @@ def get_logger(name: str) -> logging.Logger:
     You can also pass the environment variables 'LOGGING_LEVEL' or 'LOG_LEVEL' to set the logging level. If none is passed, the default is 'INFO'.
     """
 
-    if name is None or not isinstance(name, str):
-        raise ValueError("Utils::GetLogger::Argument 'name' has to be a non None string.")
+    if not name:
+        raise ValueError("Utils::GetLogger::Argument 'name' has to be a non-empty string.")
 
     logging_level = getenv("LOGGING_LEVEL", "")
 
@@ -42,8 +42,8 @@ def remove_extra_whitespace(string: str) -> str:
 
     If the input is None or not a string, a ValueError is raised.
     """
-    if string is None or not isinstance(string, str):
-        raise ValueError("Utils::RemoveExtraWhiteSpace::Argument string has to be a (non None) string.")
+    if not string:
+        raise ValueError("Utils::RemoveExtraWhiteSpace::Argument string has to be a non-empty string.")
 
     cleaned_string = " ".join(string.split()).strip()
 
@@ -69,8 +69,8 @@ def fuzzy_match_score(
     If any of the inputs is None or not a string, a ValueError is raised.
     """
 
-    if str1 is None or str2 is None or not isinstance(str1, str) or not isinstance(str2, str):
-        raise ValueError(f"Utils::FuzzyMatchScore::Arguments have to be non None strings. Got:\n'{str1}'\n'{str2}'")
+    if not str1 or not str2:
+        raise ValueError(f"Utils::FuzzyMatchScore::Arguments have to be non-empty strings. Got:\n'{str1}'\n'{str2}'")
 
     score = fuzz.token_sort_ratio(str1, str2)
 
@@ -111,7 +111,7 @@ def pretty_format_frozenset(fs: FrozenSet[object]) -> str:
     """
     Pretty format a FrozenSet object, to be used in logging or printing.
     """
-    if fs is None or fs == frozenset():
+    if fs == frozenset():
         return ""
     return ", ".join(sorted([f"{item}" for item in fs]))
 
@@ -120,6 +120,6 @@ def dump_frozenset(fs: FrozenSet[object]) -> list[str]:
     """
     Dump a FrozenSet object to a list of strings.
     """
-    if fs is None or fs == frozenset():
+    if fs == frozenset():
         return []
     return sorted([f"{item}" for item in fs])

aletk-0.1.7.dist-info/METADATA

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: aletk
+Version: 0.1.7
+Summary: Collection of general purpose tools to work with Python
+Author-email: Luis Alejandro Bordo García <bgluiszz@gmail.com>
+License: MIT
+Project-URL: Repository, https://gitlab.com/alebg/aletk
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fuzzywuzzy
+Requires-Dist: python-Levenshtein
+Provides-Extra: dev
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: jupyter; extra == "dev"
+Dynamic: license-file
+
+# Ale's Python Toolkit
+
+This is a collection of tools that I use to make my life easier when working with Python. I hope you find them useful too!
+
+## Development Setup
+
+```bash
+git clone git@gitlab.com:alebg/aletk.git
+cd aletk
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+## Code Quality
+
+This project uses strict mypy type checking:
+
+```bash
+mypy src/aletk/
+```
+
+## Making a Release
+
+Versioning is handled automatically by `setuptools_scm` — the version is derived from git tags. The CI/CD pipeline (GitLab CI) triggers only on semantic version tags.
+
+1. Commit your changes and merge to `main`
+2. Tag the commit with a semver tag:
+   ```bash
+   git tag v0.X.Y
+   git push origin v0.X.Y
+   ```
+3. The CI pipeline will automatically: build the package, publish to PyPI, and create a GitLab release
+
+## Updating Client Projects
+
+After a new release is published to PyPI, update the dependency in client projects:
+
+```bash
+# If using poetry
+poetry update aletk
+
+# If using pip
+pip install --upgrade aletk
+```

aletk-0.1.7.dist-info/RECORD

@@ -0,0 +1,11 @@
+aletk/ResultMonad.py,sha256=YGsCAPQ7yCmZhrUj7rKFJj3SImN66iOFKxGm9qo5TVk,8079
+aletk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+aletk/_version.py,sha256=szvPIs2C82UunpzuvVg3MbF4QhzbBYTsVJ8DmPfq6_E,704
+aletk/adapters.py,sha256=9IYfIg1UYC0FbzWonMWdrUDgtVaV-q5NZKrRQubhBPw,659
+aletk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+aletk/utils.py,sha256=6d9jzephqICNKqlbbVAQqzrTgggbbU37QQRq-M2EWHY,3639
+aletk-0.1.7.dist-info/licenses/LICENSE,sha256=hZFMbARrXo4zfuo80-Sg3-FT5_ceiSDf0QpjgJoUdGc,1085
+aletk-0.1.7.dist-info/METADATA,sha256=fWFGPhLV9TyQfPzvOtNhuOJD5Yfv6fCyRKGjnNzUFLk,1896
+aletk-0.1.7.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+aletk-0.1.7.dist-info/top_level.txt,sha256=LYDb8QWbh4W4hIkF0TVg5ITKEsaj-pb_xcYQRGzLqUU,6
+aletk-0.1.7.dist-info/RECORD,,

{aletk-0.1.5.dist-info → aletk-0.1.7.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

aletk-0.1.5.dist-info/METADATA

@@ -1,27 +0,0 @@
-Metadata-Version: 2.1
-Name: aletk
-Version: 0.1.5
-Summary: Collection of general purpose tools to work with Python
-Author-email: Luis Alejandro Bordo García <bgluiszz@gmail.com>
-License: MIT
-Project-URL: Repository, https://gitlab.com/alebg/aletk
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.13
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Intended Audience :: Developers
-Classifier: Typing :: Typed
-Requires-Python: >=3.13
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: fuzzywuzzy
-Requires-Dist: python-Levenshtein
-Provides-Extra: dev
-Requires-Dist: mypy; extra == "dev"
-Requires-Dist: black; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: jupyter; extra == "dev"
-
-# Ale's Python Toolkit
-
-This is a collection of tools that I use to make my life easier when working with Python. I hope you find them useful too!

aletk-0.1.5.dist-info/RECORD

@@ -1,11 +0,0 @@
-aletk/ResultMonad.py,sha256=v6BSIl7AHDfSqHypfLb5mBAQXAJQhXDLudbN8n2pK2s,7813
-aletk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-aletk/_version.py,sha256=zBVX2byWL6NrFlwjvahpnvSqDsdtebZW0K9WM_cj20U,411
-aletk/adapters.py,sha256=9IYfIg1UYC0FbzWonMWdrUDgtVaV-q5NZKrRQubhBPw,659
-aletk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-aletk/utils.py,sha256=nvG-fRt4qIr-hBOFcpLN27mC0EEp877k3sf72O1rBE0,3800
-aletk-0.1.5.dist-info/LICENSE,sha256=hZFMbARrXo4zfuo80-Sg3-FT5_ceiSDf0QpjgJoUdGc,1085
-aletk-0.1.5.dist-info/METADATA,sha256=ZPHdVQ33SnLYUG98hiXaUPU_HCgrblO1HcbL8iScyDs,980
-aletk-0.1.5.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-aletk-0.1.5.dist-info/top_level.txt,sha256=LYDb8QWbh4W4hIkF0TVg5ITKEsaj-pb_xcYQRGzLqUU,6
-aletk-0.1.5.dist-info/RECORD,,