Skip to main content

InfinityBus — Async Event Bus

Test Coverage docstring Pyright License PyPI Version Supported Python

Strongly-typed, extensible async event bus — middleware pipeline + advanced templates.

📖 中文版

📑 Table of Contents

✨ Features

Category Capability
Type Safety Pydantic payload validation · pyright strict · zero # type: ignore in business code
Flexible Subscription Regex-based event name matching · wildcard handlers
Middleware Pipeline Onion model · before_publish / on_publish dual hooks · 5+ built-in middlewares
Advanced Templates handler simplified API · expect one-shot listener · request RPC call · pipe bidirectional channel · register batch registration
Production-grade architecture Graceful shutdown · backpressure control · timeout protection · error isolation · observability
Engineering Discipline 90%+ test coverage · 85%+ docstring coverage · pre-commit automated gating

Unlike similar projects: InfinityBus is extensible (middleware onion pipeline), rather than hardcoding all functionality in the core class. See Middleware System for details.

🔍 Comparison

Feature InfinityBus bubus pyee PyPubSub
Async Native ✅ asyncio ✅ asyncio / anyio ✅ asyncio / trio ❌ sync only
Type Safety ✅ pyright strict · zero type: ignore in business code ⚠️ pyright strict · ~30 suppressions in business code ✅ mypy + pyright ❌ no type annotations
Payload Validation ✅ Pydantic auto-validation ✅ Pydantic auto-validation ❌ none ❌ none (arbitrary objects)
Subscription Model Regex class name + wildcard * exact string match topic hierarchy (a.b.c)
Middleware Pipeline ✅ onion model dual hooks
Advanced Templates ✅ handler/expect/request/pipe/register ⚠️ bus.expect() only
Event Return Values ⚠️ via request template ✅ built-in event.event_result()
Event Forwarding ⚠️ EventForwardMiddleware ✅ built-in event.forward_to()
Dependency Count 1 core (pydantic) + 5 optional 6 (anyio, aiofiles...) 0 0
Graceful Shutdown ✅ drain queue + await active tasks ✅ wait_until_idle + queue close ⚠️ wait_for_complete + cancel N/A (sync)
Timeout Protection ✅ per-handler timeout ✅ event_result.timeout N/A
Error Isolation ✅ TaskErrorEvent unified reporting ✅ errors logged, bus uninterrupted N/A
Event Dispatch FIFO ✅ asyncio.Queue guarantees enqueue order ✅ global lock guarantee ✅ listeners called in registration order N/A
Handler Execution FIFO ❌ concurrent tasks ✅ global lock guarantee ✅ sequential emit N/A
Slow Handler Alert ✅ 15s timeout alert N/A
Recursion Guard ✅ middleware (configurable) ✅ built-in (non-configurable) N/A
Logging & Auditing ✅ JSONL + SQLite (middleware) ✅ built-in JSONL WAL logging ❌ no built-in ⚠️ debug tracing
Test Coverage ✅ 94% (325 tests) ✅ 83% (138 tests) ✅ 94% (43 tests) ✅ 86% (167 tests)
Python Version 3.12+ 3.11+ 3.12+ 3.7–3.14
Baseline Version v3.1.0 d7a67f0 v1.5.6 7c09342 v13.0.1 5157de2 v4.0.7 4ec2c47

Choose InfinityBus when: you need a middleware-native architecture — hot-reloadable onion pipeline with 8 built-in middlewares (logging, metrics, rate-limit, transform, block, recursion guard, forwarding); you run pyright strict across the entire codebase with literally zero # type: ignore in any production code; you want full production-grade features (backpressure, graceful shutdown, regex subscriptions, Pydantic payload validation) with a single core dependency.

Choose bubus when: you need built-in event return values and event forwarding; you need Python 3.11 support; you prefer the class-driven API style of bus.on(EventClass, fn).

Choose pyee when: you're familiar with the Node.js EventEmitter style; you need both asyncio and trio support; you prefer a minimal API (ee.on('event', fn)); the type system has been greatly enhanced since v13, passing both mypy and pyright.

Choose PyPubSub when: you don't use asyncio; you need very broad Python version compatibility (3.7–3.14); you prefer traditional topic hierarchy string matching.

Full commits: · InfinityBus d7a67f0 · bubus 7c09342 · pyee 5157de2 (no coverage in official CI; manually measured via pytest-cov) · PyPubSub 4ec2c47

