arelle-release 2.17.1__py3-none-any.whl → 2.37.71__py3-none-any.whl

arelle/plugin/validate/NL/rules/fg_nl.py

@@ -0,0 +1,292 @@
+"""
+See COPYRIGHT.md for copyright information.
+"""
+from __future__ import annotations
+
+from collections import defaultdict
+from collections.abc import Iterable
+from typing import Any, cast
+
+from lxml.etree import _Element
+
+from arelle import ModelDocument
+from arelle.ModelInstanceObject import ModelFact
+from arelle.ModelObject import ModelObject
+from arelle.ModelValue import qname, qnameEltPfxName
+from arelle.ValidateUtr import ValidateUtr
+from arelle.ValidateXbrl import ValidateXbrl
+from arelle.XbrlConst import qnLinkSchemaRef, qnLinkLinkbaseRef, qnLinkRoleRef, qnLinkArcroleRef, qnXbrliContext, qnXbrliUnit, qnEnumerationItemTypes
+from arelle import XmlUtil
+from arelle.typing import TypeGetText
+from arelle.utils.PluginHooks import ValidationHook
+from arelle.utils.validate.Decorator import validation
+from arelle.utils.validate.Validation import Validation
+from ..DisclosureSystems import (
+    DISCLOSURE_SYSTEM_NT16,
+    DISCLOSURE_SYSTEM_NT17,
+    DISCLOSURE_SYSTEM_NT18,
+    DISCLOSURE_SYSTEM_NT19,
+)
+from ..PluginValidationDataExtension import PluginValidationDataExtension
+
+_: TypeGetText
+
+INSTANCE_ELEMENT_ORDER = {
+    qnLinkSchemaRef.clarkNotation: 0,
+    qnLinkLinkbaseRef.clarkNotation: 1,
+    qnLinkRoleRef.clarkNotation: 2,
+    qnLinkArcroleRef.clarkNotation: 3,
+    qnXbrliContext.clarkNotation: 4,
+    qnXbrliUnit.clarkNotation: 5,
+    'fact': 6,
+}
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[
+        DISCLOSURE_SYSTEM_NT16,
+        DISCLOSURE_SYSTEM_NT17,
+        DISCLOSURE_SYSTEM_NT18,
+        DISCLOSURE_SYSTEM_NT19,
+    ],
+)
+def rule_fg_nl_03(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    FG-NL-03: An XBRL instance document SHOULD use the recommended default namespace prefixes for all namespaces
+    """
+    standardNamespaceMap: dict[str, set[str]] = defaultdict(set)
+    for modelDocument in val.modelXbrl.urlDocs.values():
+        if modelDocument.type == ModelDocument.Type.INSTANCE:
+            continue
+        for element in modelDocument.targetXbrlElementTree.iter():
+            for prefix, namespace in element.nsmap.items():
+                if prefix:
+                    standardNamespaceMap[namespace].add(prefix)
+
+    warningsMap: dict[tuple[str, str], list[_Element]] = defaultdict(list)
+    for modelDocument in val.modelXbrl.urlDocs.values():
+        if modelDocument.type != ModelDocument.Type.INSTANCE:
+            continue
+        for element in modelDocument.targetXbrlElementTree.iter():
+            for prefix, namespace in element.nsmap.items():
+                if namespace not in standardNamespaceMap or not prefix:
+                    continue
+                if prefix in standardNamespaceMap[namespace]:
+                    continue
+                warningsMap[(namespace, prefix)].append(element)
+
+    for (namespace, prefix), elements in warningsMap.items():
+        yield Validation.warning(
+            codes='NL.FG-NL-03',
+            msg=_('An instance document is referencing a taxonomy namespace '
+                  '(%(namespace)s) with a non-standard prefix (%(nonStandardPrefix)s) '
+                  'instead of a standard prefix (%(standardPrefix)s)'),
+            modelObject=elements,
+            namespace=namespace,
+            nonStandardPrefix=prefix,
+            standardPrefix=', '.join(standardNamespaceMap[namespace]),
+        )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[
+        DISCLOSURE_SYSTEM_NT16,
+        DISCLOSURE_SYSTEM_NT17,
+        DISCLOSURE_SYSTEM_NT18,
+        DISCLOSURE_SYSTEM_NT19,
+    ],
+)
+def rule_fg_nl_04(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    FG-NL-04: An XBRL instance document SHOULD order the elements so that referents precede references.
+    The children of the 'xbrli:xbrl' element should appear in the following order:
+    1. schemaRef
+    2. linkbaseRef
+    3. roleRef
+    4. arcroleRef
+    5. context
+    6. units
+    7. facts
+    """
+    errors = defaultdict(list)
+    for doc in val.modelXbrl.urlDocs.values():
+        if doc.type != ModelDocument.Type.INSTANCE:
+            continue
+        # Tracks the lower "bound" of the element order starting with the first element.
+        boundName = next(iter(INSTANCE_ELEMENT_ORDER))
+        boundIndex = INSTANCE_ELEMENT_ORDER[boundName]
+        for elt in doc.xmlRootElement.iter():
+            if not isinstance(elt, ModelObject):
+                continue
+            if isinstance(elt, ModelFact):
+                eltName = 'fact'
+            else:
+                eltName = elt.elementQname.clarkNotation
+            if eltName not in INSTANCE_ELEMENT_ORDER:
+                continue
+            eltNameIndex = INSTANCE_ELEMENT_ORDER[eltName]
+            if eltNameIndex == boundIndex:
+                # This element matches the current position of the bound, move on.
+                continue
+            if eltNameIndex > boundIndex:
+                # This element is of a type positioned later in the order, move bound.
+                boundIndex = eltNameIndex
+                boundName = eltName
+                continue
+            # This element is of a type positioned earlier in the order, generate an error.
+            errors[(eltName, boundName)].append(elt)
+    for names, elts in errors.items():
+        beforeName, afterName = names
+        yield Validation.warning(
+            codes='NL.FG-NL-04',
+            msg=_('"%(beforeName)s" elements should not appear after "%(afterName)s" elements.'),
+            modelObject=elts,
+            beforeName=qname(beforeName),
+            afterName=qname(afterName),
+        )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[
+        DISCLOSURE_SYSTEM_NT16,
+        DISCLOSURE_SYSTEM_NT17,
+        DISCLOSURE_SYSTEM_NT18,
+        DISCLOSURE_SYSTEM_NT19,
+    ],
+)
+def rule_fg_nl_05(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    FG-NL-05: Unused namespace declarations SHOULD NOT exist in a XBRL instance document.
+    """
+    modelXbrl = val.modelXbrl
+    factsByDocument = pluginData.factsByDocument(modelXbrl)
+    unitsByDocument = pluginData.unitsByDocument(modelXbrl)
+    contextsByDocument = modelXbrl.contextsByDocument()
+
+    for doc in modelXbrl.urlDocs.values():
+        if doc.type != ModelDocument.Type.INSTANCE:
+            continue
+        root = doc.xmlRootElement
+        prefixes = set(k for k in root.nsmap.keys() if k)
+        usedPrefixes = set()
+
+        for elt in root.iter():
+            if not isinstance(elt, ModelObject):
+                continue
+            usedPrefixes.add(elt.qname.prefix)
+            for attrTag in elt.keys():
+                attrTag = cast(str, attrTag)
+                if attrTag.startswith("{"):
+                    prefix = XmlUtil.clarkNotationToPrefixNsLocalname(elt, attrTag, isAttribute=True)[0]
+                    if prefix:
+                        usedPrefixes.add(prefix)
+        for context in contextsByDocument.get(doc.filepath, []):
+            for dimension in context.qnameDims.values():
+                dimensionQname = dimension.dimensionQname
+                usedPrefixes.add(dimensionQname.prefix)
+                if dimension.isExplicit:
+                    memberQname = dimension.memberQname
+                else:
+                    memberQname = dimension.typedMember.qname
+                if memberQname:
+                    usedPrefixes.add(memberQname.prefix)
+        for fact in factsByDocument.get(doc.filepath, []):
+            concept = fact.concept
+            if concept.typeQname in qnEnumerationItemTypes:
+                enumQname = getattr(fact, "xValue", None) or qnameEltPfxName(fact, fact.value)
+                if enumQname:
+                    usedPrefixes.add(enumQname.prefix)
+        for unit in unitsByDocument.get(doc.filepath, []):
+            for measures in unit.measures:
+                for measure in measures:
+                    usedPrefixes.add(measure.prefix)
+        unusedPrefixes = prefixes - usedPrefixes
+        if len(unusedPrefixes) > 0:
+            yield Validation.warning(
+                codes='NL.FG-NL-05',
+                msg=_('Unused namespaces found in an instance document: %(unusedPrefixes)s'),
+                unusedPrefixes=', '.join([f'{p}: {ns}' for p, ns in root.nsmap.items() if p in unusedPrefixes]),
+                modelObject=root,
+            )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[
+        DISCLOSURE_SYSTEM_NT16,
+        DISCLOSURE_SYSTEM_NT17,
+        DISCLOSURE_SYSTEM_NT18,
+        DISCLOSURE_SYSTEM_NT19,
+    ],
+)
+def rule_fg_nl_09(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    FG-NL-09: A fact SHOULD NOT contain an 'id' attribute.
+    """
+    facts = [f for f in val.modelXbrl.facts if f.id is not None]
+    if len(facts) > 0:
+        yield Validation.warning(
+            codes='NL.FG-NL-09',
+            msg=_('A fact SHOULD NOT contain an "id" attribute'),
+            modelObject=facts,
+        )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[
+        DISCLOSURE_SYSTEM_NT16,
+        DISCLOSURE_SYSTEM_NT17,
+        DISCLOSURE_SYSTEM_NT18,
+        DISCLOSURE_SYSTEM_NT19,
+    ],
+)
+def rule_fg_nl_11(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    FG-NL-11: XBRL instance file Should only contain standard units based on the XBRL units Registry.
+    """
+    modelXbrl = val.modelXbrl
+    utrItemTypeEntries = ValidateUtr(modelXbrl).utrItemTypeEntries
+    validUtrUnits = set()
+    for entries in utrItemTypeEntries.values():
+        for entry in entries.values():
+            if entry.nsUnit and entry.unitId:
+                validUtrUnits.add((entry.nsUnit, entry.unitId))
+    for unitId, unit in modelXbrl.units.items():
+        for measures in unit.measures:
+            for measure in measures:
+                if (measure.namespaceURI, measure.localName) not in validUtrUnits:
+                    yield Validation.warning(
+                        codes='NL.FG-NL-11',
+                        msg=_('Standard units SHOULD be used. "%(modelUnit)s" is not a standard unit.'),
+                        modelObject=unit,
+                        modelUnit=measure,
+                    )

arelle/plugin/validate/NL/rules/fr_kvk.py

@@ -3,17 +3,24 @@ See COPYRIGHT.md for copyright information.
 """
 from __future__ import annotations
 
-from typing import Any, Iterable
+from collections.abc import Iterable
+from typing import Any
 
-from arelle import ModelDocument
+from arelle import ModelDocument, XbrlConst
+from arelle.ModelDtsObject import ModelResource
+from arelle.ModelInstanceObject import ModelInlineFootnote
 from arelle.ValidateXbrl import ValidateXbrl
+from arelle.ModelObject import ModelObject
 from arelle.typing import TypeGetText
 from arelle.utils.PluginHooks import ValidationHook
 from arelle.utils.validate.Decorator import validation
 from arelle.utils.validate.Validation import Validation
+from lxml.etree import _Element
 from ..DisclosureSystems import (
     DISCLOSURE_SYSTEM_NT16,
     DISCLOSURE_SYSTEM_NT17,
+    DISCLOSURE_SYSTEM_NT18,
+    DISCLOSURE_SYSTEM_NT19,
 )
 from ..PluginValidationDataExtension import PluginValidationDataExtension
 
@@ -29,6 +36,8 @@ ACCEPTED_DECIMAL_VALUES = ('INF', '-9', '-6', '-3', '0', '2')
     disclosureSystems=[
         DISCLOSURE_SYSTEM_NT16,
         DISCLOSURE_SYSTEM_NT17,
+        DISCLOSURE_SYSTEM_NT18,
+        DISCLOSURE_SYSTEM_NT19,
     ],
 )
 def rule_fr_kvk_1_01(
@@ -36,7 +45,7 @@ def rule_fr_kvk_1_01(
     val: ValidateXbrl,
     *args: Any,
     **kwargs: Any,
-) -> Iterable[Validation] | None:
+) -> Iterable[Validation]:
     """
     FR-KVK-1.01: An XBRL instance document MUST have the file extension .xbrl
     """
