cadrumo.application.modelo.workspace_models module

Strict, frontend-neutral records for the read-only Modelo Workspace V1.

class ModeloWorkspaceAdmissionKind(*values)[source]

Bases: StrEnum

The two explicitly different authority paths a workspace may request.

STATIC_INSPECTION
GRADED_SNAPSHOT
class ModeloWorkspaceCapabilityName(*values)[source]

Bases: StrEnum

The complete read-only capability denominator for Workspace V1.

SCHEMA_INSPECTION
CALCULATION_MATERIALIZATION
VERIFICATION_READINESS
FILING_DRAFT_READINESS
class ModeloWorkspaceCapabilityDisposition(*values)[source]

Bases: StrEnum

A producer-declared capability posture; Workspace never infers this.

AVAILABLE
NOT_APPLICABLE
REFUSED
UNMEASURED
class ModeloWorkspaceFacetName(*values)[source]

Bases: StrEnum

Bounded facets exposed by one Workspace projection.

WORK_REVIEW
SCHEMA
MATERIALIZATION
PROVENANCE
class ModeloWorkspaceLocaleDisposition(*values)[source]

Bases: StrEnum

The one canonical locale-resolution outcome for a displayed record.

EXACT
SPANISH_FALLBACK
SUPPRESSED
class ModeloWorkspaceRevisionAssertionSource(*values)[source]

Bases: StrEnum

The fixed coordinate that supplied one independently checked assertion.

REQUESTED
STORED
class ModeloWorkspaceRevisionAssertionDisposition(*values)[source]

Bases: StrEnum

The closed outcome of one independently checked revision assertion.

NOT_PRESENT
MATCHED
MISMATCHED
class ModeloWorkspaceRefusalCode(*values)[source]

Bases: StrEnum

Stable domain-boundary refusals for an otherwise supported Workspace V1.

TARGET_NOT_FOUND

The natural (modelo, filing_year, period) coordinate the target names resolves cleanly, but no WorkUnit exists there yet – the WORK selector’s own ABSENT state (resolution.work_unit is None). Distinct from CALCULATION_UNAVAILABLE, whose work unit DOES exist and merely carries no calculation revision: an absent work unit cannot be “calculated”; it must be created first, a different operator remedy the two codes must not share.

VISIBLE_TARGET_AMBIGUOUS
BUCKET_ASSERTION_MISMATCH
STATIC_INSPECTION_UNAVAILABLE
AUTHORITY_GRADE_UNAVAILABLE
CALCULATION_UNAVAILABLE

The WORK axis resolved an EXISTING work unit for this target, but it carries no calculation revision yet (current_calculation_revision_id is None), so a GRADED_SNAPSHOT admission cannot produce the required materialization/provenance facets. Distinct from AUTHORITY_GRADE_UNAVAILABLE (a REGISTRY-axis fact): folding a missing calculation into the grade code would send an operator to the wrong remedy – the registry, not “calculate this work unit first”. Also distinct from TARGET_NOT_FOUND (no work unit exists at all): this code’s own reconsideration text (“calculate this work unit”) presumes a work unit the operator can act on. Never raised for a STATIC_INSPECTION admission, which has no calculation dependency.

SCHEMA_UNAVAILABLE
LOCALE_UNAVAILABLE
CONSISTENCY_UNAVAILABLE
WORKSPACE_CHANGED
class ModeloWorkspaceSchemaClassification(*values)[source]

Bases: StrEnum

The exhaustive generated denominator classification for a registry field.

PROJECTED
DERIVED
BACKEND_ONLY
class ModeloWorkspaceStaticInspectionAdmissionV1(**data)[source]

Bases: _WorkspaceModel

Request static registry inspection without admitting a runtime snapshot.

Parameters:

data (Any)

kind: Literal[ModeloWorkspaceAdmissionKind.STATIC_INSPECTION]
class ModeloWorkspaceGradedSnapshotAdmissionV1(**data)[source]

Bases: _WorkspaceModel

Request a law-selected snapshot that satisfies one declared authority grade.

Parameters:

data (Any)