📦 Installation

We recommend uv — a blazing-fast Python package manager, 10–100× faster than pip, with automatic venv management, dependency locking, and conflict resolution. No need for separate virtual environment tools.

pip

# Core (pub/sub and middleware pipeline only)
pip install infinity_bus

# Core + advanced templates (expect, request, pipe, SQLite logging, etc.)
pip install infinity_bus[templates]

uv (recommended)

# Core
uv add infinity_bus

# Core + advanced templates
uv add infinity_bus --extra templates

Note: Advanced templates (expect, request, pipe, SQLiteLoggingMiddleware) require the [templates] extra. Using them without installing the extra will raise an ImportError.

Or install from source:

git clone https://github.com/yinbailiang/event_bus.git
cd event_bus
uv sync --extra dev

🚀 Quick Start

Basic Pub/Sub

Using the handler simplified API requires: pip install infinity_bus[templates] Or with uv: uv add infinity_bus --extra templates

import asyncio
from pydantic import BaseModel
from event_bus import (
    EventBus, EventDeclaration,
    EventRegistry, EventHandlerRegistry,
)
from event_bus.templates import handler

# 1. Define payload
class MyPayload(BaseModel):
    message: str

# 2. Declare event
class MyEvent(EventDeclaration):
    name = "my.event"
    payload_type = MyPayload

# 3. Implement handler (simplified: function + decorator)
@handler(MyEvent)
async def my_handler(payload: MyPayload) -> None:
    print(f"Received: {payload.message}")

# 4. Wire up and run
async def main():
    reg = EventRegistry()
    reg.register(MyEvent)
    h_reg = EventHandlerRegistry()
    h_reg.register(my_handler())

    async with EventBus(reg, h_reg) as bus:
        await bus.proxy("cli").publish("my.event", {"message": "Hello, EventBus!"})
        await asyncio.sleep(1)  # wait for handler output

asyncio.run(main())

Request-Response Pattern

Using advanced templates like request / expect / pipe requires: pip install infinity_bus[templates] Or with uv: uv add infinity_bus --extra templates

import asyncio
from pydantic import BaseModel
from event_bus import (
    EventBus, EventDeclaration, EventHandler,
    EventRegistry, EventHandlerRegistry,
)
from event_bus.templates.request import (
    request, RequestProtocol, ResponseProtocol,
)

# 1. Define request/response payloads
class GetUserRequest(RequestProtocol):
    user_id: int

class GetUserResponse(ResponseProtocol):
    user_name: str
    email: str

# 2. Declare events
class GetUserRequestEvent(EventDeclaration):
    name = "user.get.request"
    payload_type = GetUserRequest

class GetUserResponseEvent(EventDeclaration):
    name = "user.get.response"
    payload_type = GetUserResponse

# 3. Implement server-side handler
class GetUserHandler(EventHandler):
    def __init__(self):
        super().__init__(subscriptions=["user.get.request"])

    async def handle(self, payload, bus_proxy, raw_event):
        if not isinstance(payload, GetUserRequest):
            return
        resp = GetUserResponse(
            session_id=payload.session_id,
            request_id=payload.request_id,
            success=True,
            user_name="Alice",
            email="alice@example.com",
        )
        await bus_proxy.publish("user.get.response", resp)

# 4. Wire up and run
async def main():
    reg = EventRegistry()
    reg.register(GetUserRequestEvent)
    reg.register(GetUserResponseEvent)
    h_reg = EventHandlerRegistry()
    h_reg.register(GetUserHandler())

    async with EventBus(reg, h_reg) as bus:
        proxy = bus.proxy("cli")
        resp = await request(
            bus_proxy=proxy,
            req_event="user.get.request",
            req_data={"user_id": 123},
            resp_event="user.get.response",
            timeout=10.0,
        )
        resp.raise_if_failed()
        print(f"User: {resp.user_name} ({resp.email})")

asyncio.run(main())

🧱 Architecture

