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.6a1.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.6a1-py3-none-any.whl (46.4 kB view details)

Uploaded Python 3

File details

Details for the file pyddd-0.11.6a1.tar.gz.

File metadata

  • Download URL: pyddd-0.11.6a1.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.6a1.tar.gz
Algorithm Hash digest
SHA256 fa5781a0e84641116724805877c5295132e6d99b77a01b3ef9e8f6a0c06c5d86
MD5 ddf380d7614b3a5f52587e6f7a9d12a4
BLAKE2b-256 8ee9b602a4c13ff7033277e91174aad65c3304c9095061147eab5febcdea9548

See more details on using hashes here.

File details

Details for the file pyddd-0.11.6a1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for pyddd-0.11.6a1-py3-none-any.whl
Algorithm Hash digest
SHA256 ae11c9e4975ec0388c9b0c3f87de8d027052d22880b3b0b6f98d1132320cd340
MD5 363c666614ed8638355e218af0cd14ca
BLAKE2b-256 1b39921b59cee16f540af4c57af9f41aa3091dff0bd5c890ad0938fd5bb0159f

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