`arelle.oim.Load`¶

See COPYRIGHT.md for copyright information.

Module Contents¶

Classes¶

`SQNameType`
`QNameType`
`LangType`
`URIType`
`IdentifierType`
`NoRecursionCheck`
`CheckPrefix`
`KeyIsNcName`
`Singleton`
`FactProduced`

Functions¶

`jsonGet`
`csvCellValue`
`xlUnicodeChar`
`xlValue`
`parseMetadataCellValues`
`parseParameterValues`
`xlTrimHeaderRow`
`csvPeriod`
`increaseMaxFieldSize`
`openCsvReader`
`idDeduped`
`checkForDuplicates`
`getTaxonomyContextElement`
`isOimLoadable`
`oimLoader`

Data¶

`nsOims`
`nsOimCes`
`jsonDocumentTypes`
`csvDocumentTypes`
`csvDocinfoObjects`
`csvExtensibleObjects`
`reservedLinkTypesAndGroups`
`reservedLinkTypeAndGroupAliases`
`XLINKTYPE`
`XLINKLABEL`
`XLINKARCROLE`
`XLINKROLE`
`XLINKFROM`
`XLINKTO`
`XLINKHREF`
`XMLLANG`
`NSReservedAliasURIs`
`JSONNSReservedAliasURIs`
`CSVNSReservedAliasURIs`
`JSONNSReservedURIAliases`
`CSVNSReservedURIAliases`
`NSReservedAliasURIPrefixes`
`NSReservedURIAlias`
`OIMDefaultContextElement`
`OIMReservedAliasURIs`
`OIMReservedURIAlias`
`EMPTY_DICT`
`EMPTY_LIST`
`DUPJSONKEY`
`DUPJSONVALUE`
`UTF_7_16_Pattern`
`UTF_7_16_Bytes_Pattern`
`EBCDIC_Bytes_Pattern`
`NEVER_EBCDIC_Bytes_Pattern`
`JSONmetadataPattern`
`NoCanonicalPattern`
`CanonicalFloatPattern`
`CanonicalIntegerPattern`
`CanonicalXmlTypePattern`
`RowIdentifierPattern`
`PeriodPattern`
`SpecialValuePattern`
`UrlInvalidPattern`
`WhitespacePattern`
`WhitespaceUntrimmedPattern`
`xlUnicodePattern`
`decimalsSuffixPattern`
`htmlBodyTemplate`
`xhtmlTagPrefix`
`builtInDimensionKeys`
`UNSUPPORTED_DATA_TYPES`
`CSV_PARAMETER_FILE`
`CSV_FACTS_FILE`
`CSV_HAS_HEADER_ROW`
`NONE`
`COMPLETE`
`CONSISTENT`
`ALL`
`AllowedDuplicatesFeatureValues`
`DisallowedDescription`
`DuplicateTypeArgMap`
`UnrecognizedDocMemberTypes`
`UnrecognizedDocRequiredMembers`
`JsonMemberTypes`
`JsonRequiredMembers`
`CsvMemberTypes`
`CsvRequiredMembers`
`EMPTY_SET`
`EMPTY_CELL`
`NONE_CELL`
`INVALID_REFERENCE_TARGET`
`PER_ISO`
`PER_INCLUSIVE_DATES`
`PER_SINGLE_DAY`
`PER_MONTH`
`PER_YEAR`
`PER_QTR`
`PER_HALF`
`PER_WEEK`
`ONE_DAY`
`ONE_MONTH`
`ONE_YEAR`
`ONE_QTR`
`ONE_HALF`
`periodForms`

API¶

