arelle-release 2.37.46__py3-none-any.whl → 2.38.0__py3-none-any.whl

arelle/DialogFind.py

@@ -186,7 +186,7 @@ class DialogFind(Toplevel):
         else:
             if not self.modelManager.modelXbrl or not docType in (
                  ModelDocument.Type.SCHEMA, ModelDocument.Type.LINKBASE, ModelDocument.Type.INSTANCE, ModelDocument.Type.INLINEXBRL,
-                 ModelDocument.Type.RSSFEED):
+                 ModelDocument.Type.RSSFEED, ModelDocument.Type.INLINEXBRLDOCUMENTSET):
                 messagebox.showerror(_("Find cannot be completed"),
                          _("Find requires an opened DTS or RSS Feed"), parent=self.parent)
                 return

arelle/DialogPluginManager.py

@@ -386,15 +386,17 @@ class DialogPluginManager(Toplevel):
         group = {
             "ixbrl-viewer": "1",  # pip installed Arelle viewer
             "iXBRLViewerPlugin": "2",  # git clone installed Arelle viewer
-            "Edgar Renderer": "3",
+            "EDGAR": "3",
+            "Inline XBRL Document Set": "4",
+            "XBRL rule processor (xule)": "5",
         }.get(key)
         if not group:
             if key.startswith("Validate"):
-                group = "4"
+                group = "6"
             elif key.startswith("xbrlDB"):
-                group = "5"
+                group = "7"
             else:
-                group = "6"
+                group = "8"
         return group + key.lower()
 
     @staticmethod

arelle/DisclosureSystem.py

@@ -62,6 +62,7 @@ class DisclosureSystem:
         self.validateEntryText = False
         self.allowedExternalHrefPattern = None
         self.allowedImageTypes = None
+        self.arcroleCyclesAllowed = {}
         self.schemaValidateSchema = None
         self.blockDisallowedReferences = False
         self.maxSubmissionSubdirectoryEntryNesting = 0
@@ -79,6 +80,7 @@ class DisclosureSystem:
         self.utrUrl = ["http://www.xbrl.org/utr/utr.xml"]
         self.utrStatusFilters = None
         self.utrTypeEntries = None
+        self.keepOpen: bool = False
         self.identifierSchemePattern = None
         self.identifierValuePattern = None
         self.identifierValueName = None
@@ -182,6 +184,10 @@ class DisclosureSystem:
                                     self.allowedExternalHrefPattern = re.compile(dsElt.get("allowedExternalHrefPattern"))
                                 if dsElt.get("allowedImageTypes"):
                                     self.allowedImageTypes = json.loads(dsElt.get("allowedImageTypes"))
+                                if dsElt.get("arcroleCyclesAllowed"):
+                                    self.arcroleCyclesAllowed = json.loads(dsElt.get("arcroleCyclesAllowed"))
+                                    for arcrole, specSet in self.arcroleCyclesAllowed.items():
+                                        self.arcroleCyclesAllowed[arcrole] = tuple(specSet)
                                 self.blockDisallowedReferences = dsElt.get("blockDisallowedReferences") == "true"
                                 try:
                                     self.maxSubmissionSubdirectoryEntryNesting = int(dsElt.get("maxSubmissionSubdirectoryEntryNesting"))
@@ -209,6 +215,7 @@ class DisclosureSystem:
                                     self.utrUrl = [self.modelManager.cntlr.webCache.normalizeUrl(u, url)
                                                    for u in dsElt.get("utrUrl").split()]
                                 self.utrStatusFilters = dsElt.get("utrStatusFilters")
+                                self.keepOpen = dsElt.get("keepOpen") == "true"
                                 self.identifierSchemePattern = compileAttrPattern(dsElt,"identifierSchemePattern")
                                 self.identifierValuePattern = compileAttrPattern(dsElt,"identifierValuePattern")
                                 self.identifierValueName = dsElt.get("identifierValueName")

arelle/ErrorManager.py

@@ -180,7 +180,10 @@ class ErrorManager:
                             objectUrl = arg
                         else:
                             try:
-                                objectUrl = arg.modelDocument.displayUri
+                                if isinstance(arg, ObjectPropertyViewWrapper):
+                                    objectUrl = arg.modelObject.modelDocument.displayUri
+                                else:
+                                    objectUrl = arg.modelDocument.displayUri
                             except AttributeError:
                                 try:
                                     objectUrl = arg.displayUri
@@ -204,13 +207,22 @@ class ErrorManager:
                             _arg:ModelObject = arg.modelObject if isinstance(arg, ObjectPropertyViewWrapper) else arg
                             if len(modelObjectArgs) > 1 and getattr(arg,"tag",None) == "instance":
                                 continue # skip IXDS top level element
-                            fragmentIdentifier = cast(str, XmlUtil.elementFragmentIdentifier(_arg))
-                            if not hasattr(_arg, 'modelDocument') and _arg.namespaceURI == XbrlConst.svg:
+                            fragmentIdentifier = "#" + cast(str, XmlUtil.elementFragmentIdentifier(_arg))
+                            if not hasattr(_arg, 'modelDocument') and _arg.namespaceURI == XbrlConst.svg and len(refs) > 0:
                                 # This is an embedded SVG document without its own file.
