ixbrl-viewer 1.4.20__py3-none-any.whl → 1.4.49__py3-none-any.whl

iXBRLViewerPlugin/__init__.py

@@ -10,6 +10,7 @@ import tempfile
 import traceback
 from optparse import OptionGroup, OptionParser
 from pathlib import Path
+from typing import Any
 
 from arelle import Cntlr
 from arelle.LocalViewer import LocalViewer
@@ -21,7 +22,10 @@ from .constants import CONFIG_COPY_SCRIPT, CONFIG_FEATURE_PREFIX, CONFIG_LAUNCH_
     CONFIG_SCRIPT_URL, DEFAULT_COPY_SCRIPT, DEFAULT_LAUNCH_ON_LOAD, DEFAULT_OUTPUT_NAME, \
     DEFAULT_JS_FILENAME, DEFAULT_VIEWER_PATH, ERROR_MESSAGE_CODE, \
     EXCEPTION_MESSAGE_CODE, FEATURE_CONFIGS
-from .iXBRLViewer import IXBRLViewerBuilder, IXBRLViewerBuilderError
+from .iXBRLViewer import IXBRLViewerBuilder, IXBRLViewerBuilderError, isInlineDoc
+from .plugin import IXBRLViewerPluginData
+
+PLUGIN_NAME = 'ixbrl-viewer'
 
 #
 # GUI operation:
@@ -94,26 +98,45 @@ def iXBRLViewerCommandLineOptionExtender(parser, *args, **kwargs):
                       dest="zipViewerOutput",
                       help="Converts the viewer output into a self contained zip")
 
-    # Force "keepOpen" to true, so that all models are retained.  Needed for
-    # multi-instance viewers.
-    parser.set_defaults(keepOpen = True)
-
     featureGroup = OptionGroup(parser, "Viewer Features",
                             "See viewer README for information on enabling/disabling features.")
     for featureConfig in FEATURE_CONFIGS:
-        arg = f'--viewer-feature-{featureConfig.key}'
-        featureGroup.add_option(arg, arg.lower(), action="store_true", default=False, help=featureConfig.description)
+        arg = f'--viewer-feature-{featureConfig.key}'.replace('_', '-')
+        featureGroup.add_option(
+            arg,
+            arg.lower(),
+            action=featureConfig.cliAction,
+            default=featureConfig.cliDefault,
+            help=featureConfig.description
+        )
     parser.add_option_group(featureGroup)
 
+def pluginData(cntlr: Cntlr):
+    pluginData = cntlr.getPluginData(PLUGIN_NAME)
+    if pluginData is None:
+        pluginData = IXBRLViewerPluginData(PLUGIN_NAME)
+        cntlr.setPluginData(pluginData)
+    return pluginData
+
+def resetPluginData(cntlr: Cntlr):
+    pluginData(cntlr).builder = None
+
+def processModel(cntlr: Cntlr, modelXbrl: ModelXbrl):
+    try:
+        if isInlineDoc(modelXbrl.modelDocument):
+            pluginData(cntlr).builder.processModel(modelXbrl)
+    except IXBRLViewerBuilderError as ex:
+        print(ex)
+    except Exception as ex:
+        tb = traceback.format_tb(sys.exc_info()[2])
+        cntlr.addToLog(f"Exception {ex} \nTraceback {tb}", messageCode=EXCEPTION_MESSAGE_CODE)
 
 def generateViewer(
         cntlr: Cntlr,
         saveViewerDest: io.BytesIO | str | None,
-        viewerURL: str = DEFAULT_VIEWER_PATH,
+        viewerURL: str | None = None,
         showValidationMessages: bool = False,
-        useStubViewer: bool = False,
         zipViewerOutput: bool = False,
-        features: list[str] | None = None,
         packageDownloadURL: str | None = None,
         copyScript: bool = True,
 ) -> None:
@@ -126,7 +149,6 @@ def generateViewer(
     :param showValidationMessages: True if validation messages should be shown in the viewer.
     :param useStubViewer: True if the stub viewer should be used.
     :param zipViewerOutput: True if the destination is a zip archive.
-    :param features: Optional list of features to enable.
     :param packageDownloadURL: Optional URL to use as the report package download URL.
     :param copyScript: Controls if the script referenced by viewerURL is copied into the output directory, or directly set as the 'src' value of the script tag in the HTML iXBRL Viewer.
     """
@@ -136,17 +158,12 @@ def generateViewer(
         cntlr.addToLog(f"iXBRL Viewer destination not provided. {abortGenerationMsg}", messageCode=EXCEPTION_MESSAGE_CODE)
         return
 
-    if not viewerURL:
-        cntlr.addToLog(f"iXBRL Viewer script not provided. {abortGenerationMsg}", messageCode=EXCEPTION_MESSAGE_CODE)
-        return
+    viewerURL = viewerURL or DEFAULT_VIEWER_PATH
 
-    if (cntlr.modelManager is None
-        or len(cntlr.modelManager.loadedModelXbrls) == 0
-        or any(not mx.modelDocument for mx in cntlr.modelManager.loadedModelXbrls)):
-        cntlr.addToLog(f"No taxonomy loaded. {abortGenerationMsg}", messageCode=ERROR_MESSAGE_CODE)
-        return
-    if cntlr.modelManager.modelXbrl.modelDocument.type not in (Type.INLINEXBRL, Type.INLINEXBRLDOCUMENTSET):
-        cntlr.addToLog(f"No inline XBRL document loaded. {abortGenerationMsg}", messageCode=ERROR_MESSAGE_CODE)
+    bldr = pluginData(cntlr).builder
+
+    if bldr.reportCount == 0:
+        cntlr.addToLog(f"No inline XBRL documents loaded. {abortGenerationMsg}", messageCode=ERROR_MESSAGE_CODE)
         return
 
     copyScriptPath = None
@@ -173,11 +190,7 @@ def generateViewer(
             return
 
     try:
-        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)
+        iv = bldr.createViewer(scriptUrl=viewerURL, showValidations=showValidationMessages, packageDownloadURL=packageDownloadURL)
         if iv is not None:
             iv.save(saveViewerDest, zipOutput=zipViewerOutput, copyScriptPath=copyScriptPath)
     except IXBRLViewerBuilderError as ex:
@@ -185,26 +198,34 @@ def generateViewer(
     except Exception as ex:
         tb = traceback.format_tb(sys.exc_info()[2])
         cntlr.addToLog(f"Exception {ex} \nTraceback {tb}", messageCode=EXCEPTION_MESSAGE_CODE)
+    resetPluginData(cntlr)
 
 
-def getFeaturesFromOptions(options: argparse.Namespace | OptionParser):
-    return [
-        featureConfig.key
-        for featureConfig in FEATURE_CONFIGS
-        if getattr(options, f'viewer_feature_{featureConfig.key}') or getattr(options, f'viewer_feature_{featureConfig.key.lower()}')
-    ]
+def getFeaturesFromOptions(options: argparse.Namespace | OptionParser) -> dict[str, Any]:
+    features = {}
+    for featureConfig in FEATURE_CONFIGS:
+        key = featureConfig.key
+        option = f'viewer_feature_{key}'
+        value = getattr(options, option, None)
+        if value is not None:
+            features[key] = value
+    return features
+
 
+def iXBRLViewerCommandLineXbrlRun(cntlr, options, modelXbrl, *args, **kwargs):
+    pd = pluginData(cntlr)
+    if pd.builder is None:
+        pd.builder = IXBRLViewerBuilder(cntlr, useStubViewer = options.useStubViewer, features=getFeaturesFromOptions(options))
+    processModel(cntlr, modelXbrl)
 
-def iXBRLViewerCommandLineXbrlRun(cntlr, options, *args, **kwargs):
+def iXBRLViewerCommandLineFilingEnd(cntlr, options, *args, **kwargs):
     generateViewer(
         cntlr=cntlr,
         saveViewerDest=options.saveViewerDest or kwargs.get("responseZipStream"),
         viewerURL=options.viewerURL,
         copyScript=not options.viewerNoCopyScript,
         showValidationMessages=options.validationMessages,
-        useStubViewer=options.useStubViewer,
         zipViewerOutput=options.zipViewerOutput,
-        features=getFeaturesFromOptions(options),
         packageDownloadURL=options.packageDownloadURL,
     )
 
@@ -220,14 +241,19 @@ def iXBRLViewerSaveCommand(cntlr):
         return
     dialog = SaveViewerDialog(cntlr)
     dialog.render()
+    features = {
+        feature: True
+        for feature in dialog.features()
+    }
+    pluginData(cntlr).builder = IXBRLViewerBuilder(cntlr, features=features)
+    processModel(cntlr, modelXbrl)
     if dialog.accepted and dialog.filename():
         generateViewer(
             cntlr=cntlr,
             saveViewerDest=dialog.filename(),
-            viewerURL=dialog.scriptUrl() or DEFAULT_VIEWER_PATH,
+            viewerURL=dialog.scriptUrl(),
             copyScript=dialog.copyScript(),
             zipViewerOutput=dialog.zipViewerOutput(),
-            features=dialog.features(),
         )
 
 
@@ -261,9 +287,11 @@ def commandLineOptionExtender(*args, **kwargs):
     iXBRLViewerCommandLineOptionExtender(*args, **kwargs)
 
 
-def commandLineRun(*args, **kwargs):
-    iXBRLViewerCommandLineXbrlRun(*args, **kwargs)
+def commandLineRun(cntlr, options, modelXbrl, *args, **kwargs):
+    iXBRLViewerCommandLineXbrlRun(cntlr, options, modelXbrl, *args, **kwargs)
 
+def commandLineFilingEnd(*args, **kwargs):
+    iXBRLViewerCommandLineFilingEnd(*args, **kwargs)
 
 class iXBRLViewerLocalViewer(LocalViewer):
     # plugin-specific local file handler
@@ -297,18 +325,17 @@ def guiRun(cntlr, modelXbrl, attach, *args, **kwargs):
         global tempViewer
         tempViewer = tempfile.TemporaryDirectory()
         viewer_file_name = DEFAULT_OUTPUT_NAME
-        features = [
-            c.key
-            for c in FEATURE_CONFIGS
-            if cntlr.config.setdefault(f'{CONFIG_FEATURE_PREFIX}{c.key}', False)
-        ]
+        features = {}
+        for featureConfig in FEATURE_CONFIGS:
+            if cntlr.config.setdefault(f'{CONFIG_FEATURE_PREFIX}{featureConfig.key}', False):
+                features[featureConfig.key] = True
+        pluginData(cntlr).builder = IXBRLViewerBuilder(cntlr, useStubViewer=True, features=features)
+        processModel(cntlr, modelXbrl)
         generateViewer(
             cntlr=cntlr,
             saveViewerDest=tempViewer.name,
-            viewerURL=cntlr.config.get(CONFIG_SCRIPT_URL) or DEFAULT_VIEWER_PATH,
+            viewerURL=cntlr.config.get(CONFIG_SCRIPT_URL),
             copyScript=cntlr.config.get(CONFIG_COPY_SCRIPT, DEFAULT_COPY_SCRIPT),
-            useStubViewer=True,
-            features=features,
         )
         if Path(tempViewer.name, viewer_file_name).exists():
             localViewer = iXBRLViewerLocalViewer("iXBRL Viewer",  os.path.dirname(__file__))
@@ -327,7 +354,7 @@ def load_plugin_url():
 
 
 __pluginInfo__ = {
-    'name': 'ixbrl-viewer',
+    'name': PLUGIN_NAME,
     'aliases': [
         'iXBRLViewerPlugin',
     ],
@@ -337,7 +364,8 @@ __pluginInfo__ = {
     'author': 'Paul Warren',
     'copyright': 'Copyright :: Workiva Inc. :: 2019',
     'CntlrCmdLine.Options': commandLineOptionExtender,
-    'CntlrCmdLine.Filing.End': commandLineRun,
+    'CntlrCmdLine.Xbrl.Run': commandLineRun,
+    'CntlrCmdLine.Filing.End': commandLineFilingEnd,
     'CntlrWinMain.Menu.Tools': toolsMenuExtender,
     'CntlrWinMain.Xbrl.Loaded': guiRun,
 }

iXBRLViewerPlugin/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.4.20'
-__version_tuple__ = version_tuple = (1, 4, 20)
+__version__ = version = '1.4.49'
+__version_tuple__ = version_tuple = (1, 4, 49)

iXBRLViewerPlugin/constants.py

@@ -23,13 +23,98 @@ DEFAULT_JS_FILENAME = 'ixbrlviewer.js'
 DEFAULT_VIEWER_PATH = os.path.join(os.path.dirname(__file__), "viewer", "dist", DEFAULT_JS_FILENAME)
 
 FEATURE_CONFIGS = [
+    FeatureConfig(
+        key='home_link_label',
+        label='Home Link (Label)',
+        description='Customizes the label of the "Home" link enabled by "home_link_url".',
+        cliAction='store',
+        cliDefault=None,
+        guiVisible=False,
+        guiDefault=None,
+    ),
+    FeatureConfig(
+        key='home_link_url',
+        label='Home Link (URL)',
+        description='Adds a "Home" link that directs to the specified URL. Label can be customized with "home_link_label".',
+        cliAction='store',
+        cliDefault=None,
+        guiVisible=False,
+        guiDefault=None,
+    ),
+    FeatureConfig(
+        key='support_link',
+        label='Support Link',
+        description='Adds a "Support" link that directs to the specified URL.',
+        cliAction='store',
+        cliDefault=None,
+        guiVisible=False,
+        guiDefault=None,
+    ),
+    FeatureConfig(
+        key='survey_link',
+        label='Survey Link',
+        description='Adds a "Survey" link that directs to the specified URL.',
+        cliAction='store',
+        cliDefault=None,
+        guiVisible=False,
+        guiDefault=None,
+    ),
     FeatureConfig(
         key='review',
         label='Review Mode',
         description='Enables highlighting of untagged numbers and dates.',
+        cliAction='store_true',
+        cliDefault=False,
+        guiVisible=True,
+        guiDefault=False
+    ),
+    FeatureConfig(
+        key='mandatory_facts',
+        label='Mandatory Facts',
+        description='Enables the display of mandatory facts for the selected taxonomy.',
+        cliAction='store',
+        cliDefault=None,
+        guiVisible=False,
+        guiDefault=None
+    ),
+    FeatureConfig(
+        key='search_on_startup',
+        label='Search on startup',
+        description='Show the search pane by default on startup.',
+        cliAction='store_true',
+        cliDefault=None,
+        guiVisible=True,
+        guiDefault=False
+    ),
+    FeatureConfig(
+        key='highlight_facts_on_startup',
+        label='Highlight facts on startup',
+        description='Default "Highlight all facts" to on.',
+        cliAction='store_true',
+        cliDefault=None,
         guiVisible=True,
         guiDefault=False
     )
 ]
-
 GUI_FEATURE_CONFIGS = [c for c in FEATURE_CONFIGS if c.guiVisible]
+
+MANDATORY_FACTS = {
+    "companies-house": [
+            "UKCompaniesHouseRegisteredNumber",
+            "EntityCurrentLegalOrRegisteredName",
+            "BalanceSheetDate",
+            "DateAuthorisationFinancialStatementsForIssue",
+            "DirectorSigningFinancialStatements",
+            "EntityDormantTruefalse",
+            "EntityTradingStatus",
+            "AccountsStatusAuditedOrUnaudited",
+            "AccountsTypeFullOrAbbreviated",
+            "AccountingStandardsApplied",
+            "LegalFormEntity",
+            "StartDateForPeriodCoveredByReport",
+            "EndDateForPeriodCoveredByReport",
+            "CharityRegistrationNumberEnglandWales",
+            "CharityRegistrationNumberScotland",
+            "CharityRegistrationNumberNorthernIreland"
+    ]
+}

iXBRLViewerPlugin/featureConfig.py

@@ -1,4 +1,5 @@
 from dataclasses import dataclass
+from typing import Any
 
 
 @dataclass(frozen=True, repr=False, eq=False)
@@ -6,5 +7,7 @@ class FeatureConfig:
     key: str
     label: str
     description: str
+    cliAction: str
+    cliDefault: Any
     guiVisible: bool
-    guiDefault: bool
+    guiDefault: Any