kind: Literal[ModeloWorkspaceAdmissionKind.GRADED_SNAPSHOT]
required_grade: RegistryAuthorityGrade
class ModeloWorkspaceVisibleFilingTargetV1(**data)[source]

Bases: _WorkspaceModel

Serialized visible-target arm that retains the canonical target operand.

Parameters:

data (Any)

kind: Literal['visible_filing']
target: ModeloVisibleFilingTarget
class ModeloWorkspaceExactWorkUnitTargetV1(**data)[source]

Bases: _WorkspaceModel

Serialized exact-work-unit arm that retains the canonical target operand.

Parameters:

data (Any)

kind: Literal['exact_work_unit']
target: ModeloExactWorkUnitTarget
class ModeloWorkspaceRefreshTargetV1(**data)[source]

Bases: _WorkspaceModel

The exact workspace read one settled Modelo operation invalidates.

Names the resolved work-unit coordinates rather than wrapping a request selector, so a frontend re-reads the affected unit without interpreting a settled receipt it should not have to understand.

The coordinates are spelled as closed typed fields rather than reusing ModeloWorkspaceTargetV1: that union embeds a plain dataclass, whose generated schema carries no closed-object marker, and a target published through the operations public-schema registry must be closed end to end.

Parameters:

data (Any)

contract_version: Literal[1]
work_unit_id: WorkUnitId
class ModeloWorkspaceRevisionAssertionV1(**data)[source]

Bases: _WorkspaceModel

One source-fixed optional assertion and its independently supplied outcome.

Parameters:

data (Any)

source: ModeloWorkspaceRevisionAssertionSource
disposition: ModeloWorkspaceRevisionAssertionDisposition
asserted_revision_id: RevisionId | None
class ModeloWorkspaceResolvedTargetV1(**data)[source]

Bases: _WorkspaceModel

Resolved natural coordinates and optional persisted work state, never a selector.

Parameters:

data (Any)

bucket_id: BucketId
modelo: ModeloCode
filing_year: FilingYear
period: Period
law_selected_revision_id: RevisionId
review_status: RevisionReviewStatus
requested_revision_assertion: ModeloWorkspaceRevisionAssertionV1
stored_revision_assertion: ModeloWorkspaceRevisionAssertionV1
work_unit_id: WorkUnitId | None
work_state: WorkUnitState | None
class ModeloWorkspaceLocaleSummaryV1(**data)[source]

Bases: _WorkspaceModel

Canonical locale coordinates, independent from semantic workspace identity.

Parameters:

data (Any)

requested_language: OutputLanguage
resolved_language: OutputLanguage
disposition: ModeloWorkspaceLocaleDisposition
catalogue_digest: ContentDigest
class ModeloWorkspaceLocalizedTextV1(**data)[source]

Bases: _WorkspaceModel

One localized display string with its canonical resolution coordinates.

Parameters:

data (Any)

kind: Literal['localized']
locale_key: _BoundedLocaleKey
value: _BoundedLocalizedText
locale: ModeloWorkspaceLocaleSummaryV1
class ModeloWorkspaceTechnicalLabelV1(**data)[source]

Bases: _WorkspaceModel

A row’s canonical registry identifier, presented honestly as never-translated.

Formula, binding, relation, and parameter identities have no locale-catalogue entry anywhere in the tree and are never surfaced to a taxpayer as operator-facing prose – they are registry names, always shown as themselves in every diagnostic and review surface that already displays them. Wrapping a bare identifier in ModeloWorkspaceLocalizedTextV1 would misrepresent it as a translation that happened; this type says plainly that none did.

Parameters:

data (Any)

kind: Literal['technical']
identifier: _BoundedCode
class ModeloWorkspaceSchemaIdentityV1(**data)[source]

Bases: _WorkspaceModel

The selected public registry schema identity and its current field denominator.

Parameters:

data (Any)

schema_id: _BoundedCode
schema_fingerprint: ContentDigest
field_manifest_digest: ContentDigest
class ModeloWorkspaceCasillaReferenceV1(**data)[source]

Bases: _WorkspaceModel

A canonical casilla identity exposed in one schema reference.

Parameters:

