arelle-release 2.37.58__py3-none-any.whl → 2.37.59__py3-none-any.whl

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/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '2.37.58'
-__version_tuple__ = version_tuple = (2, 37, 58)
+__version__ = version = '2.37.59'
+__version_tuple__ = version_tuple = (2, 37, 59)
 
 __commit_id__ = commit_id = None

arelle/plugin/validate/EDINET/__init__.py

@@ -22,6 +22,8 @@ RELEVELER_MAP: dict[str, dict[str, tuple[str, str | None]]] = {
         "xbrl.4.8.2:sharesFactUnit-notSharesMeasure": ("ERROR", None),
         # Silence, duplicated by EDINET.EC5002E
         "xbrl.4.8.2:sharesFactUnit-notSingleMeasure": ("ERROR", None),
+        # Silence, duplicated by EDINET.EC5700W.GFM.1.7.2
+        "xbrl.5.2.5.2.1:zeroWeight": ("ERROR", None),
     },
 }
 

arelle/plugin/validate/EDINET/rules/gfm.py

@@ -10,6 +10,7 @@ from typing import Any, cast, Iterable
 import regex
 
 from arelle import XbrlConst, XmlUtil
+from arelle.LinkbaseType import LinkbaseType
 from arelle.ModelDtsObject import ModelConcept
 from arelle.ModelInstanceObject import ModelFact
 from arelle.ModelObject import ModelObject
