arelle-release 2.36.37__py3-none-any.whl → 2.36.38__py3-none-any.whl

arelle/CntlrWebMain.py

@@ -41,7 +41,6 @@ POST = 'POST'
 _CNTLR: CntlrCmdLine | None = None
 
 def getCntlr() -> CntlrCmdLine:
-    global _CNTLR
     if _CNTLR is None:
         raise ValueError(_('_CNTLR accessed before it was set.'))
     return _CNTLR
@@ -59,7 +58,6 @@ def getLogHandler() -> LogToBufferHandler:
 _RUNTIME_OPTIONS: RuntimeOptions | None = None
 
 def getRuntimeOptions() -> RuntimeOptions:
-    global _RUNTIME_OPTIONS
     if _RUNTIME_OPTIONS is None:
         raise ValueError(_('_RUNTIME_OPTIONS accessed before it was set.'))
     options = deepcopy(_RUNTIME_OPTIONS)

arelle/PackageManager.py

@@ -342,7 +342,7 @@ packagesMappings = {}
 _cntlr = None
 
 def init(cntlr: Cntlr, loadPackagesConfig: bool = True) -> None:
-    global packagesJsonFile, packagesConfig, packagesMappings, _cntlr
+    global packagesJsonFile, packagesConfig, _cntlr
     if loadPackagesConfig:
         try:
             packagesJsonFile = cntlr.userAppDir + os.sep + "taxonomyPackages.json"

arelle/PluginManager.py

@@ -105,10 +105,13 @@ def save(cntlr: Cntlr) -> None:
             f.write(jsonStr)
         pluginConfigChanged = False
 
-def close():  # close all loaded methods
-    pluginConfig.clear()
-    modulePluginInfos.clear()
-    pluginMethodsForClasses.clear()
+def close() -> None:  # close all loaded methods
+    if pluginConfig is not None:
+        pluginConfig.clear()
+    if modulePluginInfos is not None:
+        modulePluginInfos.clear()
+    if pluginMethodsForClasses is not None:
+        pluginMethodsForClasses.clear()
     global webCache
     webCache = None
 
@@ -159,7 +162,6 @@ def logPluginTrace(message: str, level: Number) -> None:
     :param message: Message to be logged
     :param level: Log level of message (e.g. logging.INFO)
     """
-    global pluginTraceFileLogger
     if pluginTraceFileLogger:
         pluginTraceFileLogger.log(level, message)
     if level >= logging.ERROR:
@@ -486,7 +488,7 @@ def _get_name_dir_prefix(
     packageImportPrefix: str
 
     moduleFilename = controller.webCache.getfilename(
-        url=moduleURL, normalize=True, base=pluginBase
+        url=moduleURL, normalize=True, base=pluginBase, allowTransformation=False
     )
 
     if moduleFilename:

arelle/WebCache.py

@@ -455,7 +455,13 @@ class WebCache:
     def getfilename(
             self, url: str | None, base: str | None = None,
             reload: bool = False, checkModifiedTime: bool = False,
-            normalize: bool = False, filenameOnly: bool = False) -> str | None:
+            normalize: bool = False, filenameOnly: bool = False,
+            allowTransformation: bool = True) -> str | None:
+        if allowTransformation:
+            for pluginXbrlMethod in pluginClassMethods("WebCache.TransformURL"):
+                url, final = pluginXbrlMethod(self.cntlr, url, base)
+                if final:
+                    return url
         if url is None:
             return url
         if base is not None or normalize:

arelle/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.36.37'
-__version_tuple__ = version_tuple = (2, 36, 37)
+__version__ = version = '2.36.38'
+__version_tuple__ = version_tuple = (2, 36, 38)

arelle/api/Session.py

@@ -36,6 +36,7 @@ class Session:
     def close(self) -> None:
         if self._cntlr is not None:
             self._cntlr.close()
+        PluginManager.close()
 
     def get_log_messages(self) -> list[dict[str, Any]]:
         """

arelle/formula/XPathParser.py

@@ -898,7 +898,7 @@ isInitialized = False
 
 
 def initializeParser(modelManager: ModelManager) -> bool:
-    global isInitialized, ixtFunctionNamespaces
+    global isInitialized
     if not isInitialized:
         from arelle import FunctionIxt
         ixtFunctionNamespaces.update(FunctionIxt.ixtNamespaceFunctions.keys())

arelle/plugin/formulaLoader.py

