arelle-release 2.37.50__py3-none-any.whl → 2.37.51__py3-none-any.whl

arelle/_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '2.37.50'
-__version_tuple__ = version_tuple = (2, 37, 50)
+__version__ = version = '2.37.51'
+__version_tuple__ = version_tuple = (2, 37, 51)
+
+__commit_id__ = commit_id = None

arelle/plugin/validate/EDINET/Constants.py

@@ -37,3 +37,5 @@ qnEdinetManifestList = qname("{http://disclosure.edinet-fsa.go.jp/2013/manifest}
 qnEdinetManifestTitle = qname("{http://disclosure.edinet-fsa.go.jp/2013/manifest}title")
 qnEdinetManifestTocComposition = qname("{http://disclosure.edinet-fsa.go.jp/2013/manifest}tocComposition")
 xhtmlDtdExtension = "xhtml1-strict-ix.dtd"
+
+COVER_PAGE_FILENAME_PREFIX = "0000000_header_"

arelle/plugin/validate/EDINET/ControllerPluginData.py

@@ -12,11 +12,11 @@ from typing import TYPE_CHECKING
 
 from arelle.Cntlr import Cntlr
 from arelle.FileSource import FileSource
-from arelle.ModelXbrl import ModelXbrl
 from arelle.typing import TypeGetText
 from arelle.utils.PluginData import PluginData
-from .InstanceType import InstanceType
-from .UploadContents import UploadContents
+from . import Constants
+from .ReportFolderType import ReportFolderType
+from .UploadContents import UploadContents, UploadPathInfo
 
 if TYPE_CHECKING:
     from .ManifestInstance import ManifestInstance
@@ -50,35 +50,46 @@ class ControllerPluginData(PluginData):
     @lru_cache(1)
     def getUploadContents(self, fileSource: FileSource) -> UploadContents:
         uploadFilepaths = self.getUploadFilepaths(fileSource)
-        amendmentPaths = defaultdict(list)
-        unknownPaths = []
-        directories = []
-        forms = defaultdict(list)
+        reports = defaultdict(list)
+        uploadPaths = {}
         for path in uploadFilepaths:
-            parents = list(reversed([p.name for p in path.parents if len(p.name) > 0]))
-            if len(parents) == 0:
-                continue
-            if parents[0] == 'XBRL':
-                if len(parents) > 1:
-                    formName = parents[1]
-                    instanceType = InstanceType.parse(formName)
-                    if instanceType is not None:
-                        forms[instanceType].append(path)
-                        continue
-            formName = parents[0]
-            instanceType = InstanceType.parse(formName)
-            if instanceType is not None:
-                amendmentPaths[instanceType].append(path)
+            if len(path.parts) == 0:
                 continue
-            if len(path.suffix) == 0:
-                directories.append(path)
-                continue
-            unknownPaths.append(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
+            isInSubdirectory = False
+            reportPath = None
+            if len(parents) > 0:
+                isCorrection = parents[0] != 'XBRL'
+                if not isCorrection:
+                    if len(parents) > 1:
+                        formName = parents[1]
+                        isInSubdirectory = len(parents) > 2
+                        reportFolderType = ReportFolderType.parse(formName)
+                if reportFolderType is None:
+                    formName = parents[0]
+                    isInSubdirectory = len(parents) > 1
+                    reportFolderType = ReportFolderType.parse(formName)
+                if reportFolderType is not None:
+                    reportPath = Path(reportFolderType.value) if isCorrection else Path("XBRL") / reportFolderType.value
+                    if not isCorrection:
+                        reports[reportFolderType].append(path)
+            uploadPaths[path] = UploadPathInfo(
+                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,
+                isRoot=len(path.parts) == 1,
+                isSubdirectory=isInSubdirectory or (isDirectory and reportFolderType is not None),
+                path=path,
+                reportFolderType=reportFolderType,
+                reportPath=reportPath,
+            )
         return UploadContents(
-            amendmentPaths={k: frozenset(v) for k, v in amendmentPaths.items() if len(v) > 0},
-            directories=frozenset(directories),
-            instances={k: frozenset(v) for k, v in forms.items() if len(v) > 0},
-            unknownPaths=frozenset(unknownPaths)
+            reports={k: frozenset(v) for k, v in reports.items() if len(v) > 0},
+            uploadPaths=uploadPaths
         )
 
     @lru_cache(1)

arelle/plugin/validate/EDINET/PluginValidationDataExtension.py

@@ -7,15 +7,17 @@ from collections import defaultdict
 from dataclasses import dataclass
 from decimal import Decimal
 from functools import lru_cache
+from lxml.etree import DTD, XML
 from operator import attrgetter
 from typing import Callable, Hashable, Iterable, cast
 
+import os
 import regex
 
 from arelle.LinkbaseType import LinkbaseType
 from arelle.ModelDocument import Type as ModelDocumentType
 from arelle.ModelDtsObject import ModelConcept
-from arelle.ModelInstanceObject import ModelFact, ModelUnit, ModelContext
+from arelle.ModelInstanceObject import ModelFact, ModelUnit, ModelContext, ModelInlineFact
 from arelle.ModelObject import ModelObject
 from arelle.ModelValue import QName, qname
 from arelle.ModelXbrl import ModelXbrl
@@ -24,7 +26,7 @@ from arelle.ValidateDuplicateFacts import getDeduplicatedFacts, DeduplicationTyp
 from arelle.XmlValidate import VALID
 from arelle.typing import TypeGetText
 from arelle.utils.PluginData import PluginData
-from .Constants import CORPORATE_FORMS, FormType
+from .Constants import CORPORATE_FORMS, FormType, xhtmlDtdExtension
 from .ControllerPluginData import ControllerPluginData
 from .ManifestInstance import ManifestInstance
 from .Statement import Statement, STATEMENTS, BalanceSheet, StatementInstance, StatementType
@@ -166,6 +168,22 @@ class PluginValidationDataExtension(PluginData):
             )
         return balanceSheets
 
+    def getProblematicTextBlocks(self, modelXbrl: ModelXbrl) -> list[ModelInlineFact]:
+        problematicTextBlocks: list[ModelInlineFact] = []
+        dtd = DTD(os.path.join(modelXbrl.modelManager.cntlr.configDir, xhtmlDtdExtension))
+        htmlBodyTemplate = "<body><div>\n{0}\n</div></body>\n"
+        for fact in modelXbrl.facts:
+            concept = fact.concept
+            if isinstance(fact, ModelInlineFact) and not fact.isNil and concept is not None and concept.isTextBlock and not fact.isEscaped:
+                xmlBody = htmlBodyTemplate.format(fact.value)
+                try:
+                    textblockXml = XML(xmlBody)
+                    if not dtd.validate(textblockXml):
+                        problematicTextBlocks.append(fact)
+                except Exception:
+                    problematicTextBlocks.append(fact)
+        return problematicTextBlocks
+
     @lru_cache(1)
     def getStatementInstance(self, modelXbrl: ModelXbrl, statement: Statement) -> StatementInstance | None:
         if statement.roleUri not in modelXbrl.roleTypes:

arelle/plugin/validate/EDINET/{InstanceType.py → ReportFolderType.py}

@@ -8,16 +8,15 @@ from functools import cached_property, lru_cache
 from pathlib import Path
 
 
-class InstanceType(Enum):
+class ReportFolderType(Enum):
     ATTACH_DOC = "AttachDoc"
     AUDIT_DOC = "AuditDoc"
-    ENGLISH_DOC = "EnglishDoc"
     PRIVATE_ATTACH = "PrivateAttach"
     PRIVATE_DOC = "PrivateDoc"
     PUBLIC_DOC = "PublicDoc"
 
     @classmethod
-    def parse(cls, value: str) -> InstanceType | None:
+    def parse(cls, value: str) -> ReportFolderType | None:
         try:
             return cls(value)
         except ValueError:
@@ -27,6 +26,10 @@ class InstanceType(Enum):
     def extensionCategory(self) -> ExtensionCategory | None:
         return FORM_TYPE_EXTENSION_CATEGORIES.get(self, None)
 
+    @cached_property
+    def isAttachment(self) -> bool:
+        return "Attach" in self.value
+
     @cached_property
     def manifestName(self) -> str:
         return f'manifest_{self.value}.xml'
@@ -49,7 +52,6 @@ class InstanceType(Enum):
 class ExtensionCategory(Enum):
     ATTACH = 'ATTACH'
     DOC = 'DOC'
-    ENGLISH_DOC = 'ENGLISH_DOC'
 
     def getValidExtensions(self, isAmendment: bool, isSubdirectory: bool) -> frozenset[str] | None:
         amendmentMap = VALID_EXTENSIONS[isAmendment]
@@ -60,12 +62,11 @@ class ExtensionCategory(Enum):
 
 
 FORM_TYPE_EXTENSION_CATEGORIES = {
-    InstanceType.ATTACH_DOC: ExtensionCategory.ATTACH,
-    InstanceType.AUDIT_DOC: ExtensionCategory.DOC,
-    InstanceType.ENGLISH_DOC: ExtensionCategory.ENGLISH_DOC,
-    InstanceType.PRIVATE_ATTACH: ExtensionCategory.ATTACH,
-    InstanceType.PRIVATE_DOC: ExtensionCategory.DOC,
-    InstanceType.PUBLIC_DOC: ExtensionCategory.DOC,
+    ReportFolderType.ATTACH_DOC: ExtensionCategory.ATTACH,
+    ReportFolderType.AUDIT_DOC: ExtensionCategory.DOC,
+    ReportFolderType.PRIVATE_ATTACH: ExtensionCategory.ATTACH,
+    ReportFolderType.PRIVATE_DOC: ExtensionCategory.DOC,
+    ReportFolderType.PUBLIC_DOC: ExtensionCategory.DOC,
 }
 
 
@@ -74,7 +75,6 @@ IMAGE_EXTENSIONS = frozenset({'.jpeg', '.jpg', '.gif', '.png'})
 ASSET_EXTENSIONS = frozenset(HTML_EXTENSIONS | IMAGE_EXTENSIONS)
 XBRL_EXTENSIONS = frozenset(HTML_EXTENSIONS | {'.xml', '.xsd'})
 ATTACH_EXTENSIONS = frozenset(HTML_EXTENSIONS | {'.pdf', })
-ENGLISH_DOC_EXTENSIONS = frozenset(ASSET_EXTENSIONS | frozenset({'.pdf', '.xml', '.txt'}))
 
 # Is Amendment -> Category -> Is Subdirectory
 VALID_EXTENSIONS = {
@@ -97,9 +97,5 @@ VALID_EXTENSIONS = {
             False: HTML_EXTENSIONS,
             True: ASSET_EXTENSIONS,
         },
-        ExtensionCategory.ENGLISH_DOC: {
-            False: ENGLISH_DOC_EXTENSIONS,
-            True: ENGLISH_DOC_EXTENSIONS,
-        },
     },
 }

