Skip to main content

RPC брокер сообщений

Project description

RabbitMQ Broker

Python versions Docker version Black code style Isort imports coverage

Не зависящий от фреймворков пакет для общения между микросервисами. Пакет предоставляет интерфейс для работы с брокером сообщений RabbitMQ и базовый класс цепочки обработчиков.

Пакет реализует паттерн цепочка обязанностей в синхронном и асинхронном виде.

Конфигурация

Переменная окружения Описание Значение по умолчанию
MICROSERVICE_SETTINGS Путь к модулю настроек проекта отно- "settings"
-сительно корня проекта. (Разделение
через точку: module1.module2.settings)

Использование

Цепочка обработчиков

Для использования цепочки обязанностей нужно импортировать базовый класс звена и унаследоваться от него. Необходимо установить параметр request_type. Обязательно должен быть переопределен абстрактный метод BaseChain.get_response_body(self, data):

from rmq_broker.chains.base import BaseChain


class LoginChain(BaseChain):
    request_type = "login"

    def get_response_body(self, data: dict) -> dict:
        ...

Также, можно унаследоваться от асинхронного варианта реализации:

from rmq_broker.async_chains.base import BaseChain


class LoginChain(BaseChain):
    request_type = "login"

    async def get_response_body(self, data: dict) -> dict:
        ...

Метод должен содержать логику обработки запроса и вызывать родительский метод BaseChain.form_response(data, body, code, message)

class LoginChain(BaseChain):
    request_type = "login"

    async def get_response_body(self, data):
        # Обработка запроса
        ...
        return super().form_response(data, response, status.HTTP_200_OK, "OK")

data: Изначальное сообщение. body: Обработанное тело запроса. code: HTTP код ответа. message: Сообщение к ответу.

Модели

Доработанные pydantic модели - могут быть использованы как для валидации, так и для генерации сообщения.

Валидация сообщения происходит так же, как и в обычной pydantic модели:

ProcessedMessage(**message_dict)

Для генерации сообщения необходимо создать объект модели, не передавая аргументы при инициализации, и вызвать метод generate. В аргументы метода generate можно передавать любой из ключей структуры сообщения, в том числе code, message, dst и src. Вложенная структура(header, status) формируется сама:

>>> ProcessedMessage().generate(dst="destination", code=201, request_type="creation")
>>> {"header": {"src": "", "dst": "destination"}, "request_type": "creation"...}

RPC брокер

Запуск прослушки и автоматического ответа на сообщения. В файле consumer.py:

from app.chains import your_chain
from rmq_broker.queues.rabbitmq import AsyncRabbitMessageQueue

async def broker_runner():
    async with AsyncRabbitMessageQueue() as provider:
        await provider.register_tasks("rpc_queue_name", your_chain.handle)
        await provider.consume()


asyncio.run(broker_runner())

Далее:

python3 consumer.py

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rabbitmq_broker-1.2.6.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rabbitmq_broker-1.2.6-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

Details for the file rabbitmq_broker-1.2.6.tar.gz.

File metadata

  • Download URL: rabbitmq_broker-1.2.6.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for rabbitmq_broker-1.2.6.tar.gz
Algorithm Hash digest
SHA256 a861126db0633b3a7db9871db91d93428ce83816251fabe2ee3785226fe5f023
MD5 08c2b9058e80ed1c7c54a97c0adcf4e4
BLAKE2b-256 dfa6f48bd9dc88a500fed86cb1ef434030d29ecd01bf82d94560dcd06c1317ca

See more details on using hashes here.

File details

Details for the file rabbitmq_broker-1.2.6-py3-none-any.whl.

File metadata

File hashes

Hashes for rabbitmq_broker-1.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 08fbe50d1f75ac32e5997e5bf4c574e65d5dd242eb8bcabbec86372670b215d3
MD5 29c9f47c7357b990ca57323978b07aef
BLAKE2b-256 0f4f322fd7f4a1141a2f96e8f3fd7089b618e34909cfa7944a28bd9ae8bdb5ac

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page