arelle.oim.tc.metadata.model

See COPYRIGHT.md for copyright information.

Module Contents

Classes

API

class arelle.oim.tc.metadata.model.TCMetadata
template_constraints: collections.abc.Mapping[str, TCTemplateConstraints]

‘field(…)’

class arelle.oim.tc.metadata.model.TCTemplateConstraints
constraints: collections.abc.Mapping[str, TCValueConstraint]

‘field(…)’

parameters: collections.abc.Mapping[str, TCValueConstraint]

‘field(…)’

keys: TCKeys | None

None

column_order: tuple[str, ...] | None

None

table_constraints: TCTableConstraints | None

None

class arelle.oim.tc.metadata.model.TCValueConstraint
type: str

None

optional: bool

False

nillable: bool

False

enumeration_values: collections.abc.Set[str] | None

None

patterns: collections.abc.Set[str] | None

None

time_zone: bool | None

None

period_type: str | None

None

duration_type: str | None

None

length: int | None

None

min_length: int | None

None

max_length: int | None

None

min_inclusive: str | None

None

max_inclusive: str | None

None

min_exclusive: str | None

None

max_exclusive: str | None

None

total_digits: int | None

None

fraction_digits: int | None

None

class arelle.oim.tc.metadata.model.TCKeys
unique: tuple[TCUniqueKey, ...] | None

None

reference: tuple[TCReferenceKey, ...] | None

None

sort_key: str | None

None

class arelle.oim.tc.metadata.model.TCUniqueKey
name: str

None

fields: tuple[str, ...]

None

severity: str

‘error’

shared: bool

False

class arelle.oim.tc.metadata.model.TCReferenceKey
name: str

None

fields: tuple[str, ...]

None

referenced_key_name: str

None

negate: bool

False

severity: str

‘error’

class arelle.oim.tc.metadata.model.TCTableConstraints
min_tables: int | None

None

max_tables: int | None

None

min_table_rows: int | None

None

max_table_rows: int | None

None