-                                ref["href"] = "#" + fragmentIdentifier
+                                # Set the href to the containing document element that defined the encoded SVG.
+                                # and define a nestedHrefs attribute with the fragment identifier.
+                                priorRef = refs[-1]
+                                ref["href"] = priorRef["href"]
+                                priorNestedHrefs = priorRef.get("customAttributes", {}).get("nestedHrefs", [])
+                                ref["customAttributes"] = {
+                                    "nestedHrefs": [*priorNestedHrefs, fragmentIdentifier]
+                                }
+                                if priorArgSourceline := priorRef.get("sourceLine"):
+                                    ref["sourceLine"] = priorArgSourceline
                             else:
-                                ref["href"] = file + "#" + fragmentIdentifier
-                            ref["sourceLine"] = _arg.sourceline
+                                ref["href"] = file + fragmentIdentifier
+                                ref["sourceLine"] = _arg.sourceline
                             ref["objectId"] = _arg.objectId()
                             if logRefObjectProperties:
                                 try:
@@ -304,3 +316,6 @@ class ErrorManager:
         if isinstance(argValue, dict):
             return dict((self._loggableValue(k), self._loggableValue(v)) for k, v in argValue.items())
         return str(argValue)
+
+    def setErrorCaptureLevel(self, errorCaptureLevel: int) -> None:
+        self._errorCaptureLevel = errorCaptureLevel

arelle/FileSource.py

@@ -51,7 +51,10 @@ def openFileSource(
     sourceFileSource: FileSource | None = None,
 ) -> FileSource:
     if sourceZipStream:
-        if isinstance(sourceZipStream, FileNamedBytesIO) and sourceZipStream.fileName:
+        if name := getattr(sourceZipStream, "name", None):
+            # Python IO convention is to use the name attribute
+            sourceZipStreamFileName: str = os.sep + str(name)
+        elif isinstance(sourceZipStream, FileNamedBytesIO) and sourceZipStream.fileName:
             sourceZipStreamFileName = os.sep + sourceZipStream.fileName
         else:
             sourceZipStreamFileName = os.sep + "POSTupload.zip"
@@ -564,7 +567,7 @@ class FileSource:
                     if encoding is None:
                         encoding = XmlUtil.encoding(b)
                     if stripDeclaration:
-                        b = stripDeclarationBytes(b)
+                        b = stripDeclarationBytes(b, encoding)
                     return (FileNamedTextIOWrapper(filepath, io.BytesIO(b), encoding=encoding),
                             encoding)
                 except KeyError as err:
@@ -581,7 +584,7 @@ class FileSource:
                     if encoding is None:
                         encoding = XmlUtil.encoding(b)
                     if stripDeclaration:
-                        b = stripDeclarationBytes(b)
+                        b = stripDeclarationBytes(b, encoding)
                     return (FileNamedTextIOWrapper(filepath, io.BytesIO(b), encoding=encoding),
                             encoding)
                 except KeyError as err:
@@ -914,7 +917,11 @@ def openXmlFileStream(
             text = stripDeclarationText(text)
         return (FileNamedStringIO(filepath, initial_value=text), encoding)
 
-def stripDeclarationBytes(xml: bytes) -> bytes:
+def stripDeclarationBytes(xml: bytes, encoding: str | None) -> bytes:
+    if encoding is not None and not encoding.lower().startswith('utf-8'):
+        text = xml.decode(encoding)
+        text = stripDeclarationText(text)
+        return text.encode(encoding)
     xmlStart = xml[0:120]
     indexOfDeclaration = xmlStart.find(b"<?xml")
     if indexOfDeclaration >= 0:

arelle/FunctionIxt.py

@@ -1254,20 +1254,25 @@ tr5Functions.update ({
 })
 deprecatedNamespaceURI = 'http://www.xbrl.org/2008/inlineXBRL/transformation' # the CR/PR pre-REC namespace
 
+ixtNamespacesByVersion = {
+    1: 'http://www.xbrl.org/inlineXBRL/transformation/2010-04-20',
+    2: 'http://www.xbrl.org/inlineXBRL/transformation/2011-07-31',
+    3: 'http://www.xbrl.org/inlineXBRL/transformation/2015-02-26',
+    4: 'http://www.xbrl.org/inlineXBRL/transformation/2020-02-12',
+    5: 'http://www.xbrl.org/inlineXBRL/transformation/2022-02-16',
+}
+
 ixtNamespaces = {
-    "ixt v1": 'http://www.xbrl.org/inlineXBRL/transformation/2010-04-20',
-    "ixt v2": 'http://www.xbrl.org/inlineXBRL/transformation/2011-07-31',
-    "ixt v3": 'http://www.xbrl.org/inlineXBRL/transformation/2015-02-26',
-    "ixt v4": 'http://www.xbrl.org/inlineXBRL/transformation/2020-02-12',
-    "ixt v5": 'http://www.xbrl.org/inlineXBRL/transformation/2022-02-16',
-    }
+    f"ixt v{key}": val
+    for key, val in ixtNamespacesByVersion.items()
+}
 
 ixtNamespaceFunctions = {
-    ixtNamespaces["ixt v1"]: tr1Functions, # transformation registry v1
-    ixtNamespaces["ixt v2"]: tr2Functions, # transformation registry v2
-    ixtNamespaces["ixt v3"]: tr3Functions, # transformation registry v3
-    ixtNamespaces["ixt v4"]: tr4Functions, # transformation registry v4
-    ixtNamespaces["ixt v5"]: tr5Functions, # transformation registry v5
+    ixtNamespacesByVersion[1]: tr1Functions, # transformation registry v1
+    ixtNamespacesByVersion[2]: tr2Functions, # transformation registry v2
+    ixtNamespacesByVersion[3]: tr3Functions, # transformation registry v3
+    ixtNamespacesByVersion[4]: tr4Functions, # transformation registry v4
+    ixtNamespacesByVersion[5]: tr5Functions, # transformation registry v5
     "http://www.xbrl.org/inlineXBRL/transformation/WGWD/YYYY-MM-DD": tr5Functions, # transformation registry v4 draft
     'http://www.xbrl.org/2008/inlineXBRL/transformation': tr1Functions # the CR/PR pre-REC namespace
 }

