topmark.toml.keys

topmark / toml / keys

Canonical TOML section and key names for TopMark documents.

This module defines the canonical user-facing string constants used when reading, writing, and documenting TopMark TOML documents, including layered configuration tables, discovery metadata, and persisted writer options.

Centralizing TOML keys

• Avoids hard-coded strings scattered across parsing and serialization code.
• Ensures consistency between defaults, parsing, documentation, and dumps.
• Makes schema changes explicit and reviewable.

Design notes

• Keys defined here represent the external TOML document names and must match user-facing TOML exactly.
• Renaming or removing a section/key name is a breaking change.
• CLI keys and TOML keys are intentionally kept separate.

Toml

TOML section names and keys used by TopMark documents.

This file is the canonical registry for external TOML section and key names.

The constants in this namespace define TopMark's external TOML section and key names as they appear in topmark.toml and in [tool.topmark] inside pyproject.toml.

The ordering of constants mirrors topmark-example.toml to make it easier to audit schema changes and keep defaults, documentation, and parsing aligned.

Notes

• Values must match user-facing TOML keys exactly.
• Renaming or removing a section/key name is a breaking change.
• CLI keys are defined separately in topmark.cli.keys.