@@ -970,3 +971,239 @@ def rule_gfm_1_5_10(
                     labelrole=label.role,
                     modelObject=label
                 )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_gfm_1_6_1(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC5700W: [GFM 1.6.1] All presentation relationships must have an order attribute
+    """
+    presentationRelationshipSet = val.modelXbrl.relationshipSet(tuple(LinkbaseType.PRESENTATION.getArcroles()))
+    if presentationRelationshipSet is None:
+        return
+    for rel in presentationRelationshipSet.modelRelationships:
+        if not rel.arcElement.get("order"):
+            yield Validation.warning(
+                codes='EDINET.EC5700W.GFM.1.6.1',
+                msg=_("The presentation relationship is missing the order attribute"),
+                modelObject=rel
+            )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_gfm_1_6_2(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC5700W: [GFM 1.6.2] Presentation relationships must have unique order attributes
+    """
+    presentationRelationshipSet = val.modelXbrl.relationshipSet(tuple(LinkbaseType.PRESENTATION.getArcroles()))
+    if presentationRelationshipSet is None:
+        return
+    for modelObject, rels in presentationRelationshipSet.fromModelObjects().items():
+        if len(rels) <= 1:
+            continue
+        relsByOrder = defaultdict(list)
+        for rel in rels:
+            order = rel.arcElement.get("order")
+            if order is not None:
+                relsByOrder[(order, rel.linkrole)].append(rel)
+        for key, orderRels in relsByOrder.items():
+            if len(orderRels) > 1:
+                yield Validation.warning(
+                    codes='EDINET.EC5700W.GFM.1.6.2',
+                    msg=_("The presentation relationships have the same order attribute: '%(order)s'"),
+                    order=key[0],
+                    modelObject=orderRels
+                )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_gfm_1_6_5(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC5700W: [GFM 1.6.5] If an element used in an instance is the target in the instance DTS of more than one
+                                effective presentation arc in a base set with the same source element, then the
+                                presentation arcs must have distinct values of the preferredLabel attribute.
+    """
+    presentationRelationshipSet = val.modelXbrl.relationshipSet(tuple(LinkbaseType.PRESENTATION.getArcroles()))
+    if presentationRelationshipSet is None:
+        return
+    for modelObject, rels in presentationRelationshipSet.toModelObjects().items():
+        if len(rels) <= 1:
+            continue
+        relsByFrom = defaultdict(list)
+        for rel in rels:
+            relsByFrom[(rel.fromModelObject, rel.preferredLabel, rel.linkrole)].append(rel)
+        for key, fromRels in relsByFrom.items():
+            if len(fromRels) > 1:
+                yield Validation.warning(
+                    codes='EDINET.EC5700W.GFM.1.6.5',
+                    msg=_("The presentation relationships must have distinct values of the preferredLabel attribute "
+                          "when they have the same source and target elements"),
+                    modelObject=fromRels
+                )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_gfm_1_7_1(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC5700W: [GFM 1.7.1] All calculation relationships must have an order attribute
+    """
+    calculationRelationshipSet = val.modelXbrl.relationshipSet(tuple(LinkbaseType.CALCULATION.getArcroles()))
+    if calculationRelationshipSet is None:
+        return
+    for rel in calculationRelationshipSet.modelRelationships:
+        if not rel.arcElement.get("order"):
+            yield Validation.warning(
+                codes='EDINET.EC5700W.GFM.1.7.1',
+                msg=_("The calculation relationship is missing the order attribute"),
+                modelObject=rel
+            )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_gfm_1_7_2(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC5700W: [GFM 1.7.2] All calculation relationships must have a weight of either 1 or -1
+    """
+    calculationRelationshipSet = val.modelXbrl.relationshipSet(tuple(LinkbaseType.CALCULATION.getArcroles()))
+    if calculationRelationshipSet is None:
+        return
+    for rel in calculationRelationshipSet.modelRelationships:
+        if rel.weight not in [1, -1]:
+            yield Validation.warning(
+                codes='EDINET.EC5700W.GFM.1.7.2',
+                msg=_("The calculation relationship must have a weight of 1 or -1, actual weight: '%(weight)s'"),
+                weight=rel.weight,
+                modelObject=rel
+            )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_gfm_1_7_3(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC5700W: [GFM 1.7.3] The concepts participating in a calculation relationship must have the same period type
+    """
+    calculationRelationshipSet = val.modelXbrl.relationshipSet(tuple(LinkbaseType.CALCULATION.getArcroles()))
+    if calculationRelationshipSet is None:
+        return
+    for rel in calculationRelationshipSet.modelRelationships:
+        fromConcept = rel.fromModelObject
+        toConcept = rel.toModelObject
+        if fromConcept is not None and toConcept is not None and fromConcept.periodType != toConcept.periodType:
+            yield Validation.warning(
+                codes='EDINET.EC5700W.GFM.1.7.3',
+                msg=_("The concepts participating in a calculation relationship must have the same period types. "
+                      "The concept of '%(concept1)s' has a period type of '%(concept1PeriodType)s' and the concept "
+                      "of '%(concept2)s' has a period type of '%(concept2PeriodType)s'"),
+                concept1=fromConcept.qname,
+                concept1PeriodType=fromConcept.periodType,
+                concept2=toConcept.qname,
+                concept2PeriodType=toConcept.periodType,
+                modelObject=rel
+            )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_gfm_1_7_6(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC5700W: [GFM 1.7.6] Calculation relationships must have unique order attributes
+    """
+    calculationRelationshipSet = val.modelXbrl.relationshipSet(tuple(LinkbaseType.CALCULATION.getArcroles()))
+    if calculationRelationshipSet is None:
+        return
+    for modelObject, rels in calculationRelationshipSet.fromModelObjects().items():
+        if len(rels) <= 1:
+            continue
+        relsByOrder = defaultdict(list)
+        for rel in rels:
+            order = rel.arcElement.get("order")
+            if order is not None:
+                relsByOrder[(order, rel.linkrole)].append(rel)
+        for key, orderRels in relsByOrder.items():
+            if len(orderRels) > 1:
+                yield Validation.warning(
+                    codes='EDINET.EC5700W.GFM.1.7.6',
+                    msg=_("The calculation relationships have the same order attribute: '%(order)s'"),
+                    order=key[0],
+                    modelObject=orderRels
+                )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_gfm_1_8_1(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC5700W: [GFM 1.8.1] All definition relationships must have an order attribute
+    """
+    definitionRelationshipSet = val.modelXbrl.relationshipSet(tuple(LinkbaseType.DEFINITION.getArcroles()))
+    if definitionRelationshipSet is None:
+        return
+    for rel in definitionRelationshipSet.modelRelationships:
+        if not rel.arcElement.get("order"):
+            yield Validation.warning(
+                codes='EDINET.EC5700W.GFM.1.8.1',
+                msg=_("The definition relationship is missing the order attribute"),
+                modelObject=rel
+            )

arelle/plugin/validate/UK/ValidateUK.py

@@ -25,6 +25,7 @@ CO_AUDIT = 'Co.Audit'
 CO_AUDIT_NR = 'Co.AuditNR'
 CO_DIR_REP = 'Co.DirReport'
 CO_DIR_RESP = 'Co.DirResp'
+CO_GROUP = 'Co.Group'
 CO_MED_CO = 'Co.MedCo'
 CO_MICRO = 'Co.Micro'
 CO_MISSING_ELEMENT = 'Co.MissingElement'
@@ -35,6 +36,7 @@ CO_SEC_477 = 'Co.Sec477'
 CO_SEC_480 = 'Co.Sec480'
 LP_ABRID = 'Lp.Abrid'
 LP_AUDIT = 'Lp.Audit'
+LP_GROUP = 'Lp.Group'
 LP_MED_LP = 'Lp.MedLp'
 LP_MEM_RESP = 'Lp.MemResp'
 LP_MICRO = 'Lp.Micro'
@@ -57,19 +59,23 @@ CONCEPT_ACCOUNTS_STATUS_DIMENSION = 'AccountsStatusDimension'
 CONCEPT_ACCOUNTS_TYPE_FULL_OR_ABBREVIATED = 'AccountsTypeFullOrAbbreviated'  # DEPRECATED IN 2022+ taxonomies.  No replacement yet.
 CONCEPT_ACCOUNTS_TYPE_DIMENSION = 'AccountsTypeDimension'
 CONCEPT_ADVERSE_OPINION = 'AdverseOpinion'
+CONCEPT_BALANCE_SHEET_DATE = 'BalanceSheetDate'
 CONCEPT_CHARITY_FUNDS = 'CharityFunds'
 CONCEPT_CHARITY_REGISTRATION_NUMBER_ENGLAND_WALES = 'CharityRegistrationNumberEnglandWales'
 CONCEPT_CHARITY_REGISTRATION_NUMBER_NORTH_IRELAND = 'CharityRegistrationNumberNorthernIreland'
 CONCEPT_CHARITY_REGISTRATION_NUMBER_SCOTLAND = 'CharityRegistrationNumberScotland'
+CONCEPT_CONSOLIDATED = 'Consolidated'
 CONCEPT_DATE_AUDITOR_REPORT = 'DateAuditorsReport'
 CONCEPT_DATE_CHARITY_AUDITORS_REPORT = 'DateCharityAuditorsReport'
 CONCEPT_DATE_SIGNING_DIRECTOR_REPORT = 'DateSigningDirectorsReport'
 CONCEPT_DATE_SIGNING_TRUSTEES_REPORT = 'DateSigningTrusteesAnnualReport'
 CONCEPT_DIRECTOR_SIGNING_DIRECTORS_REPORT = 'DirectorSigningDirectorsReport'
 CONCEPT_DISCLAIMER_OPINION = 'DisclaimerOpinion'
+CONCEPT_END_DATE_FOR_PERIOD_COVERED_BY_REPORT = 'EndDateForPeriodCoveredByReport'
 CONCEPT_ENTITY_DORMANT = 'EntityDormantTruefalse'
 CONCEPT_ENTITY_TRADING_STATUS = 'EntityTradingStatus'
 CONCEPT_ENTITY_TRADING_STATUS_DIMENSION = 'EntityTradingStatusDimension'
+CONCEPT_GROUP_COMPANY_DATA_DIMENSION = 'GroupCompanyDataDimension'
 CONCEPT_LANGUAGES_DIMENSION = 'LanguagesDimension'
 CONCEPT_MEDIUM_COMPANY = 'StatementThatCompanyHasPreparedAccountsUnderProvisionsRelatingToMedium-sizedCompanies'
 CONCEPT_MEDIUM_COMPANIES_REGIME_FOR_ACCOUNTS = 'Medium-sizedCompaniesRegimeForAccounts'
@@ -646,6 +652,39 @@ class ValidateUK:
             )
         return CodeResult()
 
+    def _evaluateGroupFacts(self) -> CodeResult:
+        """
+        BalanceSheetDate with GroupCompanyDataDimension and Consolidated must equal BalanceSheetDate with default
+        dimensions. Both facts must be non-nil.
+        """
+        consolidatedFact = None
+        defaultFact = None
+        endDateFact = None
+        for fact in self._getFacts(CONCEPT_END_DATE_FOR_PERIOD_COVERED_BY_REPORT):
+            if not fact.context.qnameDims:
+                endDateFact = fact
+                break
+        if endDateFact is None:
+            return CodeResult()
+        for balanceSheetDateFact in self._getFacts(CONCEPT_BALANCE_SHEET_DATE):
+            if self._checkValidFact(balanceSheetDateFact):
+                if not balanceSheetDateFact.context.qnameDims and balanceSheetDateFact.context.instantDate == endDateFact.context.instantDate:
+                    defaultFact = balanceSheetDateFact
+                for qname, value in balanceSheetDateFact.context.qnameDims.items():
+                    if value.xValid < VALID:
+                        continue
+                    if qname.localName == CONCEPT_GROUP_COMPANY_DATA_DIMENSION and cast(str, value.xValue.localName) == CONCEPT_CONSOLIDATED:
+                        consolidatedFact = balanceSheetDateFact
+                        break
+        if consolidatedFact is None or defaultFact is None or consolidatedFact.xValue != defaultFact.xValue:
+            return CodeResult(
+                conceptLocalName=CONCEPT_BALANCE_SHEET_DATE,
+                success=False,
+                message="A fact tagged with BalanceSheetDate with the dimension of GroupCompanyDataDimension/Consolidated "
+                        "must equal a fact tagged with BalanceSheetDate with the default dimension."
+            )
+        return CodeResult()
+
     def _evaluateCode(self, code: str) -> CodeResult:
         """
         Evaluates whether the conditions associated with the given code pass.
@@ -667,6 +706,8 @@ class ValidateUK:
             result = self._evaluateProfLossOrCharityFundsFact(code)
         elif code == CH_AUDIT:
             result = self._evaluateCharAuditFacts()
+        elif code in (CO_GROUP, LP_GROUP):
+            result = self._evaluateGroupFacts()
         return self._setCode(code, result)
 
     def _getFacts(self, conceptLocalName: str) -> list[ModelFact]:
@@ -831,6 +872,14 @@ class ValidateUK:
                     self.validateAuditedOtherLLP()
                 else:
                     self.validateAuditedOtherCompany()
+            elif self.scopeAccounts in {
+                ScopeAccounts.GROUP_ONLY.value,
+                ScopeAccounts.CONSOLIDATED_GROUP.value,
+            }:
+                if self.legalFormEntity == CONCEPT_LLP:
+                    self.validateAuditedGroupLLP()
+                else:
+                    self.validateAuditedGroupCompany()
 
     def validateCharities(self) -> None:
         """
@@ -1271,3 +1320,53 @@ class ValidateUK:
         result = self._evaluateCode(CO_SM_CO)
         if not result.success:
             self._errorOnMissingFactText(CO_SM_CO, result)
+
+    def validateAuditedGroupCompany(self) -> None:
+        """
+        Checks conditions applicable to audited group companies:
+        Co.Audit AND ((Co.DirReport AND Co.ProfLoss AND Co.Group) OR Co.SmCo).
+        """
+        result = self._evaluateCode(CO_AUDIT)
+        if not result.success:
+            self._yieldErrorOrWarning(CO_AUDIT, result)
+
+        result = self._evaluateCode(CO_SM_CO)
+        if not result.success:
+            failedOr = False
+            dirRepResult = self._evaluateCode(CO_DIR_REP)
+            if not dirRepResult.success:
+                self._yieldErrorOrWarning(CO_DIR_REP, dirRepResult)
+                failedOr = True
+            profLossResult = self._evaluateCode(CO_PROF_LOSS)
+            if not profLossResult.success:
+                self._yieldErrorOrWarning(CO_PROF_LOSS, profLossResult)
+                failedOr = True
+            groupResult = self._evaluateCode(CO_GROUP)
+            if not groupResult.success:
+                self._yieldErrorOrWarning(CO_GROUP, groupResult)
+                failedOr = True
+            if failedOr:
+                self._errorOnMissingFactText(CO_SM_CO, result)
+
+    def validateAuditedGroupLLP(self) -> None:
+        """
+        Checks conditions applicable to audited group companies:
+        LP.Audit AND ((LP.ProfLoss+LP.Group) OR LP.SmLp)
+        """
+        result = self._evaluateCode(LP_AUDIT)
+        if not result.success:
+            self._yieldErrorOrWarning(LP_AUDIT, result)
+
+        result = self._evaluateCode(LP_SM_LP)
+        if not result.success:
+            failedOr = False
+            profLossResult = self._evaluateCode(LP_PROF_LOSS)
+            if not profLossResult.success:
+                self._yieldErrorOrWarning(LP_PROF_LOSS, profLossResult)
+                failedOr = True
+            groupResult = self._evaluateCode(LP_GROUP)
+            if not groupResult.success:
+                self._yieldErrorOrWarning(LP_GROUP, groupResult)
+                failedOr = True
+            if failedOr:
+                self._errorOnMissingFactText(LP_SM_LP, result)

{arelle_release-2.37.58.dist-info → arelle_release-2.37.59.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: arelle-release
-Version: 2.37.58
+Version: 2.37.59
 Summary: An open source XBRL platform.
 Author-email: "arelle.org" <support@arelle.org>
 License-Expression: Apache-2.0

{arelle_release-2.37.58.dist-info → arelle_release-2.37.59.dist-info}/RECORD

@@ -32,7 +32,7 @@ arelle/FunctionXs.py,sha256=q0SA0e5wLRxH6kbNUOnChktcGVxaB7A6CE_O3nceysA,13163
 arelle/HashUtil.py,sha256=dS11q9UUUFzP7MgiuNdxFfvF3IpeyZUiOFxVFArEEWE,2963
 arelle/HtmlUtil.py,sha256=eXa6yF5xBCOODCuBMY7g8ePZHPOSu6X0gDsW3z9N50A,761
 arelle/InstanceAspectsEvaluator.py,sha256=TePNIs_m0vCIbN5N4PXEyJm529T2WBFi2zmv-72r3Zk,1805
-arelle/LeiUtil.py,sha256=tSPrbQrXEeH5pXgGA_6MAdgMZp20NaW5izJglIXyEQk,5095
+arelle/LeiUtil.py,sha256=yWbyU1Qnd81iYHLcyDi0I13GZkjaxCL04YVNQ6jqaP8,4698
 arelle/LinkbaseType.py,sha256=BwRQl4XZFFCopufC2FEMLhYENNTk2JUWVQvnIUsaqtI,3108
 arelle/LocalViewer.py,sha256=WVrfek_bLeFFxgWITi1EQb6xCQN8O9Ks-ZL16vRncSk,3080
 arelle/Locale.py,sha256=07IDxv8nIfvhyRRllFdEAKRI3yo1D2v781cTrjb_RoQ,33193
@@ -125,7 +125,7 @@ arelle/XmlValidateConst.py,sha256=U_wN0Q-nWKwf6dKJtcu_83FXPn9c6P8JjzGA5b0w7P0,33
 arelle/XmlValidateParticles.py,sha256=Mn6vhFl0ZKC_vag1mBwn1rH_x2jmlusJYqOOuxFPO2k,9231
 arelle/XmlValidateSchema.py,sha256=6frtZOc1Yrx_5yYF6V6oHbScnglWrVbWr6xW4EHtLQI,7428
 arelle/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-arelle/_version.py,sha256=DMtGvhO601kTygJwWMKYB_n05a0AM-s0DoCNqsyf8lE,708
+arelle/_version.py,sha256=OtIOO8dIBzaWUcN4ZpZMg03PbgyJW5ESDOu8koDT508,708
 arelle/typing.py,sha256=PRe-Fxwr2SBqYYUVPCJ3E7ddDX0_oOISNdT5Q97EbRM,1246
 arelle/api/Session.py,sha256=kgSxS7VckA1sQ7xp0pJiK7IK-vRxAdAZKUo8gEx27s8,7549
 arelle/config/creationSoftwareNames.json,sha256=5MK7XUjfDJ9OpRCCHXeOErJ1SlTBZji4WEcEOdOacx0,3128
@@ -324,7 +324,7 @@ arelle/plugin/validate/EDINET/ReportFolderType.py,sha256=Q-9a-5tJfhK-cjY8WUB2AT1
 arelle/plugin/validate/EDINET/Statement.py,sha256=0Mw5IB7LMtvUZ-2xKZfxmq67xF_dCgJo3eNLweLFRHU,9350
 arelle/plugin/validate/EDINET/UploadContents.py,sha256=o29mDoX48M3S2jQqrJO4ZaulltAPt4vD-qdsWTMCUPc,1196
 arelle/plugin/validate/EDINET/ValidationPluginExtension.py,sha256=8LNqvXzNaWP54dShEjet5ely4BnM8ByCSyimKpUx3_s,2577
-arelle/plugin/validate/EDINET/__init__.py,sha256=ECWgqzwHA7MZ3g7SeoFI7ttR9Wq_lywV-TlqeUW_juY,3186
+arelle/plugin/validate/EDINET/__init__.py,sha256=T_p2phcMw1lR4J1X4gvqJPEcZNJdJXtaPpc159A-3_8,3298
 arelle/plugin/validate/EDINET/resources/config.xml,sha256=7uT4GcRgk5veMLpFhPPQJxbGKiQvM52P8EMrjn0qd0g,646
 arelle/plugin/validate/EDINET/resources/cover-page-requirements.csv,sha256=8ILKNn8bXbcgG9V0lc8mxorKDKEjJQWLdBQRMvbqtkI,6518
 arelle/plugin/validate/EDINET/resources/edinet-taxonomies.xml,sha256=997I3RGTLg5OY3vn5hQxVFAAxOmDSOYpuyQe6VnWSY0,16285
@@ -332,7 +332,7 @@ arelle/plugin/validate/EDINET/rules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQ
 arelle/plugin/validate/EDINET/rules/contexts.py,sha256=KPoyWfRaURvxoGVcWP64mTMTAKPMSmQSX06RClCLddw,7590
 arelle/plugin/validate/EDINET/rules/edinet.py,sha256=g3IPMV5-mWbVwVmEwv5-h1LOtdfeBQ9gZI27m744FFw,12628
 arelle/plugin/validate/EDINET/rules/frta.py,sha256=N0YglHYZuLD2IuwE26viR2ViwUYjneBuMFU9vlrS0aQ,7616
-arelle/plugin/validate/EDINET/rules/gfm.py,sha256=-NHyo6QAkKoekAc5nLSpvSwQ0lImttoSD-_y1puK-y4,36741
+arelle/plugin/validate/EDINET/rules/gfm.py,sha256=BAcH_yVnJw3abMfsUBk_skZAjB96h-lff795OdnozvQ,45905
 arelle/plugin/validate/EDINET/rules/manifests.py,sha256=MoT9R_a4BzuYdQVbF7RC5wz134Ve68svSdJ3NlpO_AU,4026
 arelle/plugin/validate/EDINET/rules/upload.py,sha256=E_sEhsuUkoH648PGWwpN90uOQMjKNFaZ8priucmYMOk,47908
 arelle/plugin/validate/ESEF/Const.py,sha256=JujF_XV-_TNsxjGbF-8SQS4OOZIcJ8zhCMnr-C1O5Ho,22660
@@ -370,7 +370,7 @@ arelle/plugin/validate/ROS/config.xml,sha256=ZCpCFgr1ZAjoUuhb1eRpDnmKrae-sXA9yl6
 arelle/plugin/validate/ROS/resources/config.xml,sha256=HXWume5HlrAqOx5AtiWWqgADbRatA8YSfm_JvZGwdgQ,657
 arelle/plugin/validate/ROS/rules/__init__.py,sha256=wW7BUAIb7sRkOxC1Amc_ZKrz03FM-Qh1TyZe6wxYaAU,1567
 arelle/plugin/validate/ROS/rules/ros.py,sha256=CRZkZfsKe4y1B-PDkazQ_cD5LRZBk1GJjTscCZXXYUI,21173
-arelle/plugin/validate/UK/ValidateUK.py,sha256=h7-tnCubHme8Meaif-o55TV2rCfMWuikfpZCcK6NNDs,56447
+arelle/plugin/validate/UK/ValidateUK.py,sha256=UwNR3mhFzWNn6RKLSiC7j3LlMlConOx-9gWGovKamHA,61035
 arelle/plugin/validate/UK/__init__.py,sha256=GT67T_7qpOASzdmgRXFPmLxfPg3Gjubli7luQDK3zck,27462
 arelle/plugin/validate/UK/config.xml,sha256=mUFhWDfBzGTn7v0ZSmf4HaweQTMJh_4ZcJmD9mzCHrA,1547
 arelle/plugin/validate/UK/consistencyChecksByName.json,sha256=BgB9YAWzmcsX-_rU74RBkABwEsS75vrMlwBHsYCz2R0,25247
@@ -684,9 +684,9 @@ arelle/utils/validate/ValidationUtil.py,sha256=9vmSvShn-EdQy56dfesyV8JjSRVPj7txr
 arelle/utils/validate/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 arelle/webserver/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 arelle/webserver/bottle.py,sha256=P-JECd9MCTNcxCnKoDUvGcoi03ezYVOgoWgv2_uH-6M,362
-arelle_release-2.37.58.dist-info/licenses/LICENSE.md,sha256=Q0tn6q0VUbr-NM8916513NCIG8MNzo24Ev-sxMUBRZc,3959
-arelle_release-2.37.58.dist-info/METADATA,sha256=R7D4feFh8MfRYsXoyMrffu1IDXMxju2PLquC1Ht1H-0,9327
-arelle_release-2.37.58.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-arelle_release-2.37.58.dist-info/entry_points.txt,sha256=Uj5niwfwVsx3vaQ3fYj8hrZ1xpfCJyTUA09tYKWbzpo,111
-arelle_release-2.37.58.dist-info/top_level.txt,sha256=fwU7SYawL4_r-sUMRg7r1nYVGjFMSDvRWx8VGAXEw7w,7
-arelle_release-2.37.58.dist-info/RECORD,,
+arelle_release-2.37.59.dist-info/licenses/LICENSE.md,sha256=Q0tn6q0VUbr-NM8916513NCIG8MNzo24Ev-sxMUBRZc,3959
+arelle_release-2.37.59.dist-info/METADATA,sha256=wh7XkuU_1WbVuQhpnKA9ybkP_WlbD4eKla0WJ_2md1E,9327
+arelle_release-2.37.59.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+arelle_release-2.37.59.dist-info/entry_points.txt,sha256=Uj5niwfwVsx3vaQ3fYj8hrZ1xpfCJyTUA09tYKWbzpo,111
+arelle_release-2.37.59.dist-info/top_level.txt,sha256=fwU7SYawL4_r-sUMRg7r1nYVGjFMSDvRWx8VGAXEw7w,7
+arelle_release-2.37.59.dist-info/RECORD,,