API Reference¶
Welcome to the ForgingBlocks API reference! This section is
generated automatically from the library docstrings and gives you
the full public API surface — every class, function, and module
that makes up the toolkit.
Use it as a companion to the hand-written Guide (which walks
you through concepts and workflows) and Reference (which covers
architectural intent and design rationale). Think of this page as
your map: pick a layer below, dive into the module you need, and
explore the signatures, docstrings, and source code directly.
Application¶
Errors¶
Ports¶
Inbound¶
Outbound¶
- Cache Port
- Command Sender Port
- Event Bus Port
- Event Publisher Port
- Event Store Port
- File System Port
- Http Client Port
- Logger Port
- Message Bus Port
- Notifier Port
- Query Fetcher Port
- Specification Repository Port
- Transaction Manager Port
- Unit Of Work Port
Repository Port¶
Domain¶
Aggregate Root¶
Errors¶
- Draft Entity Is Not Hashable Error
- Entity Id Deletion Error
- Entity Id Modification Error
- Entity Id None Error
Messages¶
Message¶
Permissions¶
Specification¶
Logical Operators¶
Validators¶
Foundation¶
Autoeq¶
Autofreeze¶
Autohash¶
Errors¶
- Architecture Error
- Cant Modify Immutable Attribute Error
- Configuration Error
- Non Hashable Value Error
- None Not Allowed Error
- Not Callable Predicate Error
- Result Access Error
Base¶
Builtin¶
Combined¶
- Combined Errors
- Combined Rule Violation Errors
- Combined Validation Errors
- Field Errors
- Validation Field Errors
Core¶
Rule Violations¶
Validation¶
Meta¶
Ports¶
Result¶
Rules¶
Infrastructure¶
Caching¶
Errors¶
Event Buses¶
Event Stores¶
File System¶
Http Client¶
Logging¶
Message Bus¶
- In Memory Message Bus
- Message Bus Command Sender
- Message Bus Event Publisher
- Message Bus Query Fetcher