arelle.oim.Load.nsOims¶: (‘https://xbrl.org/2021’, ‘http://www.xbrl.org/WGWD/YYYY-MM-DD’, ‘https://www.xbrl.org/WGWD/YYYY-MM-…

arelle.oim.Load.nsOimCes¶: (‘https://xbrl.org/2021/oim-common/error’, ‘http://www.xbrl.org/WGWD/YYYY-MM-DD/oim-common/error’, ‘…

arelle.oim.Load.jsonDocumentTypes¶: (‘https://xbrl.org/2021/xbrl-json’, ‘http://www.xbrl.org/WGWD/YYYY-MM-DD/xbrl-json’, ‘http://www.xbr…

arelle.oim.Load.csvDocumentTypes¶: ‘tuple(…)’

arelle.oim.Load.csvDocinfoObjects¶: None

arelle.oim.Load.csvExtensibleObjects¶: None

arelle.oim.Load.reservedLinkTypesAndGroups¶: None

arelle.oim.Load.reservedLinkTypeAndGroupAliases¶: None

arelle.oim.Load.XLINKTYPE¶: ‘{http://www.w3.org/1999/xlink}type’

arelle.oim.Load.XLINKLABEL¶: ‘{http://www.w3.org/1999/xlink}label’

arelle.oim.Load.XLINKARCROLE¶: ‘{http://www.w3.org/1999/xlink}arcrole’

arelle.oim.Load.XLINKROLE¶: ‘{http://www.w3.org/1999/xlink}role’

arelle.oim.Load.XLINKFROM¶: ‘{http://www.w3.org/1999/xlink}from’

arelle.oim.Load.XLINKTO¶: ‘{http://www.w3.org/1999/xlink}to’

arelle.oim.Load.XLINKHREF¶: ‘{http://www.w3.org/1999/xlink}href’

arelle.oim.Load.XMLLANG¶: ‘{http://www.w3.org/XML/1998/namespace}lang’

arelle.oim.Load.NSReservedAliasURIs¶: None

arelle.oim.Load.JSONNSReservedAliasURIs: dict[str, list[str]]¶: None

arelle.oim.Load.CSVNSReservedAliasURIs¶: None

arelle.oim.Load.JSONNSReservedURIAliases: dict[str, str]¶: None

arelle.oim.Load.CSVNSReservedURIAliases¶: ‘dict(…)’

arelle.oim.Load.NSReservedAliasURIPrefixes: dict[str, str]¶: None

arelle.oim.Load.NSReservedURIAlias: dict[str, str]¶: None

arelle.oim.Load.OIMDefaultContextElement¶: ‘scenario’

arelle.oim.Load.OIMReservedAliasURIs¶: None

arelle.oim.Load.OIMReservedURIAlias¶: None

arelle.oim.Load.EMPTY_DICT: dict[Any, Any]¶: None

arelle.oim.Load.EMPTY_LIST: list[Any]¶: []

arelle.oim.Load.DUPJSONKEY¶: ‘!@%duplicateKeys%@!’

arelle.oim.Load.DUPJSONVALUE¶: ‘!@%duplicateValues%@!’

arelle.oim.Load.UTF_7_16_Pattern¶: ‘compile(…)’

arelle.oim.Load.UTF_7_16_Bytes_Pattern¶: ‘compile(…)’

arelle.oim.Load.EBCDIC_Bytes_Pattern¶: ‘compile(…)’

arelle.oim.Load.NEVER_EBCDIC_Bytes_Pattern¶: ‘compile(…)’

arelle.oim.Load.JSONmetadataPattern¶: ‘compile(…)’

arelle.oim.Load.NoCanonicalPattern¶: ‘attrdict(…)’

arelle.oim.Load.CanonicalFloatPattern¶: ‘compile(…)’

arelle.oim.Load.CanonicalIntegerPattern¶: ‘compile(…)’

arelle.oim.Load.CanonicalXmlTypePattern¶: None

arelle.oim.Load.RowIdentifierPattern¶: ‘compile(…)’

arelle.oim.Load.PeriodPattern¶: ‘compile(…)’

arelle.oim.Load.SpecialValuePattern¶: ‘compile(…)’

arelle.oim.Load.UrlInvalidPattern¶: ‘compile(…)’

arelle.oim.Load.WhitespacePattern¶: ‘compile(…)’

arelle.oim.Load.WhitespaceUntrimmedPattern¶: ‘compile(…)’

arelle.oim.Load.xlUnicodePattern¶: ‘compile(…)’

arelle.oim.Load.decimalsSuffixPattern¶: ‘compile(…)’

arelle.oim.Load.htmlBodyTemplate = <Multiline-String>¶

arelle.oim.Load.xhtmlTagPrefix¶: ‘{http://www.w3.org/1999/xhtml}’

arelle.oim.Load.builtInDimensionKeys¶: ‘frozenset(…)’

arelle.oim.Load.UNSUPPORTED_DATA_TYPES¶: None

arelle.oim.Load.CSV_PARAMETER_FILE¶: 1

arelle.oim.Load.CSV_FACTS_FILE¶: 2

arelle.oim.Load.CSV_HAS_HEADER_ROW¶: True

arelle.oim.Load.NONE¶: 1

arelle.oim.Load.COMPLETE¶: 2

arelle.oim.Load.CONSISTENT¶: 3

arelle.oim.Load.ALL¶: 4

arelle.oim.Load.AllowedDuplicatesFeatureValues¶: None

arelle.oim.Load.DisallowedDescription¶: None

arelle.oim.Load.DuplicateTypeArgMap¶: None

class arelle.oim.Load.SQNameType¶

class arelle.oim.Load.QNameType¶

class arelle.oim.Load.LangType¶

class arelle.oim.Load.URIType¶

class arelle.oim.Load.IdentifierType¶

class arelle.oim.Load.NoRecursionCheck¶

class arelle.oim.Load.CheckPrefix¶

class arelle.oim.Load.KeyIsNcName¶

arelle.oim.Load.UnrecognizedDocMemberTypes¶: None

arelle.oim.Load.UnrecognizedDocRequiredMembers¶: None

arelle.oim.Load.JsonMemberTypes¶: None

arelle.oim.Load.JsonRequiredMembers¶: None

arelle.oim.Load.CsvMemberTypes¶: None

arelle.oim.Load.CsvRequiredMembers¶: None

arelle.oim.Load.EMPTY_SET: set[Any]¶: ‘set(…)’

arelle.oim.Load.jsonGet(tbl: Any, key: Any, default: Any = None) → Any¶

class arelle.oim.Load.Singleton(value: str)¶

Bases: str

capitalize()¶

casefold()¶

center()¶

count()¶

encode()¶

endswith()¶

expandtabs()¶

find()¶

format()¶

format_map()¶

index()¶

isalnum()¶

isalpha()¶

isascii()¶

isdecimal()¶

isdigit()¶

isidentifier()¶

islower()¶

isnumeric()¶

isprintable()¶

isspace()¶

istitle()¶

isupper()¶

join()¶

ljust()¶

lower()¶

lstrip()¶

partition()¶

removeprefix()¶

removesuffix()¶

replace()¶

rfind()¶

rindex()¶

rjust()¶

rpartition()¶

rsplit()¶

rstrip()¶

split()¶

splitlines()¶

startswith()¶

strip()¶

swapcase()¶

title()¶

translate()¶

upper()¶

zfill()¶

arelle.oim.Load.EMPTY_CELL¶: ‘Singleton(…)’

arelle.oim.Load.NONE_CELL¶: ‘Singleton(…)’

arelle.oim.Load.INVALID_REFERENCE_TARGET¶: ‘Singleton(…)’

arelle.oim.Load.csvCellValue(cellValue: str) → str | arelle.oim.Load.Singleton | None¶

arelle.oim.Load.xlUnicodeChar(match: regex.Match[str]) → str¶

arelle.oim.Load.xlValue(cell: openpyxl.cell.Cell | openpyxl.cell.MergedCell) → str | arelle.oim.Load.Singleton | None¶

arelle.oim.Load.parseMetadataCellValues(metadataTable: dict[str, str | arelle.oim.Load.Singleton | None]) → None¶

arelle.oim.Load.parseParameterValues(parameters: dict[str, str | arelle.oim.Load.Singleton | None], error: collections.abc.Callable[..., Any]) → None¶

arelle.oim.Load.xlTrimHeaderRow(row: list[Any]) → list[Any]¶

exception arelle.oim.Load.OIMException(code: str | None = None, message: str | None = None, **kwargs: Any)¶

Bases: Exception

add_note()¶

class args¶

with_traceback()¶

exception arelle.oim.Load.NotOIMException(**kwargs: Any)¶