arelle-release 2.37.32__tar.gz → 2.37.33__tar.gz

{arelle_release-2.37.32/arelle_release.egg-info → arelle_release-2.37.33}/PKG-INFO

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

{arelle_release-2.37.32 → arelle_release-2.37.33}/arelle/CntlrCmdLine.py

@@ -634,7 +634,7 @@ class CntlrCmdLine(Cntlr.Cntlr):
         super().__init__(hasGui=False, uiLang=uiLang, disable_persistent_config=disable_persistent_config, logFileName=logFileName)
         self.preloadedPlugins =  {}
 
-    def run(self, options: RuntimeOptions, sourceZipStream=None, responseZipStream=None, sourceZipStreamFileName=None) -> bool:
+    def run(self, options: RuntimeOptions, sourceZipStream=None, responseZipStream=None) -> bool:
         """Process command line arguments or web service request, such as to load and validate an XBRL document, or start web server.
 
         When a web server has been requested, this method may be called multiple times, once for each web service (REST) request that requires processing.
@@ -998,7 +998,7 @@ class CntlrCmdLine(Cntlr.Cntlr):
                         _entryPoints.append({"file":f})
         filesource = None # file source for all instances if not None
         if sourceZipStream:
-            filesource = FileSource.openFileSource(None, self, sourceZipStream=sourceZipStream, sourceZipStreamFileName=sourceZipStreamFileName)
+            filesource = FileSource.openFileSource(None, self, sourceZipStream)
         elif len(_entryPoints) == 1 and "file" in _entryPoints[0]: # check if an archive and need to discover entry points (and not IXDS)
             entryPath = PackageManager.mappedUrl(_entryPoints[0]["file"])
             filesource = FileSource.openFileSource(entryPath, self, checkIfXmlIsEis=_checkIfXmlIsEis)

{arelle_release-2.37.32 → arelle_release-2.37.33}/arelle/CntlrWebMain.py

@@ -19,7 +19,7 @@ from bottle import Bottle, HTTPResponse, request, response, static_file  # type:
 
 from arelle import Version
 from arelle.CntlrCmdLine import CntlrCmdLine
-from arelle.FileSource import FileNamedStringIO
+from arelle.FileSource import FileNamedBytesIO, FileNamedStringIO
 from arelle.logging.formatters.LogFormatter import LogFormatter
 from arelle.logging.handlers.LogToBufferHandler import LogToBufferHandler
 from arelle.PluginManager import pluginClassMethods
@@ -263,19 +263,16 @@ def validation(file: str | None = None) -> str | bytes:
     isValidation = 'validation' == requestPathParts[-1] or 'validation' == requestPathParts[-2]
     view = request.query.view
     viewArcrole = request.query.viewArcrole
-    sourceZipStreamFileName = None
     sourceZipStream = None
     if request.method == 'POST':
         mimeType = request.get_header("Content-Type")
         if mimeType and mimeType.startswith("multipart/form-data"):
             if upload := request.files.get("upload"):
-                sourceZipStreamFileName = upload.filename
-                sourceZipStream = upload.file
+                sourceZipStream = FileNamedBytesIO(upload.filename, upload.file.read())
             else:
                 errors.append(_("POST 'multipart/form-data' request must include 'upload' part containing the XBRL file to process."))
         elif mimeType in ('application/zip', 'application/x-zip', 'application/x-zip-compressed', 'multipart/x-zip'):
-            sourceZipStreamFileName = request.get_header("X-File-Name")
-            sourceZipStream = request.body
+            sourceZipStream = FileNamedBytesIO(request.get_header("X-File-Name"), request.body.read())
         else:
             errors.append(_("POST request must provide an XBRL zip file to process. Content-Type '{0}' not recognized as a zip file.").format(mimeType))
     if not view and not viewArcrole:
@@ -349,14 +346,13 @@ def validation(file: str | None = None) -> str | bytes:
         viewFile = FileNamedStringIO(media)
         options.viewArcrole = viewArcrole
         options.viewFile = viewFile
-    return runOptionsAndGetResult(options, media, viewFile, sourceZipStream, sourceZipStreamFileName)
+    return runOptionsAndGetResult(options, media, viewFile, sourceZipStream)
 
 def runOptionsAndGetResult(
         options: RuntimeOptions,
         media: str,
         viewFile: FileNamedStringIO | None,
-        sourceZipStream: FileNamedStringIO | None = None,
-        sourceZipStreamFileName: str | None = None,
+        sourceZipStream: FileNamedBytesIO | None = None,
         ) -> str | bytes:
     """Execute request according to options, for result in media, with *post*ed file in sourceZipStream, if any.
 