@@ -57,6 +66,8 @@ def rule_fr_kvk_1_01(
     disclosureSystems=[
         DISCLOSURE_SYSTEM_NT16,
         DISCLOSURE_SYSTEM_NT17,
+        DISCLOSURE_SYSTEM_NT18,
+        DISCLOSURE_SYSTEM_NT19,
     ],
 )
 def rule_fr_kvk_2_01(
@@ -64,7 +75,7 @@ def rule_fr_kvk_2_01(
         val: ValidateXbrl,
         *args: Any,
         **kwargs: Any,
-) -> Iterable[Validation] | None:
+) -> Iterable[Validation]:
     """
     FR-KVK-2.01: The XBRL instance root node MUST contain attribute "xml:lang" with value "nl", "en", "de" or "fr"
     """
@@ -87,6 +98,44 @@ def rule_fr_kvk_2_01(
     disclosureSystems=[
         DISCLOSURE_SYSTEM_NT16,
         DISCLOSURE_SYSTEM_NT17,
+        DISCLOSURE_SYSTEM_NT18,
+        DISCLOSURE_SYSTEM_NT19,
+    ],
+)
+def rule_fr_kvk_2_02(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    FR-KVK-2.02: The attribute 'xml:lang' MUST contain the same value within an XBRL instance document
+    """
+    modelXbrl = val.modelXbrl
+    lang = None
+    for doc in modelXbrl.urlDocs.values():
+        if doc.type == ModelDocument.Type.INSTANCE:
+            lang = doc.xmlRootElement.get('{http://www.w3.org/XML/1998/namespace}lang')
+    for fact in modelXbrl.facts:
+        if fact.xmlLang and fact.xmlLang != lang:
+            yield Validation.error(
+                codes='NL.FR-KVK-2.02',
+                msg=_('The attribute \'xml:lang\' can be reported on different elements within an XBRL instance document. '
+                      'The attribute \'xml:lang\' must always contain the same value within an XBRL instance document. '
+                      'It is not allowed to report different values here. Document language: %(documentLang)s  Element language: %(additionalLang)s'),
+                modelObject=fact,
+                additionalLang=fact.xmlLang,
+                documentLang=lang,
+            )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[
+        DISCLOSURE_SYSTEM_NT16,
+        DISCLOSURE_SYSTEM_NT17,
+        DISCLOSURE_SYSTEM_NT18,
+        DISCLOSURE_SYSTEM_NT19,
     ],
 )
 def rule_fr_kvk_2_03(
@@ -94,7 +143,7 @@ def rule_fr_kvk_2_03(
         val: ValidateXbrl,
         *args: Any,
         **kwargs: Any,
-) -> Iterable[Validation] | None:
+) -> Iterable[Validation]:
     """
     FR-KVK-2.03: The attribute 'href' of the 'link:schemaRef' element MUST refer to the
     full web location of the published entrypoint from the annual reporting taxonomy
@@ -125,6 +174,8 @@ def rule_fr_kvk_2_03(
     disclosureSystems=[
         DISCLOSURE_SYSTEM_NT16,
         DISCLOSURE_SYSTEM_NT17,
+        DISCLOSURE_SYSTEM_NT18,
+        DISCLOSURE_SYSTEM_NT19,
     ],
 )
 def rule_fr_kvk_5_01(
@@ -132,7 +183,7 @@ def rule_fr_kvk_5_01(
         val: ValidateXbrl,
         *args: Any,
         **kwargs: Any,
-) -> Iterable[Validation] | None:
+) -> Iterable[Validation]:
     """
     FR-KVK-5.01: The attribute 'decimals' to monetary values MUST be filled with allowed values.
     """
@@ -156,6 +207,8 @@ def rule_fr_kvk_5_01(
     disclosureSystems=[
         DISCLOSURE_SYSTEM_NT16,
         DISCLOSURE_SYSTEM_NT17,
+        DISCLOSURE_SYSTEM_NT18,
+        DISCLOSURE_SYSTEM_NT19,
     ],
 )
 def rule_fr_kvk_5_02(
@@ -163,7 +216,7 @@ def rule_fr_kvk_5_02(
         val: ValidateXbrl,
         *args: Any,
         **kwargs: Any,
-) -> Iterable[Validation] | None:
+) -> Iterable[Validation]:
     """
     FR-KVK-5.02: The attribute 'decimals' for non-monetary numeric facts MUST be filled with 'INF'.
     """