Skip to content

topmark.config.resolution.synthetic

topmark / config / resolution / synthetic

Synthetic configuration provenance markers.

This module defines lightweight typed provenance objects used when TopMark resolves configuration originating from bundled, generated, or otherwise non-filesystem TOML sources. These markers allow resolution and merge layers to distinguish synthetic config origins from real filesystem Path values without relying on fragile string conventions.

Synthetic provenance values are preserved throughout config resolution and are rendered only at presentation or serialization boundaries.

DEFAULT_CONFIG_SOURCE module-attribute

DEFAULT_CONFIG_SOURCE = SyntheticConfigSource(
    label="<defaults>"
)

Synthetic provenance marker for the built-in base config layer.

BUILTIN_DEFAULTS_TOML_SOURCE module-attribute

BUILTIN_DEFAULTS_TOML_SOURCE = SyntheticConfigSource(
    label="<built-in topmark defaults>"
)

Synthetic provenance marker for the canonical built-in default TOML table.

BUNDLED_TEMPLATE_TOML_SOURCE module-attribute

BUNDLED_TEMPLATE_TOML_SOURCE = SyntheticConfigSource(
    label="<bundled topmark-template.toml>"
)

Synthetic provenance marker for the bundled starter TOML template.

SyntheticConfigSource dataclass

SyntheticConfigSource(*, label)

Typed provenance marker for non-filesystem configuration sources.

TopMark sometimes builds configuration from bundled or generated TOML inputs, such as the built-in defaults table or the bundled starter template. These sources are not real files and must not be normalized with Path.resolve().

Use this value object anywhere config provenance needs to distinguish a real filesystem Path from a synthetic source identifier. Rendering layers may convert the marker to label, but resolution and merge code should preserve the typed value.

Attributes:

Name Type Description
label str

Stable user-facing label used when rendering this synthetic source in diagnostics, config dumps, or machine-readable output.