Skip to content

topmark.core.keys

topmark / core / keys

Shared canonical argument keys.

This module defines the stable destination keys used across TopMark to represent parsed arguments and options (from the CLI and API). These keys are the internal contract between argument parsing and downstream consumers (configuration merging, policy evaluation, and runtime execution).

Notes
  • Values are Python identifiers (snake_case), not CLI spellings.
  • The CLI spellings (e.g. --include-file-types) live in topmark.cli.keys.
  • Keep this module behavior-free; it should remain a pure namespace for constants so it can be imported from anywhere without causing cycles.

ArgKey

Bases: str, Enum

Canonical argument keys used by the TopMark CLI / API.

Notes
  • Each constant is a canonical destination key (dest) used by Click.
  • These keys are the internal contract between CLI parsing and downstream consumers (config application and runtime execution).
  • Values are Python identifiers (snake_case), not CLI spellings.