arelle/plugin/validate/EDINET/UploadContents.py

@@ -6,12 +6,27 @@ from __future__ import annotations
 from dataclasses import dataclass
 from pathlib import Path
 
-from .InstanceType import InstanceType
+from .ReportFolderType import ReportFolderType
 
 
 @dataclass(frozen=True)
 class UploadContents:
-    amendmentPaths: dict[InstanceType, frozenset[Path]]
-    directories: frozenset[Path]
-    instances: dict[InstanceType, frozenset[Path]]
-    unknownPaths: frozenset[Path]
+    reports: dict[ReportFolderType, frozenset[Path]]
+    uploadPaths: dict[Path, UploadPathInfo]
+
+    @property
+    def sortedPaths(self) -> list[Path]:
+        return sorted(self.uploadPaths.keys())
+
+
+@dataclass(frozen=True)
+class UploadPathInfo:
+    isAttachment: bool
+    isCorrection: bool
+    isCoverPage: bool
+    isDirectory: bool
+    isRoot: bool
+    isSubdirectory: bool
+    path: Path
+    reportFolderType: ReportFolderType | None
+    reportPath: Path | None

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

@@ -30,7 +30,7 @@ from arelle.utils.validate.Validation import Validation
 from arelle.utils.validate.ValidationUtil import etreeIterWithDepth
 from ..DisclosureSystems import (DISCLOSURE_SYSTEM_EDINET)
 from ..PluginValidationDataExtension import PluginValidationDataExtension
