Workflow maintenance and improvements 🐍

Author: RobertoPrevato

.github/workflows/build.yml

@@ -15,10 +15,10 @@ env:
 
 jobs:
   build:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.7, 3.8, 3.9, "3.10"]
+        python-version: [3.8, 3.9, "3.10", "3.11"]
 
     steps:
       - uses: actions/checkout@v1
@@ -27,7 +27,7 @@ jobs:
           submodules: false
 
       - name: Use Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -48,7 +48,15 @@ jobs:
 
       - name: Run tests
         run: |
-          flake8 && pytest --doctest-modules --junitxml=junit/pytest-results-${{ matrix.python-version }}.xml --cov=$PROJECT_NAME --cov-report=xml tests/
+          pytest --doctest-modules --junitxml=junit/pytest-results-${{ matrix.python-version }}.xml --cov=$PROJECT_NAME --cov-report=xml tests/
+
+      - name: Run linters
+        run: |
+          echo "Running linters"
+
+          flake8 .
+          isort --check-only . 2>&1
+          black --check . 2>&1
 
       - name: Upload pytest test results
         uses: actions/upload-artifact@master
@@ -63,28 +71,28 @@ jobs:
 
       - name: Install distribution dependencies
         run: pip install --upgrade twine setuptools wheel
-        if: matrix.python-version == 3.8 || matrix.python-version == 3.9
+        if: matrix.python-version == 3.10
 
       - name: Create distribution package
         run: python setup.py sdist bdist_wheel
-        if: matrix.python-version == 3.8 || matrix.python-version == 3.9
+        if: matrix.python-version == 3.10
 
       - name: Upload distribution package
         uses: actions/upload-artifact@master
         with:
           name: dist-package-${{ matrix.python-version }}
           path: dist
-        if: matrix.python-version == 3.8 || matrix.python-version == 3.9
+        if: matrix.python-version == 3.10
 
   publish:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     needs: build
     if: github.event_name == 'release'
     steps:
       - name: Download a distribution artifact
         uses: actions/download-artifact@v2
         with:
-          name: dist-package-3.9
+          name: dist-package-3.10
           path: dist
       - name: Publish distribution 📦 to Test PyPI
         uses: pypa/gh-action-pypi-publish@master

.isort.cfg

@@ -0,0 +1,3 @@
+[settings]
+profile = black
+multi_line_output = 3

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.6] - 2022-11-05 :snake:
+- Workflow maintenance
+- Applies `black`, `flake8`, `isort`
+
 ## [1.1.5] - 2022-03-14 :tulip:
 - Adds `py.typed` file
 - Adds `ConflictException`

essentials/caching.py

@@ -1,19 +1,15 @@
 import functools
 import time
 from collections import OrderedDict
-from typing import (Any, Callable, Generic, Iterable, Iterator, Tuple, TypeVar)
-
+from typing import Any, Callable, Generic, Iterable, Iterator, Tuple, TypeVar
 
 T = TypeVar("T")
 
 
 class Cache(Generic[T]):
     """In-memory LRU cache implementation."""
 
-    def __init__(
-        self,
-        max_size: int = 500
-    ):
+    def __init__(self, max_size: int = 500):
         self._bag: OrderedDict[Any, Any] = OrderedDict()
         self._max_size = -1
         self.max_size = max_size
@@ -87,10 +83,7 @@ def clear(self) -> None:
 class CachedItem(Generic[T]):
     """Container for cached items with update timestamp."""
 
-    __slots__ = (
-        '_value',
-        '_time'
-    )
+    __slots__ = ("_value", "_time")
 
     def __init__(self, value: T):
         self._value = value
@@ -114,9 +107,7 @@ class ExpiringCache(Cache[T]):
     """A cache whose items can expire by a given function."""
 
     def __init__(
-        self,
-        expiration_policy: Callable[[CachedItem[T]], bool],
-        max_size: int = 500
+        self, expiration_policy: Callable[[CachedItem[T]], bool], max_size: int = 500
     ):
         super().__init__(max_size)
         assert expiration_policy is not None
@@ -157,17 +148,12 @@ def __setitem__(self, key, value: T) -> None:
             self._check_size()
 
     @classmethod
-    def with_max_age(
-        cls,
-        max_age: float,
-        max_size: int = 500
-    ):
+    def with_max_age(cls, max_age: float, max_size: int = 500):
         """
         Returns an instance of ExpiringCache whose items are invalidated
         when they were set more than a given number of seconds ago.
         """
-        return cls(lambda item: time.time() - item.time > max_age,
-                   max_size)
+        return cls(lambda item: time.time() - item.time > max_age, max_size)
 
     def __contains__(self, key) -> bool:
         if key not in self._bag:
