arelle-release 2.37.20__tar.gz → 2.37.22__tar.gz

{arelle_release-2.37.20 → arelle_release-2.37.22}/.github/workflows/build-documentation.yml

@@ -18,7 +18,7 @@ jobs:
         with:
           cache: 'pip'
           check-latest: true
-          python-version: '3.13'
+          python-version: '3.13.3'
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip setuptools wheel

{arelle_release-2.37.20 → arelle_release-2.37.22}/.github/workflows/build-macos.yml

@@ -13,7 +13,7 @@ on:
         required: false
         type: string
       python_version:
-        default: '3.13'
+        default: '3.13.3'
         description: 'Python version to use'
         required: false
         type: string
@@ -45,7 +45,7 @@ on:
         required: false
         type: string
       python_version:
-        default: '3.13'
+        default: '3.13.3'
         description: 'Python version to use'
         required: true
         type: string

{arelle_release-2.37.20 → arelle_release-2.37.22}/.github/workflows/build-windows.yml

@@ -8,7 +8,7 @@ on:
         required: false
         type: string
       python_version:
-        default: '3.13'
+        default: '3.13.3'
         description: 'Python version to use'
         required: false
         type: string
@@ -36,7 +36,7 @@ on:
         required: false
         type: string
       python_version:
-        default: '3.13'
+        default: '3.13.3'
         description: 'Python version to use'
         required: true
         type: string
@@ -49,8 +49,6 @@ permissions: {}
 
 jobs:
   build-windows:
-    env:
-      BUILD_PATH: build\exe.win-amd64-${{ inputs.python_version }}
     runs-on: windows-2022
     outputs:
       exe_artifact_versioned_name: ${{ steps.define-artifact-names.outputs.exe_artifact_versioned_name }}
@@ -59,6 +57,12 @@ jobs:
       zip_uploaded_artifact_name: ${{ steps.define-artifact-names.outputs.zip_uploaded_artifact_name }}
 
     steps:
+    - name: Set Python version variables
+      run: |
+        $version = "${{ inputs.python_version }}"
+        $majorMinor = ($version -split '\.')[0..1] -join '.'
+        echo "PYTHON_MAJOR_MINOR=$majorMinor" >> $env:GITHUB_ENV
+        echo "BUILD_PATH=build\exe.win-amd64-$majorMinor" >> $env:GITHUB_ENV
     - name: Checkout arelle
       uses: actions/checkout@v4.2.2
       with:

{arelle_release-2.37.20 → arelle_release-2.37.22}/.github/workflows/conformance-suite.yml

@@ -21,7 +21,7 @@ on:
         required: true
         type: string
       python_version:
-        default: '3.13'
+        default: '3.13.3'
         description: Python version to use
         required: true
         type: string

{arelle_release-2.37.20 → arelle_release-2.37.22}/.github/workflows/python-package.yml

@@ -4,14 +4,14 @@ on:
   workflow_call:
     inputs:
       python_version:
-        default: '3.13'
+        default: '3.13.3'
         description: 'Python version to use'
         required: false
         type: string
   workflow_dispatch:
     inputs:
       python_version:
-        default: '3.13'
+        default: '3.13.3'
         description: 'Python version to use'
         required: true
         type: string

{arelle_release-2.37.20 → arelle_release-2.37.22}/.github/workflows/test-scripts-parallel.yml

@@ -36,7 +36,7 @@ jobs:
           - '3.10'
           - '3.11'
           - '3.12'
-          - '3.13'
+          - '3.13.3'
     steps:
       - uses: actions/checkout@v4.2.2
         with:

{arelle_release-2.37.20 → arelle_release-2.37.22}/.github/workflows/test-scripts.yml

@@ -29,7 +29,7 @@ jobs:
           - '3.10'
           - '3.11'
           - '3.12'
-          - '3.13'
+          - '3.13.3'
     steps:
       - uses: actions/checkout@v4.2.2
       - name: Install Python 3