arelle/HtmlUtil.py

@@ -1,12 +1,13 @@
 '''
 See COPYRIGHT.md for copyright information.
 '''
-import regex as re
+from __future__ import annotations
 
-def attrValue(str, name):
+
+def attrValue(attr: str) -> str:
     # retrieves attribute in a string, such as xyz="abc" or xyz='abc' or xyz=abc;
-    prestuff, matchedName, valuePart = str.lower().partition("charset")
-    value = []
+    prestuff, matchedName, valuePart = attr.lower().partition("charset")
+    value: list[str] = []
     endSep = None
     beforeEquals = True
     for c in valuePart:

arelle/LeiUtil.py

@@ -1,55 +1,75 @@
-'''
+"""
 See COPYRIGHT.md for copyright information.
 
 Implementation of ISO 17442:2012(E) Appendix A
 
-'''
+"""
+
+import string
+from enum import Enum, auto
+
 import regex as re
 
-LEI_VALID = 0
-LEI_INVALID_LEXICAL = 1
-LEI_INVALID_CHECKSUM = 2
 
-LEI_RESULTS = ("valid", "invalid lexical", "invalid checksum")
+class LEIValidationResult(Enum):
+    VALID = auto()
+    INVALID_LEXICAL = auto()
+    INVALID_CHECKSUM = auto()
+
+    def description(self) -> str:
+        return self.name.lower().replace("_", " ")
+
+
+LEI_VALID = LEIValidationResult.VALID
+LEI_INVALID_LEXICAL = LEIValidationResult.INVALID_LEXICAL
+LEI_INVALID_CHECKSUM = LEIValidationResult.INVALID_CHECKSUM
+
+_leiLexicalPattern = re.compile(r"[0-9A-Z]{18}[0-9]{2}", re.ASCII)
+_requiredLEILength = 20
+
+_leiToDigitTable = str.maketrans(
+    dict(
+        (ord(char), str(index))
+        for index, char in enumerate(string.ascii_uppercase, start=len(string.digits))
+    )
+)
+
+# The pattern comes from Solvency II documentation here https://dev.eiopa.europa.eu/Taxonomy/Full/2.3.0/PF/EIOPA_PensionFunds_Validations_2.3.0_PWD2.xlsx
+_validLeiDespiteChecksumFailPatternString = r"^(029200720E3M3A4D6D01|029200758D5M0AI3F601|315700X8JQ3IU0NGK501|3157007SCCESQAUH5Z01|315700TCC9NTEP7J8Z01|13250000000000000301|315700ADOXDR5PCY5400|315700A0UB9Q7DOQIZ00|315700BM9Z39TNTGQW00|315700BZ5F7DRYG2UM00|315700B8401GTFFY6X01|315700DJ07P6OX10FK01|315700DKCD4QSKLAMO01|315700D23JL5C1DZNT00|315700EIYO2TLSEGQ700|315700ET7M7VQ4C84R00|315700EZSEA51937KX01|315700GXBGM8DBYKHF01|315700GZA843JXKTJ400|315700G5G24XYL1TXH00|315700HS7WJ1B0SUWM01|315700HXOEOK58E58P01|315700HZU4SMI8LZTU00|315700I3W2AFHP8MNQ01|315700JICZ3SY5SAXX00|315700JKZH6I0067ND01|315700JO5E28SRE00Q01|315700JXUHL9H2C3P700|315700LDDN3RM7Y2MP00|315700LWYOZNQ7V1T100|315700MBYPT6PGKO7M01|315700MW2F0KFR45QW01|315700M5843O6DU83901|315700NNMGS8F3P2CN00|315700N0VEIBHP0NPQ01|315700OASRCM664PAW01|315700OFW4YCOBNX4U01|315700OVW93X0T3HP200|315700O666JVNCQU9X00|315700PLI0I7W8IOV400|315700PN3J57ZUNF1V00|315700PXKOSX7WQV4N00|315700P4N9VSLK5QZV01|315700P40OV6BT045900|315700P6TZOLP92KN801|315700P89WR82VNB8Z00|315700QGM4XWZE1I5N01|315700Q1S8O1UORF9700|315700RK8M4FAHMYAP01|315700RTEHY362KXWJ00|315700SNUXK41WMW5J00|315700S22RGYRIEEOT00|315700S3TF79ALV82F01|315700TF5Z7T28HZJK01|315700TWGZ89LLSRS000|315700TXNX10N8XH4K00|315700T2EEQAPBO0C301|315700T6T49EDM16YO01|315700UJ6N4LGKLNPB00|315700UKZXWXEO126601|315700UYFD5GF9R13F01|315700VG7PTE9EJJRX01|315700VITYR7AL4M9S01|315700VMAJZ9JZTXNQ00|315700WH3YMKHCVYW201|315700WKCDF4QGRRO200|315700WR4IHOO1M5LP00|315700WYOZ6994UATN00|315700WZPEIS41QDKE00|315700XEFYMA5EZ0P500|315700XE21UYOA3GAC01|315700XI4Z8GF5BDUJ01|315700XSCP1S8WOD8E01|315700X40GNCOUWJYR00|315700YS6RQ5TF3VBP01|315700Y1W7W1JHAUBW00|315700Y5JNQMMUF5ID01|3157000VAJWZ3P8ZED00|3157001KM8GOU7PXZY01|3157001K2LAL04D87901|3157001MLDD3SDFQA901|3157001TPR6K4GBTLN00|31570010000000006400|31570010000000009601|31570010000000019301|31570010000000025800|31570010000000029001|31570010000000035500|31570010000000038701|31570010000000045200|31570010000000048401|31570010000000054900|31570010000000064600|31570010000000067801|31570010000000077501|31570010000000084000|31570010000000087201|31570010000000096901|31570010000000103400|31570010000000106601|31570010000000116301|31570010000000122800|31570010000000126001|3157002CKDQOCIHE5H01|31570020000000005900|31570029808HJVCNFA01|3157003FQSSGS9OZ9E01|3157004PTVTDOKB46401|3157004R6CH6C1P4KX00|3157005RUI28M8FANK00|3157005VJE7A3MBUS201|3157005WT1SENAE17R00|31570058O0Z320C4GZ00|3157006B6JVZ5DFMSN00|3157006DE3SPNIUY9K01|3157006FR3JBBOLOMX01|3157006I3B6RSTPQLI00|3157006KT1EZ15OIXW00|315700659AALVVLVIO01|31570067WSCDST0S3F01|3157008VKYORMUNC5O01|3157008ZY7CW6LVU5J00|3157009FTHFDDK7FHW01|3157009OVCV07O4HXM00|315700T8U7IU4W8J3A01|315700BBRQHDWX6SHZ00|3157008KD17KROO7UT01)$"
 
-leiLexicalPattern = re.compile(r"^[0-9A-Z]{18}[0-9]{2}$")
+# Turn the _validLeiDespiteChecksumFailPattern in to an immutable set as that is much faster to check
+_validLeiDespiteChecksumFailSet = frozenset(
+    _validLeiDespiteChecksumFailPatternString[2:-2].split("|")
+)
 
-validInvalidLeiPattern = re.compile("^(029200720E3M3A4D6D01|029200758D5M0AI3F601|315700X8JQ3IU0NGK501|3157007SCCESQAUH5Z01|315700TCC9NTEP7J8Z01|13250000000000000301|315700ADOXDR5PCY5400|315700A0UB9Q7DOQIZ00|315700BM9Z39TNTGQW00|315700BZ5F7DRYG2UM00|315700B8401GTFFY6X01|315700DJ07P6OX10FK01|315700DKCD4QSKLAMO01|315700D23JL5C1DZNT00|315700EIYO2TLSEGQ700|315700ET7M7VQ4C84R00|315700EZSEA51937KX01|315700GXBGM8DBYKHF01|315700GZA843JXKTJ400|315700G5G24XYL1TXH00|315700HS7WJ1B0SUWM01|315700HXOEOK58E58P01|315700HZU4SMI8LZTU00|315700I3W2AFHP8MNQ01|315700JICZ3SY5SAXX00|315700JKZH6I0067ND01|315700JO5E28SRE00Q01|315700JXUHL9H2C3P700|315700LDDN3RM7Y2MP00|315700LWYOZNQ7V1T100|315700MBYPT6PGKO7M01|315700MW2F0KFR45QW01|315700M5843O6DU83901|315700NNMGS8F3P2CN00|315700N0VEIBHP0NPQ01|315700OASRCM664PAW01|315700OFW4YCOBNX4U01|315700OVW93X0T3HP200|315700O666JVNCQU9X00|315700PLI0I7W8IOV400|315700PN3J57ZUNF1V00|315700PXKOSX7WQV4N00|315700P4N9VSLK5QZV01|315700P40OV6BT045900|315700P6TZOLP92KN801|315700P89WR82VNB8Z00|315700QGM4XWZE1I5N01|315700Q1S8O1UORF9700|315700RK8M4FAHMYAP01|315700RTEHY362KXWJ00|315700SNUXK41WMW5J00|315700S22RGYRIEEOT00|315700S3TF79ALV82F01|315700TF5Z7T28HZJK01|315700TWGZ89LLSRS000|315700TXNX10N8XH4K00|315700T2EEQAPBO0C301|315700T6T49EDM16YO01|315700UJ6N4LGKLNPB00|315700UKZXWXEO126601|315700UYFD5GF9R13F01|315700VG7PTE9EJJRX01|315700VITYR7AL4M9S01|315700VMAJZ9JZTXNQ00|315700WH3YMKHCVYW201|315700WKCDF4QGRRO200|315700WR4IHOO1M5LP00|315700WYOZ6994UATN00|315700WZPEIS41QDKE00|315700XEFYMA5EZ0P500|315700XE21UYOA3GAC01|315700XI4Z8GF5BDUJ01|315700XSCP1S8WOD8E01|315700X40GNCOUWJYR00|315700YS6RQ5TF3VBP01|315700Y1W7W1JHAUBW00|315700Y5JNQMMUF5ID01|3157000VAJWZ3P8ZED00|3157001KM8GOU7PXZY01|3157001K2LAL04D87901|3157001MLDD3SDFQA901|3157001TPR6K4GBTLN00|31570010000000006400|31570010000000009601|31570010000000019301|31570010000000025800|31570010000000029001|31570010000000035500|31570010000000038701|31570010000000045200|31570010000000048401|31570010000000054900|31570010000000064600|31570010000000067801|31570010000000077501|31570010000000084000|31570010000000087201|31570010000000096901|31570010000000103400|31570010000000106601|31570010000000116301|31570010000000122800|31570010000000126001|3157002CKDQOCIHE5H01|31570020000000005900|31570029808HJVCNFA01|3157003FQSSGS9OZ9E01|3157004PTVTDOKB46401|3157004R6CH6C1P4KX00|3157005RUI28M8FANK00|3157005VJE7A3MBUS201|3157005WT1SENAE17R00|31570058O0Z320C4GZ00|3157006B6JVZ5DFMSN00|3157006DE3SPNIUY9K01|3157006FR3JBBOLOMX01|3157006I3B6RSTPQLI00|3157006KT1EZ15OIXW00|315700659AALVVLVIO01|31570067WSCDST0S3F01|3157008VKYORMUNC5O01|3157008ZY7CW6LVU5J00|3157009FTHFDDK7FHW01|3157009OVCV07O4HXM00|315700T8U7IU4W8J3A01|315700BBRQHDWX6SHZ00|3157008KD17KROO7UT01)$")
 
-def checkLei(lei: str) -> int:
-    if validInvalidLeiPattern.match(lei):
-        return LEI_VALID
-    if not leiLexicalPattern.match(lei):
-        return LEI_INVALID_LEXICAL
-    if not int(
-        "".join({"0":"0", "1":"1", "2":"2", "3":"3", "4":"4", "5":"5", "6":"6", "7":"7", "8":"8", "9":"9",
-                 "A":"10", "B":"11", "C":"12", "D":"13", "E":"14", "F":"15", "G":"16", "H":"17", "I":"18",
-                 "J":"19", "K":"20", "L":"21", "M":"22", "N":"23", "O":"24", "P":"25", "Q":"26", "R":"27",
-                 "S":"28", "T":"29", "U":"30", "V":"31", "W":"32", "X":"33", "Y":"34", "Z":"35"
-                 }[c] for c in lei)
-               ) % 97 == 1:
-        return LEI_INVALID_CHECKSUM
-    return LEI_VALID
+def checkLei(lei: str) -> LEIValidationResult:
+    if len(lei) != _requiredLEILength:
+        return LEIValidationResult.INVALID_LEXICAL
+
+    if not _leiLexicalPattern.fullmatch(lei):
+        return LEIValidationResult.INVALID_LEXICAL
+
+    result = LEIValidationResult.INVALID_CHECKSUM
+
+    if int(lei.translate(_leiToDigitTable)) % 97 == 1:
+        result = LEIValidationResult.VALID
+
+    if (
+        result is LEIValidationResult.INVALID_CHECKSUM
+        and lei in _validLeiDespiteChecksumFailSet
+    ):
+        result = LEIValidationResult.VALID
+
+    return result
+
 
 if __name__ == "__main__":
-    # test cases
-    for lei, name in (
-                        ("001GPB6A9XPE8XJICC14", "Fidelity Advisor Series I"),
-                        ("004L5FPTUREIWK9T2N63", "Hutchin Hill Capital, LP"),
-                        ("00EHHQ2ZHDCFXJCPCL46", "Vanguard Russell 1000 Growth Index Trust"),
-                        ("00GBW0Z2GYIER7DHDS71", "Aristeia Capital, L.L.C."),
-                        ("1S619D6B3ZQIH6MS6B47", "Barclays Vie SA"),
-                        ("21380014JAZAUFJRHC43", "BRE/OPERA HOLDINGS"),
-                        ("21380016W7GAG26FIJ74", "SOCIETE FRANCAISE ET SUISSE"),
-                        ("21380058ERUIT9H53T71", "TOTAN ICAP CO., LTD"),
-                        ("213800A9GT65GAES2V60", "BARCLAYS SECURITIES JAPAN LIMITED"),
-                        ("213800DELL1MWFDHVN53", "PIRELLI JAPAN"),
-                        ("213800A9GT65GAES2V60", "BARCLAYS SECURITIES JAPAN LIMITED"),
-                        ("214800A9GT65GAES2V60", "Error 1"),
-                        ("213800A9GT65GAE%2V60", "Error 2"),
-                        ("213800A9GT65GAES2V62", "Error 3"),
-                        ("1234", "Error 4"),
-                        ("""
-5299003M8JKHEFX58Y02""", "Error 4")
-                        ):
-            print ("LEI {} result {} name {}".format(lei, LEI_RESULTS[checkLei(lei)], name)  )
+    import sys
+
+    leis = sys.argv[1:]
+    if not leis:
+        raise SystemExit("Specify the LEI(s) you want to check as arguments.")
+
+    for arg in sys.argv[1:]:
+        print(f"{arg:20s} : {checkLei(arg).description()}")

arelle/ModelDocument.py

@@ -446,7 +446,7 @@ def loadSchemalocatedSchema(modelXbrl, element, relativeUrl, namespace, baseUrl)
             doc.inDTS = False
     return doc
 
-def create(modelXbrl, type, uri, schemaRefs=None, isEntry=False, initialXml=None, initialComment=None, base=None, discover=True, documentEncoding="utf-8", xbrliNamespacePrefix=None) -> ModelDocument:
+def create(modelXbrl, type, uri, schemaRefs=None, isEntry=False, initialXml=None, initialComment=None, base=None, discover=True, documentEncoding="utf-8", xbrliNamespacePrefix=None, entrypoint=None) -> ModelDocument:
     """Returns a new modelDocument, created from scratch, with any necessary header elements
 
     (such as the schema, instance, or RSS feed top level elements)
