Skip to main content

Domain-Driven Design for Python

Project description

Coverage Status PyPI - License PyPI PyPI Mypy

pyddd

pyddd - это DDD (Domain-Driven Design) фреймворк для Python, предоставляющий встроенный менеджер зависимостей и шину сообщений. Он упрощает построение сложных доменных моделей и событийное программирование.

Возможности

  • Разделение доменов через Module
  • Использование команд и событий (DomainCommand, DomainEvent)
  • Корневые сущности (RootEntity)
  • Встроенный менеджер зависимостей
  • Событийно-ориентированная архитектура
  • Транспорт для работы с событиями
  • Базовый Unit Of Work и репозиторий

Локальная установка зависимостей

Нужно установить poetry и все зависимости. Запуск тестов через pytest

pip install uv
uv install --all-extras

pytest .

Быстрый старт

import abc
from pyddd.domain import RootEntity, DomainEvent, DomainCommand, DomainName
from pyddd.application import Module, Application, set_application

# Определение домена

__domain__ = DomainName('pet')

class PetCreated(DomainEvent, domain=__domain__):
    pet_id: str
    name: str

class Pet(RootEntity):
    name: str

    @classmethod
    def create(cls, name: str):
        pet = cls(name=name)
        pet.register_event(PetCreated(name=name, pet_id=pet.__reference__))
        return pet

# Репозитории и модуль
class IPetRepository(abc.ABC):
    @abc.abstractmethod
    def save(self, entity: RootEntity):
        ...

    @abc.abstractmethod
    def get(self, name: str) -> Pet:
        ...


class CreatePet(DomainCommand, domain=__domain__):
    name: str


pet_module = Module(__domain__)


@pet_module.register
def create_pet(cmd: CreatePet, repository: IPetRepository):
    pet = Pet.create(cmd.name)
    repository.save(pet)
    return pet.__reference__

# Запуск приложения
class InMemoryPetRepo(IPetRepository):
    def __init__(self):
        self.memory = {}

    def get(self, name: str) -> Pet:
        return self.memory.get(name)

    def save(self, entity: Pet):
        self.memory[entity.name] = entity


# Настройка приложения
app = Application()
app.run()
app.include(pet_module)
app.set_defaults('pet', repository=InMemoryPetRepo())
set_application(app)

# Работа с юзкейсами через команды и шину приложения
fluff_id = app.handle(CreatePet(name='Fluff'))
print(f'Создан питомец с ID: {fluff_id}')

Запуск интеграционных тестов:

# Поднимаем внешние сервисы
docker-compose up -d

# Запуск тестов
pytest tests

Лицензия

Этот проект распространяется под лицензией MIT. Подробности см. в файле LICENSE.

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

Мы приветствуем ваш вклад! Создавайте issue, присылайте pull request'ы и помогайте развивать pyddd.

Контакты

Если у вас есть вопросы или предложения, свяжитесь с нами через GitHub Issues.

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

pyddd-0.11.7.tar.gz (23.9 kB view details)

Uploaded Source

Built Distribution

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

pyddd-0.11.7-py3-none-any.whl (46.3 kB view details)

Uploaded Python 3

File details

Details for the file pyddd-0.11.7.tar.gz.

File metadata

  • Download URL: pyddd-0.11.7.tar.gz
  • Upload date:
  • Size: 23.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.8

File hashes

Hashes for pyddd-0.11.7.tar.gz
Algorithm Hash digest
SHA256 155865fac7d01d64b3a61d4fbb54dc22874ffb0e657605851893e34a02d9ffe0
MD5 381c7b2356b40c8f9ac755fc401e27d7
BLAKE2b-256 7aa2a2676bdfc9374790757bad2f3aecb137a37b36d7428824d41b5b9fc27560

See more details on using hashes here.

File details

Details for the file pyddd-0.11.7-py3-none-any.whl.

File metadata

  • Download URL: pyddd-0.11.7-py3-none-any.whl
  • Upload date:
  • Size: 46.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.8

File hashes

Hashes for pyddd-0.11.7-py3-none-any.whl
Algorithm Hash digest
SHA256 5d531ebd5c898ef78d874b9788b428f64b7027dee896e45fa6cd262c898f564d
MD5 8f4fc62a6569d124ded44575708038c3
BLAKE2b-256 ac2180631d9cd95fd2d11815e0689c8b2f4f42746c37ee26de6d5afaaceab11f

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