Skip to content

ump_spec.models.gate

module ump-spec

Gate definitions (registry YAML) and gate results (spec §15, §25.4).

class

class ProposedThreshold(StrictModel)

Fields

NameTypeDefaultDescription
namestr
valueAny
proposedboolTrue
notestr | NoneNone

Source: packages/ump-spec/src/ump_spec/models/gate.py, line 37

class

class GateAppliesTo(StrictModel)

Fields

NameTypeDefaultDescription
kindslist[str]list()Artifact kinds; ’*’ for every kind.
transitionslist[str]list()Target states that trigger the gate (‘checks_running’, …); ’*’ all.
operationslist[str]list()Non-transition hooks: combine, export, …

Source: packages/ump-spec/src/ump_spec/models/gate.py, line 44

class

class GateDefinition(StrictModel)

Fields

NameTypeDefaultDescription
idstr
areastr
titlestr
rulestrPlain-words rule from the spec.
on_failOnFail
insteadstr''What happens instead, from the spec table.
applies_toGateAppliesToGateAppliesTo()
fallback_handlerstr | NoneNone
route_tostr | NoneNone
strict_overrideboolFalseCan strict mode turn the fallback into a stop?
strict_statusint | NoneNone
note_codestr | NoneNone
extra_note_codeslist[str]list()
thresholdslist[ProposedThreshold]list()
spec_refstr''
statusRegistryStatus'active'Registry status (spec §21): gates the reference implementation uses but the spec does not define are ‘provisional’ and MUST NOT be presented as normative.
implemented_in_pocboolTrue
policy_versionstr'gates/0.1.0'

Source: packages/ump-spec/src/ump_spec/models/gate.py, line 52

class

class GateResult(StrictModel)

Fields

NameTypeDefaultDescription
gate_idstr
outcomeGateOutcome
on_failOnFail | NoneNone
policy_versionstr'gates/0.1.0'
artifact_idstr | NoneNone
artifact_versionint | NoneNone
passedboolTrue
messagestr''
fallback_appliedstr | NoneNone
fallbackslist[FallbackEntry]list()
noteslist[Note]list()
route_tostr | NoneNone
evidencedict[str, Any]dict()
predicatestr''Python predicate name; ‘not_implemented_in_poc’ if none.
strictboolFalse
tsdatetime | NoneNone

Source: packages/ump-spec/src/ump_spec/models/gate.py, line 77

NameTypeValueDescription
OnFailLiteral['hard_stop', 'exclude_and_continue', 'fallback', 'route', 'warn', 'in...
GateOutcomeLiteral['pass', 'hard_stop', 'strict_stop', 'exclude_and_continue', 'fallback...Result outcomes. strict_stop is a fallback turned into a stop by strict mode.
RegistryStatusLiteral['provisional', 'active', 'deprecated']Status of a registry entry (spec §21, Registries).
APPLY_ORDERdict[str, int]{'hard_stop': 0, 'strict_stop': 0, 'exclude_and_continue': 1, 'fallback': 2, ...Fixed apply order (architecture doc): hard stops, exclusions, fallbacks, routes, warnings.
STOP_OUTCOMESfrozenset[str]frozenset({'hard_stop', 'strict_stop'})