arelle-release 2.37.55__py3-none-any.whl → 2.37.57__py3-none-any.whl

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

@@ -6,20 +6,24 @@ from __future__ import annotations
 import re
 from collections import defaultdict
 from pathlib import Path
-from typing import Any, Iterable, TYPE_CHECKING
+from typing import Any, Iterable, TYPE_CHECKING, cast
 
 import regex
 
-from arelle import UrlUtil
+from arelle import UrlUtil, XbrlConst
 from arelle.Cntlr import Cntlr
 from arelle.FileSource import FileSource
+from arelle.ModelInstanceObject import ModelFact
 from arelle.ValidateXbrl import ValidateXbrl
+from arelle.XmlValidateConst import VALID
 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 .. import Constants
+from ..CoverPageRequirements import CoverPageItemStatus
 from ..DisclosureSystems import (DISCLOSURE_SYSTEM_EDINET)
+from ..FilingFormat import FILING_FORMATS
 from ..ReportFolderType import ReportFolderType, HTML_EXTENSIONS, IMAGE_EXTENSIONS
 from ..PluginValidationDataExtension import PluginValidationDataExtension
 
@@ -122,8 +126,10 @@ def rule_EC0100E(
     For this implementation, we will allow all directories that may be valid for at least one submission type.
     This allows for a false-negative outcome when a non-correction submission has a correction-only root directory.
     """
-    uploadContents = pluginData.getUploadContents(fileSource)
-    for path, pathInfo in uploadContents.uploadPaths.items():
+    uploadContents = pluginData.getUploadContents()
+    if uploadContents is None:
+        return
+    for path, pathInfo in uploadContents.uploadPathsByPath.items():
         if pathInfo.isRoot and path.name not in ALLOWED_ROOT_FOLDERS:
             yield Validation.error(
                 codes='EDINET.EC0100E',
@@ -153,8 +159,8 @@ def rule_EC0124E_EC0187E(
     """
     uploadFilepaths = pluginData.getUploadFilepaths(fileSource)
     emptyDirectories = []
-    for path in uploadFilepaths:
-        if path.suffix:
+    for path, zipPath in uploadFilepaths.items():
+        if not zipPath.is_dir():
             continue
         if not any(path in p.parents for p in uploadFilepaths):
             emptyDirectories.append(path)
@@ -227,8 +233,10 @@ def rule_EC0130E(
     """
     EDINET.EC0130E: File extensions must match the file extensions allowed in Figure 2-1-3 and Figure 2-1-5.
     """
-    uploadContents = pluginData.getUploadContents(fileSource)
-    for path, pathInfo in uploadContents.uploadPaths.items():
+    uploadContents = pluginData.getUploadContents()
+    if uploadContents is None:
+        return
+    for path, pathInfo in uploadContents.uploadPathsByPath.items():
         if pathInfo.reportFolderType is None or pathInfo.isDirectory:
             continue
         validExtensions = pathInfo.reportFolderType.getValidExtensions(pathInfo.isCorrection, pathInfo.isSubdirectory)
@@ -265,7 +273,9 @@ def rule_EC0132E(
     """
     EDINET.EC0132E: Store the manifest file directly under the relevant folder.
     """
-    uploadContents = pluginData.getUploadContents(fileSource)
+    uploadContents = pluginData.getUploadContents()
+    if uploadContents is None:
+        return
     for reportFolderType, paths in uploadContents.reports.items():
         if reportFolderType.isAttachment:
             continue
@@ -353,8 +363,10 @@ def rule_EC0192E(
     PublicDoc cover file. Please delete the cover file from PrivateDoc and upload
     it again.
     """
-    uploadContents = pluginData.getUploadContents(fileSource)
-    for path, pathInfo in uploadContents.uploadPaths.items():
+    uploadContents = pluginData.getUploadContents()
+    if uploadContents is None:
+        return
+    for path, pathInfo in uploadContents.uploadPathsByPath.items():
         if not pathInfo.isCoverPage:
             continue
         # Only applies to PrivateDoc correction reports
@@ -383,8 +395,8 @@ def rule_EC0198E(
     """
     fileCounts: dict[Path, int] = defaultdict(int)
     uploadFilepaths = pluginData.getUploadFilepaths(fileSource)
-    for path in uploadFilepaths:
-        if len(path.suffix) == 0:
+    for path, zipPath in uploadFilepaths.items():
+        if zipPath.is_dir():
             continue
         for directory in FILE_COUNT_LIMITS.keys():
             if directory in path.parents:
@@ -421,10 +433,12 @@ def rule_EC0233E(
     NOTE: This includes files in subdirectories. For example, PublicDoc/00000000_images/image.png
     comes before PublicDoc/0000000_header_*.htm
     """
-    uploadContents = pluginData.getUploadContents(fileSource)
+    uploadContents = pluginData.getUploadContents()
+    if uploadContents is None:
+        return
     directories = defaultdict(list)
     for path in uploadContents.sortedPaths:
-        pathInfo = uploadContents.uploadPaths[path]
+        pathInfo = uploadContents.uploadPathsByPath[path]
         if pathInfo.isDirectory:
             continue
         if pathInfo.reportFolderType in (ReportFolderType.PRIVATE_DOC, ReportFolderType.PUBLIC_DOC):
@@ -462,8 +476,10 @@ def rule_EC0234E(
     """
     EDINET.EC0234E: A cover file exists in an unsupported subdirectory.
     """
-    uploadContents = pluginData.getUploadContents(fileSource)
-    for path, pathInfo in uploadContents.uploadPaths.items():
+    uploadContents = pluginData.getUploadContents()
+    if uploadContents is None:
+        return
+    for path, pathInfo in uploadContents.uploadPathsByPath.items():
         if pathInfo.isDirectory:
             continue
         if pathInfo.reportFolderType not in (ReportFolderType.PRIVATE_DOC, ReportFolderType.PUBLIC_DOC):
@@ -549,14 +565,16 @@ def rule_EC0349E(
     EDINET.EC0349E: An unexpected directory or file exists in the XBRL directory.
     Only PublicDoc, PrivateDoc, or AuditDoc directories may exist beneath the XBRL directory.
     """
-    uploadContent = pluginData.getUploadContents(fileSource)
+    uploadContents = pluginData.getUploadContents()
+    if uploadContents is None:
+        return
     xbrlDirectoryPath = Path('XBRL')
     allowedPaths = {p.xbrlDirectory for p in (
         ReportFolderType.AUDIT_DOC,
         ReportFolderType.PRIVATE_DOC,
         ReportFolderType.PUBLIC_DOC,
     )}
-    for path, pathInfo in uploadContent.uploadPaths.items():
+    for path, pathInfo in uploadContents.uploadPathsByPath.items():
         if path.parent != xbrlDirectoryPath:
             continue
         if path not in allowedPaths:
@@ -583,8 +601,10 @@ def rule_EC0352E(
     """
     EDINET.EC0352E: An XBRL file with an invalid name exists.
     """
-    uploadContent = pluginData.getUploadContents(fileSource)
-    for path, pathInfo in uploadContent.uploadPaths.items():
+    uploadContents = pluginData.getUploadContents()
+    if uploadContents is None:
+        return
+    for path, pathInfo in uploadContents.uploadPathsByPath.items():
         if (
             pathInfo.isDirectory or
             pathInfo.isCorrection or
@@ -603,6 +623,127 @@ def rule_EC0352E(
             )
 
 
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rules_cover_page(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC1000E: Cover page must contain "【表紙】".
+    EDINET.EC1001E: A required item is missing from the cover page.
+    EDINET.EC1002E: A duplicate item is included on the cover page.
+    EDINET.EC1003E: An unnecessary item is included on the cover page.
+    EDINET.EC1004E: An item on the cover page is out of order.
+    EDINET.EC1005E: A required item on the cover page is missing a valid value.
+    """
+    uploadContents = pluginData.getUploadContents(val.modelXbrl)
+    if uploadContents is None:
+        return
+    for url, doc in val.modelXbrl.urlDocs.items():
+        path = Path(url)
+        pathInfo = uploadContents.uploadPathsByFullPath.get(path)
+        if pathInfo is None or not pathInfo.isCoverPage:
+            continue
+        rootElt = doc.xmlRootElement
+        coverPageTextFound = False
+        for elt in rootElt.iterdescendants():
+            if not coverPageTextFound and elt.text and '【表紙】' in elt.text:
+                coverPageTextFound = True
+                break
+        if not coverPageTextFound:
+            yield Validation.error(
+                codes='EDINET.EC1000E',
+                msg=_("There is no '【表紙】' on the cover page. "
+                      "File name: '%(file)s'. "
+                      "Please add '【表紙】' to the relevant file."),
+                file=doc.basename,
+            )
+        filingFormat = pluginData.getFilingFormat(val.modelXbrl)
+        if filingFormat is None:
+            return
+        coverPageRequirements = pluginData.getCoverPageRequirements(val.modelXbrl)
+        currentLineNumber = 0
+        for qname in pluginData.coverPageItems:
+            foundFacts = []
+            validNonNilFacts = []
+            for fact in pluginData.iterFacts(val.modelXbrl, qname):
+                if fact.modelDocument != doc:
+                    continue
+                if fact.qname.prefix is not None and filingFormat.includesTaxonomyPrefix(fact.qname.prefix):
+                    foundFacts.append(fact)
+                if fact.xValid >= VALID and not fact.isNil:
+                    validNonNilFacts.append(fact)
+
+            for fact in sorted(foundFacts, key=lambda f: cast(int, f.sourceline)):
+                if (sourceLine := cast(int, fact.sourceline)) <= currentLineNumber:
+                    yield Validation.error(
+                        codes='EDINET.EC1004E',
+                        msg=_("Cover item %(localName)s is not in the correct order. "
+                              "File name: '%(file)s'. "
+                              "Please correct the order of cover items in the appropriate file."),
+                        localName=qname.localName,
+                        file=doc.basename,
+                        modelObject=fact,
+                    )
+                else:
+                    currentLineNumber = sourceLine
+
+            if len(foundFacts) > 1:
+                yield Validation.error(
+                    codes='EDINET.EC1002E',
+                    msg=_("Cover item %(localName)s is duplicated. "
+                          "File name: '%(file)s'. "
+                          "Please check the cover item %(localName)s of the relevant file "
+                          "and make sure there are no duplicates."),
+                    localName=qname.localName,
+                    file=doc.basename,
+                    modelObject=foundFacts,
+                )
+
+            status = coverPageRequirements.get(qname, filingFormat)
+            if status is None:
+                continue
+            if status == CoverPageItemStatus.REQUIRED:
+                if len(foundFacts) == 0:
+                    yield Validation.error(
+                        codes='EDINET.EC1001E',
+                        msg=_("Cover item %(localName)s is missing. "
+                              "File name: '%(file)s'. "
+                              "Please add the cover item %(localName)s to the relevant file."),
+                        localName=qname.localName,
+                        file=doc.basename,
+                    )
+                elif len(validNonNilFacts) == 0:
+                    yield Validation.error(
+                        codes='EDINET.EC1005E',
+                        msg=_("Cover item %(localName)s is missing a valid value. "
+                              "File name: '%(file)s'. "
+                              "Please enter a valid value for %(localName)s in the relevant file."),
+                        localName=qname.localName,
+                        file=doc.basename,
+                        modelObject=foundFacts,
+                    )
+            elif status == CoverPageItemStatus.PROHIBITED:
+                for fact in foundFacts:
+                    if fact.isNil:
+                        continue  # Prohibited cover pages facts are allowed, only if nil.
+                    yield Validation.error(
+                        codes='EDINET.EC1003E',
+                        msg=_("Cover item %(localName)s is not necessary. "
+                              "File name: '%(file)s' (line %(line)s). "
+                              "Please add the cover item %(localName)s to the relevant file."),
+                        localName=qname.localName,
+                        file=doc.basename,
+                        line=fact.sourceline,
+                        modelObject=fact,
+                    )
+
+
 @validation(
     hook=ValidationHook.XBRL_FINALLY,
     disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
@@ -644,8 +785,13 @@ def rule_uri_references(
     """
     EDINET.EC1007E: The URI in the HTML specifies a URL or absolute path.
     EDINET.EC1013E: The URI in the HTML specifies a path not under a subdirectory.
-    EDINET.EC1014E: The URI in the HTML specifies a path to a file that doesn't exist.
+    EDINET.EC1014E: The URI in the HTML specifies a path to a directory.
+    EDINET.EC1021E: The URI in the HTML specifies a path to a file that doesn't exist.
+    EDINET.EC1023E: The URI in the HTML specifies a path to a PDF file.
     """
+    uploadContents = pluginData.getUploadContents(val.modelXbrl)
+    if uploadContents is None:
+        return
     for uriReference in pluginData.uriReferences:
         if UrlUtil.isAbsolute(uriReference.attributeValue):
             yield Validation.error(
@@ -671,10 +817,11 @@ def rule_uri_references(
             )
             continue
         fullPath = Path(uriReference.document.uri).parent / path
-        if not val.modelXbrl.fileSource.exists(str(fullPath)):
+        pathInfo = uploadContents.uploadPathsByFullPath.get(fullPath)
+        if pathInfo is not None and pathInfo.isDirectory:
             yield Validation.error(
                 codes='EDINET.EC1014E',
-                msg=_("The URI in the HTML specifies a path to a file that doesn't exist. "
+                msg=_("The URI in the HTML specifies a path to a directory. "
                       "File name: '%(file)s' (line %(line)s). "
                       "Please update the URI to reference a file."),
                 file=uriReference.document.basename,
@@ -682,6 +829,100 @@ def rule_uri_references(
                 modelObject=uriReference.element,
             )
             continue
+        if path.suffix.lower() == '.pdf':
+            yield Validation.error(
+                codes='EDINET.EC1023E',
+                msg=_("The URI in the HTML specifies a path to a PDF file. "
+                      "File name: '%(file)s' (line %(line)s). "
+                      "Please remove the link from the relevant file."),
+                file=uriReference.document.basename,
+                line=uriReference.element.sourceline,
+                modelObject=uriReference.element,
+            )
+            continue
+        if not val.modelXbrl.fileSource.exists(str(fullPath)):
+            yield Validation.error(
+                codes='EDINET.EC1021E',
+                msg=_("The linked file ('%(path)s') does not exist. "
+                      "File name: '%(file)s' (line %(line)s). "
+                      "Please update the URI to reference a file."),
+                path=str(path),
+                file=uriReference.document.basename,
+                line=uriReference.element.sourceline,
+                modelObject=uriReference.element,
+            )
+            continue
+
+
+@validation(
+    hook=ValidationHook.FILESOURCE,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_EC1009R(
+        pluginData: ControllerPluginData,
+        cntlr: Cntlr,
+        fileSource: FileSource,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC1009R: The HTML file size must be 2.5MB (megabytes) or less.
+    """
+    for path, size in pluginData.getUploadFileSizes(fileSource).items():
+        if path.suffix not in HTML_EXTENSIONS:
+            continue
+        if size > 2_500_000:
+            yield Validation.warning(
+                codes='EDINET.EC1009R',
+                msg=_("The HTML file size exceeds the maximum limit. "
+                      "File name: '%(path)s'. "
+                      "Please split the file so that the file size is 2.5MB or less."),
+                path=str(path),
+            )
+
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_EC1010E(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC1010E: The charset specification in the content attribute of the HTML <meta> tag must be UTF-8.
+    """
+    for modelDocument in val.modelXbrl.urlDocs.values():
+        path = Path(modelDocument.uri)
+        if path.suffix not in HTML_EXTENSIONS:
+            continue
+        rootElt = modelDocument.xmlRootElement
+        matchingElt = None
+        missingElts = []
+        for metaElt in rootElt.iterdescendants(tag=XbrlConst.qnXhtmlMeta.clarkNotation):
+            if metaElt.qname.localName != 'meta':
+                continue
+            content = metaElt.get('content')
+            if content is None:
+                continue
+            charset = content.split('charset=')[-1].strip().lower()
+            if charset == 'utf-8':
+                matchingElt = metaElt
+            else:
+                missingElts.append(metaElt)
+
+        if matchingElt is None or len(missingElts) > 0:
+            yield Validation.error(
+                codes='EDINET.EC1010E',
+                msg=_("The charset specification in the content attribute of the HTML <meta> tag is not UTF-8. "
+                      "File name: '%(path)s'. "
+                      "Please change the character code of the file to UTF-8."),
+                path=str(path),
+                modelObject=missingElts
+            )
 
 
 @validation(
@@ -727,10 +968,12 @@ def rule_EC1017E(
     """
     EDINET.EC1017E: There is an unused file.
     """
-    uploadContents = pluginData.getUploadContents(fileSource)
+    uploadContents = pluginData.getUploadContents()
+    if uploadContents is None:
+        return
     existingSubdirectoryFilepaths = {
         path
-        for path, pathInfo in uploadContents.uploadPaths.items()
+        for path, pathInfo in uploadContents.uploadPathsByPath.items()
         if pathInfo.isSubdirectory and not pathInfo.isDirectory
     }
     usedFilepaths = pluginData.getUsedFilepaths()
@@ -749,20 +992,22 @@ def rule_EC1017E(
     hook=ValidationHook.XBRL_FINALLY,
     disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
 )
-def rule_EC1020E(
+def rule_html_elements(
         pluginData: PluginValidationDataExtension,
         val: ValidateXbrl,
         *args: Any,
         **kwargs: Any,
 ) -> Iterable[Validation]:
     """
+    EDINET.EC1011E: The HTML lang attribute is not Japanese.
     EDINET.EC1020E: When writing a DOCTYPE declaration, do not define it multiple times.
-    Also, please modify the relevant file so that there is only one html tag, one head tag, and one body tag each.
+        Also, please modify the relevant file so that there is only one html tag, one head tag, and one body tag each.
 
-    Note: Some violations of this rule (such as multiple DOCTYPE declarations) prevent Arelle from parsing
+    Note: Some violations of EC1020E (such as multiple DOCTYPE declarations) prevent Arelle from parsing
     the XML at all, and thus an XML schema error will be triggered rather than this validation error.
     """
     checkNames = frozenset({'body', 'head', 'html'})
+    langAttributeValues = frozenset({'ja', 'jp', 'ja-jp', 'JA', 'JP', 'JA-JP'})
     for modelDocument in val.modelXbrl.urlDocs.values():
         path = Path(modelDocument.uri)
         if path.suffix not in HTML_EXTENSIONS:
@@ -773,10 +1018,22 @@ def rule_EC1020E(
         }
         for elt in rootElt.iterdescendants():
             name = elt.qname.localName
-            if name not in checkNames:
-                continue
-            eltCounts[name] = eltCounts.get(name, 0) + 1
-            pass
+            if name in checkNames:
+                eltCounts[name] = eltCounts.get(name, 0) + 1
+            if not isinstance(elt, ModelFact):
+                lang = elt.get(XbrlConst.qnXmlLang.clarkNotation)
+                if lang is not None and lang not in langAttributeValues:
+                    yield Validation.error(
+                        codes='EDINET.EC1011E',
+                        msg=_("The language setting is not Japanese. "
+                              "File name: %(file)s (line %(line)s). "
+                              "Please set the lang attribute on the given line of the "
+                              "relevant file to one of the following: %(langValues)s."),
+                        file=modelDocument.basename,
+                        line=elt.sourceline,
+                        langValues=', '.join(langAttributeValues),
+                    )
+
         if any(count > 1 for count in eltCounts.values()):
             yield Validation.error(
                 codes='EDINET.EC1020E',
@@ -810,7 +1067,7 @@ def rule_EC1031E(
                 msg=_("Prohibited attribute '%(attributeName)s' is used in HTML. "
                       "File name: %(file)s (line %(line)s). "
                       "Please correct the tag attributes of the relevant file."),
-                attributeName=elt.qname.localName,
+                attributeName=attributeName,
                 file=doc.basename,
                 line=elt.sourceline,
                 modelObject=elt,
@@ -838,7 +1095,10 @@ def rule_filenames(
     than those allowed (alphanumeric characters, '-' and '_').
     Note: Applies ONLY to files directly beneath non-correction report folders.
     """
-    for path, pathInfo in pluginData.getUploadContents(fileSource).uploadPaths.items():
+    uploadContents = pluginData.getUploadContents()
+    if uploadContents is None:
+        return
+    for path, pathInfo in uploadContents.uploadPathsByPath.items():
         isReportFile = (
             not pathInfo.isAttachment and
             not pathInfo.isCorrection and

arelle/plugin/validate/ROS/PluginValidationDataExtension.py

@@ -35,6 +35,8 @@ SCHEMA_PATTERNS = {
     "http://www.cro.ie/": re.compile(r"^\d{1,6}$")
 }
 
+UK_REF_NS_PATTERN = re.compile(r"^http://xbrl.frc.org.uk/general/\d{4,}-\d{2,}-\d{2,}/ref$")
+
 TR_NAMESPACES = {
     "http://www.xbrl.org/inlineXBRL/transformation/2010-04-20",
     "http://www.xbrl.org/inlineXBRL/transformation/2011-07-31",

arelle/plugin/validate/ROS/ValidationPluginExtension.py

@@ -12,6 +12,7 @@ from .PluginValidationDataExtension import PluginValidationDataExtension
 
 _: TypeGetText
 
+CURRENCIES_DIMENSION = 'CurrenciesDimension'
 EQUITY = 'Equity'
 IE_PROFIT_LOSS = 'ProfitLossBeforeTax'
 IE_PROFIT_LOSS_ORDINARY = 'ProfitLossOnOrdinaryActivitiesBeforeTax'

arelle/plugin/validate/ROS/rules/ros.py

@@ -10,6 +10,7 @@ from collections import Counter
 from collections.abc import Iterable
 from decimal import Decimal
 
+from arelle import XbrlConst
 from arelle.typing import TypeGetText
 from arelle.ValidateXbrl import ValidateXbrl
 from collections import defaultdict
@@ -28,8 +29,8 @@ from arelle.utils.validate.Validation import Validation
 from arelle.ValidateXbrlCalcs import inferredDecimals, rangeValue
 from arelle.XbrlConst import qnXbrliMonetaryItemType, qnXbrliXbrl, xhtml
 from arelle.XmlValidateConst import VALID
-from ..ValidationPluginExtension import EQUITY, PRINCIPAL_CURRENCY, TURNOVER_REVENUE
-from ..PluginValidationDataExtension import MANDATORY_ELEMENTS,  SCHEMA_PATTERNS, TR_NAMESPACES, PluginValidationDataExtension
+from ..ValidationPluginExtension import CURRENCIES_DIMENSION, EQUITY, PRINCIPAL_CURRENCY, TURNOVER_REVENUE
+from ..PluginValidationDataExtension import MANDATORY_ELEMENTS, SCHEMA_PATTERNS, TR_NAMESPACES, UK_REF_NS_PATTERN, PluginValidationDataExtension
 
 
 def checkFileEncoding(modelXbrl: ModelXbrl) -> None:
@@ -302,14 +303,14 @@ def rule_ros19(
     equity_facts = val.modelXbrl.factsByLocalName.get(EQUITY, set())
     largest_equity_fact = None
     for e_fact in equity_facts:
-        if e_fact.xValid >= VALID:
+        if e_fact.xValid >= VALID and e_fact.xValue is not None:
             if largest_equity_fact is None or abs(convertToDecimal(e_fact.xValue)) > abs(convertToDecimal(largest_equity_fact.xValue)):
                 largest_equity_fact = e_fact
 
     turnover_facts = val.modelXbrl.factsByLocalName.get(TURNOVER_REVENUE, set())
     largest_turnover_fact = None
     for t_fact in turnover_facts:
-        if t_fact.xValid >= VALID:
+        if t_fact.xValid >= VALID and t_fact.xValue is not None:
             if largest_turnover_fact is None or convertToDecimal(t_fact.xValue) > convertToDecimal(largest_turnover_fact.xValue):
                 largest_turnover_fact = t_fact
 
@@ -337,27 +338,56 @@ def rule_ros20(
     used for the majority of monetary facts.
     """
     principal_currency_facts = val.modelXbrl.factsByLocalName.get(PRINCIPAL_CURRENCY, set())
-    principal_currency_values = set(fact.text for fact in principal_currency_facts)
+    principal_currency_values = {
+        currencyDimensionCode
+        for pc_fact in principal_currency_facts
+        if (currencyDimensionCode := _getCurrencyDimensionCode(val.modelXbrl, pc_fact))
+    }
     if len(principal_currency_values) != 1:
         yield Validation.error(
             "ROS.20",
             _("'PrincipalCurrencyUsedInBusinessReport' must exist and have a single value.  Values found: %(principal_currency_values)s."),
             modelObject=principal_currency_facts,
-            principal_currency_values=principal_currency_values,
+            principal_currency_values=sorted(principal_currency_values),
         )
     else:
         principal_currency_value = principal_currency_values.pop()
         monetary_facts = list(val.modelXbrl.factsByDatatype(False, qnXbrliMonetaryItemType))
-        monetary_units = [list(fact.utrEntries)[0].unitName for fact in monetary_facts if fact.unit is not None]
+        monetary_units = [list(fact.utrEntries)[0].unitId for fact in monetary_facts if fact.unit is not None]
         unit_counts = Counter(monetary_units)
         principal_currency_value_count = unit_counts[principal_currency_value]
-        for unit, count in unit_counts.items():
+        for count in unit_counts.values():
             if count > principal_currency_value_count:
                 yield Validation.warning(
                     "ROS.20",
-                    _("'PrincipalCurrencyUsedInBusinessReport' has a value of %(principal_currency_value)s, "
+                    _("'PrincipalCurrencyUsedInBusinessReport' has a %(currencies_dimension)s value of %(principal_currency_value)s, "
                       "which must match the functional(majority) unit of the financial statement."),
                     modelObject=principal_currency_facts,
+                    currencies_dimension=CURRENCIES_DIMENSION,
                     principal_currency_value=principal_currency_value,
                 )
                 break
+
+def _getCurrencyDimensionCode(modelXbrl: ModelXbrl, fact: ModelInlineFact) -> str | None:
+    if fact.context is None:
+        return None
+    for dim, mem in fact.context.qnameDims.items():
+        if dim.localName != CURRENCIES_DIMENSION:
+            continue
+        if mem.xValid < VALID:
+            return None
+        mem_concept = modelXbrl.qnameConcepts.get(mem.xValue)
+        if mem_concept is None:
+            return None
+        for ref_rel in modelXbrl.relationshipSet(XbrlConst.conceptReference).fromModelObject(mem_concept):
+            concept_ref = ref_rel.toModelObject
+            uk_ref_ns = None
+            for ns in concept_ref.nsmap.values():
+                if UK_REF_NS_PATTERN.match(ns):
+                    uk_ref_ns = ns
+                    break
+            if uk_ref_ns is None:
+                continue
+            if code := concept_ref.findtext(f"{{{uk_ref_ns}}}Code"):
+                return code.strip()
+        return None

{arelle_release-2.37.55.dist-info → arelle_release-2.37.57.dist-info}/METADATA

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