sindripy 1.0.0

Value Object and Object Mother patterns implementation for Python

Sindripy

Value Object and Object Mother patterns for Python and Domain Driven Design applications

Easy use and customizable implementation for Value Object and Object Mother patterns.

Getting Started  •  Value Object Pattern  •  Object Mother Pattern

Sindri replaces ad hoc primitives and fragile validators with a consistent Value Object and Aggregate toolkit you can adopt quickly. Spin up validated value objects, aggregates, and test data with a simple and a small, focused API. Sindripy provides a basic-high-customizable implementation to help you enforce domain invariants and improve code quality with minimal effort. Why use sindripy? Building your domain with Sindri lets you: ⏱️ Cut domain modeling and validation to seconds 🛡️ Declare immutable, validated value objects with clear error messages 🧩 Model aggregates with explicit invariants and composition 🧪 Generate realistic test data via the Object Mother pattern 🧰 Start from ready made primitives and identifiers or extend with your own 🔧 Plug in custom validators, decorators, and typed primitives

💧

Created with Instant Python
This project was generated using Instant Python, a fast, easy and reliable project generator for Python projects.

Navigation Guide

This section provides a high-level overview of the sindripy documentation so you can find quickly what you need.

For Users

• Installation
• First Steps
• Value Object Pattern
• Object Mother Pattern

For Developers

• Contributing Guide
• Security Policy

Need help?

• Join a discussion 💬 on GitHub Discussions
• Raise an issue on GitHub

Fast Kickstart

The latest version of sindripy can be installed from PyPI:

pip install sindripy

Here is a simple example of how to use sindri to create a value object and generate test data using an object mother.

from sindripy.value_objects import Integer, String

age = Integer(30)
name = String("John Doe")

print(f"Name: {name.value}, Age: {age.value}")

from sindripy.mothers import IntegerPrimitivesMother, StringPrimitivesMother

random_age = IntegerPrimitivesMother.any()
random_name = StringPrimitivesMother.any()

Migrating to v1.0.0

This release includes a breaking change to the validator API used by value objects:

• Validators no longer accept the incoming value as a parameter. Instead, the value is assigned to self._value before validators run, and validator methods have the signature def _validate_xxx(self) -> None:.
• This simplifies validator signatures and reduces repetition across validation methods.

Why this is a breaking change

• Existing validator methods that still declare a value parameter will receive the wrong signature and raise a TypeError when the framework calls them. Custom code that expects the old parameter (for example, custom exception constructors or external utilities) may also need small updates.

How to migrate

• Follow the step-by-step migration guide which shows the exact edits and examples: Validator Signature Migration Guide.
• In short: find all methods decorated with @validate, remove the value parameter, replace uses of value with self._value, and update any error messages or custom exceptions that referenced the old parameter.

A quick checklist:

• Update @validate methods to def _... (self) -> None
• Replace value references with self._value
• Update error messages and custom exception usages
• Run your tests

ℹ️

Learn More
To learn more about advanced usage of value objects, including validation, custom value objects, complex objects like aggregates, visit the Value Object Pattern and Object Mother Pattern sections of the documentation.