{arelle_release-2.37.20 → arelle_release-2.37.22}/.github/workflows/test-ui.yml

@@ -8,7 +8,7 @@ on:
         required: false
         type: string
       python_version:
-        default: '3.13'
+        default: '3.13.3'
         description: 'Python version to use'
         required: false
         type: string
@@ -82,7 +82,7 @@ jobs:
         with:
           cache: 'pip'
           check-latest: true
-          python-version: ${{ github.event_name == 'workflow_dispatch' && inputs.python_version || '3.13' }}
+          python-version: ${{ github.event_name == 'workflow_dispatch' && inputs.python_version || '3.13.3' }}
       - name: Install Python dependencies
         if: matrix.build-type == 'source'
         run: |

{arelle_release-2.37.20 → arelle_release-2.37.22}/.github/workflows/tests.yml

@@ -23,7 +23,7 @@ jobs:
           - '3.10'
           - '3.11'
           - '3.12'
-          - '3.13'
+          - '3.13.3'
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4.2.2

{arelle_release-2.37.20/arelle_release.egg-info → arelle_release-2.37.22}/PKG-INFO

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

{arelle_release-2.37.20 → arelle_release-2.37.22}/arelle/CntlrCmdLine.py

@@ -537,6 +537,14 @@ def parseArgs(args):
         runtimeOptions = RuntimeOptions(pluginOptions=pluginOptions, **baseOptions)
     except RuntimeOptionsException as e:
         parser.error(f"{e}, please try\n python CntlrCmdLine.py --help")
+    if (
+        runtimeOptions.entrypointFile is None and
+        not runtimeOptions.proxy and
+        not runtimeOptions.plugins and
+        not pluginOptions and
+        not runtimeOptions.webserver
+    ):
+        parser.error("No entrypoint specified, please try\n python CntlrCmdLine.py --help")
     return runtimeOptions, arellePluginModules
 
 

{arelle_release-2.37.20 → arelle_release-2.37.22}/arelle/RuntimeOptions.py

@@ -183,12 +183,6 @@ class RuntimeOptions:
                 raise RuntimeOptionsException('Provided plugin options already exist as base options {}'.format(existingBaseOptions))
             for optionName, optionValue in pluginOptions.items():
                 setattr(self, optionName, optionValue)