data (Any)

kind: Literal['casilla']
casilla_id: CasillaId
class ModeloWorkspaceBindingReferenceV1(**data)[source]

Bases: _WorkspaceModel

A canonical binding identity exposed in one schema reference.

Parameters:

data (Any)

kind: Literal['binding']
binding_id: BindingId
class ModeloWorkspaceFormulaReferenceV1(**data)[source]

Bases: _WorkspaceModel

A canonical formula identity exposed in one schema reference.

Parameters:

data (Any)

kind: Literal['formula']
formula_id: FormulaId
class ModeloWorkspaceRelationReferenceV1(**data)[source]

Bases: _WorkspaceModel

A canonical relation identity exposed in one schema reference.

Parameters:

data (Any)

kind: Literal['relation']
relation_id: RelationId
class ModeloWorkspaceParameterReferenceV1(**data)[source]

Bases: _WorkspaceModel

A canonical parameter identity exposed in one schema reference.

Parameters:

data (Any)

kind: Literal['parameter']
parameter_id: ParameterId
class ModeloWorkspaceExportFieldReferenceV1(**data)[source]

Bases: _WorkspaceModel

A canonical export-field identity exposed in one schema reference.

Parameters:

data (Any)

kind: Literal['export_field']
export_field_id: ExportFieldId
class ModeloWorkspaceContinuityReferenceV1(**data)[source]

Bases: _WorkspaceModel

A canonical cross-revision casilla continuity identity.

Parameters:

data (Any)

kind: Literal['continuity']
continuidad_id: ContinuidadId
class ModeloWorkspaceFormulaCasillaOperandReferenceV1(**data)[source]

Bases: _WorkspaceModel

A formula operand that addresses a canonical casilla.

Parameters:

data (Any)

kind: Literal['formula_operand_casilla']
formula_id: FormulaId
casilla_id: CasillaId
class ModeloWorkspaceFormulaBindingOperandReferenceV1(**data)[source]

Bases: _WorkspaceModel

A formula operand that reads a canonical decimal binding.

Parameters:

data (Any)

kind: Literal['formula_operand_binding']
formula_id: FormulaId
binding_id: BindingId
class ModeloWorkspaceFormulaDateBindingOperandReferenceV1(**data)[source]

Bases: _WorkspaceModel

A formula operand that reads a canonical date binding.

Parameters:

data (Any)

kind: Literal['formula_operand_date_binding']
formula_id: FormulaId
binding_id: BindingId
class ModeloWorkspaceFormulaParameterOperandReferenceV1(**data)[source]

Bases: _WorkspaceModel

A formula operand that addresses a canonical parameter.

Parameters:

data (Any)

kind: Literal['formula_operand_parameter']
formula_id: FormulaId
parameter_id: ParameterId
class ModeloWorkspaceFormulaRelationOperandReferenceV1(**data)[source]

Bases: _WorkspaceModel

A formula operand that addresses a canonical relation.

Parameters:

data (Any)

kind: Literal['formula_operand_relation']
formula_id: FormulaId
relation_id: RelationId
class ModeloWorkspaceFormulaLiteralOperandReferenceV1(**data)[source]

Bases: _WorkspaceModel

A formula literal arm without exporting its formula compiler node.

Parameters:

data (Any)

kind: Literal['formula_operand_literal']
formula_id: FormulaId
class ModeloWorkspaceFormulaDispatchOperandReferenceV1(**data)[source]

Bases: _WorkspaceModel

A dispatch-table formula operand retaining its parameter identities.

Parameters:

data (Any)

kind: Literal['formula_operand_dispatch']
formula_id: FormulaId
parameter_ids: Annotated[tuple[ParameterId, ...], Field(min_length=1, max_length=_MAX_SCHEMA_RELATIONSHIPS)]
class ModeloWorkspaceRelationSourceEndpointReferenceV1(**data)[source]

Bases: _WorkspaceModel

The canonical source-casilla endpoint of one registry relation.

Parameters:

data (Any)

kind: Literal['relation_source_casilla']
relation_id: RelationId
casilla_id: CasillaId
class ModeloWorkspaceRelationTargetEndpointReferenceV1(**data)[source]

