Metadata-Version: 2.4
Name: protocols-dispatcher
Version: 0.2.0
Summary: Гибкая асинхронная библиотека для диспетчеризации бинарных протоколов
Project-URL: PyPI, https://pypi.org/project/protocols_dispatcher/
Project-URL: Homepage, https://github.com/Enigma0960/protocols_dispatcher
Project-URL: Source, https://github.com/Enigma0960/protocols_dispatcher
Project-URL: Issues, https://github.com/Enigma0960/protocols_dispatcher/issues
Author-email: Supryadkin Igor <igorsupr@gamail.com>
License: MIT License
        
        Copyright (c) 2025 Igor Supradkin
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.9
Requires-Dist: typing-extensions; python_version < '3.11'
Provides-Extra: all
Requires-Dist: aioserial; extra == 'all'
Requires-Dist: pytest-asyncio>=1.0.0; (python_version >= '3.8') and extra == 'all'
Requires-Dist: pytest-cov>=6.2.1; extra == 'all'
Requires-Dist: pytest-mock>=3.14.1; extra == 'all'
Requires-Dist: pytest>=8.4.1; extra == 'all'
Provides-Extra: dev
Requires-Dist: pytest-asyncio>=1.0.0; (python_version >= '3.8') and extra == 'dev'
Requires-Dist: pytest-cov>=6.2.1; extra == 'dev'
Requires-Dist: pytest-mock>=3.14.1; extra == 'dev'
Requires-Dist: pytest>=8.4.1; extra == 'dev'
Provides-Extra: serial
Requires-Dist: aioserial; extra == 'serial'
Description-Content-Type: text/markdown

# protocols_dispatcher

> **Гибкая асинхронная библиотека для диспетчеризации бинарных протоколов**

`protocols_dispatcher` упрощает жизнь, когда нужно:

* **принять поток байтов** → превратить в «пакеты» (словарь Python);
* **выбрать обработчик** по произвольным фильтрам;
* **отправить ответ** тем же транспортом или другим;
* легко **добавлять свои протоколы и транспорты** (TCP, serial, файлы — любые).

Библиотека уже используется в производственном проекте для работы с наборами микроконтроллеров и бинарных команд.

[![PyPI version](https://img.shields.io/pypi/v/protocols_dispatcher?color=brightgreen)](https://pypi.org/project/protocols_dispatcher/)
![License](https://img.shields.io/github/license/Enigma0960/protocols_dispatcher)

---

## 📦 Установка

```bash
# минимальный набор
pip install protocols_dispatcher

# + поддержка работы по последовательному порту через aioserial
pip install protocols_dispatcher[serial]
```

| extra    | что подтягивает                                    |   |
| -------- | -------------------------------------------------- | - |
| `serial` | [`aioserial`](https://pypi.org/project/aioserial/) |   |

---

## 🚀 Быстрый старт

```python
import asyncio
from protocols_dispatcher import Dispatcher, AbstractProtocol, AbstractTransport
from protocols_dispatcher.transports.serial import SerialTransport

class EchoProtocol(AbstractProtocol):
    async def matches(self, raw: bytes) -> bool:
        # «Принимаем» любой кадр
        return True

    async def deserialize(self, data: bytes):
        # Каждый пришедший фрейм — отдельный «пакет»
        return [dict(raw=data)]

    async def serialize(self, packet: dict):
        # Просто оборачиваем в префикс
        return b"ACK:" + packet["raw"]

async def main():
    proto     = EchoProtocol()
    transport = SerialTransport(port="/dev/ttyUSB0", baudrate=115200)

    dsp = Dispatcher(proto, transport)

    @dsp.handler()              # без фильтров — ловим всё
    async def handle(pkt):
        print("RX:", pkt["raw"].hex())
        # сформируем и отправим ответ
        return dict(raw=pkt["raw"])

    # транспорт запускается отдельной корутиной
    await transport.run()

asyncio.run(main())
```

---

## 🔍 Основные возможности

* **Асинхронность на всех уровнях** — от транспорта до callback-ов.
* **Паттерн «декоратор‑фильтр»**

  ```python
  @dispatcher.handler(MyFilter())
  def on_custom(pkt): ...
  ```

  либо через `router.handler(filter=..., protocol=...)`, если протоколов несколько.
* **ProtocolRouter** — маршрутизация, когда по одному каналу идёт несколько независимых бинарных протоколов.
* **Тестирование из коробки** — примерные `DummyProtocol` / `DummyTransport` и фикстуры для `pytest`.
* **Extras‑dependencies** — лишние зависимости ставятся только при необходимости.

---

## 🗂️ Структура проекта

```
📦 protocols_dispatcher
 ├─ __init__.py
 ├─ dispatcher.py          # ядро: AbstractProtocol / AbstractTransport / Dispatcher / ProtocolRouter
 ├─ transports/
 │   ├─ __init__.py
 │   └─ serial.py          # SerialTransport (опция [serial])
 └─ tests/
     ├─ helpers.py         # заглушки для юнит‑тестов
     ├─ conftest.py
     └─ ...
```

---

## 🧪 Запуск тестов

```bash
git clone https://github.com/your-github/protocols_dispatcher.git
cd protocols_dispatcher
pip install -e .[dev]      # dev‑зависимости: pytest, pytest-asyncio, ruff, mypy ...
pytest -q
```

---

## 🤝 Контрибьюция

1. Сделайте форк, создайте ветку `feature/whatever`.
2. `pre-commit install` — сразу проверит code‑style.
3. Напишите тесты к новому коду.
4. Отправьте PR и опишите, зачем change полезен.

---

## 📄 Лицензия

Проект распространяется под лицензией MIT — см. файл [LICENSE](LICENSE).

---

### 🙌 Авторы и благодарности

* **Игорь Супрядкин** — архитектура и основная реализация
* **ChatGPT** — помощь в проработке решений и написаний документации

> Если библиотека помогла вам — поставьте ⭐️ в GitHub и расскажите о ней коллегам!