@@ -1698,7 +1698,7 @@ def compileXfsGrammar( cntlr, debugParsing ):
 def parse(cntlr, _logMessage, xfFiles, modelXbrl=None, debugParsing=False):
     from pyparsing import ParseException, ParseSyntaxException
 
-    global xc, logMessage
+    global logMessage
     logMessage = _logMessage
 
     xfsGrammar = compileXfsGrammar(cntlr, debugParsing)

arelle/plugin/streamingExtensions.py

@@ -824,7 +824,7 @@ def streamingOptionsExtender(parser):
 '''
 
 def streamingExtensionsSetup(cntlr, options, *args, **kwargs):
-    global _streamingExtensionsCheck, _streamingExtensionsValidate
+    global _streamingExtensionsValidate
     # streaming only checked in CmdLine/web server mode if requested
     # _streamingExtensionsCheck = getattr(options, 'check_streaming', False)
     _streamingExtensionsValidate = options.validate

arelle/utils/PluginHooks.py

@@ -790,3 +790,26 @@ class PluginHooks(ABC):
         :return: None
         """
         raise NotImplementedError
+
+    @staticmethod
+    def webCacheTransformUrl(
+            cntlr: CntlrCmdLine,
+            url: str | None,
+            base: str | None,
+            *args: Any,
+            **kwargs: Any,
+    ) -> tuple[str | None, bool]:
+        """
+        Plugin hook: `WebCache.TransformURL`
+
+        This hook is triggered before the web cache maps a URL to a file path.
+        It's useful if you need to map certain URLs to a location other than the web cache.
+
+        :param cntlr: The [Cntlr](#arelle.Cntlr.Cntlr) being initialized.
+        :param url: The URL to transform.
+        :param base: The base URL.
+        :param args: Argument capture to ensure new parameters don't break plugin hook.
+        :param kwargs: Argument capture to ensure new named parameters don't break plugin hook.
+        :return: Tuple of transformed URL or filepath and a boolean indicating if the URL should be returned as the final filename.
+        """
+        raise NotImplementedError

{arelle_release-2.36.37.dist-info → arelle_release-2.36.38.dist-info}/METADATA

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

{arelle_release-2.36.37.dist-info → arelle_release-2.36.38.dist-info}/RECORD

@@ -5,7 +5,7 @@ arelle/CntlrCmdLine.py,sha256=B4C8ZnfRH67WVkFUFy3G_bTQ_vGc-DbQK6SLc-fcSCg,94266
 arelle/CntlrComServer.py,sha256=h1KPf31uMbErpxTZn_iklDqUMGFgQnjZkFkFjd8gtLQ,1888
 arelle/CntlrProfiler.py,sha256=2VQJudiUhxryVypxjODx2ccP1-n60icTiWs5lSEokhQ,972
 arelle/CntlrQuickBooks.py,sha256=BMqd5nkNQOZyNFPefkTeWUUDCYNS6BQavaG8k1Lepu4,31543
-arelle/CntlrWebMain.py,sha256=eOzqrp0XA3TrOu7m6Arcvnmdxt7-7zQ8xyaLs-dpDHg,51028
+arelle/CntlrWebMain.py,sha256=3llPzwDhshu7tcDZhdHQVuikTC5AucnQOvBgFSGsIAg,50982
 arelle/CntlrWinMain.py,sha256=eSdO_PQynuZcE3S7BnZyP-wnn_9oiUOMlF0Qe4Dl8x0,96812
 arelle/CntlrWinTooltip.py,sha256=6MzoAIfkYnNu_bl_je8n0adhwmKxAIcymkg9Tij9Z4M,7951
 arelle/DialogAbout.py,sha256=XXzMV0fO4BQ3-l1Puirzmn7EZEdmgJg7JNYdJm1FueM,1987
@@ -50,8 +50,8 @@ arelle/ModelValue.py,sha256=6Vko4aytXg2Ajv7rI6houQb-ZX39-tcjQ4N90ZxZvE8,39430
 arelle/ModelVersObject.py,sha256=cPD1IzhkCfuV1eMgVFWes88DH_6WkUj5kj7sgGF2M0I,26062
 arelle/ModelVersReport.py,sha256=bXEA9K3qkH57aABn5l-m3CTY0FAcF1yX6O4fo-URjl8,73326
 arelle/ModelXbrl.py,sha256=7rz4rxIGopwRDQTD12P0sdqzvPPoMhGgkg5qkMD6TDQ,72109
-arelle/PackageManager.py,sha256=VtiCnhX-ljObmZuf-wNmQC8OdVxz4Jan-rzSMJgY_QU,32548
-arelle/PluginManager.py,sha256=jpeRH-Co5NA8tVXQeIDgibOWN7aB8wprMNvjSYh_K6I,41947
+arelle/PackageManager.py,sha256=tw0PI9sbuy258Xv_Ldloj8mamDpc9_cBl6zhSdkiCLE,32530
+arelle/PluginManager.py,sha256=1Lvms_m1cUI27ETpKryDV5BQrKkTL_svRnyXVtjqZ3c,42076
 arelle/PluginUtils.py,sha256=0vFQ29wVVpU0cTY3YOBL6FhNQhhCTwShBH4qTJGLnvc,2426
 arelle/PrototypeDtsObject.py,sha256=0lf60VcXR_isx57hBPrc7vEMkFpYkVuK4JVBSmopzkQ,7989
 arelle/PrototypeInstanceObject.py,sha256=CXUoDllhDqpMvSQjqIYi1Ywp-J8fLhQRV9wVD2YXgVo,13204
@@ -113,7 +113,7 @@ arelle/ViewWinTupleGrid.py,sha256=Li21jmMSZP3xIkpg8eY8Sq7KTIuAgM57wHu7i7Nu3P0,89
 arelle/ViewWinVersReport.py,sha256=aYfsOgynVZpMzl6f2EzQCBLzdihYGycwb5SiTghkgMQ,9344
 arelle/ViewWinXml.py,sha256=4ZGKtjaoCwU9etKYm9ZAS7jSmUxba1rqNEdv0OIyjTY,1250
 arelle/WatchRss.py,sha256=5Ih4igH2MM4hpOuAXy9eO0QAyZ7jZR3S5bPzo2sdFpw,14097
-arelle/WebCache.py,sha256=_GDLhkEf1fxe0nTdO5eCKdNcB1f3Dfv2E6H5PPjNeX8,44733
+arelle/WebCache.py,sha256=8dTAc-A6whcNOfPCCo0e6XpVrXw1Kom9hSqGGeyaXNE,45018
 arelle/XbrlConst.py,sha256=YDvnf0gQ3IY5v07d8wxAHTxDmvcHIpl2mSMZeTgvKmk,56695
 arelle/XbrlUtil.py,sha256=s2Vmrh-sZI5TeuqsziKignOc3ao-uUgnCNoelP4dDj0,9212
 arelle/XhtmlValidate.py,sha256=0gtm7N-kXK0RB5o3c1AQXjfFuRp1w2fKZZAeyruNANw,5727
@@ -123,9 +123,9 @@ 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=5LSmSgWRRZykPQAlxX3yg4mSBU2cR_rLM7u3_PwsoaU,515
+arelle/_version.py,sha256=sZAy8AmcBgunxVPN9fYWYjWDD_AHGookdwWSsQ_snyw,515
 arelle/typing.py,sha256=Ct5lrNKRow_o9CraMEXNza8nFsJ_iGIKoUeGfPs2dxI,1084
-arelle/api/Session.py,sha256=Vd09RAutWX7mxHSsrW7Bl8CsE1UzXpQpAJsZb55mqng,6188
+arelle/api/Session.py,sha256=O8zpg7MJys9uxwwHf8OsSlZxpPdq7A3ONyY39Q4A3Kc,6218
 arelle/archive/CustomLogger.py,sha256=v_JXOCQLDZcfaFWzxC9FRcEf9tQi4rCI4Sx7jCuAVQI,1231
 arelle/archive/LoadEFMvalidate.py,sha256=HR1ZJmOvWGUlWEsWd0tGCa2TTtZSNzeL6tgN1TFfrl0,986
 arelle/archive/LoadSavePreLbCsv.py,sha256=mekr1R6OE5d3xdUCZIVfSeolyet0HO8R6wsHnW4eyaA,767
@@ -231,7 +231,7 @@ arelle/formula/FormulaConsisAsser.py,sha256=hO4GZwozM5cGl1xTU6OwoF3LlaMxAEB5Oy0r
 arelle/formula/FormulaEvaluator.py,sha256=WKNyJz1Os9gsKedJXLNC9y9u11Ea4_JQ-RAI7gSFmPU,82600
 arelle/formula/ValidateFormula.py,sha256=b_stG7h8RhaSsPt07_x-GRBHOl2uy-JNSMd6v-jkg_w,95942
 arelle/formula/XPathContext.py,sha256=JerF1suUL9RcKRFeF6kXZXGkuw6yaMb6gijNacrqugU,49386
-arelle/formula/XPathParser.py,sha256=hJkHT4siC8VpSP5JQ4a1qqSYWwHeDprK6aakrhxlcDk,50344
+arelle/formula/XPathParser.py,sha256=vqG2dj0yXVPZpIBsY2rxDIAFC376GSye4CLHfjVyhyM,50321
 arelle/formula/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 arelle/images/arelle-full-word.ico,sha256=jsAzyAJZTtVPafxhgFQtdWJj7r_r0YhX_iWvWnZ4QKg,2430
 arelle/images/arelle-mac-icon-4.gif,sha256=jTXc1dBEgZuXuZVd1XOuLuXfpjNW_pusn0mPhHhkOtk,2619
@@ -310,7 +310,7 @@ arelle/plugin/EdgarRendererAllReports.py,sha256=V3AeDj29U1XbnFGUO30kAvZtWzDH5G-t
 arelle/plugin/SECCorrespondenceLoader.py,sha256=dX3k4uI5SOKR-8zpv1Xk4X34eDQMPaWFS8R2wf8WTNs,9561
 arelle/plugin/TDnetLoader.py,sha256=iuvp5HsSbqJHoy3XBV2Zf1m2bow2ZR47obGw3QyH67Q,9208
 arelle/plugin/UKCompaniesHouseLoader.py,sha256=XDqt5KM_uv2gZVn8d0Kw18wbzhZEkagKirnDz1fSBGg,4682
-arelle/plugin/formulaLoader.py,sha256=AQTld34B_JWUX1uU5P7vIAW0dl51hoPlBVvOd1IDROU,101799
+arelle/plugin/formulaLoader.py,sha256=_pPZQPAZeNjGj85rvH7QRl4gEjYD7Yhxl1JhuV9wOoE,101795
 arelle/plugin/formulaSaver.py,sha256=STlKyDA-pVUxZoEW57MSu74RdpyHVTxaHvOZyOt0cyg,31385
 arelle/plugin/formulaXPathChecker.py,sha256=sEEeLHx17XSj8eOgFdzYLBp9ZFk2UUYLOEKtaF_pq34,18795
 arelle/plugin/functionsMath.py,sha256=Z8N7ok3w1aOusCQA9QvqYwQ8W1j80bb-_4lVclBnNQM,9037
@@ -326,7 +326,7 @@ arelle/plugin/saveLoadableExcel.py,sha256=ZPYB6injFabav0dRzgS7adCFzfHkwtftjl3PfB
 arelle/plugin/saveLoadableOIM.py,sha256=onT61QRygFCMGS7xTZHJz9WSo1V5PyqKQRtoTBf7GDE,38180
 arelle/plugin/saveSKOS.py,sha256=7Z1Qedf83zMo9EbigKkxNpiMjzkTYQvLEnwWMObLc1Y,12465
 arelle/plugin/saveSampleInstance.py,sha256=w66Nd4He8yIK4Il_M9qnelpeUJ_6cBBe5q01DanOxEA,23823
-arelle/plugin/streamingExtensions.py,sha256=gDt3TfkHcDHqnP8jnBWmC3j5i0u53lgUOSKxHJU8HnI,47646
+arelle/plugin/streamingExtensions.py,sha256=9W4iQ1u8LFn7-ZEfbqBtuwKiZj-aq8FUXNmj5VawRXQ,47619
 arelle/plugin/systemInfo.py,sha256=Rv_9HmDwkswwBmhxrkz8uAL65J332r-QItTYMSz2Zbc,1641
 arelle/plugin/unpackSecEisFile.py,sha256=TVdYUKhgAZ0145anRi6kBesOxPJEvC5YROO1j-hcuwU,2631
 arelle/plugin/xuleSaver.py,sha256=3eNZAxziFos0YrC5NWezFPsIxN7Ex8jb-CaOVTd8Gw4,30073
@@ -697,7 +697,7 @@ arelle/scripts-macOS/startWebServer.command,sha256=KXLSwAwchDZBlL-k9PYXdf39RNBtt
 arelle/scripts-unix/startWebServer.sh,sha256=_0puRzaGkdMZoFn3R7hDti9a3ryN6kTZAXwLweeZU1s,42
 arelle/scripts-windows/startWebServer.bat,sha256=qmnF1yrjNo__bi4QodONWlN0qHShVLTKptJQYyZtgcY,122
 arelle/utils/PluginData.py,sha256=GUnuZaApm1J4Xm9ZA1U2M1aask-AaNGviLtc0fgXbFg,265
-arelle/utils/PluginHooks.py,sha256=USi7zEZzwzTnKdKSyM3Xjacodo6YcU_Lb3EPQwWiVg4,30220
+arelle/utils/PluginHooks.py,sha256=nqL5NdW8yea0cMqePSf4TbNK1IU6jbqIwBX18Ar2n2A,31189
 arelle/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 arelle/utils/validate/Decorator.py,sha256=8LGmA171HZgKrALtsMKyHqMNM-XCdwJOv6KpZz4pC2c,3161
 arelle/utils/validate/DetectScriptsInXhtml.py,sha256=JOgsUP0_kvE6O3TuhzKxqKG1ZFP9LrUYZBgrar6JEm0,2178
@@ -706,7 +706,7 @@ arelle/utils/validate/ValidationPlugin.py,sha256=_WeRPXZUTCcSN3FLbFwiAe_2pAUTxZZ
 arelle/utils/validate/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 arelle/webserver/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 arelle/webserver/bottle.py,sha256=676nP8SOB42QscV0WIbXoSV9MwdgvbrzeIApxr6mlUI,171255
-arelle_release-2.36.37.dist-info/licenses/LICENSE.md,sha256=rMbWwFLGzPgLoEjEu8LCmkpWDTqsvfOI-wzLSfeJsis,4107
+arelle_release-2.36.38.dist-info/licenses/LICENSE.md,sha256=rMbWwFLGzPgLoEjEu8LCmkpWDTqsvfOI-wzLSfeJsis,4107
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/integration_tests/download_cache.py,sha256=jVMIVICsZjcVc9DCPPu3fCjF9_cWSS3tqSynhFs3oAM,4097
 tests/integration_tests/integration_test_util.py,sha256=H7mncbv0T9ZeVyrtk9Hohe3k6jgcYykHkt-LGE-Q9aQ,10270
@@ -1554,8 +1554,8 @@ tests/unit_tests/arelle/oim/test_load.py,sha256=NxiUauQwJVfWAHbbpsMHGSU2d3Br8Pki
 tests/unit_tests/arelle/plugin/test_plugin_imports.py,sha256=bdhIs9frAnFsdGU113yBk09_jis-z43dwUItMFYuSYM,1064
 tests/unit_tests/arelle/plugin/validate/ESEF/ESEF_Current/test_validate_css_url.py,sha256=XHABmejQt7RlZ0udh7v42f2Xb2STGk_fSaIaJ9i2xo0,878
 tests/unit_tests/arelle/utils/validate/test_decorator.py,sha256=ZS8FqIY1g-2FCbjF4UYm609dwViax6qBMRJSi0vfuhY,2482
-arelle_release-2.36.37.dist-info/METADATA,sha256=i0hQ9WSC7GP9vrnQbQ3kiMMUeQCeMDjt6rC8oon6e2U,9032
-arelle_release-2.36.37.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
-arelle_release-2.36.37.dist-info/entry_points.txt,sha256=Uj5niwfwVsx3vaQ3fYj8hrZ1xpfCJyTUA09tYKWbzpo,111
-arelle_release-2.36.37.dist-info/top_level.txt,sha256=ZYmYGmhW5Jvo3vJ4iXBZPUI29LvYhntom04w90esJvU,13
-arelle_release-2.36.37.dist-info/RECORD,,
+arelle_release-2.36.38.dist-info/METADATA,sha256=15bU0khPJ2yhjrC7NA6Mrh7k44oRA_M9B8MvW7BuD_Y,9032
+arelle_release-2.36.38.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+arelle_release-2.36.38.dist-info/entry_points.txt,sha256=Uj5niwfwVsx3vaQ3fYj8hrZ1xpfCJyTUA09tYKWbzpo,111
+arelle_release-2.36.38.dist-info/top_level.txt,sha256=ZYmYGmhW5Jvo3vJ4iXBZPUI29LvYhntom04w90esJvU,13
+arelle_release-2.36.38.dist-info/RECORD,,

{arelle_release-2.36.37.dist-info → arelle_release-2.36.38.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (77.0.3)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any