Bases: _WorkspaceModel

The canonical target-binding endpoint of one registry relation.

Parameters:

data (Any)

kind: Literal['relation_target_binding']
relation_id: RelationId
binding_id: BindingId
class ModeloWorkspaceApplicabilityReferenceV1(**data)[source]

Bases: _WorkspaceModel

A canonical registry applicability-rule identity.

Parameters:

data (Any)

kind: Literal['applicability']
applicability_rule_id: ApplicabilityRuleId
class ModeloWorkspaceConstraintReferenceV1(**data)[source]

Bases: _WorkspaceModel

The casilla identity to which its canonical registry constraints apply.

Parameters:

data (Any)

kind: Literal['constraint']
casilla_id: CasillaId
class ModeloWorkspaceExportExposureReferenceV1(**data)[source]

Bases: _WorkspaceModel

One canonical casilla-to-export-field exposure without layout internals.

Parameters:

data (Any)

kind: Literal['export_exposure']
casilla_id: CasillaId
export_field_id: ExportFieldId
class ModeloWorkspaceSchemaRecordV1(**data)[source]

Bases: _WorkspaceModel

Explanatory schema row using canonical registry identities, never grammar objects.

Parameters:

data (Any)

reference: ModeloWorkspaceSchemaReferenceV1
record_family: Annotated[tuple[_BoundedText, ...], Field(max_length=_MAX_SCHEMA_RECORD_FAMILY_DEPTH)]
section_path: Annotated[tuple[_BoundedText, ...], Field(max_length=_MAX_SCHEMA_RECORD_FAMILY_DEPTH)]

The modelo’s OWN declared section path for this record, when it has one.

Distinct from record_family, which labels which registry family the record belongs to. Only casillas carry a declared section: a binding, formula, relation or parameter is not placed anywhere in the modelo’s printed structure, so an empty tuple there means “this kind of record has no section”, not “the section was dropped”.

data_type: _BoundedCode
label: ModeloWorkspaceRecordLabelV1
classification: ModeloWorkspaceSchemaClassification
family_disposition: RegistrySchemaFamilyDisposition
legal_refs: _BoundedRefList[LegalRefId] | None

None means this admission’s producer never carries legal grounding for this reference kind; an empty tuple means it does, and none is declared. The two must never collapse into one “nothing here” shape – a bare empty tuple over legal grounding reads as “the law requires nothing,” while None honestly reads as “not measured”.

source_refs: _BoundedRefList[SourceRefId]
continuity: Annotated[tuple[ModeloWorkspaceContinuityReferenceV1, ...], Field(max_length=_MAX_SCHEMA_RELATIONSHIPS)]
applicability: Annotated[tuple[ModeloWorkspaceApplicabilityReferenceV1, ...], Field(max_length=_MAX_SCHEMA_RELATIONSHIPS)]
constraints: Annotated[tuple[ModeloWorkspaceConstraintReferenceV1, ...], Field(max_length=_MAX_SCHEMA_RELATIONSHIPS)] | None

None means this admission’s producer never carries constraint declarations for this reference kind (the same distinction as legal_refs): a static inspection has no CasillaDefinition to check, so it cannot honestly claim “no constraints declared” the way an empty tuple would.

formula_operands: Annotated[tuple[ModeloWorkspaceFormulaOperandReferenceV1, ...], Field(max_length=_MAX_SCHEMA_RELATIONSHIPS)]
relation_endpoints: Annotated[tuple[ModeloWorkspaceRelationEndpointReferenceV1, ...], Field(max_length=_MAX_SCHEMA_RELATIONSHIPS)]
export_exposure: Annotated[tuple[ModeloWorkspaceExportExposureReferenceV1, ...], Field(max_length=_MAX_SCHEMA_RELATIONSHIPS)]
class ModeloWorkspaceFamilyDispositionV1(**data)[source]

Bases: _WorkspaceModel

One named registry schema-family disposition with its safe evidence references.

Parameters:

data (Any)