-from ..Constants import xhtmlDtdExtension
+
 
 _: TypeGetText
 
@@ -368,28 +368,15 @@ def rule_gfm_1_2_14(
     (a format that conforms to XML grammar, such as all start and end tags being paired, and the end tag of a nested tag not coming after the end tag of its parent tag, etc.).
     Please modify it so that it is well-formed.
     """
-    CDATApattern = regex.compile(r"<!\[CDATA\[(.+)\]\]")
-    dtd = DTD(os.path.join(val.modelXbrl.modelManager.cntlr.configDir, xhtmlDtdExtension))
-    htmlBodyTemplate = "<body><div>\n{0}\n</div></body>\n"
-    namedEntityPattern = regex.compile("&[_A-Za-z\xC0-\xD6\xD8-\xF6\xF8-\xFF\u0100-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD]"
-                                    r"[_\-\.:"
-                                    "\xB7A-Za-z0-9\xC0-\xD6\xD8-\xF6\xF8-\xFF\u0100-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\u0300-\u036F\u203F-\u2040]*;")
-    XMLpattern = regex.compile(r".*(<|&lt;|&#x3C;|&#60;)[A-Za-z_]+[A-Za-z0-9_:]*[^>]*(/>|>|&gt;|/&gt;).*", regex.DOTALL)
-
-    for fact in val.modelXbrl.facts:
-        concept = fact.concept
-        if not fact.isNil and concept is not None and concept.isTextBlock and XMLpattern.match(fact.value):
-            for xmlText in [fact.value] + CDATApattern.findall(fact.value):
-                xmlBodyWithoutEntities = htmlBodyTemplate.format(namedEntityPattern.sub("", xmlText).replace('&','&amp;'))
-                textblockXml = XML(xmlBodyWithoutEntities)
-                if not dtd.validate(textblockXml):
-                    yield Validation.warning(
-                        codes='EDINET.EC5700W.GFM.1.2.14',
-                        msg=_('The content of an element with a data type of nonnum:textBlockItemType is not well-formed XML (a format that conforms to XML grammar, '
-                              'such as all start and end tags being in pairs, and the end tag of a nested tag not coming after the end tag of its parent tag). '
-                              'Correct the content so that it is well-formed.'),
-                        modelObject = fact
-                    )
+    problematicFacts = pluginData.getProblematicTextBlocks(val.modelXbrl)
+    if len(problematicFacts) > 0:
+        yield Validation.warning(
+            codes='EDINET.EC5700W.GFM.1.2.14',
+            msg=_('The content of an element with a data type of nonnum:textBlockItemType is not well-formed XML (a format that conforms to XML grammar, '
+                  'such as all start and end tags being in pairs, and the end tag of a nested tag not coming after the end tag of its parent tag). '
+                  'Correct the content so that it is well-formed.'),
+            modelObject = problematicFacts
+        )
 
 
 @validation(

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

@@ -16,7 +16,7 @@ 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_EDINET)
-from ..InstanceType import InstanceType, HTML_EXTENSIONS, IMAGE_EXTENSIONS
+from ..ReportFolderType import ReportFolderType, HTML_EXTENSIONS, IMAGE_EXTENSIONS
 from ..PluginValidationDataExtension import PluginValidationDataExtension
 
 if TYPE_CHECKING:
@@ -24,6 +24,16 @@ if TYPE_CHECKING:
 
 _: TypeGetText
 
+ALLOWED_ROOT_FOLDERS = {
+    "AttachDoc",
+    "AuditDoc",
+    "PrivateAttach",
+    "PrivateDoc",
+    "PublicAttach",
+    "PublicDoc",
+    "XBRL",
+}
+
 FILE_COUNT_LIMITS = {
     Path("AttachDoc"): 990,
     Path("AuditDoc"): 990,
@@ -43,7 +53,7 @@ FILENAME_STEM_PATTERN = re.compile(r'[a-zA-Z0-9_-]*')
     hook=ValidationHook.FILESOURCE,
     disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
 )
-def rule_EC0121E(
+def rule_EC0100E(
         pluginData: ControllerPluginData,
         cntlr: Cntlr,
         fileSource: FileSource,
@@ -51,30 +61,32 @@ def rule_EC0121E(
         **kwargs: Any,
 ) -> Iterable[Validation]:
     """
-    EDINET.EC0121E: There is a directory or file that contains more than 31 characters
-    or uses characters other than those allowed (alphanumeric characters, '-' and '_').
-
-    Note: Sample instances from EDINET almost always violate this rule based on our
-    current interpretation. The exception being files placed outside the XBRL directory,
-    i.e. amendment documents. For now, we will only check amendment documents, directory
-    names, or other files in unexpected locations.
+    EDINET.EC0100E: An illegal directory is found directly under the transferred directory.
+    Only the following root folders are allowed:
+        AttachDoc
+        AuditDoc*
+        PrivateAttach
+        PrivateDoc*
+        PublicAttach
+        PublicDoc*
+        XBRL
+    * Only when reporting corrections
+
+    NOTE: since we do not have access to the submission type, we can't determine if the submission is a correction or not.
+    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)
-    paths = set(uploadContents.directories | uploadContents.unknownPaths)
-    for amendmentPaths in uploadContents.amendmentPaths.values():
-        paths.update(amendmentPaths)
-    for path in paths:
-        if len(str(path.name)) > 31 or not FILENAME_STEM_PATTERN.match(path.stem):
+    for path, pathInfo in uploadContents.uploadPaths.items():
+        if pathInfo.isRoot and path.name not in ALLOWED_ROOT_FOLDERS:
             yield Validation.error(
-                codes='EDINET.EC0121E',
-                msg=_("There is a directory or file in '%(directory)s' that contains more than 31 characters "
-                      "or uses characters other than those allowed (alphanumeric characters, '-' and '_'). "
-                      "Directory or file name: '%(basename)s'. "
-                      "Please change the file name (or folder name) to within 31 characters and to usable "
-                      "characters, and upload again."),
-                directory=str(path.parent),
-                basename=path.name,
-                file=str(path)
+                codes='EDINET.EC0100E',
+                msg=_("An illegal directory is found directly under the transferred directory. "
+                      "Directory name or file name: '%(rootDirectory)s'. "
+                      "Delete all folders except the following folders that exist directly "
+                      "under the root folder, and then upload again: %(allowedDirectories)s."),
+                rootDirectory=path.name,
+                allowedDirectories=', '.join(f"'{d}'" for d in ALLOWED_ROOT_FOLDERS)
             )
 
 
