arelle-release 2.37.55__tar.gz → 2.37.56__tar.gz

{arelle_release-2.37.55 → arelle_release-2.37.56}/PKG-INFO

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

{arelle_release-2.37.55 → arelle_release-2.37.56}/arelle/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '2.37.55'
-__version_tuple__ = version_tuple = (2, 37, 55)
+__version__ = version = '2.37.56'
+__version_tuple__ = version_tuple = (2, 37, 56)
 
-__commit_id__ = commit_id = 'g122eb892b'
+__commit_id__ = commit_id = 'g672ebed7e'

{arelle_release-2.37.55 → arelle_release-2.37.56}/arelle/plugin/validate/EDINET/ControllerPluginData.py

@@ -27,12 +27,14 @@ _: TypeGetText
 @dataclass
 class ControllerPluginData(PluginData):
     _manifestInstancesById: dict[str, ManifestInstance]
+    _uploadContents: UploadContents | None
     _usedFilepaths: set[Path]
 
     def __init__(self, name: str):
         super().__init__(name)
         self._manifestInstancesById = {}
         self._usedFilepaths = set()
+        self._uploadContents = None
 
     def __hash__(self) -> int:
         return id(self)
@@ -49,18 +51,21 @@ class ControllerPluginData(PluginData):
         """
         return list(self._manifestInstancesById.values())
 
-    @lru_cache(1)
-    def getUploadContents(self, fileSource: FileSource) -> UploadContents:
-        uploadFilepaths = self.getUploadFilepaths(fileSource)
+    def getUploadContents(self) -> UploadContents | None:
+        return self._uploadContents
+
+    def setUploadContents(self, fileSource: FileSource) -> UploadContents:
         reports = defaultdict(list)
         uploadPaths = {}
-        for path in uploadFilepaths:
+        for path, zipPath in self.getUploadFilepaths(fileSource).items():
             if len(path.parts) == 0:
                 continue
+            assert isinstance(fileSource.basefile, str)
+            fullPath = Path(fileSource.basefile) / path
             parents = list(reversed([p.name for p in path.parents if len(p.name) > 0]))
             reportFolderType = None
             isCorrection = True
-            isDirectory = len(path.suffix) == 0
+            isDirectory = zipPath.is_dir()
             isInSubdirectory = False
             reportPath = None
             if len(parents) > 0:
@@ -79,32 +84,43 @@ class ControllerPluginData(PluginData):
                     if not isCorrection:
                         reports[reportFolderType].append(path)
             uploadPaths[path] = UploadPathInfo(
+                fullPath=fullPath,
                 isAttachment=reportFolderType is not None and reportFolderType.isAttachment,
                 isCorrection=isCorrection,
                 isCoverPage=not isDirectory and path.stem.startswith(Constants.COVER_PAGE_FILENAME_PREFIX),
-                isDirectory=len(path.suffix) == 0,
+                isDirectory=isDirectory,
                 isRoot=len(path.parts) == 1,
                 isSubdirectory=isInSubdirectory or (isDirectory and reportFolderType is not None),
                 path=path,
                 reportFolderType=reportFolderType,
                 reportPath=reportPath,
             )
-        return UploadContents(
+        self._uploadContents = UploadContents(
             reports={k: frozenset(v) for k, v in reports.items() if len(v) > 0},
-            uploadPaths=uploadPaths
+            uploadPaths=list(uploadPaths.values())
         )
+        return self._uploadContents
 
     @lru_cache(1)
-    def getUploadFilepaths(self, fileSource: FileSource) -> list[Path]:
+    def getUploadFilepaths(self, fileSource: FileSource) -> dict[Path, zipfile.Path]:
         if not self.isUpload(fileSource):
-            return []
-        paths = set()
+            return {}
+        paths = {}
         assert isinstance(fileSource.fs, zipfile.ZipFile)
-        for name in fileSource.fs.namelist():
-            path = Path(name)
-            paths.add(path)
-            paths.update(path.parents)
-        return sorted(paths)
+        # First, fill in paths from zip file list
+        for file in fileSource.fs.filelist:
+            zipPath = zipfile.Path(fileSource.fs, file.filename)
+            paths[Path(file.filename)] = zipPath
+        # Then, fill in any parent directories that weren't in file list
+        for path in list(paths):
+            for parent in path.parents:
+                if parent in paths:
+                    continue
+                paths[parent] = zipfile.Path(fileSource.fs, parent.as_posix() + '/')
+        return {
+            path: paths[path]
+            for path in sorted(paths)
+        }
 
     @lru_cache(1)
     def getUploadFileSizes(self, fileSource: FileSource) -> dict[Path, int]:

{arelle_release-2.37.55 → arelle_release-2.37.56}/arelle/plugin/validate/EDINET/PluginValidationDataExtension.py

@@ -35,6 +35,7 @@ from .Constants import CORPORATE_FORMS, FormType, xhtmlDtdExtension, PROHIBITED_
 from .ControllerPluginData import ControllerPluginData
 from .ManifestInstance import ManifestInstance
 from .Statement import Statement, STATEMENTS, BalanceSheet, StatementInstance, StatementType
+from .UploadContents import UploadContents
 
 _: TypeGetText
 
@@ -309,7 +310,7 @@ class PluginValidationDataExtension(PluginData):
         for elt in modelDocument.xmlRootElement.iter():
             if not isinstance(elt, ModelObject):
                 continue
-            for attributeName in elt.attrib.keys():
+            for attributeName in elt.attrib:
                 if attributeName in PROHIBITED_HTML_ATTRIBUTES:
                     results.append((elt, str(attributeName)))
         return results
@@ -327,6 +328,10 @@ class PluginValidationDataExtension(PluginData):
                 elts.append(elt)
         return elts
 
+    def getUploadContents(self, modelXbrl: ModelXbrl) -> UploadContents | None:
+        controllerPluginData = ControllerPluginData.get(modelXbrl.modelManager.cntlr, self.name)
+        return controllerPluginData.getUploadContents()
+
     @lru_cache(1)
     def getUriAttributeValues(self, modelDocument: ModelDocument) -> list[tuple[ModelObject, str, str]]:
         results: list[tuple[ModelObject, str, str]] = []

{arelle_release-2.37.55 → arelle_release-2.37.56}/arelle/plugin/validate/EDINET/UploadContents.py

@@ -4,6 +4,7 @@ See COPYRIGHT.md for copyright information.
 from __future__ import annotations
 
 from dataclasses import dataclass
+from functools import cached_property
 from pathlib import Path
 
 from .ReportFolderType import ReportFolderType
@@ -12,15 +13,30 @@ from .ReportFolderType import ReportFolderType
 @dataclass(frozen=True)
 class UploadContents:
     reports: dict[ReportFolderType, frozenset[Path]]
-    uploadPaths: dict[Path, UploadPathInfo]
+    uploadPaths: list[UploadPathInfo]
 
     @property
     def sortedPaths(self) -> list[Path]:
-        return sorted(self.uploadPaths.keys())
+        return sorted(uploadPath.path for uploadPath in self.uploadPaths)
+
+    @cached_property
+    def uploadPathsByFullPath(self) -> dict[Path, UploadPathInfo]:
+        return {
+            uploadPath.fullPath: uploadPath
+            for uploadPath in self.uploadPaths
+        }
+
+    @cached_property
+    def uploadPathsByPath(self) -> dict[Path, UploadPathInfo]:
+        return {
+            uploadPath.path: uploadPath
+            for uploadPath in self.uploadPaths
+        }
 
 
 @dataclass(frozen=True)
 class UploadPathInfo:
+    fullPath: Path
     isAttachment: bool
     isCorrection: bool
     isCoverPage: bool

{arelle_release-2.37.55 → arelle_release-2.37.56}/arelle/plugin/validate/EDINET/ValidationPluginExtension.py

@@ -37,6 +37,7 @@ class ValidationPluginExtension(ValidationPlugin):
             }, level=logging.INFO
         )
         pluginData = ControllerPluginData.get(filesource.cntlr, self.name)
+        pluginData.setUploadContents(filesource)
         entrypointFiles = []
         for instance in instances:
             pluginData.addManifestInstance(instance)

{arelle_release-2.37.55 → arelle_release-2.37.56}/arelle/plugin/validate/EDINET/rules/gfm.py

@@ -670,3 +670,34 @@ def rule_gfm_1_3_8(
             msg=_("The submitter-specific taxonomy has an embedded linkbase."),
             modelObject=embeddedElements
         )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_gfm_1_5_6(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC5700W: [GFM 1.5.6] The length of a label must be less than 511 characters unless it its role is documentation.
+    """
+    labelRelationshipSet = val.modelXbrl.relationshipSet(XbrlConst.conceptLabel)
+    if labelRelationshipSet is None:
+        return
+    for concept in val.modelXbrl.qnameConcepts.values():
+        labelRels = labelRelationshipSet.fromModelObject(concept)
+        for rel in labelRels:
+            label = rel.toModelObject
+            if label.role != XbrlConst.documentationLabel and label.viewText() is not None and len(label.viewText()) > 511:
+                yield Validation.warning(
+                    codes='EDINET.EC5700W.GFM.1.5.6',
+                    msg=_("The concept of '%(concept)s' has a label classified as '%(role)s' that is longer than 511 characters: %(label)s"),
+                    concept=concept.qname,
+                    role=label.role,
+                    label=label.viewText(),
+                    modelObject=label
+                )

{arelle_release-2.37.55 → arelle_release-2.37.56}/arelle/plugin/validate/EDINET/rules/upload.py

@@ -122,8 +122,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 +155,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 +229,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 +269,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 +359,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 +391,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 +429,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 +472,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 +561,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 +597,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 +619,43 @@ 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 "【表紙】".
+    """
+    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
+            # TODO: Other checks related to the cover page will be implemented here.
+        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,
+            )
+
+
 @validation(
     hook=ValidationHook.XBRL_FINALLY,
     disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
@@ -644,8 +697,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 +729,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 +741,29 @@ 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(
@@ -727,10 +809,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()
@@ -810,7 +894,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 +922,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_release-2.37.55 → arelle_release-2.37.56}/arelle/plugin/validate/ROS/rules/ros.py

@@ -302,14 +302,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
 

{arelle_release-2.37.55 → arelle_release-2.37.56}/arelle_release.egg-info/PKG-INFO

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