family: _BoundedCode
disposition: RegistrySchemaFamilyDisposition
legal_refs: _BoundedRefList[LegalRefId]
source_refs: _BoundedRefList[SourceRefId]
class ModeloWorkspaceProvenanceRecordV1(**data)[source]

Bases: _WorkspaceModel

One selected canonical resolver lineage row, optionally for a workspace subject.

subject is None when the underlying calculation_source (CalculationSourceRef) carries no linked casilla identity – source_casilla_ids empty, which is the common case today since most resolver call sites do not yet populate it. This is the same None-vs-()-shaped distinction drawn by a schema record’s optional grounding fields: None means “this producer never carries this data for this row”, never a silently dropped record. An unlinked ref still produces exactly one record (never zero), so an audit reader sees every contributing source and can distinguish “unattributed” from “record never surfaced”.

Parameters:

data (Any)

subject: ModeloWorkspaceSchemaReferenceV1 | None
calculation_source: CalculationSourceRef
class ModeloWorkspaceScalarMaterializationV1(**data)[source]

Bases: _WorkspaceModel

One scalar materialization keyed by the canonical casilla identity.

Parameters:

data (Any)

casilla_id: CasillaId
value: ModeloScalar
class ModeloWorkspaceRepeatedRowMaterializationV1(**data)[source]

Bases: _WorkspaceModel

One positive-index repeated binding row without flattening it into a casilla id.

Parameters:

data (Any)

binding_id: BindingId
row_index: Annotated[int, Field(ge=1)]
values: Annotated[tuple[ModeloWorkspaceScalarMaterializationV1, ...], Field(min_length=1, max_length=_MAX_REPEATED_ROW_VALUES)]
class ModeloWorkspaceScalarMaterializationRecordV1(**data)[source]

Bases: _WorkspaceModel

One scalar materialization arm with no nullable sibling payload.

Parameters:

data (Any)

kind: Literal['scalar']
scalar: ModeloWorkspaceScalarMaterializationV1
class ModeloWorkspaceRepeatedRowMaterializationRecordV1(**data)[source]

Bases: _WorkspaceModel

One repeated-row materialization arm with no nullable sibling payload.

Parameters:

data (Any)

kind: Literal['repeated_row']
repeated_row: ModeloWorkspaceRepeatedRowMaterializationV1
class ModeloWorkspaceTextFactValueV1(**data)[source]

Bases: _WorkspaceModel

A bounded safe text fact, never a raw exception or localized command.

Parameters:

data (Any)

kind: Literal['text']
value: Annotated[str, Field(min_length=1, max_length=_MAX_SAFE_FACT_TEXT_LENGTH)]
class ModeloWorkspaceEvidenceFactV1(**data)[source]

Bases: _WorkspaceModel

A bounded non-financial fact for capability or refusal explanation.

Parameters:

data (Any)

name: _BoundedCode
value: ModeloWorkspaceTextFactValueV1
class ModeloWorkspaceLegalEvidenceReferenceV1(**data)[source]

Bases: _WorkspaceModel

A canonical legal-reference identity used as safe evidence.

Parameters:

data (Any)

kind: Literal['legal']
legal_ref_id: LegalRefId
class ModeloWorkspaceSourceEvidenceReferenceV1(**data)[source]

Bases: _WorkspaceModel

A canonical source-reference identity used as safe evidence.

Parameters:

data (Any)

kind: Literal['source']
source_ref_id: SourceRefId
class ModeloWorkspaceBaselineV1(**data)[source]

Bases: _WorkspaceModel

Opaque read consistency identity; this is not mutation authority or approval.

COMPARABLE BY EQUALITY, deliberately. Every field is a content digest or a resolved coordinate: there is no timestamp and no minted id, so two baselines computed over the same state ARE equal, and the codebase relies on that to keep a cursor, a facet and a projection pinned to one read.

Do not carry this property to ModeloEditBaselineV1. That one is a time-bounded admission authority carrying issued_at, expires_at and baseline_id, so two admissions of an unchanged tree are never equal and record equality there can only ever report “different”. The two are compared in OPPOSITE ways and share a name; an editor session once answered staleness by comparing edit baselines as if they were these, and its stale signal was permanently on.

