API References
Use this section as the authoritative catalogue of the Abstract Backend APIs. Each page documents the contracts you target in your own code and the hooks providers must implement.
Core interfacesโ
MessageQueueBackendprotocol โ Async contract every provider implements.EventConsumer& helpers โ Standard consumption loop and lifecycle management.load_backend()loader โ Entry-point discovery rules and configuration.- Shared types โ Type aliases exported from
abe/types.pyfor payloads and handler signatures.
Provider utilitiesโ
MemoryBackendโ Development fallback shipped with the library and its limitations.LoggingConfighelpers โ Optional utilities for providers that want consistent logging behaviour.
Every reference page includes:
- Function and method signatures with type hints.
- Expected behaviour and error handling.
- Configuration/environment variables recognised by the component.
- Examples for both application developers and provider authors.
If you are building a new provider, read all core interface pages first; if you are consuming the library, focus on the loader and consumer docs.