@@ -381,7 +377,7 @@ def runOptionsAndGetResult(
     else:
         responseZipStream = None
     cntlr = getCntlr()
-    successful = cntlr.run(options, sourceZipStream, responseZipStream, sourceZipStreamFileName)
+    successful = cntlr.run(options, sourceZipStream, responseZipStream)
     if media == "xml":
         response.content_type = 'text/xml; charset=UTF-8'
     elif media == "csv":

{arelle_release-2.37.32 → arelle_release-2.37.33}/arelle/FileSource.py

@@ -13,7 +13,7 @@ import struct
 import tarfile
 import zipfile
 import zlib
-from typing import IO, TYPE_CHECKING, Any, Optional, TextIO, cast
+from typing import IO, TYPE_CHECKING, Any, BinaryIO, Optional, TextIO, cast
 
 import regex as re
 from lxml import etree
@@ -44,15 +44,17 @@ TAXONOMY_PACKAGE_FILE_NAMES = ('.taxonomyPackage.xml', 'catalog.xml') # pre-PWD
 def openFileSource(
     filename: str | None,
     cntlr: Cntlr | None = None,
-    sourceZipStream: str | None = None,
+    sourceZipStream: BinaryIO | FileNamedBytesIO | None = None,
     checkIfXmlIsEis: bool = False,
     reloadCache: bool = False,
     base: str | None = None,
     sourceFileSource: FileSource | None = None,
-    sourceZipStreamFileName: str | None = None,
 ) -> FileSource:
     if sourceZipStream:
-        sourceZipStreamFileName = os.sep + (sourceZipStreamFileName or "POSTupload.zip")
+        if isinstance(sourceZipStream, FileNamedBytesIO) and sourceZipStream.fileName:
+            sourceZipStreamFileName = os.sep + sourceZipStream.fileName
+        else:
+            sourceZipStreamFileName = os.sep + "POSTupload.zip"
         filesource = FileSource(sourceZipStreamFileName, cntlr)
         filesource.openZipStream(sourceZipStream)
         if filename:
@@ -390,7 +392,7 @@ class FileSource:
                 assert self.taxonomyPackage is not None
                 self.mappedPaths = cast('dict[str, str]', self.taxonomyPackage.get("remappings"))
 
-    def openZipStream(self, sourceZipStream: str) -> None:
+    def openZipStream(self, sourceZipStream: BinaryIO) -> None:
         if not self.isOpen:
             assert isinstance(self.url, str)
             self.basefile = self.url
@@ -655,6 +657,30 @@ class FileSource:
         else:
             return openXmlFileStream(self.cntlr, filepath, stripDeclaration)
 
+    def getBytesSize(self) -> int | None:
+        """
+        Get the size of the zip file in bytes.
+        :return: Size of the zip file in bytes, or None if not applicable.
+        """
+        if isinstance(self.basefile, str) and os.path.isfile(self.basefile):
+            return os.path.getsize(self.basefile)
+        # ZipFile.fp is a private field, but is currently the simplest way for us to
+        # access the internal stream
+        if isinstance(self.fs, zipfile.ZipFile) and (fp := getattr(self.fs, 'fp')) is not None:
+            stream = cast(IO[Any], fp)
+            stream.seek(0, 2)  # Move to the end of the file
+            return stream.tell()  # Report the current position, which is the size of the file
+        return None
+
+    def getBytesSizeEstimate(self) -> int | None:
+        """
+        Get an estimated size of the zip file in bytes.
+        :return: Estimated size of the zip file in bytes, or None if not applicable.
+        """
+        if not isinstance(self.fs, zipfile.ZipFile):
+            return None
+        return sum(zi.compress_size for zi in self.fs.infolist())
+
     def exists(self, filepath: str) -> bool:
         archiveFileSource = self.fileSourceContainingFilepath(filepath)
         if archiveFileSource is not None:

{arelle_release-2.37.32 → arelle_release-2.37.33}/arelle/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.37.32'
-__version_tuple__ = version_tuple = (2, 37, 32)
+__version__ = version = '2.37.33'
+__version_tuple__ = version_tuple = (2, 37, 33)

{arelle_release-2.37.32 → arelle_release-2.37.33}/arelle/api/Session.py

@@ -12,6 +12,7 @@ from typing import Any, BinaryIO
 
 from arelle import PackageManager, PluginManager
 from arelle.CntlrCmdLine import CntlrCmdLine, createCntlrAndPreloadPlugins
+from arelle.FileSource import FileNamedBytesIO
 from arelle.ModelXbrl import ModelXbrl
 from arelle.RuntimeOptions import RuntimeOptions
 
@@ -102,11 +103,10 @@ class Session:
     def run(
         self,
         options: RuntimeOptions,
-        sourceZipStream: BinaryIO | None = None,
+        sourceZipStream: BinaryIO | FileNamedBytesIO | None = None,
         responseZipStream: BinaryIO | None = None,
         logHandler: logging.Handler | None = None,
         logFilters: list[logging.Filter] | None = None,
-        sourceZipStreamFileName: str | None = None,
     ) -> bool:
         """
         Perform a run using the given options.
@@ -114,13 +114,10 @@ class Session:
         :param sourceZipStream: Optional stream to read source data from.
         :param responseZipStream: Options stream to write response data to.
         :param logHandler: Optional log handler to use for logging.
-        :param sourceZipStreamFileName: Optional file name to use for the passed zip stream.
         :return: True if the run was successful, False otherwise.
         """
         with _session_lock:
             self._check_thread()
-            if sourceZipStreamFileName is not None and sourceZipStream is None:
-                raise ValueError("sourceZipStreamFileName may only be provided if sourceZipStream is not None.")
             PackageManager.reset()
             PluginManager.reset()
             if self._cntlr is None:
@@ -174,5 +171,4 @@ class Session:
                     options,
                     sourceZipStream=sourceZipStream,
                     responseZipStream=responseZipStream,
-                    sourceZipStreamFileName=sourceZipStreamFileName,
                 )