Parameters:

data (Any)

contract_version: Literal[1]
token: ContentDigest
contributor_stamp_digest: ContentDigest
contributor_epoch_digest: ContentDigest
target: ModeloWorkspaceResolvedTargetV1
selected_revision_id: RevisionId
schema_identity: ModeloWorkspaceSchemaIdentityV1
locale_catalogue_digest: ContentDigest
class ModeloWorkspaceContributorIdentityV1(**data)[source]

Bases: _WorkspaceModel

One producer identity captured in a baseline-pinned Workspace read.

Parameters:

  • owner (_BoundedCode)

  • producer (_BoundedCode)

owner: _BoundedCode
producer: _BoundedCode
class ModeloWorkspaceCursorV1(**data)[source]

Bases: _WorkspaceModel

One opaque continuation bound to the complete Workspace read coordinate.

Parameters:

data (Any)

contract_version: Literal[1]
baseline: ModeloWorkspaceBaselineV1
selected_revision_id: RevisionId
schema_identity: ModeloWorkspaceSchemaIdentityV1
facet: ModeloWorkspaceFacetName
contributor_epoch_digest: ContentDigest
continuation: _BoundedText
class ModeloWorkspaceCapabilityV1(**data)[source]

Bases: _WorkspaceModel

One non-inferred capability answer copied from its canonical producer.

Parameters:

data (Any)

capability: ModeloWorkspaceCapabilityName
disposition: ModeloWorkspaceCapabilityDisposition
target: ModeloWorkspaceResolvedTargetV1
selected_revision_id: RevisionId
producer_owner: _BoundedCode
producer: _BoundedCode
evidence: Annotated[tuple[ModeloWorkspaceEvidenceReferenceV1, ...], Field(max_length=_MAX_SCHEMA_EVIDENCE_REFERENCES)]
facts: Annotated[tuple[ModeloWorkspaceEvidenceFactV1, ...], Field(max_length=_MAX_SAFE_FACTS)]
source_disposition: RegistrySchemaFamilyDisposition | None
recovery_action: ActionReference | None
class ModeloWorkspaceBoundedFacetV1(**data)[source]

Bases: _WorkspaceModel, Generic

A baseline-pinned, finite page from one workspace facet.

Parameters:
contract_version: Literal[1]
selected_revision_id: RevisionId
schema_identity: ModeloWorkspaceSchemaIdentityV1
baseline: ModeloWorkspaceBaselineV1
contributor_epoch_digest: ContentDigest
contributors: Annotated[tuple[ModeloWorkspaceContributorIdentityV1, ...], Field(min_length=1, max_length=_MAX_CONTRIBUTORS)]
facet: ModeloWorkspaceFacetName
disposition: ModeloWorkspaceCapabilityDisposition
records: Annotated[tuple[RecordT, ...], Field(max_length=_MAX_FACET_PAGE_SIZE)]
page_size: Annotated[int, Field(ge=1, le=_MAX_FACET_PAGE_SIZE)]
next_cursor: ModeloWorkspaceCursorV1 | None
has_more: bool
class ModeloWorkspaceWorkReviewFacetV1(**data)[source]

Bases: _WorkspaceModel

The exact canonical review facet or an explicit ineligible disposition.

Parameters:
disposition: ModeloWorkspaceCapabilityDisposition
review: ModeloWorkReview | None
class ModeloWorkspaceEvidenceHorizonV1(**data)[source]

Bases: _WorkspaceModel

The safe evidence coordinates on which the admitted projection rests.

Parameters:

data (Any)

source_refs: _BoundedRefList[SourceRefId]
evidence_digest: ContentDigest
class ModeloWorkspaceProfileRequirementV1(**data)[source]

Bases: _WorkspaceModel

One bounded profile requirement from the canonical readiness axis.

Parameters:

data (Any)

