Feature/42 ruff (#51)

* Feature/42 ruff

* Feature/42 ruff

* ignore D213 instead

* fix D212 warning

* remove all from pyi

* fix requirements

* update dependencies in pipeline

* update typing-extensions for pipeline

* update all libs; remove types-dataclasses

* update pipeline dependencies

* fix pre-commit

* auto fix linting problems

* remove unused shape.py file

* fix docstring

* check for format in pipeline as well

* fix typo

* add ruff options

* reformat file; disable D413

* bump library version

---------

Co-authored-by: mityuha <mit.makaroff@gmail.com>

Author: legatusAlex

.github/workflows/build.yaml

@@ -13,8 +13,6 @@ jobs:
     strategy:
       matrix:
         include:
-          - { python-version: "3.6", runs-on: "ubuntu-20.04" }
-          - { python-version: "3.7" }
           - { python-version: "3.8" }
           - { python-version: "3.9" }
           - { python-version: "3.10" }

.pre-commit-config.yaml

@@ -1,29 +1,20 @@
 repos:
   - repo: local
     hooks:
-      - id: pydocstringformatter
-        name: pydocstringformatter
-        description: "Formats docstrings to follow PEP8 and PEP257."
-        language: system
-        entry: poetry run pydocstringformatter
-        args:
-          [
-            "-w",
-            "--max-line-length=120",
-          ]
-        types: [python]
-      - id: isort
-        name: isort
+      - id: ruff
+        name: ruff
         stages: [commit]
-        language: system
-        entry: poetry run isort
-        types: [python]
-      - id: black
-        name: black
+        language: python
+        types_or: [python, pyi]
+        entry: poetry run ruff check
+        exclude: examples
+      - id: ruff-format
+        name: ruff-format
         stages: [commit]
-        language: system
-        entry: poetry run black
-        types: [python]
+        language: python
+        types_or: [python, pyi]
+        entry: poetry run ruff format
+        exclude: examples
       - id: mypy
         name: mypy
         stages: [commit]
@@ -32,13 +23,6 @@ repos:
         types: [python]
         require_serial: true
         exclude: examples
-      - id: pylint
-        name: pylint
-        stages: [commit]
-        language: system
-        entry: poetry run pylint
-        types: [python]
-        exclude: examples
       - id: sort-all
         name: sort-all
         stages: [commit]

README.md

@@ -32,7 +32,7 @@ It is [nearly] production-ready, and gives you the following:
 
 ## Requirements
 
-Python 3.6+
+Python 3.8+
 
 ## Installation
 

bakery/__init__.py

@@ -1,23 +1,23 @@
 """Bakery house."""
 
-from typing import Optional
+from __future__ import annotations
 
 from .stuff import BakeryLogger, DefaultLogger
 
+logger: BakeryLogger | None = DefaultLogger()
 
-logger: Optional[BakeryLogger] = DefaultLogger()
-
+# ruff: noqa: F403, E402
 from .bakery import *
 from .baking import *
 from .cake import *
 from .piece_of_cake import *
 from .stuff import *
 
-
+# ruff: noqa: F405, PLE0604
 __all__ = [
-    *bakery.__all__,  # type: ignore # pylint: disable=undefined-variable
-    *baking.__all__,  # type: ignore # pylint: disable=undefined-variable
-    *cake.__all__,  # type: ignore # pylint: disable=undefined-variable
-    *piece_of_cake.__all__,  # type: ignore # pylint: disable=undefined-variable
-    *stuff.__all__,  # type: ignore # pylint: disable=undefined-variable
+    *bakery.__all__,  # type: ignore[name-defined]
+    *baking.__all__,  # type: ignore[name-defined]
+    *cake.__all__,  # type: ignore[name-defined]
+    *piece_of_cake.__all__,  # type: ignore[name-defined]
+    *stuff.__all__,  # type: ignore[name-defined]
 ]

bakery/bakery.py

@@ -3,30 +3,31 @@
 Opened around the clock.
 """
 
+from __future__ import annotations
+
 __all__ = ["Bakery"]
 
-from typing import Any, Dict, List, Optional, Type, TypeVar, Union
+from typing import Any, TypeVar
 
 from .baking import bake, unbake
 from .cake import Cake
-from .stuff import _LOGGER as logger
+from .stuff import _LOGGER as logger  # noqa: N811
 from .stuff import Cakeable, is_cake
 
-
-T = TypeVar('T', bound='Bakery')
+T = TypeVar("T", bound="Bakery")
 
 
 class Bakery:
     """Your bakery."""
 
     __bakery_visitors__: int
-    __bakery_items__: Dict[str, Cakeable[Any]]
+    __bakery_items__: dict[str, Cakeable[Any]]
 
     async def __aenter__(self: T) -> T:
         """Open up your real bakery."""
         return await type(self).aopen()
 
-    async def __aexit__(self, *_args: Any) -> None:
+    async def __aexit__(self, *_args: object) -> None:
         """Close up bakery.
 
         Unbake all cakes.
@@ -42,13 +43,14 @@ def __getattribute__(self, attr: str) -> Any:
 
     def __init_subclass__(cls, **kwargs: Any) -> None:
         """Initialize bakery subclass."""
-        bakery_items: Dict[str, Cakeable[Any]] = {}
+        bakery_items: dict[str, Cakeable[Any]] = {}
         # Do filter __dict__, because iterating
         # over __annotations__ forces to annotate
         # every cake
-        for cake_name, cake in cls.__dict__.items():
+        for cake_name, _cake in cls.__dict__.items():
             if cake_name.startswith("__") and cake_name.endswith("__"):
                 continue
+            cake = _cake
             if not is_cake(cake):
                 # wrap value into cake
                 cake = Cake(cake)
@@ -60,9 +62,8 @@ def __init_subclass__(cls, **kwargs: Any) -> None:
         cls.__bakery_visitors__ = 0
 
     @classmethod
-    async def aopen(cls: Type[T]) -> T:
+    async def aopen(cls: type[T]) -> T:
         """Open bakery."""
-
         if cls.__bakery_visitors__:
             cls.__bakery_visitors__ += 1
             # no concurrency yet (like aopen/aopen/aopen)
@@ -71,31 +72,25 @@ async def aopen(cls: Type[T]) -> T:
 
         cls.__bakery_visitors__ += 1
 
-        exception: Optional[Union[Exception, BaseException]] = None
-
         # let's bake all your cakes
-        cake: Cakeable[Any]
-        for cake in cls.__bakery_items__.values():
-            try:
+        cake: Cakeable | None = None
+        try:
+            for cake in cls.__bakery_items__.values():
                 await bake(cake)
-            except (Exception, BaseException) as exc:  # pylint: disable=broad-except
-                exception = exc
-                logger.error(f'{cake} cannot be baked: {exc}')
-                break
-
-        if exception:
+        except (Exception, BaseException) as exc:
+            logger.error(f"{cake} cannot be baked: {exc}")
             await cls.aclose()
-            raise exception
+            raise exc from None
 
         logger.debug(f"Bakery '{cls}' is opened. Welcome!")
         return cls()
 
     @classmethod
     async def aclose(
         cls,
-        exc_type: Optional[type] = None,
-        exc_value: Optional[Exception] = None,
-        traceback: Optional[Any] = None,
+        exc_type: type | None = None,
+        exc_value: Exception | None = None,
+        traceback: Any | None = None,
     ) -> None:
         """Close bakery."""
         cls.__bakery_visitors__ -= 1
@@ -104,22 +99,22 @@ async def aclose(
             logger.debug(f"Bakery '{cls}' is working till the last visitor!")
             return
 
-        exceptions: List[Union[Exception, BaseException]] = []
+        exceptions: list[Exception | BaseException] = []
         item: Cakeable[Any]
         for item in reversed(  # it's important to unbake in reverse order
             # dict views are reversible since 3.8
             # https://docs.python.org/3/library/stdtypes.html#dictionary-view-objects
-            list(cls.__bakery_items__.values())
+            list(cls.__bakery_items__.values()),
         ):
             try:
                 await unbake(item, exc_type, exc_value, traceback)
-            except (Exception, BaseException) as exc:  # pylint: disable=broad-except
+            except (Exception, BaseException) as exc:  # noqa: PERF203
                 exceptions.append(exc)
 
         logger.debug(f"Bakery '{cls}' is closed.")
 
         if exceptions:
-            # For now raise the first exception occured.
+            # For now raise the first exception occurred.
             # Use trio MultiError (inception) on demand
             # https://github.com/python-trio/trio/blob/v0.21.0/trio/_core/_multierror.py#L154
             # or use exception groups (python 3.11)

bakery/bakery.pyi

@@ -1,17 +1,17 @@
 # isort: skip_file
-from typing import Any, Dict, Type, TypeVar
+from typing import Any, TypeVar
 
 from .stuff import Cakeable
 
-T = TypeVar('T', bound='Bakery')
+T = TypeVar("T", bound=Bakery)  # noqa: PYI001
 
 class Bakery:
     __bakery_visitors__: int
-    __bakery_items__: Dict[str, Cakeable[Any]]
+    __bakery_items__: dict[str, Cakeable[Any]]
     async def __aenter__(self: T) -> T: ...
-    async def __aexit__(self, *_args: Any) -> None: ...
+    async def __aexit__(self, *_args: object) -> None: ...
     @classmethod
-    async def aopen(cls: Type[T]) -> T: ...
+    async def aopen(cls: type[T]) -> T: ...
     @classmethod
     async def aclose(
         cls,