topmark.registry.machine package index¶

Machine-output support for registry-related TopMark commands.

This package implements the machine-readable JSON/NDJSON output shapes for commands that expose TopMark's internal registries, such as:

topmark registry filetypes
topmark registry processors
topmark registry bindings

The design follows TopMark's general machine-readable output layering:

1) Schema types (schemas.py) TypedDict-based types describing the payload shapes emitted by registry commands.

2) Payload builders (payloads.py) Pure, deterministic builders that convert runtime registry objects into JSON-serializable Python structures (dicts/lists). These functions are Click-free, Console-free, and do not serialize JSON.

3) Shape builders (shapes.py) Wrap payloads into canonical TopMark machine envelopes: - JSON envelope: {"meta": ..., <payload_key>: ...} - NDJSON record: {"kind": ..., "meta": ..., <container_key>: ...}

4) Serializers (serializers.py) Convert shaped envelopes/records into JSON/NDJSON strings without printing. CLI commands are responsible for emitting serialized strings to the active console.

This package intentionally does not depend on Click and does not print to the console.

Notes

Typed schemas, payloads, envelopes and serializers are available from: - topmark.registry.machine.schemas - topmark.registry.machine.payloads - topmark.registry.machine.envelopes - topmark.registry.machine.envelopes Callers can be explicit about which layer they depend on.

Immediate children in this package¶

topmark.registry.machine.envelopes: Envelope/record builders for registry machine-readable output.
topmark.registry.machine.payloads: Payload builders for registry-related machine-readable output.
topmark.registry.machine.schemas: Registry machine-readable output schema types.
topmark.registry.machine.serializers: Pure serializers for registry machine-readable output.