arelle-release 2.37.30__tar.gz → 2.37.31__tar.gz

{arelle_release-2.37.30 → arelle_release-2.37.31}/.github/dependabot.yml

@@ -32,6 +32,9 @@ updates:
           - "*"
     ignore:
       - dependency-name: "cx_Freeze"
+      - dependency-name: "lxml"
+        versions:
+          - ">=6.0.0"
   - package-ecosystem: nuget
     directories:
       - /tests/integration_tests/ui_tests/ArelleGUITest

{arelle_release-2.37.30/arelle_release.egg-info → arelle_release-2.37.31}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: arelle-release
-Version: 2.37.30
+Version: 2.37.31
 Summary: An open source XBRL platform.
 Author-email: "arelle.org" <support@arelle.org>
-License: Apache-2.0
+License-Expression: Apache-2.0
 Project-URL: Homepage, https://arelle.org/
 Project-URL: Downloads, https://arelle.org/arelle/pub/
 Project-URL: Documentation, https://arelle.org/arelle/documentation/
@@ -16,7 +16,6 @@ Platform: any
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9

{arelle_release-2.37.30 → arelle_release-2.37.31}/arelle/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.37.30'
-__version_tuple__ = version_tuple = (2, 37, 30)
+__version__ = version = '2.37.31'
+__version_tuple__ = version_tuple = (2, 37, 31)

{arelle_release-2.37.30 → arelle_release-2.37.31}/arelle/plugin/validate/EDINET/PluginValidationDataExtension.py

@@ -60,6 +60,21 @@ class PluginValidationDataExtension(PluginData):
             return False  # Not a zipfile
         return True
 
+    def getUploadFileSizes(self, modelXbrl: ModelXbrl) -> dict[Path, int]:
+        """
+        Get the sizes of files in the upload directory.
+        :param modelXbrl: The ModelXbrl instance to get file sizes for.
+        :return: A dictionary mapping file paths to their sizes.
+        """
+        if not self.isUpload(modelXbrl):
+            return {}
+        assert isinstance(modelXbrl.fileSource.fs, zipfile.ZipFile)
+        return {
+            Path(i.filename): i.file_size
+            for i in modelXbrl.fileSource.fs.infolist()
+            if not i.is_dir()
+        }
+
     @lru_cache(1)
     def getUploadContents(self, modelXbrl: ModelXbrl) -> UploadContents:
         uploadFilepaths = self.getUploadFilepaths(modelXbrl)
@@ -96,16 +111,23 @@ class PluginValidationDataExtension(PluginData):
 
     @lru_cache(1)
     def getUploadFilepaths(self, modelXbrl: ModelXbrl) -> list[Path]:
-        if not modelXbrl.fileSource.fs or \
-                not isinstance(modelXbrl.fileSource.fs, zipfile.ZipFile):
-            modelXbrl.warning(
-                codes="EDINET.uploadNotValidated",
-                msg=_("The target file is not a zip file, so upload validation could not be performed.")
-            )
+        if not self.isUpload(modelXbrl):
             return []
         paths = set()
+        assert isinstance(modelXbrl.fileSource.fs, zipfile.ZipFile)
         for name in modelXbrl.fileSource.fs.namelist():
             path = Path(name)
             paths.add(path)
             paths.update(path.parents)
         return sorted(paths)
+
+    @lru_cache(1)
+    def isUpload(self, modelXbrl: ModelXbrl) -> bool:
+        if not modelXbrl.fileSource.fs or \
+                not isinstance(modelXbrl.fileSource.fs, zipfile.ZipFile):
+            modelXbrl.warning(
+                codes="EDINET.uploadNotValidated",
+                msg=_("The target file is not a zip file, so upload validation could not be performed.")
+            )
+            return False
+        return True

{arelle_release-2.37.30 → arelle_release-2.37.31}/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 ..FormType import FormType, HTML_EXTENSIONS
+from ..FormType import FormType, HTML_EXTENSIONS, IMAGE_EXTENSIONS
 from ..PluginValidationDataExtension import PluginValidationDataExtension
 
 _: TypeGetText
