PyPI - arelle-release - Versions diffs - 2.17.1__py3-none-any.whl → 2.37.71__py3-none-any.whl - Mend

arelle-release 2.17.1py3-none-any.whl → 2.37.71py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (893) hide show

arelle/plugin/logging/saveMessages.py CHANGED Viewed

@@ -162,7 +162,7 @@ class LogHandler(logging.Handler):
 __pluginInfo__ = {
-    'name': 'XBRL Database',
+    'name': 'Logging - Save Messages',
     'version': '1.2',
     'description': "This plug-in saves logger messages of instances for post processing.  ",
     'license': 'Apache-2 (Arelle plug-in), BSD license (pg8000 library)',

arelle/plugin/saveHtmlEBAtables.py CHANGED Viewed

@@ -1,100 +1,222 @@
-'''
+"""
 Save HTML EBA Tables is an example of a plug-in to both GUI menu and command line/web service
 that will save a directory containing HTML Tablesets with an EBA index page.
 See COPYRIGHT.md for copyright information.
-'''
-from arelle.Version import authorLabel, copyrightLabel
+"""
-def generateHtmlEbaTablesetFiles(dts, indexFile, lang="en"):
-    try:
-        import os, io
-        from arelle import Version, XbrlConst, XmlUtil
-        from arelle.ViewFileRenderedGrid import viewRenderedGrid
-        from arelle.ModelRenderingObject import ModelEuTable, ModelTable
+import os
+import threading
+from operator import itemgetter
+from optparse import OptionParser
+from tkinter import Menu
+from typing import Any
-        numTableFiles = 0
+from lxml import etree
+from arelle import Version, XbrlConst, XmlUtil
+from arelle.CntlrCmdLine import CntlrCmdLine
+from arelle.CntlrWinMain import CntlrWinMain
+from arelle.ModelDocument import Type
+from arelle.ModelObjectFactory import parser
+from arelle.ModelRenderingObject import DefnMdlTable
+from arelle.ModelXbrl import ModelXbrl
+from arelle.rendering import RenderingEvaluator
+from arelle.RuntimeOptions import RuntimeOptions
+from arelle.typing import TypeGetText
+from arelle.utils.PluginHooks import PluginHooks
+from arelle.ViewFileRenderedGrid import viewRenderedGrid
+_: TypeGetText
+MENU_HTML = """<!DOCTYPE html>
+<html>
+<head>
+  <style>
+    body {
+      margin: 0;
+      padding: 10px;
+      font-family: Arial, sans-serif;
+      color: #243e5e;
+    }
+    .nav-list-menu-ul {
+      list-style-type: none;
+      padding: 0;
+      margin: 0;
+    }
+    .nav-list-menu-li {
+      margin: 5px 0;
+      padding: 5px;
+      border-bottom: 1px solid #eee;
+    }
+    .nav-list-menu-link {
+      text-decoration: none;
+      cursor: pointer;
+      display: block;
+      background: none;
+      border: none;
+      padding: 0;
+    }
+    .nav-list-menu-link:hover {
+      text-decoration: underline;
+    }
+  </style>
+</head>
+<body>
+    <ul class="nav-list-menu-ul"/>
+</body>
+</html>
+"""
-        file = io.StringIO('''
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head id="Left">
-  <link type="text/css" rel="stylesheet" href="http://arelle.org/files/EBA/style20121210/eba.css" />
+CENTER_LANDING_HTML = """<!DOCTYPE html>
+<html>
+<head>
+  <style>
+    body {
+      margin: 0;
+      padding: 20px;
+      font-family: Arial, sans-serif;
+    }
+    #page-title {
+      margin-bottom: 20px;
+    }
+    #page-title h1 {
+      color: #243e5e;
+      margin-top: 0;
+    }
+    #content-center {
+      margin-top: 20px;
+      line-height: 1.5;
+    }
+  </style>
 </head>