{arelle_release-2.37.32 → arelle_release-2.37.33}/arelle/oim/Load.py

@@ -1532,7 +1532,7 @@ def _loadFromOIM(cntlr, error, warning, modelXbrl, oimFile, mappedUri):
                                             hasRowError = True
                                         elif propGrpColValue in propGrpObjects:
                                             rowPropGroups[propGrpName] = propGrpObjects[propGrpColValue]
-                                        else:
+                                        elif propGrpColValue is not EMPTY_CELL:
                                             error("xbrlce:unknownPropertyGroup",
                                                   _("Table %(table)s unknown property group row %(row)s column %(column)s group %(propertyGroup)s, url: %(url)s"),
                                                   table=tableId, row=rowIndex+1, column=rowIdColName, url=tableUrl, propertyGroup=propGrpName)
@@ -1573,12 +1573,11 @@ def _loadFromOIM(cntlr, error, warning, modelXbrl, oimFile, mappedUri):
                                                     if _isParamRef(val):
                                                         rowPropGrpParamRefs.add(_getParamRefName(val))
                                     if factDimensions[colName] is None:
-                                        if colName in paramRefColNames:
-                                            value = _cellValue(row[colNameIndex[colName]])
-                                            if value:
-                                                paramColsWithValue.add(colName)
-                                            elif value is EMPTY_CELL or value is NONE_CELL:
-                                                emptyCols.add(colName)
+                                        value = _cellValue(row[colNameIndex[colName]])
+                                        if value is EMPTY_CELL or value is NONE_CELL:
+                                            emptyCols.add(colName)
+                                        elif colName in paramRefColNames:
+                                            paramColsWithValue.add(colName)
                                         if not cellPropGroup:
                                             continue # not a fact column
                                     for rowPropGrpParamRef in rowPropGrpParamRefs:

{arelle_release-2.37.32 → arelle_release-2.37.33}/arelle/plugin/validate/EDINET/rules/upload.py

@@ -238,11 +238,10 @@ def rule_EC0183E(
     """
     if not pluginData.shouldValidateUpload(val):
         return
-    zipFile = cast(zipfile.ZipFile, val.modelXbrl.fileSource.fs)
-    file = cast(IO[Any], zipFile.fp)
-    file.seek(0, 2)  # Move to the end of the file
-    size = file.tell()
-    if size > 55 * 1000 * 1000:  # Interpretting MB as megabytes (1,000,000 bytes)
+    size = val.modelXbrl.fileSource.getBytesSize()
+    if size is None:
+        return  # File size is not available, cannot validate
+    if size > 55_000_000:  # Interpretting MB as megabytes (1,000,000 bytes)
         yield Validation.error(
             codes='EDINET.EC0183E',
             msg=_("The compressed file size exceeds 55MB. "

{arelle_release-2.37.32 → arelle_release-2.37.33}/arelle/plugin/validate/ESEF/ESEF_2021/ValidateXbrlFinally.py

@@ -88,12 +88,25 @@ def validateXbrlFinally(val: ValidateXbrl, *args: Any, **kwargs: Any) -> None:
     if reportPackageMaxMB is not None and modelXbrl.fileSource.fs: # must be a zip to be a report package
         assert isinstance(modelXbrl.fileSource.fs, zipfile.ZipFile)
         maxMB = float(reportPackageMaxMB)
+        _size: int | None = None
+        _sizeExact = True
         if val.authParam["reportPackageMeasurement"] == "unzipped":
             _size = sum(zi.file_size for zi in modelXbrl.fileSource.fs.infolist())
+            _sizeExact = False
         else:
-            _size = sum(zi.compress_size for zi in modelXbrl.fileSource.fs.infolist())
-            # not usable because zip may be posted or streamed: _size = os.path.getsize(modelXbrl.fileSource.basefile)
-        if _size > maxMB * 1048576:
+            try:
+                _size = modelXbrl.fileSource.getBytesSize()
+            except Exception:
+                pass
+            if _size is None:
+                _size = modelXbrl.fileSource.getBytesSizeEstimate()
+                _sizeExact = False
+        modelXbrl.info("arelle.ESEF.reportPackageSize",
+                       _("The %(estimated)s report package %(reportPackageMeasurement)s size is %(size)s bytes."),
+                       estimated=_("exact") if _sizeExact else _("estimated"),
+                       reportPackageMeasurement=_(val.authParam["reportPackageMeasurement"]) or _("zipped"),
+                       size=_size)
+        if _size is not None and _size > maxMB * 1048576:
             modelXbrl.error("arelle.ESEF.maximumReportPackageSize",
                             _("The authority %(authority)s requires a report package size under %(maxSize)s MB, size is %(size)s."),
                             modelObject=modelXbrl, authority=val.authority, maxSize=reportPackageMaxMB, size=_size)

{arelle_release-2.37.32 → arelle_release-2.37.33}/arelle/plugin/validate/ESEF/ESEF_Current/ValidateXbrlFinally.py

@@ -93,12 +93,25 @@ def validateXbrlFinally(val: ValidateXbrl, *args: Any, **kwargs: Any) -> None:
         assert isinstance(modelXbrl.fileSource.fs, zipfile.ZipFile)
 
         maxMB = float(reportPackageMaxMB)
+        _size: int | None = None
+        _sizeExact = True
         if val.authParam["reportPackageMeasurement"] == "unzipped":
             _size = sum(zi.file_size for zi in modelXbrl.fileSource.fs.infolist())
+            _sizeExact = False
         else:
-            _size = sum(zi.compress_size for zi in modelXbrl.fileSource.fs.infolist())
-            # not usable because zip may be posted or streamed: _size = os.path.getsize(modelXbrl.fileSource.basefile)
-        if _size > maxMB * 1048576:
+            try:
+                _size = modelXbrl.fileSource.getBytesSize()
+            except Exception:
+                pass
+            if _size is None:
+                _size = modelXbrl.fileSource.getBytesSizeEstimate()
+                _sizeExact = False
+        modelXbrl.info("arelle.ESEF.reportPackageSize",
+                       _("The %(estimated)s report package %(reportPackageMeasurement)s size is %(size)s bytes."),
+                       estimated=_("exact") if _sizeExact else _("estimated"),
+                       reportPackageMeasurement=_(val.authParam["reportPackageMeasurement"]) or _("zipped"),
+                       size=_size)
+        if _size is not None and _size > maxMB * 1048576:
             modelXbrl.error("arelle.ESEF.maximumReportPackageSize",
                             _("The authority %(authority)s requires a report package size under %(maxSize)s MB, size is %(size)s."),
                             modelObject=modelXbrl, authority=val.authority, maxSize=reportPackageMaxMB, size=_size)

{arelle_release-2.37.32 → arelle_release-2.37.33}/arelle/plugin/validate/NL/rules/nl_kvk.py

@@ -1785,17 +1785,15 @@ def rule_nl_kvk_6_1_1_1(
     """
     NL-KVK.6.1.1.1: The size of the report package MUST NOT exceed 100 MB.
     """
-    if val.modelXbrl.fileSource.fs and isinstance(val.modelXbrl.fileSource.fs, zipfile.ZipFile):
-        maxMB = float(MAX_REPORT_PACKAGE_SIZE_MBS)
-        # The following code computes report package size by adding the compressed file sizes within the package.
-        # This method of computation is over 99% accurate and gets more accurate the larger the filesize is.
-        _size = sum(zi.compress_size for zi in val.modelXbrl.fileSource.fs.infolist())
-        if _size > maxMB * 1000000:
-            yield Validation.error(
-                codes='NL.NL-KVK.6.1.1.1.reportPackageMaximumSizeExceeded',
-                msg=_('The size of the report package must not exceed %(maxSize)s MBs, size is %(size)s MBs.'),
-                modelObject=val.modelXbrl, maxSize=MAX_REPORT_PACKAGE_SIZE_MBS, size=int(_size/1000000)
-            )
+    size = val.modelXbrl.fileSource.getBytesSize()
+    if size is None:
+        return  # File size is not available, cannot validate
+    if size > MAX_REPORT_PACKAGE_SIZE_MBS * 1_000_000:  # Interpretting MB as megabytes (1,000,000 bytes)
+        yield Validation.error(
+            codes='NL.NL-KVK.6.1.1.1.reportPackageMaximumSizeExceeded',
+            msg=_('The size of the report package must not exceed %(maxSize)s MBs, size is %(size)s MBs.'),
+            modelObject=val.modelXbrl, maxSize=MAX_REPORT_PACKAGE_SIZE_MBS, size=int(size/1000000)
+        )
 
 
 @validation(

{arelle_release-2.37.32 → arelle_release-2.37.33/arelle_release.egg-info}/PKG-INFO

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

{arelle_release-2.37.32 → arelle_release-2.37.33}/arelle_release.egg-info/SOURCES.txt

@@ -814,16 +814,18 @@ docker/docker-compose.yml
 docker/ubuntu.Dockerfile
 docs/Makefile
 docs/make.bat
-docs/source/build_docs.md
 docs/source/command_line.md
 docs/source/conf.py
-docs/source/contributing.md
 docs/source/esef.md
 docs/source/faq.md
 docs/source/index.md
 docs/source/install.md
 docs/source/license.md
 docs/source/_static/css/extra.css
+docs/source/contributor_guides/build_docs.md
+docs/source/contributor_guides/contributing.md
+docs/source/contributor_guides/contributor_guides.md
+docs/source/contributor_guides/efm_conf_update.md
 docs/source/images/gui_manage_plugins.png
 docs/source/images/gui_plugin_manager.png
 docs/source/images/gui_plugin_manager_browse.png
@@ -877,11 +879,13 @@ tests/integration_tests/scripts/tests/python_api_ixbrl-viewer.py
 tests/integration_tests/scripts/tests/python_api_query_model.py
 tests/integration_tests/scripts/tests/python_api_taxonomy_service.py
 tests/integration_tests/scripts/tests/python_api_validate_esef.py
+tests/integration_tests/scripts/tests/webserver_validate_esef.py
 tests/integration_tests/ui_tests/ArelleGUITest/ArelleGUITest.sln
 tests/integration_tests/ui_tests/ArelleGUITest/ArelleGUITest/ArelleGUITest.csproj
 tests/integration_tests/ui_tests/ArelleGUITest/ArelleGUITest/Tests.cs
 tests/integration_tests/ui_tests/ArelleGUITest/ArelleGUITest/Usings.cs
 tests/integration_tests/ui_tests/resources/workiva.zip
+tests/integration_tests/validation/EFM.md
 tests/integration_tests/validation/README.md
 tests/integration_tests/validation/assets.py
 tests/integration_tests/validation/conformance_suite_config.py

{arelle_release-2.37.32 → arelle_release-2.37.33}/docs/source/conf.py

@@ -2,6 +2,8 @@
 #
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
+import os
+import shutil
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

arelle_release-2.37.33/docs/source/contributor_guides/contributing.md

@@ -0,0 +1,2 @@
+:::{include} ../../../CONTRIBUTING.md
+:::

arelle_release-2.37.33/docs/source/contributor_guides/contributor_guides.md

@@ -0,0 +1,11 @@
+# Contributor Guides
+
+:::{index} Contributor Guides
+:::
+
+:::{toctree}
+:maxdepth: 1
+contributing
+build_docs
+efm_conf_update
+:::

arelle_release-2.37.33/docs/source/contributor_guides/efm_conf_update.md

@@ -0,0 +1,37 @@
+# Updating the EFM Conformance Suite
+
+:::{warning}
+Steps in this guide require upload access to Arelle's S3 bucket, which is currently limited to Arelle team members.
+:::
+
+## Prepare Assets
+
+### Upload Conformance Suite Package
+1. Download latest EFM conformance suite from the [SEC website](https://www.sec.gov/structureddata/osdinteractivedatatestsuite). Retain the filename (e.g. efm-74-250616.zip).
+2. Upload the conformance suite package to the public S3 bucket at `/ci/conformance_suites`.
+
+### Run Conformance Suite
+In `efm_current.py`, update `CONFORMANCE_SUITE_ZIP_NAME` to the filename of the conformance suite package.
+Run the following command to run the full conformance suite while generating a cache ZIP for each shard as well as a timing JSON file.
+```shell
+python tests/integration_tests/validation/run_conformance_suites.py --test --log-to-file --download-missing --name efm_current --shard=0-39 --build-cache 
+```
+
+### Build and Upload Cache
+To ensure a complete cache package is generated, we need to merge the cache packages generated for each shard into a single package.
+There are a number of ways to do this, below is one possible way:
+```shell
+mkdir merge
+for x in *.zip ; do unzip -d merge -o -u $x ; done
+cd merge
+zip -r efm_current.zip .
+```
+Upload the final cache package (`efm_current.zip`) to the public S3 bucket at `/ci/caches/conformance_suites`.
+This will add a new "version" of the existing `efm_current.zip` package in the bucket, which can be viewed by navigating into the file details in S3.
+In `efm_current.py`, update `cache_version_id` with the latest `efm_current.zip` asset version ID.
+
+### Update Timing File
+The previous run also generated `conf-efm_current-timing.json`. Rename this to `efm_current.json` and relocate to `tests/resources/conformance_suites_timing/efm_current.json`
+
+## Submit Pull Request
+PR your changes to `efm_current.py` and `efm_current.json` ([example](https://github.com/Arelle/Arelle/pull/1739)).

{arelle_release-2.37.32 → arelle_release-2.37.33}/docs/source/index.md

@@ -10,8 +10,7 @@ esef
 user_guides/user_guides
 plugins/plugins
 python_api/python_api
-contributing
-build_docs
+contributor_guides/contributor_guides
 license
 apidocs/index
 genindex

{arelle_release-2.37.32 → arelle_release-2.37.33}/docs/source/install.md

@@ -56,7 +56,7 @@ See the contributing documentation for [setting up your environment][setting-up-
 if you're comfortable setting up your own Python environment and would like to run
 Arelle from source.
 
-[setting-up-your-environment]: project:contributing.md#setting-up-your-environment
+[setting-up-your-environment]: project:contributor_guides/contributing.md#setting-up-your-environment
 
 ## Python Package
 

{arelle_release-2.37.32 → arelle_release-2.37.33}/docs/source/plugins/development/validation.md

@@ -59,4 +59,4 @@ need a rule to run before another you can either implement them with different h
 [plugin-data]: #arelle.utils.PluginData.PluginData
 [example-plugin]: https://github.com/Arelle/Arelle/tree/master/arelle/examples/plugin/validate/XYZ
 [validations-directory]: https://github.com/Arelle/Arelle/tree/master/arelle/plugin/validate
-[contributing-code]: project:../../contributing.md#contributing-code
+[contributing-code]: project:../../contributor_guides/contributing.md#contributing-code

{arelle_release-2.37.32 → arelle_release-2.37.33}/requirements-dev.txt

@@ -3,7 +3,7 @@ flake8-noqa==1.4.0
 
 mypy==1.16.1
 
-boto3-stubs==1.39.2
+boto3-stubs==1.39.3
 lxml-stubs==0.5.1
 types-PyMySQL==1.1.0.20250516
 types-openpyxl==3.1.5.20250602
@@ -13,6 +13,6 @@ types-regex==2024.11.6.20250403
 types-simplejson==3.20.0.20250326
 types-ujson==5.10.0.20250326
 types-waitress==3.0.1.20241117
-typing-extensions==4.14.0
+typing-extensions==4.14.1
 
 -r requirements-test.txt

arelle_release-2.37.33/requirements-plugins.txt

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

{arelle_release-2.37.32 → arelle_release-2.37.33}/requirements-test.txt

@@ -1,4 +1,5 @@
-boto3==1.39.2
+boto3==1.39.3
 pytest==8.4.1
+requests==2.32.4
 
 -r requirements.txt

{arelle_release-2.37.32 → arelle_release-2.37.33}/requirements.txt

@@ -7,7 +7,7 @@ lxml==5.4.0
 OpenPyXL==3.1.5
 pyparsing==3.2.3
 regex==2024.11.6
-typing-extensions==4.14.0
+typing-extensions==4.14.1
 isodate==0.7.2
 aniso8601==10.0.1
 bottle==0.13.4

{arelle_release-2.37.32 → arelle_release-2.37.33}/tests/integration_tests/scripts/script_util.py

@@ -174,7 +174,7 @@ def validate_log_tree(
 
 
 def validate_log_xml(
-        xml: str,
+        xml: str | bytes,
         expected_results: dict[str, dict[regex.Pattern[str], int]] | None = None,
 ) -> list[str]:
     tree = etree.fromstring(xml)

{arelle_release-2.37.32 → arelle_release-2.37.33}/tests/integration_tests/scripts/tests/python_api_validate_esef.py

@@ -55,6 +55,7 @@ options = RuntimeOptions(
     logFile=str(arelle_log_file),
     logFormat="[%(messageCode)s] %(message)s - %(file)s",
     packages=package_paths,
+    parameters="authority=SE",
     plugins='validate/ESEF',
     validate=True,
 )

arelle_release-2.37.33/tests/integration_tests/scripts/tests/webserver_validate_esef.py

@@ -0,0 +1,89 @@
+from __future__ import annotations
+
+import os
+import re
+import urllib.parse
+import urllib.request
+from pathlib import Path
+
+import requests
+
+from tests.integration_tests.integration_test_util import get_s3_uri
+from tests.integration_tests.scripts.script_util import parse_args, assert_result, prepare_logfile, run_arelle_webserver, validate_log_xml
+from tests.integration_tests.validation.assets import ESEF_PACKAGES
+from tests.integration_tests.validation.download_assets import download_assets
+
+errors = []
+this_file = Path(__file__)
+args = parse_args(
+    this_file.stem,
+    "Confirm ESEF validation runs successfully using the webserver.",
+    arelle=False,
+)
+arelle_command = args.arelle
+arelle_offline = args.offline
+working_directory = Path(args.working_directory)
+test_directory = Path(args.test_directory)
+report_zip_path = test_directory / 'TC2_invalid.zip'
+arelle_log_file = prepare_logfile(test_directory, this_file)
+report_zip_url = get_s3_uri(
+    'ci/packages/python_api_validate_esef.zip',
+    version_id='U3sEz.B8kjUWw0l6momz87EndK05cxFZ'
+)
+
+print(f"Downloading report: {report_zip_path}")
+urllib.request.urlretrieve(report_zip_url, report_zip_path)
+
+print("Downloading packages...")
+package_assets = {
+    package for year in [2017, 2019, 2020, 2021, 2022] for package in ESEF_PACKAGES[year]
+}
+download_assets(
+    assets=package_assets,
+    overwrite=False,
+    download_and_apply_cache=False,
+    download_private=False,
+)
+package_paths = [str(a.full_local_path) for a in package_assets]
+
+contents = ''
+port = 8100
+log_xml_bytes = None
+with run_arelle_webserver(arelle_command, port) as proc:
+    url = f"http://localhost:{port}/rest/xbrl/validation?media=xml"
+    url += "&plugins=validate/ESEF"
+    url += "&disclosureSystemName=esef"
+    url += f"&internetConnectivity={'false' if arelle_offline else 'true'}"
+    url += f"&logFile={urllib.parse.quote_plus(str(arelle_log_file))}"
+    url += f"&packages=" + '|'.join(urllib.parse.quote_plus(str(p)) for p in package_paths)
+    url += f"&parameters=authority=SE"
+    print(f"Validating: {url}")
+    with open(report_zip_path, "rb") as f:
+        files = {"upload": f}
+        response = requests.post(url, files=files)
+    response.raise_for_status()
+    contents = response.content
+    with open(arelle_log_file, 'x') as file:
+        log_xml_bytes = contents
+        file.write(log_xml_bytes.decode())
+
+if "[info] Activation of plug-in Validate ESMA ESEF successful" not in contents.decode():
+    errors.append("Plugin activation failed with response: \n" + contents.decode())
+
+print("Checking log XML for errors...")
+errors += validate_log_xml(log_xml_bytes, expected_results={
+    'error': {
+        re.compile(r'.*\[ESEF\.2\.2\.1\.precisionAttributeUsed] .*'): 1
+    },
+    'info': {
+        re.compile(r'.*\[arelle\.ESEF\.reportPackageSize] The exact report package zipped .*'): 1
+    }
+})
+
+assert_result(errors)
+
+print("Cleaning up")
+try:
+    os.unlink(working_directory / 'webserver_validate_esef' / 'TC2_invalid.zip')
+except PermissionError as exc:
+    print(f"Failed to cleanup test files: {exc}")