Add JSON formatted output reports to the EDGAR/render plugin

render/Filing.py

@@ -323,6 +323,7 @@ def __init__(self, controller, modelXbrl, outputFolderName, transform, suplSuffi
         self.validatedForEFM = controller.validatedForEFM
         self.reportXmlFormat = 'xml' in controller.reportFormat.casefold()
         self.reportHtmlFormat = 'html' in controller.reportFormat.casefold()
+        self.reportJsonFormat = 'json' in controller.reportFormat.casefold()
         self.fileNamePrefix = 'R'
         if controller.reportZip:
             self.fileNameBase = None

render/Report.py

@@ -1106,9 +1106,24 @@ def writeHtmlAndOrXmlFiles(self, reportSummary):
         baseNameBeforeExtension = self.filing.fileNamePrefix + str(self.cube.fileNumber)
         reportSummary.baseNameBeforeExtension = baseNameBeforeExtension
         tree = self.rootETree.getroottree()
+        if self.filing.reportJsonFormat: self.writeJsonFile(baseNameBeforeExtension, tree, reportSummary)
         if self.filing.reportXmlFormat: self.writeXmlFile(baseNameBeforeExtension, tree, reportSummary)
         if self.filing.reportHtmlFormat: self.writeHtmlFile(baseNameBeforeExtension, tree, reportSummary)
 
+    def writeJsonFile(self, baseNameBeforeExtension, tree, reportSummary):
+        import json, xmltodict
+        baseName = (self.filing.rFilePrefix or '') + baseNameBeforeExtension + '.json' + (self.filing.suplSuffix or '')
+        reportSummary.xmlFileName = baseName
+        xmlText = treeToString(tree, xml_declaration=True, encoding='utf-8', pretty_print=True)
+        json_data = json.dumps(xmltodict.parse(xmlText), indent=4)
+
+        if self.filing.reportZip:
+            self.filing.reportZip.writestr(self.filing.zipDir + baseName, json_data)
+            self.controller.renderedFiles.add(baseName)
+        elif self.filing.fileNameBase is not None:
+            self.controller.writeFile(os.path.join(self.filing.fileNameBase, baseName), json_data)
+            self.controller.renderedFiles.add(baseName)
+
     def writeXmlFile(self, baseNameBeforeExtension, tree, reportSummary):
         baseName = (self.filing.rFilePrefix or '') + baseNameBeforeExtension + '.xml' + (self.filing.suplSuffix or '')
         reportSummary.xmlFileName = baseName

render/__init__.py

@@ -242,7 +242,7 @@ def edgarRendererCmdLineOptionExtender(parser, *args, **kwargs):
                       help=_("Type of HTML report...Complete: asPage rendering = True, or Fragment: asPage rendering = False."))
 
     parser.add_option("--reportFormat", dest="reportFormat",
-                      help=_("One of Xml, Html, HtmlAndXml or None."))
+                      help=_("One of Xml, Html, JSON, HtmlAndXml or None."))
 
     parser.add_option("--failFile", dest="failFile", help=_("Relative path and name of fail file. "))
 
@@ -404,7 +404,7 @@ def setProp(prop, init, rangeList=None, cs=False):
 
         # options applicable to rendering in either mode:
         options.renderingService = setProp('renderingService', options.renderingService, rangeList=['Instance', 'Daemon'])
-        options.reportFormat = setProp('reportFormat', options.reportFormat, rangeList=['Html', 'Xml', 'HtmlAndXml', 'None'])
+        options.reportFormat = setProp('reportFormat', options.reportFormat, rangeList=['Html', 'Xml', 'JSON', 'HtmlAndXml', 'None'])
         options.htmlReportFormat = setProp('htmlReportFormat', options.htmlReportFormat, rangeList=['Complete', 'Fragment'])
         options.zipOutputFile = setProp('zipOutputFile', options.zipOutputFile, cs=True)
         options.sourceList = " ".join(setProp('sourceList', options.sourceList, cs=True).split()).split(',')

render/requirements.txt

@@ -1,3 +1,4 @@
 lxml>=4.6.3
 matplotlib>=3.4.2
 openpyxl>=3.0.7
+xmltodict==0.13.0