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

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

@@ -6,7 +6,7 @@ from __future__ import annotations
 from collections import defaultdict
 from typing import Any, Iterable
 
-from arelle import XbrlConst
+from arelle import XbrlConst, ModelDocument
 from arelle.ModelDtsObject import ModelResource, ModelConcept
 from arelle.ValidateXbrl import ValidateXbrl
 from arelle.typing import TypeGetText
@@ -60,7 +60,7 @@ def rule_frta_2_1_10(
         **kwargs: Any,
 ) -> Iterable[Validation]:
     """
-    EDINET: [FRTA.2.1.10] All extension taxonomy concepts must have a standard label.
+    EDINET.EC5710W: [FRTA.2.1.10] All extension taxonomy concepts must have a standard label.
     """
     errors = []
     for concept in val.modelXbrl.qnameConcepts.values():
@@ -70,7 +70,7 @@ def rule_frta_2_1_10(
             errors.append(concept)
     if len(errors) > 0:
         yield Validation.warning(
-            codes='EDINET.FRTA.2.1.10',  # Not associated with EC5710W code.
+            codes='EDINET.EC5710W.FRTA.2.1.10',
             msg=_("All extension taxonomy concepts must have a standard label. "
                   "A standard label is not specified for a concept in an "
                   "extension taxonomy. When adding a concept to an extension taxonomy, "
@@ -180,3 +180,122 @@ def rule_frta_3_1_10(
             msg=_("Role types defined in the extension taxonomy must have a definition."),
             modelObject=errors,
         )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_frta_4_2_2(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC5710W: [FRTA.4.2.2] Taxonomy schemas must be defined in XML documents in which the XML Schema 'schema'
+                                 element appears once only as the root element.
+    """
+    for modelDocument in val.modelXbrl.urlDocs.values():
+        if pluginData.isStandardTaxonomyUrl(modelDocument.uri, val.modelXbrl):
+            continue
+        # check for nested Schema declarations which are not allowed.
+        schemaElts = {elt for elt in modelDocument.xmlRootElement.iterdescendants(XbrlConst.qnXsdSchema.clarkNotation)}
+        if len(schemaElts) > 0:
+            yield Validation.warning(
+                codes='EDINET.EC5710W.FRTA.4.2.2',
+                msg=_("The root of a taxonomy schema file MUST be the XMLSchema element."),
+                modelObject=modelDocument,
+            )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_frta_4_2_4(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC5710W: [FRTA.4.2.4] Taxonomy schemas must declare elementFormDefault to be 'qualified',
+                                 attributeFormDefault must have the value 'unqualified', and the 'form' attribute
+                                  must not appear on element and attribute declarations.
+    """
+    for modelDocument in val.modelXbrl.urlDocs.values():
+        if pluginData.isStandardTaxonomyUrl(modelDocument.uri, val.modelXbrl) or not modelDocument.type == ModelDocument.Type.SCHEMA:
+            continue
+        rootElt = modelDocument.xmlRootElement
+        if rootElt.get('elementFormDefault') != 'qualified' or rootElt.get('attributeFormDefault') != 'unqualified':
+            yield Validation.warning(
+                codes='EDINET.EC5710W.FRTA.4.2.4',
+                msg=_("The XMLSchema root in taxonomy schema files must have the 'elementFormDefault' attribute set as "
+                      "'qualified' and the 'attributeFormDefault' attribute set as 'unqualified'"),
+                modelObject=modelDocument,
+            )
+        formUsages = []
+        for elt in rootElt.iterdescendants([XbrlConst.qnXsdElement.clarkNotation, XbrlConst.qnXsdAttribute.clarkNotation]):
+            if elt.get('form') is not None:
+                formUsages.append(elt)
+        if len(formUsages) > 0:
+            yield Validation.warning(
+                codes='EDINET.EC5710W.FRTA.4.2.4',
+                msg=_("The 'form' attribute is not allowed on 'xsd:element' or 'xsd:attribute' declarations in a schema file"),
+                modelObject=formUsages,
+            )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_frta_4_2_7(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC5710W: [FRTA.4.2.7] A label linkbase should only contain labels defined in a single language.
+    """
+    for modelDocument in val.modelXbrl.urlDocs.values():
+        if pluginData.isStandardTaxonomyUrl(modelDocument.uri, val.modelXbrl) or not modelDocument.type == ModelDocument.Type.LINKBASE:
+            continue
+        usedLangs = {
+            elt.get(XbrlConst.qnXmlLang.clarkNotation)
+            for elt in modelDocument.xmlRootElement.iterdescendants(XbrlConst.qnLinkLabel.clarkNotation)
+        }
+        if len(usedLangs) > 1:
+            yield Validation.warning(
+                codes='EDINET.EC5710W.FRTA.4.2.7',
+                msg=_("A label linkbase should only contain labels defined in a single language. This linkbase uses the following languages: %(langs)s"),
+                langs=usedLangs,
+                modelObject=modelDocument,
+            )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_frta_4_2_11(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC5710W: [FRTA.4.2.11] Every schema in a DTS must define a non-empty targetNamespace attribute value
+    """
+    for modelDocument in val.modelXbrl.urlDocs.values():
+        if pluginData.isStandardTaxonomyUrl(modelDocument.uri, val.modelXbrl) or not modelDocument.type == ModelDocument.Type.SCHEMA:
+            continue
+        rootElt = modelDocument.xmlRootElement
+        if rootElt.get('targetNamespace') is None or rootElt.get('targetNamespace') == "":
+            yield Validation.warning(
+                codes='EDINET.EC5710W.FRTA.4.2.11',
+                msg=_("Every schema in a DTS must define a non-empty targetNamespace attribute value."),
+                modelObject=modelDocument,
+            )