@@ -538,6 +538,7 @@ def create(modelXbrl, type, uri, schemaRefs=None, isEntry=False, initialXml=None
         modelDocument.isQualifiedElementFormDefault = False
         modelDocument.isQualifiedAttributeFormDefault = False
     modelDocument.definesUTR = False
+    modelDocument.entrypoint = entrypoint
     return modelDocument
 
 class Type:
@@ -727,10 +728,12 @@ class ModelDocument:
     # The document encoding. The XML declaration is stripped from the document
     # before lxml parses the document making the lxml DocInfo encoding unreliable.
     documentEncoding: str
+    entrypoint: dict[str, Any] | None
     xmlRootElement: Any
     targetXbrlRootElement: ModelObject
 
     def __init__(self, modelXbrl, type, uri, filepath, xmlDocument):
+        self.entrypoint = None
         self.modelXbrl = modelXbrl
         self.skipDTS = modelXbrl.skipDTS
         self.type = type
@@ -1579,12 +1582,6 @@ def inlineIxdsDiscover(modelXbrl, modelIxdsDocument, setTargetModelXbrl=False, *
     modelXbrl.targetRoleRefs = {} # roleRefs used by selected target
     modelXbrl.targetArcroleRefs = {}  # arcroleRefs used by selected target
     modelXbrl.targetRelationships = set() # relationship elements used by selected target
-    targetModelXbrl = modelXbrl if setTargetModelXbrl else None # modelXbrl of target for contexts/units in multi-target/multi-instance situation
-    assignUnusedContextsUnits = (not setTargetModelXbrl and not ixdsTarget and
-                                 not getattr(modelXbrl, "supplementalModelXbrls", ()) and (
-                                    not getattr(modelXbrl, "targetIXDSesToLoad", ()) or
-                                    set(e.modelDocument for e in modelXbrl.ixdsHtmlElements) ==
-                                    set(x.modelDocument for e in getattr(modelXbrl, "targetIXDSesToLoad", ()) for x in e[1])))
     hasResources = hasHeader = False
     for htmlElement in modelXbrl.ixdsHtmlElements:
         mdlDoc = htmlElement.modelDocument
@@ -1611,8 +1608,12 @@ def inlineIxdsDiscover(modelXbrl, modelIxdsDocument, setTargetModelXbrl=False, *
         for modelInlineFact in htmlElement.iterdescendants(ixNStag + "nonNumeric", ixNStag + "nonFraction", ixNStag + "fraction"):
             if isinstance(modelInlineFact,ModelObject):
                 _target = modelInlineFact.get("target")
-                factTargetContextRefs[_target].add(modelInlineFact.get("contextRef"))
-                factTargetUnitRefs[_target].add(modelInlineFact.get("unitRef"))
+                contextRef = modelInlineFact.get("contextRef")
+                if contextRef is not None:
+                    factTargetContextRefs[_target].add(contextRef.strip())
+                unitRef = modelInlineFact.get("unitRef")
+                if unitRef is not None:
+                    factTargetUnitRefs[_target].add(unitRef.strip())
                 if modelInlineFact.id:
                     factsByFactID[modelInlineFact.id] = modelInlineFact
         for elt in htmlElement.iterdescendants(tag=ixNStag + "continuation"):
@@ -1734,9 +1735,9 @@ def inlineIxdsDiscover(modelXbrl, modelIxdsDocument, setTargetModelXbrl=False, *
                     targetRoleUris[_target].add(footnoteRole)
 
     contextRefs = factTargetContextRefs[ixdsTarget]
+    contextRefsForAllTargets = {ref for refs in factTargetContextRefs.values() for ref in refs}
     unitRefs = factTargetUnitRefs[ixdsTarget]
-    allContextRefs = set.union(*factTargetContextRefs.values())
-    allUnitRefs = set.union(*factTargetUnitRefs.values())
+    unitRefsForAllTargets = {ref for refs in factTargetUnitRefs.values() for ref in refs}
 
     # discovery of contexts, units and roles which are used by target document
     for htmlElement in modelXbrl.ixdsHtmlElements:
@@ -1745,13 +1746,17 @@ def inlineIxdsDiscover(modelXbrl, modelIxdsDocument, setTargetModelXbrl=False, *
 
         for inlineElement in htmlElement.iterdescendants(tag=ixNStag + "resources"):
             for elt in inlineElement.iterchildren("{http://www.xbrl.org/2003/instance}context"):
-                id = elt.get("id")
-                if id in contextRefs or (assignUnusedContextsUnits and id not in allContextRefs):
+                contextId = elt.get("id")
+                if contextId in contextRefs:
                     modelIxdsDocument.contextDiscover(elt, setTargetModelXbrl)
+                elif contextId not in contextRefsForAllTargets:
+                    modelXbrl.ixdsUnmappedContexts[contextId] = elt
             for elt in inlineElement.iterchildren("{http://www.xbrl.org/2003/instance}unit"):
-                id = elt.get("id")
-                if id in unitRefs or (assignUnusedContextsUnits and id not in allUnitRefs):
+                unitId = elt.get("id")
+                if unitId in unitRefs:
                     modelIxdsDocument.unitDiscover(elt, setTargetModelXbrl)
+                elif unitId not in unitRefsForAllTargets:
+                    modelXbrl.ixdsUnmappedUnits[unitId] = elt
             for refElement in inlineElement.iterchildren("{http://www.xbrl.org/2003/linkbase}roleRef"):
                 r = refElement.get("roleURI")
                 if r in targetRoleUris[ixdsTarget]:

arelle/ModelDtsObject.py

@@ -1690,6 +1690,7 @@ class RelationStatus:
     INEFFECTIVE = 4
 
 arcCustAttrsExclusions = {XbrlConst.xlink, "use","priority","order","weight","preferredLabel"}
+modelObjectAttrs = frozenset(dir(ModelObject))
 
 class ModelRelationship(ModelObject):
     """
@@ -2014,6 +2015,7 @@ class ModelRelationship(ModelObject):
     @property
     def equivalenceHash(self): # not exact, use equivalenceKey if hashes are the same
         return hash((self.qname,
+                     self.arcrole,
                      self.linkQname,
                      self.linkrole,  # needed when linkrole=None merges multiple links
                      self.fromModelObject.objectIndex if isinstance(self.fromModelObject, ModelObject) else -1,
@@ -2027,6 +2029,7 @@ class ModelRelationship(ModelObject):
         """(tuple) -- Key to determine relationship equivalence per 2.1 spec"""
         # cannot be cached because this is unique per relationship
         return (self.qname,
+                self.arcrole,
                 self.linkQname,
                 self.linkrole,  # needed when linkrole=None merges multiple links
                 self.fromModelObject.objectIndex if isinstance(self.fromModelObject, ModelObject) else -1,
@@ -2086,6 +2089,11 @@ class ModelRelationship(ModelObject):
                         self.toModelObject.qname if isinstance(self.toModelObject, ModelObject) else "??",
                         self.modelDocument.basename, self.sourceline))
 
+    def __dir__(self):
+        # Ignore ModelObject attributes because most relate to the underlying lxml element,
+        # which ModelRelationship does not have.
+        return [a for a in object.__dir__(self) if a.startswith('__') or a not in modelObjectAttrs]
+
     @property
     def viewConcept(self):
         if isinstance(self.toModelObject, ModelConcept):

arelle/ModelInstanceObject.py

@@ -1159,7 +1159,7 @@ class ModelContext(ModelObject):
             self._dimsHash = hash( frozenset(self.qnameDims.values()) )
             return self._dimsHash
 
-    def nonDimValues(self, contextElement):
+    def nonDimValues(self, contextElement: str | int) -> list[ModelObject]:
         """([ModelObject]) -- ContextElement is either string or Aspect code for segment or scenario, returns nonXDT ModelObject children of context element.
 
         :param contextElement: one of 'segment', 'scenario', Aspect.NON_XDT_SEGMENT, Aspect.NON_XDT_SCENARIO, Aspect.COMPLETE_SEGMENT, Aspect.COMPLETE_SCENARIO

arelle/ModelObject.py

@@ -8,7 +8,6 @@ from lxml import etree
 from arelle import Locale
 from arelle import ModelValue
 from arelle.XmlValidateConst import VALID_NO_CONTENT
-from arelle.model import CommentBase, ElementBase, PIBase
 
 if TYPE_CHECKING:
     from arelle.ModelDocument import ModelDocument
@@ -21,7 +20,7 @@ if TYPE_CHECKING:
     from arelle.ModelInstanceObject import ModelInlineFootnote
     from arelle.ModelInstanceObject import ModelInlineFact
     from arelle.ModelInstanceObject import ModelDimensionValue
-    from arelle.ModelValue import qname, qnameEltPfxName, QName, TypeSValue, TypeXValue
+    from arelle.ModelValue import QName, TypeSValue, TypeXValue
 
 XmlUtil: Any = None
 
@@ -32,7 +31,7 @@ def init() -> None: # init globals
     if XmlUtil is None:
         from arelle import XmlUtil
 
-class ModelObject(ElementBase):
+class ModelObject(etree.ElementBase):
     """ModelObjects represent the XML elements within a document, and are implemented as custom
     lxml proxy objects.  Each modelDocument has a parser with the parser objects in ModelObjectFactory.py,
     to determine the type of model object to correspond to a proxied lxml XML element.
@@ -117,6 +116,7 @@ class ModelObject(ElementBase):
     xValueError: Exception | None
     xValid: int
     xlinkLabel: str
+    tag: str
     targetModelXbrl: ModelXbrl
 
     def _init(self) -> None:
@@ -125,9 +125,9 @@ class ModelObject(ElementBase):
         if parent is not None and hasattr(parent, "modelDocument"):
             self.init(parent.modelDocument)
 
-    def clear(self) -> None:
+    def clear(self, keep_tail: bool = False) -> None:
         self.__dict__.clear()  # delete local attributes
-        super(ModelObject, self).clear()  # delete children
+        super().clear(keep_tail)  # delete children
 
     def init(self, modelDocument: ModelDocument) -> None:
         self.modelDocument = modelDocument
@@ -160,9 +160,10 @@ class ModelObject(ElementBase):
         return emptySet
 
     def setNamespaceLocalName(self) -> None:
-        ns, sep, self._localName = self.tag.rpartition("}")
+        tag = self.tag
+        ns, sep, self._localName = tag.rpartition("}")
         if sep:
-            self._namespaceURI = ns[1:]
+            self._namespaceURI: str | None = ns[1:]
         else:
             self._namespaceURI = None
         if self.prefix:
@@ -257,7 +258,7 @@ class ModelObject(ElementBase):
             return self._parentQname
         except AttributeError:
             parentObj = self.getparent()
-            self._parentQname = parentObj.elementQname if parentObj is not None else None  # type: ignore[attr-defined]
+            self._parentQname = parentObj.elementQname if parentObj is not None else None
             return self._parentQname
 
 
@@ -267,18 +268,18 @@ class ModelObject(ElementBase):
 
     @property
     def stringValue(self) -> str:    # "string value" of node, text of all Element descendants
-        return ''.join(self._textNodes(recurse=True))  # return text of Element descendants
+        return ''.join(self.textNodes(recurse=True))  # return text of Element descendants
 
     @property
     def textValue(self) -> str:  # xml axis text() differs from string value, no descendant element text
-        return ''.join(self._textNodes())  # no text nodes returns ''
+        return ''.join(self.textNodes())  # no text nodes returns ''
 
-    def _textNodes(self, recurse:bool = False) ->  Generator[str | Any, None, None]:
+    def textNodes(self, recurse:bool = False) ->  Generator[str | Any, None, None]:
         if self.text and getattr(self,"xValid", 0) != VALID_NO_CONTENT: # skip tuple whitespaces
                 yield self.text
         for c in self.iterchildren():
             if recurse and isinstance(c, ModelObject):
-                for nestedText in c._textNodes(recurse):
+                for nestedText in c.textNodes(recurse):
                     yield nestedText
             if c.tail and getattr(self,"xValid", 0) != VALID_NO_CONTENT: # skip tuple whitespaces
                 yield c.tail  # get tail of nested element, comment or processor nodes
@@ -305,10 +306,7 @@ class ModelObject(ElementBase):
 
     @property
     def elementAttributesStr(self) -> str:
-        # Note 2022-09-09:
-        # Mypy raises the following error. Not sure why this is the case, this returns a str not binary data?
-        # On Python 3 formatting "b'abc'" with "{}" produces "b'abc'", not "abc"; use "{!r}" if this is desired behavior
-        return ', '.join(["{0}='{1}'".format(name, value) for name, value in self.items()]) # type: ignore[str-bytes-safe]
+        return ', '.join(["{0}='{1}'".format(name, value) for name, value in self.items()])
 
     def resolveUri(
         self,
@@ -398,7 +396,7 @@ class ModelObject(ElementBase):
     def __repr__(self) -> str:
         return ("{0}[{1}, {2} line {3})".format(type(self).__name__, self.objectIndex, self.modelDocument.basename, self.sourceline))
 
-class ModelComment(CommentBase): # type: ignore[misc]
+class ModelComment(etree.CommentBase):
     """ModelConcept is a custom proxy objects for etree.
     """
     def _init(self) -> None:
@@ -410,7 +408,7 @@ class ModelComment(CommentBase): # type: ignore[misc]
     def init(self, modelDocument: ModelDocument) -> None:
         self.modelDocument = modelDocument
 
-class ModelProcessingInstruction(PIBase): # type: ignore[misc]
+class ModelProcessingInstruction(etree.PIBase):
     """ModelProcessingInstruction is a custom proxy object for etree.
     """
     def _init(self) -> None: