ixbrl-viewer 1.4.13__py3-none-any.whl → 1.4.15__py3-none-any.whl

iXBRLViewerPlugin/__init__.py

@@ -9,7 +9,6 @@ import sys
 import tempfile
 import traceback
 from optparse import OptionGroup, OptionParser
-from typing import Optional, Union
 
 from arelle import Cntlr
 from arelle.LocalViewer import LocalViewer
@@ -18,7 +17,7 @@ from arelle.webserver.bottle import static_file
 
 from .constants import CONFIG_FEATURE_PREFIX, CONFIG_LAUNCH_ON_LOAD, \
     CONFIG_SCRIPT_URL, DEFAULT_LAUNCH_ON_LOAD, DEFAULT_OUTPUT_NAME, \
-    DEFAULT_VIEWER_PATH, FEATURE_CONFIGS
+    DEFAULT_JS_FILENAME, DEFAULT_VIEWER_PATH, FEATURE_CONFIGS
 from .iXBRLViewer import IXBRLViewerBuilder, IXBRLViewerBuilderError
 
 
@@ -96,13 +95,15 @@ def iXBRLViewerCommandLineOptionExtender(parser, *args, **kwargs):
 
 def generateViewer(
         cntlr: Cntlr,
-        saveViewerDest: Union[io.BytesIO, str],
+        saveViewerDest: io.BytesIO | str | None,
         viewerURL: str = DEFAULT_VIEWER_PATH,
         showValidationMessages: bool = False,
         useStubViewer: bool = False,
         zipViewerOutput: bool = False,
-        features: Optional[list[str]] = None,
-        packageDownloadURL: str = None):
+        features: list[str] | None = None,
+        packageDownloadURL: str | None = None,
+        copyScript = True
+) -> None:
     """
     Generate and save a viewer at the given destination (file, directory, or in-memory file) with the given viewer URL.
     If the viewer URL is a location on the local file system, a copy will be placed included in the output destination.
@@ -115,6 +116,8 @@ def generateViewer(
     :param features: List of feature names to enable via generated JSON data.
     """
     # extend XBRL-loaded run processing for this option
+    if saveViewerDest is None:
+        return
     if (cntlr.modelManager is None 
         or len(cntlr.modelManager.loadedModelXbrls) == 0 
         or any(not mx.modelDocument for mx in cntlr.modelManager.loadedModelXbrls)):
@@ -135,24 +138,22 @@ def generateViewer(
         else:
             viewerAbsolutePath = getAbsoluteViewerPath(saveViewerDest, viewerURL)
 
-        if os.path.isfile(viewerAbsolutePath):
+        if copyScript and os.path.isfile(viewerAbsolutePath):
             # The script was found on the local file system and will be copied into the
             # destination directory, so the local path (just the basename) of viewerURL should
             # be passed to the script tag
             copyScriptPath = viewerURL
             viewerURL = os.path.basename(viewerURL)
     try:
-        out = saveViewerDest
-        if out:
-            viewerBuilder = IXBRLViewerBuilder(cntlr.modelManager.loadedModelXbrls)
-            if features:
-                for feature in features:
-                    viewerBuilder.enableFeature(feature)
-            iv = viewerBuilder.createViewer(scriptUrl=viewerURL, showValidations=showValidationMessages, useStubViewer=useStubViewer, packageDownloadURL=packageDownloadURL)
-            if iv is not None:
-                iv.save(out, zipOutput=zipViewerOutput, copyScriptPath=copyScriptPath)
+        viewerBuilder = IXBRLViewerBuilder(cntlr.modelManager.loadedModelXbrls)
+        if features:
+            for feature in features:
+                viewerBuilder.enableFeature(feature)
+        iv = viewerBuilder.createViewer(scriptUrl=viewerURL, showValidations=showValidationMessages, useStubViewer=useStubViewer, packageDownloadURL=packageDownloadURL)
+        if iv is not None:
+            iv.save(saveViewerDest, zipOutput=zipViewerOutput, copyScriptPath=copyScriptPath)
     except IXBRLViewerBuilderError as ex:
-        print(ex.message)
+        print(ex)
     except Exception as ex:
         cntlr.addToLog("Exception {} \nTraceback {}".format(ex, traceback.format_tb(sys.exc_info()[2])))
 
@@ -170,7 +171,7 @@ def getAbsoluteViewerPath(saveViewerPath: str, relativeViewerPath: str) -> str:
     return os.path.join(saveViewerDir, relativeViewerPath)
 
 
-def getFeaturesFromOptions(options: Union[argparse.Namespace, OptionParser]):
+def getFeaturesFromOptions(options: argparse.Namespace | OptionParser):
     return [
         featureConfig.key
         for featureConfig in FEATURE_CONFIGS
@@ -206,7 +207,7 @@ def iXBRLViewerSaveCommand(cntlr):
         generateViewer(
             cntlr,
             dialog.filename(),
-            dialog.scriptUrl(),
+            dialog.scriptUrl() or DEFAULT_VIEWER_PATH,
             zipViewerOutput=dialog.zipViewerOutput(),
             features=dialog.features()
         )
@@ -249,23 +250,23 @@ def commandLineRun(*args, **kwargs):
 class iXBRLViewerLocalViewer(LocalViewer):
     # plugin-specific local file handler
     def getLocalFile(self, file, relpath, request):
-        _report, _sep, _file = file.partition("/")
-        if file == 'ixbrlviewer.js':
-            return static_file('ixbrlviewer.js', os.path.dirname(DEFAULT_VIEWER_PATH))
-        elif _report.isnumeric():  # in reportsFolder folder
+        if file == DEFAULT_JS_FILENAME:
+            return static_file(DEFAULT_JS_FILENAME, os.path.dirname(DEFAULT_VIEWER_PATH))
+        _report, _, _file = file.partition("/")
+        if _report.isnumeric():  # in reportsFolder folder
             # check if file is in the current or parent directory
             _fileDir = self.reportsFolders[int(_report)]
             _fileExists = False
             if os.path.exists(os.path.join(_fileDir, _file)):
                 _fileExists = True
-            elif "/" in _file and os.path.exists(os.path.join(_fileDir, os.path.filepart(_file))):
+            elif "/" in _file and os.path.exists(os.path.join(_fileDir, os.path.basename(_file))):
                 # xhtml in a subdirectory for output files may refer to an image file in parent directory
                 _fileExists = True
-                _file = os.path.filepart(_file)
+                _file = os.path.basename(_file)
             if not _fileExists:
                 self.cntlr.addToLog("http://localhost:{}/{}".format(self.port, file), messageCode="localViewer:fileNotFound", level=logging.DEBUG)
             return static_file(_file, root=_fileDir, headers=self.noCacheHeaders)  # extra_headers modification to py-bottle
-        return static_file(file, root="/")  # probably can't get here unless path is wrong
+        return static_file(file, root="/")  # absolute path used for ixbrlviewer.js.
 
 
 def guiRun(cntlr, modelXbrl, attach, *args, **kwargs):
@@ -286,7 +287,7 @@ def guiRun(cntlr, modelXbrl, attach, *args, **kwargs):
         generateViewer(
             cntlr,
             saveViewerDest=tempViewer.name,
-            viewerURL=cntlr.config.setdefault(CONFIG_SCRIPT_URL, DEFAULT_VIEWER_PATH),
+            viewerURL=cntlr.config.get(CONFIG_SCRIPT_URL) or DEFAULT_VIEWER_PATH,
             useStubViewer=True,
             features=features
         )

iXBRLViewerPlugin/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.4.13'
-__version_tuple__ = version_tuple = (1, 4, 13)
+__version__ = version = '1.4.15'
+__version_tuple__ = version_tuple = (1, 4, 15)

iXBRLViewerPlugin/constants.py

@@ -13,7 +13,8 @@ CONFIG_ZIP_OUTPUT = 'iXBRLViewerZipOutput'
 
 DEFAULT_LAUNCH_ON_LOAD = True
 DEFAULT_OUTPUT_NAME = 'ixbrlviewer.html'
-DEFAULT_VIEWER_PATH = os.path.join(os.path.dirname(__file__), "viewer", "dist", "ixbrlviewer.js")
+DEFAULT_JS_FILENAME = 'ixbrlviewer.js'
+DEFAULT_VIEWER_PATH = os.path.join(os.path.dirname(__file__), "viewer", "dist", DEFAULT_JS_FILENAME)
 
 FEATURE_CONFIGS = [
     FeatureConfig(

iXBRLViewerPlugin/iXBRLViewer.py

@@ -12,7 +12,6 @@ import urllib.parse
 import zipfile
 from collections import defaultdict
 from copy import deepcopy
-from typing import Optional, Union
 
 import pycountry
 from arelle import XbrlConst
@@ -266,11 +265,15 @@ class IXBRLViewerBuilder:
             factData["v"] = None
         elif f.concept is not None and f.concept.isEnumeration:
             qnEnums = f.xValue
-            if not isinstance(qnEnums, list):
-                qnEnums = (qnEnums,)
-            factData["v"] = " ".join(self.nsmap.qname(qn) for qn in qnEnums)
-            for qn in qnEnums:
-                self.addConcept(report, report.qnameConcepts.get(qn))
+            if qnEnums is None:
+                factData["v"] = f.value
+                factData["err"] = 'INVALID_IX_VALUE'
+            else:
+                if not isinstance(qnEnums, list):
+                    qnEnums = (qnEnums,)
+                factData["v"] = " ".join(self.nsmap.qname(qn) for qn in qnEnums)
+                for qn in qnEnums:
+                    self.addConcept(report, report.qnameConcepts.get(qn))
         else:
             factData["v"] = f.value 
             if f.value == INVALIDixVALUE:
@@ -390,7 +393,13 @@ class IXBRLViewerBuilder:
         self.taxonomyData["sourceReports"].append(sourceReport)
         return sourceReport
 
-    def createViewer(self, scriptUrl: str = DEFAULT_VIEWER_PATH, useStubViewer: bool = False, showValidations: bool = True, packageDownloadURL: str = None) -> Optional[iXBRLViewer]:
+    def createViewer(
+            self,
+            scriptUrl: str = DEFAULT_VIEWER_PATH,
+            useStubViewer: bool = False,
+            showValidations: bool = True,
+            packageDownloadURL: str | None = None,
+    ) -> iXBRLViewer | None:
         """
         Create an iXBRL file with XBRL data as a JSON blob, and script tags added.
         :param scriptUrl: The `src` value of the script tag that loads the viewer script.
@@ -526,7 +535,7 @@ class iXBRLViewer:
     def addFilingDoc(self, filingDocuments):
         self.filingDocuments = filingDocuments
 
-    def save(self, destination: Union[io.BytesIO, str], zipOutput: bool = False, copyScriptPath: Optional[str] = None):
+    def save(self, destination: io.BytesIO | str, zipOutput: bool = False, copyScriptPath: str | None = None):
         """
         Save the iXBRL viewer.
         :param destination: The target that viewer data/files will be written to (path to file/directory, or a file object itself).

iXBRLViewerPlugin/ui.py

@@ -10,8 +10,9 @@ import os
 
 from .constants import CONFIG_FEATURE_PREFIX, CONFIG_FILE_DIRECTORY, CONFIG_LAUNCH_ON_LOAD, \
     CONFIG_OUTPUT_FILE, CONFIG_SCRIPT_URL, CONFIG_ZIP_OUTPUT, DEFAULT_LAUNCH_ON_LOAD, \
-    DEFAULT_VIEWER_PATH, GUI_FEATURE_CONFIGS
+    GUI_FEATURE_CONFIGS
 
+UNSET_SCRIPT_URL = ''
 
 class BaseViewerDialog(Toplevel):
     """
@@ -28,7 +29,7 @@ class BaseViewerDialog(Toplevel):
             featureVar.set(self.cntlr.config.setdefault(f'{CONFIG_FEATURE_PREFIX}{featureConfig.key}', featureConfig.guiDefault))
             self._features[featureConfig.key] = featureVar
         self._scriptUrl = StringVar()
-        self._scriptUrl.set(self.cntlr.config.setdefault(CONFIG_SCRIPT_URL, DEFAULT_VIEWER_PATH))
+        self._scriptUrl.set(self.cntlr.config.setdefault(CONFIG_SCRIPT_URL, UNSET_SCRIPT_URL))
 
     def addButtons(self, frame: Frame, x: int, y: int) -> int:
         """
@@ -56,7 +57,7 @@ class BaseViewerDialog(Toplevel):
         :return: Row `y` that the last field was added on
         """
         y += 1
-        scriptUrlLabel = Label(frame, text="Script URL")
+        scriptUrlLabel = Label(frame, text="Script URL (leave blank for default)")
         scriptUrlEntry = Entry(frame, textvariable=self._scriptUrl, width=80)
         scriptUrlLabel.grid(row=y, column=0, sticky=W, pady=3, padx=3)
         scriptUrlEntry.grid(row=y, column=1, columnspan=2, sticky=EW, pady=3, padx=3)
@@ -247,6 +248,6 @@ class SettingsDialog(BaseViewerDialog):
         Resets dialog variable values to default values
         """
         self._launchOnLoad.set(DEFAULT_LAUNCH_ON_LOAD)
-        self._scriptUrl.set(DEFAULT_VIEWER_PATH)
+        self._scriptUrl.set(UNSET_SCRIPT_URL)
         for featureConfig in GUI_FEATURE_CONFIGS:
             self._features[featureConfig.key].set(featureConfig.guiDefault)