-        if (self.entrypointFile is None and
-                not self.proxy and
-                not self.plugins and
-                not pluginOptions and
-                not self.webserver):
-            raise RuntimeOptionsException('Incorrect arguments')
         if self.webserver and not hasWebServer():
             raise RuntimeOptionsException("Webserver option requires webserver module")
         if self.webserver and any((

{arelle_release-2.37.20 → arelle_release-2.37.22}/arelle/XbrlConst.py

@@ -101,6 +101,7 @@ elementLabel = "http://xbrl.org/arcrole/2008/element-label"
 genLabel = "http://xbrl.org/2008/label"
 qnGenLabel = qname("{http://xbrl.org/2008/label}label")
 xbrldt = "http://xbrl.org/2005/xbrldt"
+qnXbrldtClosed = qname("{http://xbrl.org/2005/xbrldt}xbrldt:closed")
 qnXbrldtHypercubeItem = qname("{http://xbrl.org/2005/xbrldt}xbrldt:hypercubeItem")
 qnXbrldtDimensionItem = qname("{http://xbrl.org/2005/xbrldt}xbrldt:dimensionItem")
 qnXbrldtContextElement = qname("{http://xbrl.org/2005/xbrldt}xbrldt:contextElement")
@@ -108,6 +109,9 @@ xbrldi = "http://xbrl.org/2006/xbrldi"
 qnXbrldiExplicitMember = qname("{http://xbrl.org/2006/xbrldi}xbrldi:explicitMember")
 qnXbrldiTypedMember = qname("{http://xbrl.org/2006/xbrldi}xbrldi:typedMember")
 xlink = "http://www.w3.org/1999/xlink"
+qnXlinkArcRole = qname("{http://www.w3.org/1999/xlink}xlink:arcrole")
+qnXlinkFrom = qname("{http://www.w3.org/1999/xlink}xlink:from")
+qnXlinkType = qname("{http://www.w3.org/1999/xlink}xlink:type")
 xl = "http://www.xbrl.org/2003/XLink"
 qnXlExtended = qname("{http://www.xbrl.org/2003/XLink}xl:extended")
 qnXlLocator = qname("{http://www.xbrl.org/2003/XLink}xl:locator")

{arelle_release-2.37.20 → arelle_release-2.37.22}/arelle/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.37.20'
-__version_tuple__ = version_tuple = (2, 37, 20)
+__version__ = version = '2.37.22'
+__version_tuple__ = version_tuple = (2, 37, 22)

arelle_release-2.37.22/arelle/api/Session.py

@@ -0,0 +1,178 @@
+"""
+See COPYRIGHT.md for copyright information.
+
+The `arelle.api` module is the supported method for integrating Arelle into other Python applications.
+"""
+from __future__ import annotations
+
+import logging
+import threading
+from types import TracebackType
+from typing import Any, BinaryIO
+
+from arelle import PackageManager, PluginManager
+from arelle.CntlrCmdLine import CntlrCmdLine, createCntlrAndPreloadPlugins
+from arelle.ModelXbrl import ModelXbrl
+from arelle.RuntimeOptions import RuntimeOptions
+
+_session_lock = threading.Lock()
+
+
+class Session:
+    """
+    CRITICAL THREAD SAFETY WARNING:
+
+    Arelle uses shared global state (PackageManager, PluginManager) which is NOT thread-safe.
+    Only ONE Session can run at a time across the entire process.
+
+    Safe usage:
+    - Use one Session at a time per process
+    - Use a process pool instead of thread pool for parallelism
+
+    Unsafe usage:
+    - Running multiple Sessions concurrently in any threads
+    - Threading.Thread with Session.run()
+    """
+
+    def __init__(self) -> None:
+        self._cntlr: CntlrCmdLine | None = None
+        self._thread_id = threading.get_ident()
+
+    def _check_thread(self) -> None:
+        """Ensure session is only used from the thread that created it."""
+        if threading.get_ident() != self._thread_id:
+            raise RuntimeError(
+                "Session objects cannot be shared between threads. Create a new Session instance in each thread."
+            )
+
+    def __enter__(self) -> Any:
+        return self
+
+    def __exit__(
+        self,
+        exc_type: type[BaseException],
+        exc_val: BaseException,
+        exc_tb: TracebackType | None
+    ) -> None:
+        self.close()
+
+    def close(self) -> None:
+        with _session_lock:
+            self._check_thread()
+            if self._cntlr is not None:
+                self._cntlr.close()
+            PluginManager.close()
+
+    def get_log_messages(self) -> list[dict[str, Any]]:
+        """
+        :return: Raw log records (messages) from the session.
+        """
+        if not self._cntlr or not self._cntlr.logHandler:
+            return []
+        return getattr(self._cntlr.logHandler, 'messages', [])
+
+    def get_logs(self, log_format: str, clear_logs: bool = False) -> str:
+        """
+        Retrieve logs as a string in the configured format.
+        Raises a `ValueError` if the log format is not supported by the current log handler.
+        Optionally clear the log buffer after retrieving.
+        :param log_format: The format to retrieve logs in. Supported formats are 'json', 'text', and 'xml'.
+        :param clear_logs: If enabled, clears the log buffer after retrieving logs.
+        :return:
+        """
+        if self._cntlr:
+            handler = self._cntlr.logHandler
+            if log_format == 'json' and hasattr(handler, 'getJson'):
+                return str(handler.getJson(clearLogBuffer=clear_logs))
+            if log_format == 'text' and hasattr(handler, 'getText'):
+                return str(handler.getText(clearLogBuffer=clear_logs))
+            if log_format == 'xml' and hasattr(handler, 'getXml'):
+                return str(handler.getXml(clearLogBuffer=clear_logs, includeDeclaration=False))
+            raise ValueError('Unsupported log format for {}: {}'.format(type(handler).__name__, log_format))
+        return ""
+
+    def get_models(self) -> list[ModelXbrl]:
+        """
+        Retrieve a list of loaded models.
+        """
+        if self._cntlr is None:
+            return []
+        return self._cntlr.modelManager.loadedModelXbrls
+
+    def run(
+        self,
+        options: RuntimeOptions,
+        sourceZipStream: BinaryIO | 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.
+        :param options: Options to use for the run.
+        :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:
+                # Certain options must be passed into the controller constructor to have the intended effect
+                self._cntlr = createCntlrAndPreloadPlugins(
+                    uiLang=options.uiLang,
+                    disablePersistentConfig=options.disablePersistentConfig,
+                    arellePluginModules={},
+                )
+            else:
+                # Certain options passed into the controller constructor need to be updated
+                if self._cntlr.uiLang != options.uiLang:
+                    self._cntlr.setUiLanguage(options.uiLang)
+                self._cntlr.disablePersistentConfig = options.disablePersistentConfig or False
+            logRefObjectProperties = True
+            if options.logRefObjectProperties is not None:
+                logRefObjectProperties = options.logRefObjectProperties
+            if options.webserver:
+                assert sourceZipStream is None, "Source streaming is not supported with webserver"
+                assert responseZipStream is None, "Response streaming is not supported with webserver"
+                if not self._cntlr.logger:
+                    self._cntlr.startLogging(
+                        logFileName='logToBuffer',
+                        logFilters=logFilters,
+                        logHandler=logHandler,
+                        logTextMaxLength=options.logTextMaxLength,
+                        logRefObjectProperties=logRefObjectProperties,
+                        logPropagate=options.logPropagate,
+                    )
+                    self._cntlr.postLoggingInit()
+                from arelle import CntlrWebMain
+                CntlrWebMain.startWebserver(self._cntlr, options)
+                return True
+            else:
+                if not self._cntlr.logger:
+                    self._cntlr.startLogging(
+                        logFileName=(options.logFile or "logToPrint"),
+                        logFileMode=options.logFileMode,
+                        logFormat=(options.logFormat or "[%(messageCode)s] %(message)s - %(file)s"),
+                        logLevel=(options.logLevel or "DEBUG"),
+                        logFilters=logFilters,
+                        logHandler=logHandler,
+                        logToBuffer=options.logFile == 'logToBuffer',
+                        logTextMaxLength=options.logTextMaxLength,  # e.g., used by EDGAR/render to require buffered logging
+                        logRefObjectProperties=logRefObjectProperties,
+                        logXmlMaxAttributeLength=options.logXmlMaxAttributeLength,
+                        logPropagate=options.logPropagate,
+                    )
+                    self._cntlr.postLoggingInit()  # Cntlr options after logging is started
+                return self._cntlr.run(
+                    options,
+                    sourceZipStream=sourceZipStream,
+                    responseZipStream=responseZipStream,
+                    sourceZipStreamFileName=sourceZipStreamFileName,
+                )

arelle_release-2.37.22/arelle/plugin/validate/NL/DisclosureSystems.py

@@ -0,0 +1,19 @@
+DISCLOSURE_SYSTEM_NT16 = 'NT16'
+DISCLOSURE_SYSTEM_NT17 = 'NT17'
+DISCLOSURE_SYSTEM_NT18 = 'NT18'
+DISCLOSURE_SYSTEM_NT19 = 'NT19'
+DISCLOSURE_SYSTEM_NL_INLINE_2024 = 'NL-INLINE-2024'
+DISCLOSURE_SYSTEM_NL_INLINE_2024_GAAP_OTHER = 'NL-INLINE-2024-GAAP-OTHER'
+
+ALL_NL_INLINE_DISCLOSURE_SYSTEMS = [
+    DISCLOSURE_SYSTEM_NL_INLINE_2024,
+    DISCLOSURE_SYSTEM_NL_INLINE_2024_GAAP_OTHER,
+]
+
+NL_INLINE_GAAP_IFRS_DISCLOSURE_SYSTEMS = [
+    DISCLOSURE_SYSTEM_NL_INLINE_2024,
+]
+
+NL_INLINE_GAAP_OTHER_DISCLOSURE_SYSTEMS = [
+    DISCLOSURE_SYSTEM_NL_INLINE_2024_GAAP_OTHER,
+]

arelle_release-2.37.22/arelle/plugin/validate/NL/LinkbaseType.py

@@ -0,0 +1,77 @@
+'''
+See COPYRIGHT.md for copyright information.
+'''
+from __future__ import annotations
+
+from enum import Enum
+
+from arelle import XbrlConst
+from arelle.ModelValue import QName
+
+
+class LinkbaseType(Enum):
+    CALCULATION = "calculation"
+    DEFINITION = "definition"
+    LABEL = "label"
+    PRESENTATION = "presentation"
+    REFERENCE = "reference"
+
+    @staticmethod
+    def fromRefUri(refUri: str | None) -> LinkbaseType | None:
+        """
+        Returns the LinkbaseType corresponding to the given ref URI.
+        If the URI does not match any known linkbase reference type, returns None.
+        """
+        if refUri is None:
+            return None
+        return LINKBASE_TYPE_BY_REF_URI.get(refUri, None)
+
+    def getArcQn(self) -> QName:
+        """
+        Returns the qname of the arc associated with this LinkbaseType.
+        """
+        return LINKBASE_ARC_QN[self]
+
+    def getLinkQn(self) -> QName:
+        """
+        Returns the qname of the link associated with this LinkbaseType.
+        """
+        return LINKBASE_LINK_QN[self]
+
+    def getLowerName(self) -> str:
+        """
+        Returns the lower-case name of this LinkbaseType.
+        """
+        return self.value.lower()
+
+    def getRefUri(self) -> str:
+        """
+        Returns the ref URI associated with this LinkbaseType.
+        """
+        return LINKBASE_REF_URIS[self]
+
+
+LINKBASE_ARC_QN = {
+    LinkbaseType.CALCULATION: XbrlConst.qnLinkCalculationArc,
+    LinkbaseType.DEFINITION: XbrlConst.qnLinkDefinitionArc,
+    LinkbaseType.LABEL: XbrlConst.qnLinkLabelArc,
+    LinkbaseType.PRESENTATION: XbrlConst.qnLinkPresentationArc,
+    LinkbaseType.REFERENCE: XbrlConst.qnLinkReferenceArc,
+}
+
+LINKBASE_LINK_QN = {
+    LinkbaseType.CALCULATION: XbrlConst.qnLinkCalculationLink,
+    LinkbaseType.DEFINITION: XbrlConst.qnLinkDefinitionLink,
+    LinkbaseType.LABEL: XbrlConst.qnLinkLabelLink,
+    LinkbaseType.PRESENTATION: XbrlConst.qnLinkPresentationLink,
+    LinkbaseType.REFERENCE: XbrlConst.qnLinkReferenceLink,
+}
+
+LINKBASE_REF_URIS = {
+    LinkbaseType.CALCULATION: "http://www.xbrl.org/2003/role/calculationLinkbaseRef",
+    LinkbaseType.DEFINITION: "http://www.xbrl.org/2003/role/definitionLinkbaseRef",
+    LinkbaseType.LABEL: "http://www.xbrl.org/2003/role/labelLinkbaseRef",
+    LinkbaseType.PRESENTATION: "http://www.xbrl.org/2003/role/presentationLinkbaseRef",
+    LinkbaseType.REFERENCE: "http://www.xbrl.org/2003/role/referenceLinkbaseRef",
+}
+LINKBASE_TYPE_BY_REF_URI = {v: k for k, v in LINKBASE_REF_URIS.items()}