Merge branch 'release/0.4.0'

Author: s3rius

.flake8

@@ -1,5 +1,5 @@
 [flake8]
-max-complexity = 6
+max-complexity = 7
 inline-quotes = double
 max-line-length = 88
 extend-ignore = E203
@@ -90,6 +90,8 @@ ignore =
   N802,
   ; Do not perform function calls in argument defaults.
   B008,
+  ; Found too many public instance attributes
+  WPS230,
 
   ; all init files
   __init__.py:

.github/workflows/test.yml

@@ -1,6 +1,6 @@
 name: Testing taskiq
 
-on: push
+on: [pull_request]
 
 jobs:
   lint:

docs/available-components/README.md

@@ -9,5 +9,6 @@ dir:
 In this section, you can find a list of officially supported plugins for the taskiq.
 
 - [Available brokers](./brokers.md)
+- [Available middlewares](./middlewares.md)
 - [Available result backends](./result-backends.md)
 - [Available schedule sources](./schedule-sources.md)

docs/available-components/middlewares.md

@@ -0,0 +1,69 @@
+---
+order: 5
+---
+
+# Available middlewares
+
+Middlewares allow you to execute code when specific event occurs.
+Taskiq has several default middlewares.
+
+### Simple retry middleware
+
+This middleware allows you to restart functions on errors. If exception was raised during task execution,
+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
+
+broker = ...
+
+broker.add_middlewares(SimpleRetryMiddleware(default_retry_count=3))
+```
+
+After that you can add a label to task that you want to restart on error.
+
+```python
+
+@broker.task(retry_on_error=True, max_retries=20)
+async def test():
+    raise Exception("AAAAA!")
+
+```
+
+`retry_on_error` enables retries for a task. `max_retries` is the maximum number of times,.
+
+### Prometheus middleware
+
+You can enable prometheus metrics for workers by adding PrometheusMiddleware.
+To do so, you need to install `prometheus_client` package or you can install metrics extras for taskiq.
+
+::: tabs
+
+
+@tab only prometheus
+
+```bash
+pip install "prometheus_client"
+```
+
+@tab taskiq with extras
+
+```bash
+pip install "taskiq[metrics]"
+```
+
+:::
+
+
+```python
+from taskiq import PrometheusMiddleware
+
+broker = ...
+
+broker.add_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.
+If you have other metrics, they'll be shown as well.

docs/examples/extending/broker.py

@@ -25,12 +25,12 @@ async def shutdown(self) -> None:
         return await super().shutdown()
 
     async def kick(self, message: BrokerMessage) -> None:
-        # Send a message.
+        # Send a message.message.
         pass
 
-    async def listen(self) -> AsyncGenerator[BrokerMessage, None]:
+    async def listen(self) -> AsyncGenerator[bytes, None]:
         while True:
             # Get new message.
-            new_message: BrokerMessage = ...  # type: ignore
+            new_message: bytes = ...  # type: ignore
             # Yield it!
             yield new_message

docs/extending-taskiq/README.md

@@ -13,7 +13,7 @@ All abstract classes can be found in `taskiq.abc` package.
 ## Contents:
 
 - [Brokers](./broker.md)
-- [Brokers](./broker.md)
+- [Middlewares](./middleware.md)
 - [Result backends](./resutl-backend.md)
 - [CLI](./cli.md)
 - [Schedule sources](./schedule-sources.md)

docs/extending-taskiq/broker.md

@@ -11,6 +11,20 @@ Here is a template for new brokers:
 
 @[code python](../examples/extending/broker.py)
 
+
+# About kick and listen
+
+The `kick` method takes a `BrokerMessage` as a parameter. The `BrokerMessage` class is a handy helper class for brokers. You can use information from the BrokerMessage to alter the delivery method.
+
+::: warning "cool warning!"
+
+As a broker developer, please send only raw bytes from the `message` field of a BrokerMessage if possible. Serializing it to the string may result in a problem if message bytes are not utf-8 compatible.
+
+:::
+
+
+The `listen` method should yield raw bytes that were sent over the network.
+
 ## Conventions
 
 For brokers, we have several conventions. It's good if your broker implements them.

docs/guide/cli.md

@@ -47,10 +47,29 @@ To disable this pass the `--no-parse` option to the taskiq.
 ### Hot reload
 
 This is annoying to restart workers every time you modify tasks. That's why taskiq supports hot-reload.
-To enable this option simply pass the `--reload` or `-r` option to taskiq CLI.
+Reload is unavailable by default. To enable this feature install taskiq with `reload` extra.
 
-Also this option supports `.gitignore` files. If you have such files in your directory. It won't reload worker
-if you ignore file's contents. To disable this functionality pass `--do-not-use-gitignore` option.
+::: tabs
+
+
+@tab pip
+
+```bash:no-line-numbers
+pip install "taskiq[reload]"
+```
+
+@tab poetry
+
+```bash:no-line-numbers
+poetry add taskiq -E reload
+```
+
+:::
+
+To enable this option simply pass the `--reload` or `-r` option to worker taskiq CLI.
+
+Also this option supports `.gitignore` files. If you have such file in your directory, it won't reload worker
+when you modify ignored files. To disable this functionality pass `--do-not-use-gitignore` option.
 
 ## Scheduler