selector: Annotated[str, Field(min_length=1, max_length=128)]
section_key: Annotated[str, Field(min_length=1, max_length=64)]
field_key: Annotated[str, Field(min_length=1, max_length=128)]
label: _BoundedLocalizedText
legal_refs: Annotated[tuple[LegalRefId, ...], Field(max_length=_MAX_SCHEMA_EVIDENCE_REFERENCES)]
modelos: Annotated[tuple[ModeloCode, ...], Field(max_length=_MAX_SCHEMA_EVIDENCE_REFERENCES)]
class ModeloWorkspaceBindingRequirementV1(**data)[source]

Bases: _WorkspaceModel

One missing canonical calculation-binding requirement from readiness.

Parameters:

data (Any)

binding_id: BindingId
source: BindingSourceKind
input_channel: Annotated[str, Field(min_length=1, max_length=16)]
class ModeloWorkspaceLedgerTransactionSubjectV1(**data)[source]

Bases: _WorkspaceModel

A ledger-preflight issue attached to one identified transaction.

Parameters:

data (Any)

kind: Literal['transaction']
transaction_id: TransactionId
class ModeloWorkspaceLedgerPeriodSubjectV1(**data)[source]

Bases: _WorkspaceModel

A ledger-preflight issue that is not tied to any one transaction.

LedgerPreflightIssue carries transaction_id: TransactionId | Literal["__period__"] for a condition scoped to the whole period rather than one row (an unsupported period with no date span, per _unsupported_period_issue). Collapsing that case into a required TransactionId would either drop the issue (silent under-declaration on exactly the axis a taxpayer consults before filing) or pin it to a fabricated transaction that has nothing to do with it; this type represents the period-level case as itself.

Parameters:

data (Any)

kind: Literal['period']
class ModeloWorkspaceLedgerIssueV1(**data)[source]

Bases: _WorkspaceModel

One bounded ledger-preflight issue preserving its canonical typed axis.

Parameters:

data (Any)

subject: ModeloWorkspaceLedgerIssueSubjectV1
reason: LedgerPreflightIssueReason
detail: _BoundedLocalizedText
class ModeloWorkspaceReadinessV1(**data)[source]

Bases: _WorkspaceModel

Typed, axis-preserving Workspace projection of canonical Modelo readiness.

Parameters:

data (Any)

profile_id: ProfileId
modelo: ModeloCode
revision_id: RevisionId
filing_year: FilingYear
period: Period
missing: Annotated[tuple[ModeloWorkspaceProfileRequirementV1, ...], Field(max_length=128)]
profile_ready: bool
per_operation_requirements_assessed: bool
profile_refusal: Annotated[str, Field(max_length=512)]
registry_ready: bool
registry_refusal: Annotated[str, Field(max_length=512)]
binding_ready: bool
missing_bindings: Annotated[tuple[ModeloWorkspaceBindingRequirementV1, ...], Field(max_length=128)]
ledger_preflight_required: bool
ledger_ready: bool | None
ledger_period: Period | None
ledger_checked_transaction_count: Annotated[int, Field(ge=0)]
ledger_issues: Annotated[tuple[ModeloWorkspaceLedgerIssueV1, ...], Field(max_length=128)]
ready: bool
class ModeloWorkspaceSnapshotScopeV1(**data)[source]

Bases: _WorkspaceModel

The explicitly requested and declared grade for one snapshot admission.

A third effective_grade field was retired here. The registry’s own grade check (_check_snapshot_authority_grade) REFUSES a snapshot whose declared grade is below the requested one; it never truncates and never returns a snapshot built at some lesser grade. Under every path that exists, an “effective” grade could therefore only ever equal declared_grade – a field that can only restate its neighbour asserts a narrowing step the system never performs, and nothing in the codebase ever constructed or read it. Retired outright because nothing persists this class. Reintroduction condition: if a future revision-selection path ever TRUNCATES instead of refusing – admitting a snapshot at a grade below the one requested, rather than raising – then an effective grade becomes a real, distinct fact and the field earns its place back with that defined meaning.

Parameters:

data (Any)

required_grade: RegistryAuthorityGrade
declared_grade: RegistryAuthorityGrade
snapshot_scope_digest: ContentDigest
class ModeloWorkspaceStaticInspectionScopeV1(**data)[source]

Bases: _WorkspaceModel

The successful scope of inspection-only admission.

Parameters:

data (Any)

kind: Literal[ModeloWorkspaceAdmissionKind.STATIC_INSPECTION]
snapshot_admitted: Literal[False]
class ModeloWorkspaceGradedSnapshotScopeV1(**data)[source]

Bases: _WorkspaceModel

The successful scope of one authority-grade-admitted snapshot.

Parameters:

data (Any)

kind: Literal[ModeloWorkspaceAdmissionKind.GRADED_SNAPSHOT]
snapshot_admitted: Literal[True]
scope: ModeloWorkspaceSnapshotScopeV1
class ModeloWorkspaceProjectionV1(**data)[source]

Bases: _WorkspaceModel

One assembled, baseline-pinned read projection with no mutation authority.

Parameters:

data (Any)

contract_version: Literal[1]
admission: ModeloWorkspaceProjectionAdmissionV1
target: ModeloWorkspaceResolvedTargetV1
schema_identity: ModeloWorkspaceSchemaIdentityV1
locale: ModeloWorkspaceLocaleSummaryV1
evidence_horizon: ModeloWorkspaceEvidenceHorizonV1
family_dispositions: Annotated[tuple[ModeloWorkspaceFamilyDispositionV1, ...], Field(max_length=_MAX_SCHEMA_RELATIONSHIPS)]
contributors: Annotated[tuple[ModeloWorkspaceContributorIdentityV1, ...], Field(min_length=1, max_length=_MAX_CONTRIBUTORS)]
baseline: ModeloWorkspaceBaselineV1
schema_facet: ModeloWorkspaceBoundedFacetV1[ModeloWorkspaceSchemaRecordV1]
materialization_facet: ModeloWorkspaceBoundedFacetV1[ModeloWorkspaceMaterializationRecordV1] | None
provenance_facet: ModeloWorkspaceBoundedFacetV1[ModeloWorkspaceProvenanceRecordV1] | None
work_review: ModeloWorkspaceWorkReviewFacetV1
readiness: ModeloWorkspaceReadinessV1 | None
capabilities: Annotated[tuple[ModeloWorkspaceCapabilityV1, ...], Field(min_length=len(ModeloWorkspaceCapabilityName), max_length=len(ModeloWorkspaceCapabilityName))]
class ModeloWorkspaceStaticInspectionResultV1(**data)[source]

Bases: _WorkspaceModel

A successful static registry inspection with no runtime snapshot admission.

Parameters:

data (Any)

outcome: Literal['static_inspection']
contract_version: Literal[1]
projection: ModeloWorkspaceProjectionV1
class ModeloWorkspaceGradedSnapshotResultV1(**data)[source]

Bases: _WorkspaceModel

A successful grade-admitted projection with bounded materialization facets.

Parameters:

data (Any)

outcome: Literal['graded_snapshot']
contract_version: Literal[1]
projection: ModeloWorkspaceProjectionV1
class ModeloWorkspaceDomainRefusalV1(**data)[source]

Bases: _WorkspaceModel

Typed post-parse refusal without a partial projection or raw exception.

Parameters:

data (Any)

kind: Literal['domain']
contract_version: Literal[1]
code: ModeloWorkspaceRefusalCode
boundary: Literal['admission', 'capability', 'consistency', 'locale', 'schema']
capability: ModeloWorkspaceCapabilityName | None
requested_target: ModeloWorkspaceTargetV1
selected_target: ModeloWorkspaceResolvedTargetV1 | None
facts: Annotated[tuple[ModeloWorkspaceEvidenceFactV1, ...], Field(max_length=_MAX_SAFE_FACTS)]
evidence: _BoundedRefList[ModeloWorkspaceEvidenceReferenceV1]
responsible_owner: _BoundedCode
reconsideration_condition: _BoundedText
source_disposition: RegistrySchemaFamilyDisposition | None
recovery_action: ActionReference | None
class ModeloWorkspaceRefusedResultV1(**data)[source]

Bases: _WorkspaceModel

The result arm that exposes a refusal without calling it a partial success.

Parameters:

data (Any)

outcome: Literal['refused']
refusal: ModeloWorkspaceDomainRefusalV1