@@ -188,10 +174,7 @@ def __iter__(self) -> Iterator[Tuple[Any, T]]:
                 yield (key, item.value)
 
 
-def lazy(
-    max_seconds: int = 1,
-    cache=None
-):
+def lazy(max_seconds: int = 1, cache=None):
     """
     Wraps a function so that it is called up to once
     every max_seconds, by input arguments.
@@ -217,6 +200,7 @@ def wrapper(*args):
                 value = fn(*args)
                 cache[args] = (value, now)
             return value
+
         return wrapper
 
     return lazy_decorator

essentials/decorators/__init__.py

@@ -1,12 +1,12 @@
 from functools import wraps
 from inspect import iscoroutinefunction
 from typing import Type
-from .retry import retry, CatchException, OnException  # noqa
+
+from .retry import CatchException, OnException, retry  # noqa
 
 
 def exception_handle(
-    exception_type: Type[Exception],
-    catch_exceptions_types: CatchException = None
+    exception_type: Type[Exception], catch_exceptions_types: CatchException = None
 ):
     """
     Wraps a given function to catch all exceptions that might happen during

essentials/decorators/retry.py

@@ -1,9 +1,8 @@
-import time
 import asyncio
+import time
 from functools import wraps
 from inspect import iscoroutinefunction
-from typing import Optional, Tuple, Type, Union, Callable
-
+from typing import Callable, Optional, Tuple, Type, Union
 
 CatchException = Union[Tuple[Type[Exception]], Type[Exception], None]
 OnException = Optional[Callable[[Type[Exception], int], None]]

essentials/meta.py

@@ -1,35 +1,57 @@
 import warnings
 from functools import wraps
+from inspect import iscoroutinefunction
 
 
 class DeprecatedException(Exception):
     def __init__(self, param_name):
-        super().__init__("Member `%s` is deprecated" % param_name)
+        super().__init__("The function `%s` is deprecated" % param_name)
 
 
 def deprecated(message=None, raise_exception=False):
     """
     This is a decorator which can be used to mark functions
     as deprecated. It will result in a warning being emitted
-    when the function is used."""
+    when the function is used, or optionally an exception raised.
+    """
     if message:
         message = " " + message
     else:
         message = ""
 
-    def _deprecated(f):
-        @wraps(f)
-        def wrapped(*args, **kwargs):
-            warnings.warn_explicit(
-                f"`{f.__name__}` is deprecated.{message}",
-                category=DeprecationWarning,
-                filename=f.__code__.co_filename,
-                lineno=f.__code__.co_firstlineno + 1,
-            )
+    def _deprecated(fn):
+        if iscoroutinefunction(fn):
+
+            @wraps(fn)
+            async def async_wrapper(*args, **kwargs):
+                with warnings.catch_warnings():
+                    warnings.simplefilter("always")
+                    warnings.warn_explicit(
+                        f"`{fn.__name__}` is deprecated.{message}",
+                        category=DeprecationWarning,
+                        filename=fn.__code__.co_filename,
+                        lineno=fn.__code__.co_firstlineno + 1,
+                    )
+                if raise_exception:
+                    raise DeprecatedException(fn.__name__)
+                return await fn(*args, **kwargs)
+
+            return async_wrapper
+
+        @wraps(fn)
+        def wrapper(*args, **kwargs):
+            with warnings.catch_warnings():
+                warnings.simplefilter("always")
+                warnings.warn_explicit(
+                    f"`{fn.__name__}` is deprecated.{message}",
+                    category=DeprecationWarning,
+                    filename=fn.__code__.co_filename,
+                    lineno=fn.__code__.co_firstlineno + 1,
+                )
             if raise_exception:
-                raise DeprecatedException(f.__name__)
-            return f(*args, **kwargs)
+                raise DeprecatedException(fn.__name__)
+            return fn(*args, **kwargs)
 
-        return wrapped
+        return wrapper
 
     return _deprecated

requirements.txt

@@ -3,3 +3,5 @@ pytest-cov
 pytest-asyncio
 flake8
 dataclasses==0.7;python_version<'3.7'
+isort
+black

setup.py

@@ -8,9 +8,8 @@ def readme():
 
 setup(
     name="essentials",
-    version="1.1.5",
-    description="General purpose classes and functions, "
-    "reusable in any kind of Python application",
+    version="1.1.6",
+    description="General purpose classes and functions",
     long_description=readme(),
     long_description_content_type="text/markdown",
     classifiers=[
@@ -21,6 +20,8 @@ def readme():
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
         "Operating System :: OS Independent",
     ],
     url="https://github.com/Neoteroi/essentials",