`arelle.utils.validate.ContextIssues`¶

See COPYRIGHT.md for copyright information.

Module Contents¶

Classes¶

ContextIssues

Result of structural context validation. Contains sets of contexts that violate common XBRL/ESEF context rules (period format, segment/scenario usage).

Functions¶

getContextIssues

Iterate all contexts and collect those with common issues:

API¶

class arelle.utils.validate.ContextIssues.ContextIssues¶

Result of structural context validation. Contains sets of contexts that violate common XBRL/ESEF context rules (period format, segment/scenario usage).

contextsWithImproperContent: set[arelle.ModelInstanceObject.ModelContext]¶: None

contextsWithPeriodTime: set[arelle.ModelInstanceObject.ModelContext]¶: None

contextsWithPeriodTimeZone: set[arelle.ModelInstanceObject.ModelContext]¶: None

contextsWithSegments: set[arelle.ModelInstanceObject.ModelContext]¶: None

contextsWithWrongInstantDate: set[arelle.ModelInstanceObject.ModelContext]¶: None

arelle.utils.validate.ContextIssues.getContextIssues(modelXbrl: arelle.ModelXbrl.ModelXbrl, esefYear: int | None = None) → arelle.utils.validate.ContextIssues.ContextIssues¶

Iterate all contexts and collect those with common issues:

Period elements (startDate, endDate, instant) with time or timezone
Contexts using xbrli:segment (disallowed in ESEF/NL/GFM)
Scenario elements with non-dimensional content
Optional: int indicating the year of the ESEF taxonomy and whether to check for instant dates on January 1st.