basic_usage.py

"""Basic usage: register callables with metadata and retrieve them."""

from micro_reg import DuplicateRegistrationError, Registry

reg = Registry("hardware_tools")


@reg.register(name="read_voltage", type="sensor", unit="V")
def read_voltage() -> float:
    """Return the current voltage reading."""
    return 5.0


@reg.register(name="read_temperature", type="sensor", unit="C")
def read_temperature() -> float:
    """Return the current temperature reading."""
    return 22.5


@reg.register(name="toggle_led", type="actuator", pin=13)
def toggle_led() -> bool:
    """Toggle the onboard LED and return its new state."""
    return True


# Retrieve and call each registered function.
for entry_name in ("read_voltage", "read_temperature", "toggle_led"):
    func, meta = reg.get(entry_name)
    print(f"{entry_name}: result={func()!r}  metadata={meta}")

print()

# Attempting to register the same name twice raises DuplicateRegistrationError.
try:
    @reg.register(name="read_voltage")
    def duplicate() -> float:
        return 0.0
except DuplicateRegistrationError as e:
    print(f"Caught expected error — name already taken: {e.name!r}")