Merge branch 'release/0.4.2'

Author: s3rius

.flake8

@@ -6,6 +6,8 @@ extend-ignore = E203
 docstring_style=sphinx
 
 ignore =
+  ; Found `no cover` comments overuse
+  WPS403
   ; Found a line that starts with a dot
   WPS348,
   ; Found overly complex type annotation

docs/available-components/middlewares.md

@@ -15,11 +15,11 @@ the task would be resent with same parameters.
 To enable this middleware, add it to the list of middlewares for a broker.
 
 ```python
-from taskiq import SimpleRetryMiddleware
+from taskiq import ZeroMQBroker, SimpleRetryMiddleware
 
-broker = ...
-
-broker.add_middlewares(SimpleRetryMiddleware(default_retry_count=3))
+broker = ZeroMQBroker().with_middlewares(
+    SimpleRetryMiddleware(default_retry_count=3),
+)
 ```
 
 After that you can add a label to task that you want to restart on error.
@@ -58,11 +58,11 @@ pip install "taskiq[metrics]"
 
 
 ```python
-from taskiq import PrometheusMiddleware
-
-broker = ...
+from taskiq import ZeroMQBroker, PrometheusMiddleware
 
-broker.add_middlewares(PrometheusMiddleware(server_addr="0.0.0.0", server_port=9000))
+broker = ZeroMQBroker().with_middlewares(
+    PrometheusMiddleware(server_addr="0.0.0.0", server_port=9000),
+)
 ```
 
 After that, metrics will be available at port 9000. Of course, this parameter can be configured.

docs/available-components/result-backends.md

@@ -7,7 +7,6 @@ order: 3
 Result backends are used to store execution results.
 This includes:
 
-- Captured logs;
 - return value;
 - Execution time in seconds.
 

docs/examples/extending/broker.py

@@ -1,18 +1,13 @@
-from typing import AsyncGenerator, Callable, Optional, TypeVar
+from typing import AsyncGenerator
 
-from taskiq import AsyncBroker, AsyncResultBackend, BrokerMessage
-
-_T = TypeVar("_T")
+from taskiq import AsyncBroker, BrokerMessage
 
 
 class MyBroker(AsyncBroker):
-    def __init__(
-        self,
-        result_backend: "Optional[AsyncResultBackend[_T]]" = None,
-        task_id_generator: Optional[Callable[[], str]] = None,
-    ) -> None:
-        # Please call this super and allow people to use their result_backends.
-        super().__init__(result_backend, task_id_generator)
+    def __init__(self) -> None:
+        # Please call this super method to set default values to
+        # many different fields.
+        super().__init__()
 
     async def startup(self) -> None:
         # Here you can do some startup magic.

docs/examples/extending/result_backend.py

@@ -18,27 +18,45 @@ async def set_result(
         task_id: str,
         result: TaskiqResult[_ReturnType],
     ) -> None:
-        # Here you must set result somewhere.
-        pass
+        """
+        Set result in your backend.
+
+        :param task_id: current task id.
+        :param result: result of execution.
+        """
 
     async def get_result(
         self,
         task_id: str,
         with_logs: bool = False,
     ) -> TaskiqResult[_ReturnType]:
-        # Here you must retrieve result by id.
+        """
+        Here you must retrieve result by id.
+
+        Logs is a part of a result.
+        Here we have a parameter whether you want to
+        fetch result with logs or not, because logs
+        can have a lot of info and sometimes it's critical
+        to get only needed information.
 
-        # Logs is a part of a result.
-        # Here we have a parameter whether you want to
-        # fetch result with logs or not, because logs
-        # can have a lot of info and sometimes it's critical
-        # to get only needed information.
-        pass
+        :param task_id: id of a task.
+        :param with_logs: whether to fetch logs.
+        :return: result.
+        """
+        return ...  # type: ignore
 
     async def is_result_ready(
         self,
         task_id: str,
     ) -> bool:
-        # This function checks if result of a task exists,
-        # without actual fetching the result.
-        pass
+        """
+        Check if result exists.
+
+        This function must check whether result
+        is available in your resul backend
+        without fetching the result.
+
+        :param task_id: id of a task.
+        :return: True if result is ready.
+        """
+        return ...  # type: ignore

docs/examples/introduction/full_example.py

@@ -6,8 +6,7 @@
 
 broker = AioPikaBroker(
     "amqp://guest:guest@localhost:5672",
-    result_backend=RedisAsyncResultBackend("redis://localhost"),
-)
+).with_result_backend(RedisAsyncResultBackend("redis://localhost"))
 
 
 @broker.task

docs/examples/state/events_example.py

@@ -14,10 +14,7 @@
 
 broker = AioPikaBroker(
     "amqp://localhost",
-    result_backend=RedisAsyncResultBackend(
-        "redis://localhost/0",
-    ),
-)
+).with_result_backend(RedisAsyncResultBackend("redis://localhost"))
 
 
 @broker.on_event(TaskiqEvents.WORKER_STARTUP)

docs/guide/getting-started.md

@@ -171,8 +171,7 @@ from taskiq_redis import RedisAsyncResultBackend
 
 broker = AioPikaBroker(
     "amqp://guest:guest@localhost:5672",
-    result_backend=RedisAsyncResultBackend("redis://localhost"),
-)
+).with_result_backend(RedisAsyncResultBackend("redis://localhost"))
 ```
 
 Now we need to start redis.