@@ -319,3 +319,137 @@ def rule_EC0198E(
                 actual="{:,}".format(actual),
                 limit="{:,}".format(limit),
             )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_EC0237E(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC0237E: The directory or file path to the lowest level exceeds the maximum value (259 characters).
+    """
+    if not pluginData.shouldValidateUpload(val):
+        return
+    uploadFilepaths = pluginData.getUploadFilepaths(val.modelXbrl)
+    for path in uploadFilepaths:
+        if len(str(path)) <= 259:
+            continue
+        yield Validation.error(
+            codes='EDINET.EC0237E',
+            msg=_("The directory or file path ('%(path)s') to the lowest level exceeds the maximum value (259 characters). "
+                  "Please shorten the absolute path of the folder (or file) "
+                  "to 259 characters or less and try uploading again."),
+            path=str(path),
+            file=str(path),
+        )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_EC0206E(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC0206E: Empty files are not permitted.
+    """
+    if not pluginData.shouldValidateUpload(val):
+        return
+    for path, size in pluginData.getUploadFileSizes(val.modelXbrl).items():
+        if size > 0:
+            continue
+        yield Validation.error(
+            codes='EDINET.EC0206E',
+            msg=_("An empty file exists. "
+                  "File name: '%(path)s'. "
+                  "Please delete the empty file and upload again."),
+            path=str(path),
+            file=str(path),
+        )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_EC1016E(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    EDINET.EC1016E: The image file is over 300KB.
+    """
+    if not pluginData.shouldValidateUpload(val):
+        return
+    for path, size in pluginData.getUploadFileSizes(val.modelXbrl).items():
+        if path.suffix not in IMAGE_EXTENSIONS:
+            continue
+        if size <= 300_000:  # Interpretting KB as kilobytes (1,000 bytes)
+            continue
+        yield Validation.error(
+            codes='EDINET.EC1016E',
+            msg=_("The image file is over 300KB. "
+                  "File name: '%(path)s'. "
+                  "Please create an image file with a size of 300KB or less."),
+            path=str(path),
+            file=str(path),
+        )
+
+
+@validation(
+    hook=ValidationHook.XBRL_FINALLY,
+    disclosureSystems=[DISCLOSURE_SYSTEM_EDINET],
+)
+def rule_EC1020E(
+        pluginData: PluginValidationDataExtension,
+        val: ValidateXbrl,
+        *args: Any,
+        **kwargs: Any,
+) -> Iterable[Validation]:
+    """
+    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.
+
+    Note: Some violations of this rule (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.
+    """
+    if not pluginData.shouldValidateUpload(val):
+        return
+    checkNames = frozenset({'body', 'head', 'html'})
+    for modelDocument in val.modelXbrl.urlDocs.values():
+        path = Path(modelDocument.uri)
+        if path.suffix not in HTML_EXTENSIONS:
+            continue
+        rootElt = modelDocument.xmlRootElement
+        eltCounts = {
+            rootElt.qname.localName: 1
+        }
+        for elt in rootElt.iterdescendants():
+            name = elt.qname.localName
+            if name not in checkNames:
+                continue
+            eltCounts[name] = eltCounts.get(name, 0) + 1
+            pass
+        if any(count > 1 for count in eltCounts.values()):
+            yield Validation.error(
+                codes='EDINET.EC1020E',
+                msg=_("The HTML syntax is incorrect. "
+                      "File name: '%(path)s'. "
+                      "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."),
+                path=str(path),
+                file=str(path),
+            )

{arelle_release-2.37.30 → arelle_release-2.37.31/arelle_release.egg-info}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: arelle-release
-Version: 2.37.30
+Version: 2.37.31
 Summary: An open source XBRL platform.
 Author-email: "arelle.org" <support@arelle.org>
-License: Apache-2.0
+License-Expression: Apache-2.0
 Project-URL: Homepage, https://arelle.org/
 Project-URL: Downloads, https://arelle.org/arelle/pub/
 Project-URL: Documentation, https://arelle.org/arelle/documentation/
@@ -16,7 +16,6 @@ Platform: any
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9

{arelle_release-2.37.30 → arelle_release-2.37.31}/arelle_release.egg-info/SOURCES.txt

@@ -1273,6 +1273,14 @@ tests/resources/conformance_suites/edinet/EC0188E/index.xml
 tests/resources/conformance_suites/edinet/EC0188E/invalid01.zip
 tests/resources/conformance_suites/edinet/EC0198E/index.xml
 tests/resources/conformance_suites/edinet/EC0198E/invalid01.zip
+tests/resources/conformance_suites/edinet/EC0206E/index.xml
+tests/resources/conformance_suites/edinet/EC0206E/invalid01.zip
+tests/resources/conformance_suites/edinet/EC0237E/index.xml
+tests/resources/conformance_suites/edinet/EC0237E/invalid01.zip
+tests/resources/conformance_suites/edinet/EC1016E/index.xml
+tests/resources/conformance_suites/edinet/EC1016E/invalid01.zip
+tests/resources/conformance_suites/edinet/EC1020E/index.xml
+tests/resources/conformance_suites/edinet/EC1020E/invalid01.zip
 tests/resources/conformance_suites/edinet/valid/index.xml
 tests/resources/conformance_suites/edinet/valid/valid01.zip
 tests/resources/conformance_suites/edinet/valid/valid02.zip

{arelle_release-2.37.30 → arelle_release-2.37.31}/arelle_release.egg-info/top_level.txt

@@ -1,2 +1 @@
 arelle
-tests

{arelle_release-2.37.30 → arelle_release-2.37.31}/distro.py

@@ -159,7 +159,7 @@ else:
 setup(
     executables=[guiExecutable, cliExecutable],
     options=options,
-    setup_requires=["setuptools_scm~=8.1"],
+    setup_requires=["setuptools_scm~=8.3"],
     use_scm_version={
         "tag_regex": r"^(?:[\w-]+-?)?(?P<version>[vV]?\d+(?:\.\d+){0,2}[^\+]*)(?:\+.*)?$",
         "write_to": os.path.normcase("arelle/_version.py"),

{arelle_release-2.37.30 → arelle_release-2.37.31}/pyproject.toml

@@ -1,12 +1,12 @@
 [build-system]
-requires = ["setuptools>=73,<81", "wheel~=0.44", "setuptools_scm[toml]~=8.1"]
+requires = ["setuptools>=73,<81", "wheel~=0.45", "setuptools_scm[toml]~=8.3"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "arelle-release"
 dynamic = ['version']
 readme = "README.md"
-license = {text = "Apache-2.0"}
+license = "Apache-2.0"
 description = "An open source XBRL platform."
 authors = [
     {name = "arelle.org", email = "support@arelle.org"}
@@ -16,7 +16,6 @@ classifiers = [
     'Development Status :: 5 - Production/Stable',
     'Intended Audience :: End Users/Desktop',
     'Intended Audience :: Developers',
-    'License :: OSI Approved :: Apache Software License',
     'Natural Language :: English',
     'Programming Language :: Python :: 3',
     'Programming Language :: Python :: 3.9',
@@ -89,7 +88,7 @@ arelleGUI = "arelle.CntlrWinMain:main"
 platforms = ["any"]
 
 [tool.setuptools.packages.find]
-namespaces = false
+include = ["arelle*"]
 
 [tool.setuptools_scm]
 tag_regex = "^(?:[\\w-]+-?)?(?P<version>[vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?$"

{arelle_release-2.37.30 → arelle_release-2.37.31}/requirements-dev.txt

@@ -3,7 +3,7 @@ flake8-noqa==1.4.0
 
 mypy==1.16.1
 
-boto3-stubs==1.38.41
+boto3-stubs==1.39.2
 lxml-stubs==0.5.1
 types-PyMySQL==1.1.0.20250516
 types-openpyxl==3.1.5.20250602

arelle_release-2.37.31/requirements-plugins.txt

@@ -0,0 +1 @@
+ixbrl-viewer==1.4.68

{arelle_release-2.37.30 → arelle_release-2.37.31}/requirements-test.txt

@@ -1,4 +1,4 @@
-boto3==1.38.41
+boto3==1.39.2
 pytest==8.4.1
 
 -r requirements.txt

arelle_release-2.37.31/tests/resources/conformance_suites/edinet/EC0206E/index.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?xml-stylesheet type="text/xsl" href="../testcase.xsl"?>
+<testcase
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xmlns="http://xbrl.org/2005/conformance"
+        name="EDINET.EC0206E"
+        description="EDINET.EC0206E: Empty files are not permitted."
+        outpath=''
+        owner="support@arelle.org"
+        xsi:schemaLocation="http://xbrl.org/2005/conformance https://www.xbrl.org/2005/conformance.xsd">
+    <variation id="invalid01" name="invalid01">
+        <description>
+            Empty file exists.
+            <!--valid09.zip with zero-byte `empty.html` added to `XBRL/PublicDoc/images`.-->
+        </description>
+        <data>
+            <instance readMeFirst="true">invalid01.zip</instance>
+        </data>
+        <result>
+            <error>EDINET.EC0206E</error>
+        </result>
+    </variation>
+</testcase>

arelle_release-2.37.31/tests/resources/conformance_suites/edinet/EC0237E/index.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?xml-stylesheet type="text/xsl" href="../testcase.xsl"?>
+<testcase
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xmlns="http://xbrl.org/2005/conformance"
+        name="EDINET.EC0237E"
+        description="EDINET.EC0237E: The directory or file path to the lowest level exceeds the maximum value (259 characters)."
+        outpath=''
+        owner="support@arelle.org"
+        xsi:schemaLocation="http://xbrl.org/2005/conformance https://www.xbrl.org/2005/conformance.xsd">
+    <variation id="invalid01" name="invalid01">
+        <description>
+            A file's path exceeds the maximum length of 259 characters.
+            <!--valid09.zip with long-named image file added to `XBRL/PublicDoc/images`.-->
+        </description>
+        <data>
+            <instance readMeFirst="true">invalid01.zip</instance>
+        </data>
+        <result>
+            <error>EDINET.EC0237E</error>
+        </result>
+    </variation>
+</testcase>

arelle_release-2.37.31/tests/resources/conformance_suites/edinet/EC1016E/index.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?xml-stylesheet type="text/xsl" href="../testcase.xsl"?>
+<testcase
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xmlns="http://xbrl.org/2005/conformance"
+        name="EDINET.EC1016E"
+        description="EDINET.EC1016E: The image file is over 300KB."
+        outpath=''
+        owner="support@arelle.org"
+        xsi:schemaLocation="http://xbrl.org/2005/conformance https://www.xbrl.org/2005/conformance.xsd">
+    <variation id="invalid01" name="invalid01">
+        <description>
+            Large image file exists.
+            <!--valid09.zip with 300KB+ `big.jpg` added to `XBRL/PublicDoc/images`.-->
+        </description>
+        <data>
+            <instance readMeFirst="true">invalid01.zip</instance>
+        </data>
+        <result>
+            <error>EDINET.EC1016E</error>
+        </result>
+    </variation>
+</testcase>

arelle_release-2.37.31/tests/resources/conformance_suites/edinet/EC1020E/index.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?xml-stylesheet type="text/xsl" href="../testcase.xsl"?>
+<testcase
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xmlns="http://xbrl.org/2005/conformance"
+        name="EDINET.EC1020E"
+        description="EDINET.EC1020E: In HTML files, do not include multiple DOCTYPE, html, head, or body elements."
+        outpath=''
+        owner="support@arelle.org"
+        xsi:schemaLocation="http://xbrl.org/2005/conformance https://www.xbrl.org/2005/conformance.xsd">
+    <variation id="invalid01" name="invalid01">
+        <description>
+            An HTML file includes a duplicate set of html, head, and body elements.
+            <!--valid09.zip with group of html, head, and body elements added within outer body element.-->
+        </description>
+        <data>
+            <instance readMeFirst="true">invalid01.zip</instance>
+        </data>
+        <result>
+            <error>EDINET.EC1020E</error>
+            <error>lxml.SCHEMAV_ELEMENT_CONTENT</error>
+        </result>
+    </variation>
+</testcase>

{arelle_release-2.37.30 → arelle_release-2.37.31}/tests/resources/conformance_suites/edinet/index.xml

@@ -7,5 +7,9 @@
     <testcase uri="EC0132E/index.xml" />
     <testcase uri="EC0188E/index.xml" />
     <testcase uri="EC0198E/index.xml" />
+    <testcase uri="EC0206E/index.xml" />
+    <testcase uri="EC0237E/index.xml" />
+    <testcase uri="EC1016E/index.xml" />
+    <testcase uri="EC1020E/index.xml" />
     <testcase uri="valid/index.xml" />
 </testcases>

arelle_release-2.37.31/tests/resources/conformance_suites_timing/edinet.json

@@ -0,0 +1,32 @@
+{
+    "EC0121E/index.xml:invalid01": 0.02703600004457073,
+    "EC0124E/index.xml:invalid01": 0.02569921830187641,
+    "EC0129E/index.xml:invalid01": 0.02824221487880636,
+    "EC0130E/index.xml:invalid01": 0.02799771352858409,
+    "EC0132E/index.xml:invalid01": 0.026733650620345946,
+    "EC0188E/index.xml:invalid01": 0.026002348757340085,
+    "EC0198E/index.xml:invalid01": 0.034210823007616235,
+    "EC0206E/index.xml:invalid01": 0.027052673377489986,
+    "EC0237E/index.xml:invalid01": 0.025897136975272413,
+    "EC1016E/index.xml:invalid01": 0.024953604289498003,
+    "EC1020E/index.xml:invalid01": 0.028016334808143407,
+    "valid/index.xml:valid01": 2.728330698277656,
+    "valid/index.xml:valid02": 2.344747847006104,
+    "valid/index.xml:valid03": 2.586634013061843,
+    "valid/index.xml:valid04": 2.270466046463045,
+    "valid/index.xml:valid05": 1.8036590848427352,
+    "valid/index.xml:valid06": 2.2670624161400945,
+    "valid/index.xml:valid07": 0.44213088299561026,
+    "valid/index.xml:valid08": 0.3913086344952697,
+    "valid/index.xml:valid09": 0.02393115028959867,
+    "valid/index.xml:valid10": 2.2864008896831125,
+    "valid/index.xml:valid11": 2.2894823276814877,
+    "valid/index.xml:valid12": 1.2596892778736921,
+    "valid/index.xml:valid13": 0.08568784952956446,
+    "valid/index.xml:valid14": 0.09286702248872353,
+    "valid/index.xml:valid20": 2.238069992165467,
+    "valid/index.xml:valid21": 2.2819404189538477,
+    "valid/index.xml:valid22": 2.305749729462604,
+    "<mean>": 9.176329693392713,
+    "<stdev>": 10.1666838714459
+}

arelle_release-2.37.30/requirements-plugins.txt

@@ -1 +0,0 @@
-ixbrl-viewer==1.4.67

arelle_release-2.37.30/tests/resources/conformance_suites_timing/edinet.json

@@ -1,27 +0,0 @@
-{
-    "EC0121E/index.xml:invalid01": 0.021397107151465426,
-    "EC0124E/index.xml:invalid01": 0.025065859647180982,
-    "EC0129E/index.xml:invalid01": 0.025710372240162902,
-    "EC0130E/index.xml:invalid01": 0.024780983764080007,
-    "EC0132E/index.xml:invalid01": 0.02462372305348644,
-    "EC0188E/index.xml:invalid01": 0.024174226776656742,
-    "valid/index.xml:valid01": 2.218586479322035,
-    "valid/index.xml:valid02": 1.8975368535376134,
-    "valid/index.xml:valid03": 2.1517138064207777,
-    "valid/index.xml:valid04": 1.8392213759599199,
-    "valid/index.xml:valid05": 1.473965575088599,
-    "valid/index.xml:valid06": 1.8527121706182885,
-    "valid/index.xml:valid07": 0.34719477053453607,
-    "valid/index.xml:valid08": 0.3564396889215411,
-    "valid/index.xml:valid09": 0.02052188435627358,
-    "valid/index.xml:valid10": 1.9058721497364142,
-    "valid/index.xml:valid11": 1.9128932407916943,
-    "valid/index.xml:valid12": 1.030585801767353,
-    "valid/index.xml:valid13": 0.06919699768273625,
-    "valid/index.xml:valid14": 0.07040565868529285,
-    "valid/index.xml:valid20": 1.8975022356808997,
-    "valid/index.xml:valid21": 1.8989700484311731,
-    "valid/index.xml:valid22": 1.9109289898318178,
-    "<mean>": 10.105569713860346,
-    "<stdev>": 9.295345555978425
-}