@@ -82,7 +94,7 @@ def rule_EC0121E(
     hook=ValidationHook.FILESOURCE,
     disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
 )
-def rule_EC0124E(
+def rule_EC0124E_EC0187E(
         pluginData: ControllerPluginData,
         cntlr: Cntlr,
         fileSource: FileSource,
@@ -90,7 +102,8 @@ def rule_EC0124E(
         **kwargs: Any,
 ) -> Iterable[Validation]:
     """
-    EDINET.EC0124E: There are no empty directories.
+    EDINET.EC0124E: There are no empty root directories.
+    EDINET.EC0187E: There are no empty subdirectories.
     """
     uploadFilepaths = pluginData.getUploadFilepaths(fileSource)
     emptyDirectories = []
@@ -98,15 +111,24 @@ def rule_EC0124E(
         if path.suffix:
             continue
         if not any(path in p.parents for p in uploadFilepaths):
-            emptyDirectories.append(str(path))
+            emptyDirectories.append(path)
     for emptyDirectory in emptyDirectories:
-        yield Validation.error(
-            codes='EDINET.EC0124E',
-            msg=_("There is no file directly under '%(emptyDirectory)s'. "
-                  "No empty folders. "
-                  "Please store the file in the appropriate folder or delete the folder and upload again."),
-            emptyDirectory=emptyDirectory,
-        )
+        if len(emptyDirectory.parts) <= 1:
+            yield Validation.error(
+                codes='EDINET.EC0124E',
+                msg=_("There is no file directly under '%(emptyDirectory)s'. "
+                      "No empty root folders. "
+                      "Please store the file in the appropriate folder or delete the folder and upload again."),
+                emptyDirectory=str(emptyDirectory),
+            )
+        else:
+            yield Validation.error(
+                codes='EDINET.EC0187E',
+                msg=_("'%(parentDirectory)s' contains a subordinate directory ('%(emptyDirectory)s') with no files. "
+                      "Please store the file in the corresponding subfolder or delete the subfolder and upload again."),
+                parentDirectory=str(emptyDirectory.parent),
+                emptyDirectory=str(emptyDirectory),
+            )
 
 
 @validation(
@@ -160,22 +182,13 @@ 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)
-    checks = []
-    for instanceType, amendmentPaths in uploadContents.amendmentPaths.items():
-        for amendmentPath in amendmentPaths:
-            isSubdirectory = amendmentPath.parent.name != instanceType.value
-            checks.append((amendmentPath, True, instanceType, isSubdirectory))
-    for instanceType, formPaths in uploadContents.instances.items():
-        for amendmentPath in formPaths:
-            isSubdirectory = amendmentPath.parent.name != instanceType.value
-            checks.append((amendmentPath, False, instanceType, isSubdirectory))
-    for path, isAmendment, instanceType, isSubdirectory in checks:
-        ext = path.suffix
-        if len(ext) == 0:
+    for path, pathInfo in uploadContents.uploadPaths.items():
+        if pathInfo.reportFolderType is None or pathInfo.isDirectory:
             continue
-        validExtensions = instanceType.getValidExtensions(isAmendment, isSubdirectory)
+        validExtensions = pathInfo.reportFolderType.getValidExtensions(pathInfo.isCorrection, pathInfo.isSubdirectory)
         if validExtensions is None:
             continue
+        ext = path.suffix
         if ext not in validExtensions:
             yield Validation.error(
                 codes='EDINET.EC0130E',
@@ -207,18 +220,17 @@ def rule_EC0132E(
     EDINET.EC0132E: Store the manifest file directly under the relevant folder.
     """
     uploadContents = pluginData.getUploadContents(fileSource)
-    for instanceType in (InstanceType.AUDIT_DOC, InstanceType.PRIVATE_DOC, InstanceType.PUBLIC_DOC):
-        if instanceType not in uploadContents.instances:
+    for reportFolderType, paths in uploadContents.reports.items():
+        if reportFolderType.isAttachment:
             continue
-        if instanceType.manifestPath in uploadContents.instances.get(instanceType, []):
-            continue
-        yield Validation.error(
-            codes='EDINET.EC0132E',
-            msg=_("'%(expectedManifestName)s' does not exist in '%(expectedManifestDirectory)s'. "
-                  "Please store the manifest file (or cover file) directly under the relevant folder and upload it again. "),
-            expectedManifestName=instanceType.manifestPath.name,
-            expectedManifestDirectory=str(instanceType.manifestPath.parent),
-        )
+        if reportFolderType.manifestPath not in paths:
+            yield Validation.error(
+                codes='EDINET.EC0132E',
+                msg=_("'%(expectedManifestName)s' does not exist in '%(expectedManifestDirectory)s'. "
+                      "Please store the manifest file (or cover file) directly under the relevant folder and upload it again. "),
+                expectedManifestName=reportFolderType.manifestPath.name,
+                expectedManifestDirectory=str(reportFolderType.manifestPath.parent),
+            )
 
 
 @validation(
@@ -279,6 +291,36 @@ def rule_EC0188E(
             )
 
 
+@validation(
+    hook=ValidationHook.FILESOURCE,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_EC0192E(
+        pluginData: ControllerPluginData,
+        cntlr: Cntlr,
+        fileSource: FileSource,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC0192E: The cover file for PrivateDoc cannot be set because it uses a
+    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():
+        if not pathInfo.isCoverPage:
+            continue
+        # Only applies to PrivateDoc correction reports
+        if pathInfo.isCorrection and pathInfo.reportFolderType == ReportFolderType.PRIVATE_DOC:
+            yield Validation.error(
+                codes='EDINET.EC0192E',
+                msg=_("The cover file for PrivateDoc ('%(file)s') cannot be set because it uses a PublicDoc cover file. "
+                      "Please delete the cover file from PrivateDoc and upload it again."),
+                file=str(path),
+            )
+
+
 @validation(
     hook=ValidationHook.FILESOURCE,
     disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
@@ -315,6 +357,82 @@ def rule_EC0198E(
             )
 
 
+@validation(
+    hook=ValidationHook.FILESOURCE,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_EC0233E(
+        pluginData: ControllerPluginData,
+        cntlr: Cntlr,
+        fileSource: FileSource,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC0233E: There is a file in the report directory that comes before the cover file
+    in file name sort order.
+
+    NOTE: This includes files in subdirectories. For example, PublicDoc/00000000_images/image.png
+    comes before PublicDoc/0000000_header_*.htm
+    """
+    uploadContents = pluginData.getUploadContents(fileSource)
+    directories = defaultdict(list)
+    for path in uploadContents.sortedPaths:
+        pathInfo = uploadContents.uploadPaths[path]
+        if pathInfo.isDirectory:
+            continue
+        if pathInfo.reportFolderType in (ReportFolderType.PRIVATE_DOC, ReportFolderType.PUBLIC_DOC):
+            directories[pathInfo.reportPath].append(pathInfo)
+    for reportPath, pathInfos in directories.items():
+        coverPagePath = next(iter(p for p in pathInfos if p.isCoverPage), None)
+        if coverPagePath is None:
+            continue
+        errorPathInfos = pathInfos[:pathInfos.index(coverPagePath)]
+        for pathInfo in errorPathInfos:
+            yield Validation.error(
+                codes='EDINET.EC0233E',
+                msg=_("There is a file in the report directory in '%(reportPath)s' that comes before the cover "
+                      "file ('%(coverPage)s') in file name sort order. "
+                      "Directory name or file name: '%(path)s'. "
+                      "Please make sure that there are no files that come before the cover file in the file "
+                      "name sort order, and then upload again."),
+                reportPath=str(reportPath),
+                coverPage=str(coverPagePath.path.name),
+                path=str(pathInfo.path),
+            )
+
+
+@validation(
+    hook=ValidationHook.FILESOURCE,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_EC0234E(
+        pluginData: ControllerPluginData,
+        cntlr: Cntlr,
+        fileSource: FileSource,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC0234E: A cover file exists in an unsupported subdirectory.
+    """
+    uploadContents = pluginData.getUploadContents(fileSource)
+    for path, pathInfo in uploadContents.uploadPaths.items():
+        if pathInfo.isDirectory:
+            continue
+        if pathInfo.reportFolderType not in (ReportFolderType.PRIVATE_DOC, ReportFolderType.PUBLIC_DOC):
+            continue
+        if pathInfo.isSubdirectory and pathInfo.isCoverPage:
+            yield Validation.error(
+                codes='EDINET.EC0234E',
+                msg=_("A cover file ('%(coverPage)s') exists in an unsupported subdirectory. "
+                      "Directory: '%(directory)s'. "
+                      "Please make sure there is no cover file in the subfolder and upload again."),
+                coverPage=str(path.name),
+                directory=str(path.parent),
+            )
+
+
 @validation(
     hook=ValidationHook.FILESOURCE,
     disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
@@ -444,6 +562,61 @@ def rule_EC1020E(
             )
 
 
+@validation(
+    hook=ValidationHook.FILESOURCE,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_filenames(
+        pluginData: ControllerPluginData,
+        cntlr: Cntlr,
+        fileSource: FileSource,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC0121E: There is a directory or file that contains
+    more than 31 characters or uses characters other than those allowed (alphanumeric characters,
+    '-' and '_').
+    Note: Applies to everything EXCEPT files directly beneath non-correction report folders.
+
+    EDINET.EC0200E: There is a file that uses characters other
+    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():
+        isReportFile = (
+            not pathInfo.isAttachment and
+            not pathInfo.isCorrection and
+            not pathInfo.isDirectory and
+            not pathInfo.isSubdirectory
+        )
+        charactersAreValid = FILENAME_STEM_PATTERN.fullmatch(path.stem)
+        lengthIsValid = isReportFile or (len(path.name) <= 31)
+        if charactersAreValid and lengthIsValid:
+            continue
+        if isReportFile:
+            yield Validation.error(
+                codes='EDINET.EC0200E',
+                msg=_("There is a file inside the XBRL directory that uses characters "
+                      "other than those allowed (alphanumeric characters, '-' and '_'). "
+                      "File: '%(path)s'. "
+                      "Please change the filename to usable characters, and upload again."),
+                path=str(path)
+            )
+        else:
+            yield Validation.error(
+                codes='EDINET.EC0121E',
+                msg=_("There is a directory or file in '%(directory)s' that contains more "
+                      "than 31 characters or uses characters other than those allowed "
+                      "(alphanumeric characters, '-' and '_'). "
+                      "Directory or filename: '%(basename)s'. "
+                      "Please change the file name (or folder name) to within 31 characters and to usable "
+                      "characters, and upload again."),
+                directory=str(path.parent),
+                basename=path.name,
+            )
+
+
 @validation(
     hook=ValidationHook.FILESOURCE,
     disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],

{arelle_release-2.37.50.dist-info → arelle_release-2.37.51.dist-info}/METADATA

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

{arelle_release-2.37.50.dist-info → arelle_release-2.37.51.dist-info}/RECORD

@@ -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=njDexQGIu5W1_Bx2XXI0APU6EFVbL-MHc7OHXGD6xDg,515
+arelle/_version.py,sha256=5ledvoDL_7HieaAt4kjZqd9TGIaAC8kJJgJuFA-vUT4,708
 arelle/typing.py,sha256=PRe-Fxwr2SBqYYUVPCJ3E7ddDX0_oOISNdT5Q97EbRM,1246
 arelle/api/Session.py,sha256=kgSxS7VckA1sQ7xp0pJiK7IK-vRxAdAZKUo8gEx27s8,7549
 arelle/config/creationSoftwareNames.json,sha256=5MK7XUjfDJ9OpRCCHXeOErJ1SlTBZji4WEcEOdOacx0,3128
@@ -312,14 +312,14 @@ arelle/plugin/validate/DBA/rules/tm.py,sha256=ui9oKBqlAForwkQ9kk9KBiUogTJE5pv1Rb
 arelle/plugin/validate/DBA/rules/tr.py,sha256=4TootFjl0HXsKZk1XNBCyj-vnjRs4lg35hfiz_b_4wU,14684
 arelle/plugin/validate/EBA/__init__.py,sha256=x3zXNcdSDJ3kHfL7kMs0Ve0Vs9oWbzNFVf1TK4Avmy8,45924
 arelle/plugin/validate/EBA/config.xml,sha256=37wMVUAObK-XEqakqD8zPNog20emYt4a_yfL1AKubF8,2022
-arelle/plugin/validate/EDINET/Constants.py,sha256=bYLMdzEFw6X1jchW5iN5pUAQ8K7-cGtiZRN22r1LP6g,1339
-arelle/plugin/validate/EDINET/ControllerPluginData.py,sha256=PrEhllue_lh-sLeUy9w8I9XLMLgpo5eW-c7ZKgNyGLE,6256
+arelle/plugin/validate/EDINET/Constants.py,sha256=H_OX8hq7nns6TbKPpmDlg1_pNOd7P-XMFF03MMZBAuk,1387
+arelle/plugin/validate/EDINET/ControllerPluginData.py,sha256=T4m8GFiVg9tNoLcC3HxeegNnKVqAqZdc6kNdxM5Vz1Y,7005
 arelle/plugin/validate/EDINET/DisclosureSystems.py,sha256=3rKG42Eg-17Xx_KXU_V5yHW6I3LTwQunvf4a44C9k_4,36
-arelle/plugin/validate/EDINET/InstanceType.py,sha256=aLKb4-AJ6nDZKMOLCp7u08E9VD64ExeZy9_oGth-LTk,3207
 arelle/plugin/validate/EDINET/ManifestInstance.py,sha256=SkQV-aOsYn3CTgCkH4IXNdM3QKoiz8okwb29ftMtV3Q,6882
-arelle/plugin/validate/EDINET/PluginValidationDataExtension.py,sha256=NBCXANYep0AvQVe2zm2eaKzklvLCC1zeQ_oa8L6cryM,11498
+arelle/plugin/validate/EDINET/PluginValidationDataExtension.py,sha256=4xGDhwLo_JOJSu16w_CkPCca1SYMu980bb2-r6sbI5s,12459
+arelle/plugin/validate/EDINET/ReportFolderType.py,sha256=Q-9a-5tJfhK-cjY8WUB2AT1NI-Nn9cFtARVOIJoLRGU,2979
 arelle/plugin/validate/EDINET/Statement.py,sha256=0Mw5IB7LMtvUZ-2xKZfxmq67xF_dCgJo3eNLweLFRHU,9350
-arelle/plugin/validate/EDINET/UploadContents.py,sha256=L0u5171cLBKX7NT-_szRqOfkiy4Gv1xPsfpPVgPhtu0,409
+arelle/plugin/validate/EDINET/UploadContents.py,sha256=IKQYl6lXYTfAZKLIDzRRGSRt3FXoL2Eldbx3Dh7T2I4,712
 arelle/plugin/validate/EDINET/ValidationPluginExtension.py,sha256=oMY0ntLr1qIh3uMi1W_M-bT5bhXPDx048X3oDFP5zOY,2042
 arelle/plugin/validate/EDINET/__init__.py,sha256=OZ7gMknCHd0M-9nt8UOmjEZW50YQzbvSLongr9O7Yi0,3022
 arelle/plugin/validate/EDINET/resources/config.xml,sha256=7uT4GcRgk5veMLpFhPPQJxbGKiQvM52P8EMrjn0qd0g,646
@@ -328,9 +328,9 @@ 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=VYrDZaKbsQuQEvOY5F0Pv4Jzk9YZ4iETOkAFOggrhEY,12632
 arelle/plugin/validate/EDINET/rules/frta.py,sha256=N0YglHYZuLD2IuwE26viR2ViwUYjneBuMFU9vlrS0aQ,7616
-arelle/plugin/validate/EDINET/rules/gfm.py,sha256=Ty5zDqIRkXwnOQTzK5JD2F6jbK1xEiseltosVfYUrVM,24772
+arelle/plugin/validate/EDINET/rules/gfm.py,sha256=vJz8OGbXQb1Lbp5tF6ObCifM3AuPB_PXTjSPU5WXYF4,23484
 arelle/plugin/validate/EDINET/rules/manifests.py,sha256=MoT9R_a4BzuYdQVbF7RC5wz134Ve68svSdJ3NlpO_AU,4026
-arelle/plugin/validate/EDINET/rules/upload.py,sha256=k1o12K_vMN2N5bAXPxLRwyKjghoOGrgfLijE_j_5ilQ,19811
+arelle/plugin/validate/EDINET/rules/upload.py,sha256=VQKjuDxMAER14Cb0kymoc-xdnAqJ9l1ZaqlQNIEG8gU,26606
 arelle/plugin/validate/ESEF/Const.py,sha256=JujF_XV-_TNsxjGbF-8SQS4OOZIcJ8zhCMnr-C1O5Ho,22660
 arelle/plugin/validate/ESEF/Dimensions.py,sha256=MOJM7vwNPEmV5cu-ZzPrhx3347ZvxgD6643OB2HRnIk,10597
 arelle/plugin/validate/ESEF/Util.py,sha256=QH3btcGqBpr42M7WSKZLSdNXygZaZLfEiEjlxoG21jE,7950
@@ -680,9 +680,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.50.dist-info/licenses/LICENSE.md,sha256=Q0tn6q0VUbr-NM8916513NCIG8MNzo24Ev-sxMUBRZc,3959
-arelle_release-2.37.50.dist-info/METADATA,sha256=4w922-d1vIeCmfCpQ18ImtcI_0C7_qguifO2WlU-yYo,9327
-arelle_release-2.37.50.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-arelle_release-2.37.50.dist-info/entry_points.txt,sha256=Uj5niwfwVsx3vaQ3fYj8hrZ1xpfCJyTUA09tYKWbzpo,111
-arelle_release-2.37.50.dist-info/top_level.txt,sha256=fwU7SYawL4_r-sUMRg7r1nYVGjFMSDvRWx8VGAXEw7w,7
-arelle_release-2.37.50.dist-info/RECORD,,
+arelle_release-2.37.51.dist-info/licenses/LICENSE.md,sha256=Q0tn6q0VUbr-NM8916513NCIG8MNzo24Ev-sxMUBRZc,3959
+arelle_release-2.37.51.dist-info/METADATA,sha256=BZlHz_pXjybuHYVwQ-qzY5TmwxoyNVIRhJTjBez0H6w,9327
+arelle_release-2.37.51.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+arelle_release-2.37.51.dist-info/entry_points.txt,sha256=Uj5niwfwVsx3vaQ3fYj8hrZ1xpfCJyTUA09tYKWbzpo,111
+arelle_release-2.37.51.dist-info/top_level.txt,sha256=fwU7SYawL4_r-sUMRg7r1nYVGjFMSDvRWx8VGAXEw7w,7
+arelle_release-2.37.51.dist-info/RECORD,,