Component Responsibility
Event Runtime event instance with name, payload, and handler chain tracking
EventDeclaration Event type metadata declaration (name + optional Pydantic payload model)
EventRegistry Central management of registered event declarations; validates on publish
EventHandler Handler base class; implement handle method for business logic
EventHandlerRegistry Manages handler instances; matches handler lists by event name
EventQueue Replaceable dispatch queue abstraction: EventQueue ABC + InMemoryEventQueue default (config owned by the queue)
EventBus Event dispatch hub: concurrency control, error reporting, lifecycle (queue injected via queue=)
Middleware Middleware base class, onion pipeline: before_publish / on_publish dual hooks
MiddlewareChain Chain of responsibility manager; wraps the publish flow in order
templates Advanced templates: handler simplified API, expect listener, request RPC, pipe channel, register batch registration
middlewares Built-in middlewares: logging (JSONL+SQLite), rate limiting, transform, block, recursion guard

📚 Documentation

Document Content
Core Overview Event / EventDeclaration / EventHandler / EventBus / Middleware core concepts
Middleware System Middleware base class, MiddlewareChain onion pipeline
Advanced Templates expect, request, pipe, register — the four major templates
Built-in Middlewares Logging, rate limiting, transform, block, recursion guard
Engineering Quality Type safety, test coverage, pre-commit gating, modularity standards

🧪 Testing

pip

# Clone and install test dependencies
git clone https://github.com/yinbailiang/event_bus.git
cd event_bus
pip install -e ".[test]"

# Run all tests
pytest --cov=src -v

# Run template tests only
pytest tests/templates/ -v

uv

# Clone and sync test dependencies
git clone https://github.com/yinbailiang/event_bus.git
cd event_bus
uv sync --extra test

# Run all tests
uv run pytest --cov=src -v

# Run template tests only
uv run pytest tests/templates/ -v

🧑‍💻 Development

The sole toolchain for developing this project is uv. The pre-commit gating invokes tests and code quality tools via uv run — please install uv first.

# 1. Clone and sync all dependencies (auto-creates venv)
git clone https://github.com/yinbailiang/event_bus.git
cd event_bus
uv sync --extra dev

# 2. Install pre-commit hooks
uv run pre-commit install

Development Loop

# lint + format
uv run ruff check src/ && uv run ruff format src/ --check

# type check
uv run pyright src/

# test + coverage
uv run pytest --cov=src -v

# run all gates manually
uv run pre-commit run --all-files
Tool Purpose
uv Blazing-fast Python package manager (replaces pip/venv)
ruff Lint + formatting
pyright Strict type checking
pytest + pytest-cov Testing + coverage
interrogate Docstring coverage
pre-commit Pre-commit automated gating

📖 See CONTRIBUTING.md for the full guide.

📄 License

MIT

Part of InfinitySystem

icon

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

infinity_bus-3.1.0.tar.gz (54.7 kB view details)

Uploaded Source

Built Distribution

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

infinity_bus-3.1.0-py3-none-any.whl (63.1 kB view details)

Uploaded Python 3

File details

Details for the file infinity_bus-3.1.0.tar.gz.

File metadata

  • Download URL: infinity_bus-3.1.0.tar.gz
  • Upload date:
  • Size: 54.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.10 {"installer":{"name":"uv","version":"0.12.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for infinity_bus-3.1.0.tar.gz
Algorithm Hash digest
SHA256 ae827b52fcd541e12cd635a8b4149b2f40d556f9a8e6a9fcb4a63e61c3992322
MD5 0dfe63c5cdbb6ca3acf1523048660723
BLAKE2b-256 8d1a5e5d463d58f029d258a506de95ee3f06018d6f208555bc6d757a77caa53f

See more details on using hashes here.

File details

Details for the file infinity_bus-3.1.0-py3-none-any.whl.

File metadata

  • Download URL: infinity_bus-3.1.0-py3-none-any.whl
  • Upload date:
  • Size: 63.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.10 {"installer":{"name":"uv","version":"0.12.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for infinity_bus-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 156e324605f9f04b4a6503baff9c4eb5fa0a0204dea12128f97b96e03c99895d
MD5 997ce0e67d241de601895278071b663a
BLAKE2b-256 a9c6fd3b224827343495c3ebd85430bbff7179b51fcfb350afb6fdc0345d3792

See more details on using hashes here.

Release history Release notifications | RSS feed

4.0.1

2 files

4.0.0

2 files

This release

3.1.0 This release

2 files

3.0.0

2 files

2.2.1

2 files

2.2.0

2 files

2.1.0

2 files

2.0.0

2 files

1.5.6

2 files

1.5.5

2 files

1.5.4

2 files

1.5.3

2 files

1.5.2

2 files

1.5.1

2 files

1.5.0

2 files

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

1.3.6

2 files

1.3.5

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page