-<body class="LTR IE7 ENGB">
-    <ul class="CMSListMenuUL" id="Vertical2"/>
+<body>
+  <div id="page-title">
+    <h1>Taxonomy Tables Viewer</h1>
+  </div>
+  <div id="content-center">
+    <p>Please select tables to view by clicking in the left column.</p>
+  </div>
+</body>
+</html>
+"""
+TABLE_CSS_EXTRAS = """
+table {background:#fff}
+"""
+def indexFileHTML(indexBaseName: str) -> str:
+    return f'''<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>EBA - Tablesets</title>
+  <style>
+    html, body {{
+      margin: 0;
+      padding: 0;
+      height: 100%;
+      width: 100%;
+      font-family: Arial, sans-serif;
+      display: flex;
+      flex-direction: column;
+    }}
+    #header {{
+      background: rgb(36, 62, 94);
+      color: rgb(255, 255, 255);
+      height: 40px;
+    }}
+    #header h1 {{
+      font-size: 1.5em;
+      margin: 0.25em;
+    }}
+    #main-container {{
+      display: flex;
+      flex: 1;
+      height: calc(100vh - 40px);
+    }}
+    #menu-container {{
+      width: 360px;
+      border-right: 2px solid #243e5e;
+      overflow-y: auto;
+      box-sizing: border-box;
+    }}
+    #content-container {{
+      flex: 1;
+      overflow: auto;
+      box-sizing: border-box;
+    }}
+    iframe {{
+      border: none;
+      width: 100%;
+      height: 100%;
+    }}
+  </style>
+  <script>
+    function loadContent(url) {{
+      document.getElementById('content-frame').src = url;
+    }}
+  </script>
+</head>
+<body>
+  <div id="header"><h1>EBA - Tablesets</h1></div>
+  <div id="main-container">
+    <div id="menu-container">
+      <iframe src="{indexBaseName}FormsFrame.html" width="100%" height="100%" frameborder="0" id="menu-frame"></iframe>
+    </div>
+    <div id="content-container">
+      <iframe src="{indexBaseName}CenterLanding.html" width="100%" height="100%" frameborder="0" id="content-frame"></iframe>
+    </div>
+  </div>
 </body>
 </html>
 '''
-         )
-        from arelle.ModelObjectFactory import parser
-        parser, parserLookupName, parserLookupClass = parser(dts,None)
-        from lxml import etree
-        indexDocument = etree.parse(file,parser=parser,base_url=indexFile)
-        file.close()
-        #xmlDocument.getroot().init(self)  ## is this needed ??
-        for listElt in  indexDocument.iter(tag="{http://www.w3.org/1999/xhtml}ul"):
-            break
-        class nonTkBooleanVar():
-            def __init__(self, value=True):
-                self.value = value
-            def set(self, value):
-                self.value = value
-            def get(self):
-                return self.value
-        class View():
-            def __init__(self, tableOrELR, ignoreDimValidity, xAxisChildrenFirst, yAxisChildrenFirst):
-                self.tblELR = tableOrELR
-                # context menu boolean vars (non-tkinter boolean
-                self.ignoreDimValidity = nonTkBooleanVar(value=ignoreDimValidity)
-                self.xAxisChildrenFirst = nonTkBooleanVar(value=xAxisChildrenFirst)
-                self.yAxisChildrenFirst = nonTkBooleanVar(value=yAxisChildrenFirst)
+def generateHtmlEbaTablesetFiles(dts: ModelXbrl, indexFile: str, lang: str = "en") -> None:
+    try:
+        numTableFiles = 0
+        _parser = parser(dts, None)[0]
+        menuFrameDocument = etree.fromstring(MENU_HTML, parser=_parser, base_url=indexFile)
+        listElt = menuFrameDocument.find(".//ul")
+        assert listElt is not None, "No list element in index document"
         indexBase = indexFile.rpartition(".")[0]
         groupTableRels = dts.modelXbrl.relationshipSet(XbrlConst.euGroupTable)
         modelTables = []
-        tblCssExtras='''
-body {background-image:url('http://arelle.org/files/EBA/style20121210/lhsbackground.jpg')}
-table {background:#fff}
-'''
-        # order number is missing
-        def viewTable(modelTable):
+        def viewTable(modelTable: DefnMdlTable) -> None:
             if modelTable is None:
                 return
-            if isinstance(modelTable, (ModelEuTable, ModelTable)):
-                # status
-                dts.modelManager.cntlr.addToLog("viewing: " + modelTable.id)
-                # for table file name, use table ELR
-                tblFile = os.path.join(os.path.dirname(indexFile), modelTable.id + ".html")
-                viewRenderedGrid(dts,
-                                 tblFile,
-                                 lang=lang,
-                                 sourceView=View(modelTable, False, False, True),
-                                 cssExtras=tblCssExtras)
-                # generaate menu entry
-                elt = etree.SubElement(listElt, "{http://www.w3.org/1999/xhtml}li")
-                elt.set("class", "CMSListMenuLI")
-                elt.set("id", modelTable.id)
-                elt = etree.SubElement(elt, "{http://www.w3.org/1999/xhtml}a")
+            tableId = modelTable.id or ""
+            if isinstance(modelTable, DefnMdlTable):
+                dts.modelManager.cntlr.addToLog("viewing: " + tableId)
+                tblFile = os.path.join(os.path.dirname(indexFile), tableId + ".html")
+                tableName = tableId
+                if tableName.startswith("eba_t"):
+                    tableName = tableName.removeprefix("eba_t")
+                elif tableName.startswith("srb_t"):
+                    tableName = tableName.removeprefix("srb_t")
+                viewRenderedGrid(dts, tblFile, lang=lang, cssExtras=TABLE_CSS_EXTRAS, table=tableName)  # type: ignore[no-untyped-call]
+                elt = etree.SubElement(listElt, "li")
+                elt.set("class", "nav-list-menu-li")
+                elt.set("id", tableId)
+                elt = etree.SubElement(elt, "button")
                 elt.text = modelTable.genLabel(lang=lang, strip=True)
-                elt.set("class", "CMSListMenuLink")
-                elt.set("href", "javascript:void(0)")
-                elt.set("onClick", "javascript:parent.body.location.href='{0}';".format(modelTable.id + ".html"))
+                elt.set("class", "nav-list-menu-link")
+                elt.set("onClick", f"javascript:parent.loadContent('{tableId}.html');")
                 elt.text = modelTable.genLabel(lang=lang, strip=True)
-            else:  # just a header
-                # generaate menu entry
-                elt = etree.SubElement(listElt, "{http://www.w3.org/1999/xhtml}li")
-                elt.set("class", "CMSListMenuLink")
-                elt.set("id", modelTable.id)
+            else:
+                elt = etree.SubElement(listElt, "li")
+                elt.set("id", tableId)
                 elt.text = modelTable.label(lang=lang, strip=True)
             for rel in groupTableRels.fromModelObject(modelTable):
                 viewTable(rel.toModelObject)
         for rootConcept in groupTableRels.rootConcepts:
             sourceline = 0
             for rel in dts.modelXbrl.relationshipSet(XbrlConst.euGroupTable).fromModelObject(rootConcept):
@@ -102,171 +224,129 @@ table {background:#fff}
                 break
             modelTables.append((rootConcept, sourceline))
-        for modelTable, order in sorted(modelTables, key=lambda x: x[1]):
+        for modelTable, _order in sorted(modelTables, key=itemgetter(1)):
             viewTable(modelTable)
-        with open(indexBase + "FormsFrame.html", "wt", encoding="utf-8") as fh:
-            XmlUtil.writexml(fh, indexDocument, encoding="utf-8")
+        with open(indexBase + "FormsFrame.html", "w", encoding="utf-8") as fh:
+            XmlUtil.writexml(fh, menuFrameDocument, encoding="utf-8")
-        with open(indexFile, "wt", encoding="utf-8") as fh:
-            fh.write(
-'''
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head id="Head1">
-  <title>European Banking Authority - EBA  - FINREP Taxonomy</title>
-  <meta name="generator" content="Arelle(r) {0}" />
-  <meta name="provider" content="Aguilonius(r)" />
-  <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
-  <meta http-equiv="pragma" content="no-cache" />
-  <meta http-equiv="content-style-type" content="text/css" />
-  <meta http-equiv="content-script-type" content="text/javascript" />
-  <link type="text/css" rel="stylesheet" href="http://arelle.org/files/EBA/style20121210/eba.css" />
-</head>
-<frameset border="0" frameborder="0" rows="90,*">
-   <frame name="head" src="{1}" scrolling="no" marginwidth="0" marginheight="10"/>
-   <frameset  bordercolor="#0000cc" border="10" frameborder="no" framespacing="0" cols="360, *">
-      <frame src="{2}" name="menu" bordercolor="#0000cc"/>
-      <frame src="{3}" name="body" bordercolor="#0000cc"/>
-   </frameset>
-</frameset>
-'''.format(Version.version,
-           os.path.basename(indexBase) + "TopFrame.html",
-           os.path.basename(indexBase) + "FormsFrame.html",
-           os.path.basename(indexBase) + "CenterLanding.html",
-           ))
-        with open(indexBase + "TopFrame.html", "wt", encoding="utf-8") as fh:
-            fh.write(
-'''
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head id="Top">
-  <link type="text/css" rel="stylesheet" href="http://arelle.org/files/EBA/style20121210/eba.css" />
-</head>
-  <body class="LTR IE7 ENGB">
-   <div id="topsection">
-      <div id="topsectionLeft" style="cursor:pointer;" onclick="location.href='http://www.eba.europa.eu/home.aspx';"></div>
-      <div id="topsectionRight"></div>
-      <div id="topnavigation">
-      <ul id="menuElem">
-        <li><a href="http://www.eba.europa.eu/topnav/Contacts.aspx">Contacts</a></li>
-        <li><a href="http://www.eba.europa.eu/topnav/Links.aspx">Links</a></li>
-        <li><a href="http://www.eba.europa.eu/topnav/Sitemap.aspx">Sitemap</a></li>
-        <li><a href="http://www.eba.europa.eu/topnav/Legal-Notice.aspx">Legal Notice</a></li>
-      </ul>
-    </div>
-  </body>
-</html>
-''')
-        with open(indexBase + "CenterLanding.html", "wt", encoding="utf-8") as fh:
-            fh.write(
-'''
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head id="Center">
-  <link type="text/css" rel="stylesheet" href="http://http://arelle.org/files/EBA/style20121210/eba.css" />
-</head>
-<body class="LTR IE7 ENGB">
-  <div id="plc_lt_zoneContent_usercontrol_userControlElem_ContentPanel">
-    <div id="plc_lt_zoneContent_usercontrol_userControlElem_PanelTitle">
-      <div id="pagetitle" style="float:left;width:500px;">
-        <h1>Taxonomy Tables Viewer</h1>
-      </div>
-    </div>
-  </div>
-  <div style="clear:both;"></div>
-  <div id="contentcenter">
-    <p style="text-align: justify; margin-top: 0pt; margin-bottom: 0pt">Please select tables to view by clicking in the left column.</p>
-  </div>
-</body>
-</html>
-''')
+        with open(indexFile, "w", encoding="utf-8") as fh:
+            fh.write(indexFileHTML(os.path.basename(indexBase)))
-        # to merge gif's and style sheets, use a zipfile sibling of the python plug-in file.
-        #import zipfile
-        #zf = zipfile.ZipFile(__file__.rpartition('.')[0] + "Files.zip", mode="r")
-        #zf.extractall(path=os.path.dirname(indexBase))
-        #zf.close()
+        with open(indexBase + "CenterLanding.html", "w", encoding="utf-8") as fh:
+            fh.write(CENTER_LANDING_HTML)
-        dts.info("info:saveEBAtables",
-                 _("Tables index file of %(entryFile)s has %(numberTableFiles)s table files with index file %(indexFile)s."),
-                 modelObject=dts,
-                 entryFile=dts.uri, numberTableFiles=numTableFiles, indexFile=indexFile)
+        dts.info(
+            "info:saveEBAtables",
+            _("Tables index file of %(entryFile)s has %(numberTableFiles)s table files with index file %(indexFile)s."),
+            modelObject=dts,
+            entryFile=dts.uri,
+            numberTableFiles=numTableFiles,
+            indexFile=indexFile,
+        )
         dts.modelManager.showStatus(_("Saved EBA HTML Table Files"), 5000)
     except Exception as ex:
-        dts.error("exception",
-            _("HTML EBA Tableset files generation exception: %(error)s"), error=ex,
+        dts.error(
+            "exception",
+            _("HTML EBA Tableset files generation exception: %(error)s"),
+            error=ex,
             modelXbrl=dts,
-            exc_info=True)
+            exc_info=True,
+        )
-def saveHtmlEbaTablesMenuEntender(cntlr, menu, *args, **kwargs):
-    # Extend menu with an item for the save infoset plugin
-    menu.add_command(label="Save HTML EBA Tables",
-                     underline=0,
-                     command=lambda: saveHtmlEbaTablesMenuCommand(cntlr) )
-def saveHtmlEbaTablesMenuCommand(cntlr):
-    # save Infoset menu item has been invoked
-    from arelle.ModelDocument import Type
+def saveHtmlEbaTablesMenuCommand(cntlr: CntlrWinMain) -> None:
     if cntlr.modelManager is None or cntlr.modelManager.modelXbrl is None:
-        cntlr.addToLog("No DTS loaded.")
+        cntlr.addToLog("No DTS loaded.")  # type: ignore[no-untyped-call]
         return
-        # get file name into which to save log file while in foreground thread
-    indexFile = cntlr.uiFileDialog("save",
-            title=_("arelle - Save HTML EBA Tables Index file"),
-            initialdir=cntlr.config.setdefault("htmlEbaTablesFileDir","."),
-            filetypes=[(_("HTML index file .html"), "*.html")],
-            defaultextension=".html")
-    if not indexFile:
-        return False
-    import os
+    assert cntlr.config is not None
+    indexFile = cntlr.uiFileDialog(  # type: ignore[no-untyped-call]
+        "save",
+        title=_("arelle - Save HTML EBA Tables Index file"),
+        initialdir=cntlr.config.setdefault("htmlEbaTablesFileDir", "."),
+        filetypes=[(_("HTML index file .html"), "*.html")],
+        defaultextension=".html",
+    )
+    if not isinstance(indexFile, str):
+        return
     cntlr.config["htmlEbaTablesFileDir"] = os.path.dirname(indexFile)
     cntlr.saveConfig()
-    import threading
-    thread = threading.Thread(target=lambda
-                                  _dts=cntlr.modelManager.modelXbrl,
-                                  _indexFile=indexFile:
-                                        generateHtmlEbaTablesetFiles(_dts, _indexFile))
+    thread = threading.Thread(
+        target=lambda _dts=cntlr.modelManager.modelXbrl, _indexFile=indexFile: generateHtmlEbaTablesetFiles(
+            _dts, _indexFile
+        )
+    )
     thread.daemon = True
     thread.start()
-def saveHtmlEbaTablesCommandLineOptionExtender(parser, *args, **kwargs):
-    # extend command line options with a save DTS option
-    parser.add_option("--save-EBA-tablesets",
-                      action="store",
-                      dest="ebaTablesetIndexFile",
-                      help=_("Save HTML EBA Tablesets index file, with tablest HTML files to out directory specify 'generateOutFiles'."))
-def saveHtmlEbaTablesCommandLineXbrlLoaded(cntlr, options, modelXbrl, *args, **kwargs):
-    # extend XBRL-loaded run processing for this option
-    from arelle.ModelDocument import Type
-    if getattr(options, "ebaTablesetIndexFile", None) and options.ebaTablesetIndexFile == "generateEBAFiles" and modelXbrl.modelDocument.type in (Type.TESTCASESINDEX, Type.TESTCASE):
-        cntlr.modelManager.generateEBAFiles = True
-def saveHtmlEbaTablesCommandLineXbrlRun(cntlr, options, modelXbrl, *args, **kwargs):
-    # extend XBRL-loaded run processing for this option
-    if getattr(options, "ebaTablesetIndexFile", None) and options.ebaTablesetIndexFile != "generateEBAFiles":
+class SaveHtmlEbaTablesPlugin(PluginHooks):
+    @staticmethod
+    def cntlrWinMainMenuTools(
+        cntlr: CntlrWinMain,
+        menu: Menu,
+        *args: Any,
+        **kwargs: Any,
+    ) -> None:
+        menu.add_command(label="Save HTML EBA Tables", underline=0, command=lambda: saveHtmlEbaTablesMenuCommand(cntlr))
+    @staticmethod
+    def cntlrCmdLineOptions(
+        parser: OptionParser,
+        *args: Any,
+        **kwargs: Any,
+    ) -> None:
+        parser.add_option(
+            "--save-EBA-tablesets",
+            action="store",
+            dest="ebaTablesetIndexFile",
+            help=_("Save HTML EBA Tablesets index file with provided filename."),
+        )
+    @staticmethod
+    def cntlrCmdLineXbrlLoaded(
+        cntlr: CntlrCmdLine,
+        options: RuntimeOptions,
+        modelXbrl: ModelXbrl,
+        *args: Any,
+        **kwargs: Any,
+    ) -> None:
+        ebaTablesetIndexFile = getattr(options, "ebaTablesetIndexFile", None)
+        modelDocType = getattr(modelXbrl.modelDocument, "type", None)
+        if ebaTablesetIndexFile == "generateEBAFiles" and modelDocType in (Type.TESTCASESINDEX, Type.TESTCASE):
+            cntlr.modelManager.generateEBAFiles = True  # type: ignore[attr-defined]
+    @staticmethod
+    def cntlrCmdLineXbrlRun(
+        cntlr: CntlrCmdLine,
+        options: RuntimeOptions,
+        modelXbrl: ModelXbrl,
+        *args: Any,
+        **kwargs: Any,
+    ) -> None:
+        ebaTablesetIndexFile = getattr(options, "ebaTablesetIndexFile", None)
+        if ebaTablesetIndexFile is None or ebaTablesetIndexFile == "generateEBAFiles":
+            return
         if cntlr.modelManager is None or cntlr.modelManager.modelXbrl is None:
             cntlr.addToLog("No taxonomy loaded.")
             return
-        from arelle import RenderingEvaluator
-        RenderingEvaluator.init(modelXbrl)
-        generateHtmlEbaTablesetFiles(cntlr.modelManager.modelXbrl, options.ebaTablesetIndexFile)
+        RenderingEvaluator.init(modelXbrl)  # type: ignore[no-untyped-call]
+        generateHtmlEbaTablesetFiles(cntlr.modelManager.modelXbrl, ebaTablesetIndexFile)
 __pluginInfo__ = {
-    'name': 'Save HTML EBA Tables',
-    'version': '0.9',
-    'description': "This plug-in adds a feature to a directory containing HTML Tablesets with an EBA index page.  ",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
+    "name": "Save HTML EBA Tables",
+    "version": "0.10",
+    "description": "This plug-in adds a feature to a directory containing HTML Tablesets with an EBA index page.",
+    "license": "Apache-2",
+    "author": Version.authorLabel,
+    "copyright": Version.copyrightLabel,
     # classes of mount points (required)
-    'CntlrWinMain.Menu.Tools': saveHtmlEbaTablesMenuEntender,
-    'CntlrCmdLine.Options': saveHtmlEbaTablesCommandLineOptionExtender,
-    'CntlrCmdLine.Xbrl.Loaded': saveHtmlEbaTablesCommandLineXbrlLoaded,
-    'CntlrCmdLine.Xbrl.Run': saveHtmlEbaTablesCommandLineXbrlRun,
+    "CntlrWinMain.Menu.Tools": SaveHtmlEbaTablesPlugin.cntlrWinMainMenuTools,
+    "CntlrCmdLine.Options": SaveHtmlEbaTablesPlugin.cntlrCmdLineOptions,
+    "CntlrCmdLine.Xbrl.Loaded": SaveHtmlEbaTablesPlugin.cntlrCmdLineXbrlLoaded,
+    "CntlrCmdLine.Xbrl.Run": SaveHtmlEbaTablesPlugin.cntlrCmdLineXbrlRun,
 }

arelle-release 2.17.1__py3-none-any.whl → 2.37.71__py3-none-any.whl

arelle-release 2.17.1py3-none-any.whl → 2.37.71py3-none-any.whl