arelle.RuntimeOptions
¶
See COPYRIGHT.md for copyright information.
Module Contents¶
Classes¶
This class contains the runtime options for Arelle. The base options are defined as member variables and are passed directly to the constructor. Plugin options are dynamic and passed using the pluginOptions InitVar and applied to the class using setattr() in __post_init RuntimeOptionsException is raised if an improper combination of options are specified. |
Data¶
API¶
- arelle.RuntimeOptions.RuntimeOptionValue¶
None
- exception arelle.RuntimeOptions.RuntimeOptionsException¶
Bases:
Exception
- class arelle.RuntimeOptions.RuntimeOptions¶
This class contains the runtime options for Arelle. The base options are defined as member variables and are passed directly to the constructor. Plugin options are dynamic and passed using the pluginOptions InitVar and applied to the class using setattr() in __post_init RuntimeOptionsException is raised if an improper combination of options are specified.
- _initialized: bool¶
False
- pluginOptions: dataclasses.InitVar[Optional[dict[str, arelle.RuntimeOptions.RuntimeOptionValue]]]¶
None
- strictOptions: bool¶
True
- abortOnMajorError: Optional[bool]¶
None
- about: Optional[str]¶
None
- anchFile: Optional[str]¶
None
- arcroleTypesFile: Optional[str]¶
None
- betaObjectModel: Optional[bool]¶
False
- cacheDirectory: Optional[str]¶
None
- calFile: Optional[str]¶
None
- calcDecimals: Optional[int]¶
None
- calcDeduplicate: Optional[bool]¶
None
- calcPrecision: Optional[int]¶
None
- calcs: Optional[str]¶
None
- collectProfileStats: Optional[bool]¶
None
- conceptsFile: Optional[str]¶
None
- deduplicateFacts: Optional[arelle.ValidateDuplicateFacts.DeduplicationType]¶
None
- diagnostics: Optional[bool]¶
None
- diffFile: Optional[str]¶
None
- dimFile: Optional[str]¶
None
- disablePersistentConfig: Optional[bool]¶
None
- disableRtl: Optional[bool]¶
None
- disclosureSystemName: Optional[str]¶
None
- DTSFile: Optional[str]¶
None
- entrypointFile: Optional[str]¶
None
- factListCols: Optional[int]¶
None
- factTableCols: Optional[int]¶
None
- factTableFile: Optional[str]¶
None
- factsFile: Optional[str | arelle.FileSource.FileNamedStringIO]¶
None
- formulaAction: Optional[str]¶
None
- formulaAsserResultCounts: Optional[bool]¶
None
- formulaCacheSize: Optional[int]¶
None
- formulaCallExprCode: Optional[bool]¶
None
- formulaCallExprEval: Optional[bool]¶
None
- formulaCallExprResult: Optional[bool]¶
None
- formulaCallExprSource: Optional[bool]¶
None
- formulaCompileOnly: Optional[bool]¶
None
- formulaFormulaRules: Optional[bool]¶
None
- formulaParamExprResult: Optional[bool]¶
None
- formulaParamInputValue: Optional[bool]¶
None
- formulaRunIDs: Optional[int]¶
None
- formulaSatisfiedAsser: Optional[bool]¶
None
- formulaUnmessagedUnsatisfiedAsser: Optional[bool]¶
None
- formulaUnsatisfiedAsser: Optional[bool]¶
None
- formulaUnsatisfiedAsserError: Optional[bool]¶
None
- formulaVarExpressionCode: Optional[bool]¶
None
- formulaVarExpressionEvaluation: Optional[bool]¶
None
- formulaVarExpressionResult: Optional[bool]¶
None
- formulaVarExpressionSource: Optional[bool]¶
None
- formulaVarFilterWinnowing: Optional[bool]¶
None
- formulaVarFiltersResult: Optional[bool]¶
None
- formulaVarSetExprEval: Optional[bool]¶
None
- formulaVarSetExprResult: Optional[bool]¶
None
- formulaVarsOrder: Optional[bool]¶
None
- formulaeFile: Optional[str]¶
None
- httpUserAgent: Optional[str]¶
None
- httpsRedirectCache: Optional[bool]¶
None
- importFiles: Optional[str]¶
None
- infosetValidate: Optional[bool]¶
None
- internetConnectivity: Optional[str]¶
None
- internetLogDownloads: Optional[bool]¶
None
- internetRecheck: Optional[str]¶
None
- internetTimeout: Optional[int]¶
None
- keepOpen: Optional[bool]¶
None
- labelLang: Optional[str]¶
None
- labelRole: Optional[str]¶
None
- logCodeFilter: Optional[str]¶
None
- logFile: Optional[str]¶
None
- logFileMode: Optional[str]¶
None
- logFormat: Optional[str]¶
None
- logLevel: Optional[str]¶
None
- logLevelFilter: Optional[str]¶
None
- logRefObjectProperties: Optional[bool]¶
None
- logTextMaxLength: Optional[int]¶
None
- logXmlMaxAttributeLength: Optional[int]¶
None
- monitorParentProcess: Optional[bool]¶
None
- noCertificateCheck: Optional[bool]¶
None
- outputAttribution: Optional[str]¶
None
- packageManifestName: Optional[str]¶
None
- packages: Optional[list[str]]¶
None
- parameterSeparator: Optional[str]¶
None
- parameters: Optional[str]¶
None
- password: Optional[str]¶
None
- plugins: Optional[str]¶
None
- preFile: Optional[str]¶
None
- proxy: Optional[str]¶
None
- redirectFallbacks: Optional[dict[Pattern[str], str]]¶
None
- relationshipCols: Optional[int]¶
None
- responseZipStream: Optional[BinaryIO]¶
None
- roleTypesFile: Optional[str]¶
None
- rssReport: Optional[str]¶
None
- rssReportCols: Optional[int]¶
None
- saveDeduplicatedInstance: Optional[bool]¶
None
- saveOIMToXMLReport: Optional[str]¶
None
- showEnvironment: Optional[bool]¶
None
- showOptions: Optional[bool]¶
None
- skipDTS: Optional[bool]¶
None
- skipLoading: Optional[bool]¶
None
- sourceZipStream: Optional[BinaryIO]¶
None
- statusPipe: Optional[str]¶
None
- tableFile: Optional[str]¶
None
- testReport: Optional[str]¶
None
- testReportCols: Optional[int]¶
None
- testcaseFilters: Optional[list[str]]¶
None
- testcaseResultOptions: Optional[str]¶
None
- testcaseResultsCaptureWarnings: Optional[bool]¶
None
- timeVariableSetEvaluation: Optional[bool]¶
None
- uiLang: Optional[str]¶
None
- username: Optional[str]¶
None
- utrUrl: Optional[str]¶
None
- utrValidate: Optional[bool]¶
None
- validate: Optional[bool]¶
None
- validateDuplicateFacts: Optional[str]¶
None
- validateXmlOim: Optional[bool]¶
None
- validateEFM: Optional[bool]¶
None
- validateEFMCalcTree: Optional[bool]¶
None
- validateHMRC: Optional[bool]¶
None
- validateTestcaseSchema: Optional[bool]¶
None
- versReportFile: Optional[str | arelle.FileSource.FileNamedStringIO]¶
None
- viewArcrole: Optional[bool]¶
None
- viewFile: Optional[str | arelle.FileSource.FileNamedStringIO]¶
None
- webserver: Optional[str]¶
None
- xdgConfigHome: Optional[str]¶
None
- __delattr__(name: str) Any ¶
Delete attribute while silencing AttributeError if it does not exist and
strictOptions
is False.- Parameters:
name –
- Returns:
None
- __eq__(other: Any) bool ¶
Default dataclass implementation doesn’t consider plugin applied options.
- __getattr__(name: str) Any ¶
If an attribute isn’t found, it may be an unspecified plugin option. Return None for any attributes not found on the class.
- Parameters:
name –
- Returns:
None
- __repr__() str ¶
Default dataclass implementation doesn’t consider plugin applied options.
- __post_init__(pluginOptions: Optional[dict[str, arelle.RuntimeOptions.RuntimeOptionValue]]) None ¶
This runs through the options object, verifies that the arguments are expected and sets the options appropriately
- Parameters:
pluginOptions – Options that are introduced via plugins
- Returns:
Nothing