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

arelle/examples/CustomLogger.py

@@ -1,43 +0,0 @@
-'''
-This module is an example Arelle controller in non-interactive mode
-
-See COPYRIGHT.md for copyright information.
-'''
-from __future__ import print_function
-from arelle import Cntlr
-from arelle.ValidateXbrlCalcs import ValidateCalcsMode
-
-class CntlrCustomLoggingExample(Cntlr.Cntlr):
-
-    def __init__(self):
-        # no logFileName parameter to prevent default logger from starting
-        super().__init__()
-
-    def run(self):
-        # start custom logger
-        CustomLogHandler(self)
-
-        modelXbrl = self.modelManager.load("c:\\temp\\test.xbrl")
-
-        self.modelManager.validateCalcs = ValidateCalcsMode.XBRL_v2_1
-
-        self.modelManager.validate()
-
-        self.modelManager.close()
-
-        self.close()
-
-import logging
-class CustomLogHandler(logging.Handler):
-    def __init__(self, cntlr):
-        logger = logging.getLogger("arelle")
-        self.level = logging.DEBUG
-        self.setFormatter(logging.Formatter("[%(messageCode)s] %(message)s - %(file)s %(sourceLine)s"))
-        logger.addHandler(self)
-
-    def emit(self, logRecord):
-        # just print to standard output (e.g., terminal window)
-        print(self.format(logRecord))
-
-if __name__ == "__main__":
-    CntlrCustomLoggingExample().run()

arelle/examples/LoadEFMvalidate.py

@@ -1,32 +0,0 @@
-'''
-This module is an example Arelle controller in non-interactive mode
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle import Cntlr
-from arelle.ValidateXbrlCalcs import ValidateCalcsMode
-
-class CntlrEfmValidateExample(Cntlr.Cntlr):
-
-    def __init__(self):
-        super().__init__(logFileName="c:\\temp\\test-log.txt")
-
-    def run(self):
-        # select SEC Edgar Filer Manual validation before validation (causes file name and contents checking
-        self.modelManager.validateDisclosureSystem = True
-        self.modelManager.disclosureSystem.select("efm")
-
-        modelXbrl = self.modelManager.load("c:\\temp\\test.xbrl")
-
-        self.modelManager.validateCalcs = ValidateCalcsMode.XBRL_v2_1
-
-        # perfrom XBRL 2.1, dimensions, calculation and SEC EFM validation
-        self.modelManager.validate()
-
-        # close the loaded instance
-        self.modelManager.close()
-
-        self.close()
-
-if __name__ == "__main__":
-    CntlrEfmValidateExample().run()

arelle/examples/LoadSavePreLbCsv.py

@@ -1,26 +0,0 @@
-'''
-This module is an example Arelle controller in non-interactive mode
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle import Cntlr
-from arelle.ViewCsvRelationshipSet import viewRelationshipSet
-
-class CntlrCsvPreLbExample(Cntlr.Cntlr):
-
-    def __init__(self):
-        super().__init__(logFileName="c:\\temp\\test-log.txt")
-
-    def run(self):
-        modelXbrl = self.modelManager.load("c:\\temp\\test.xbrl")
-
-        # output presentation linkbase tree as a csv file
-        viewRelationshipSet(modelXbrl, "c:\\temp\\test-pre.csv", "Presentation", "http://www.xbrl.org/2003/arcrole/parent-child")
-
-        # close the loaded instance
-        self.modelManager.close()
-
-        self.close()
-
-if __name__ == "__main__":
-    CntlrCsvPreLbExample().run()

arelle/examples/LoadValidate.cs

@@ -1,31 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Net;
-using System.IO;
-using System.Diagnostics;
-
-namespace ArelleCsharpProject
-{
-    class LoadValidate
-    {
-        static void Main(string[] args)
-        {
-		    string restAPIstr =
-			    "http://localhost:8080/rest/xbrl/" + 
-			    "C:/Users/John%20Doe/Samples/instance0010000.xbrl" +
-			    "/validation/xbrl?media=text";
-
-            HttpWebRequest req = WebRequest.Create(restAPIstr) as HttpWebRequest;
-
-            string line;
-            using (HttpWebResponse resp = req.GetResponse() as HttpWebResponse)
-            {
-                StreamReader reader = new StreamReader(resp.GetResponseStream());
-                while ((line = reader.ReadLine()) != null)
-                    Debug.WriteLine(line);
-            }
-        }
-    }
-}

arelle/examples/LoadValidate.py

@@ -1,36 +0,0 @@
-'''
-This module is an example Arelle controller in non-interactive mode
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle import Cntlr
-from arelle.ValidateXbrlCalcs import ValidateCalcsMode
-
-# this is the controller class
-class CntlrValidateExample(Cntlr.Cntlr):
-
-    # init sets up the default controller for logging to a file (instead of to terminal window)
-    def __init__(self):
-        # initialize superclass with default file logger
-        super().__init__(logFileName="c:\\temp\\test-log.txt", logFileMode="w")
-
-    def run(self):
-        # create the modelXbrl by load instance and discover DTS
-        modelXbrl = self.modelManager.load("c:\\temp\\test.xbrl")
-
-        # select validation of calculation linkbase using infer decimals option
-        self.modelManager.validateCalcs = ValidateCalcsMode.XBRL_v2_1
-
-        # perfrom XBRL 2.1, dimensions, calculation
-        self.modelManager.validate()
-
-        # close the loaded instance
-        self.modelManager.close()
-
-        # close controller and application
-        self.close()
-
-# if python is initiated as a main program, start the controller
-if __name__ == "__main__":
-    # create the controller and start it running
-    CntlrValidateExample().run()

arelle/examples/LoadValidateCmdLine.java

@@ -1,69 +0,0 @@
-import java.io.BufferedInputStream;
-import java.io.BufferedReader;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
-
-public class LoadValidateCmdLine {
-	public static void main(String[] args) throws IOException {
-		Runtime r = Runtime.getRuntime();
-		String arelleExe = "\"C:\\Program Files\\Arelle\\arelleCmdLine.exe\"";
-		// XDG_CONFIG_HOME is optional, when omitted it defaults to "~/.config"
-		String arelleXdgConfigHome = "C:\\Users\\hermfi~1\\appdir\\local";
-		String fileBase = "C:\\Users\\John Doe\\samples\\";
-		String [] fileNames = {
-				"instance0000010.xml",
-				"instance0010000.xml"
-				//"instance0020000.xml",
-				//"instance0040000.xml",
-				//"instance0060000.xml",
-				//"instance0080000.xml",
-				//"instance0100000.xml",
-				//"instance0120000.xml",
-				//"instance0165000.xml"
-		};
-		for (String fileName : fileNames) {
-			try {
-				System.out.println("File: " + fileName);
-				String cmdLine = 
-					arelleExe +
-					" --file " +
-					"\"" + fileBase + fileName + "\"" +
-					" -v";
-				System.out.println("CmdLine: " + cmdLine);
-				String[] envp = new String[1];
-				// XDG_CONFIG_HOME is optional, defaults to "~/.config"
-				envp[0] = "XDG_CONFIG_HOME=" + arelleXdgConfigHome;
-				Process p = r.exec(cmdLine, envp);
-				InputStream in = p.getInputStream();
-				BufferedInputStream buf = new BufferedInputStream(in);
-				InputStreamReader inread = new InputStreamReader(buf);
-				BufferedReader br = new BufferedReader(inread);
-				
-				String line;
-				while ((line = br.readLine()) != null) {
-					System.out.println(line);
-				}
-				try {
-					if (p.waitFor() != 0) {
-						System.err.println("exit value = " + p.exitValue());
-						}
-				} 
-				catch (InterruptedException e) {
-					System.err.println(e);
-				} 
-				finally {
-					// Close the InputStream
-					br.close();
-					inread.close();
-					buf.close();
-					in.close();
-				}
-			} 
-			catch (IOException e) {
-				System.err.println(e.getMessage());
-				}
-			}
-		System.out.println("Done");
-	}
-}

arelle/examples/LoadValidatePostedZip.java

@@ -1,57 +0,0 @@
-import java.io.BufferedReader;
-import java.io.DataOutputStream;
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.io.PrintStream;
-import java.net.HttpURLConnection;
-import java.net.URL;
-
-public class LoadValidatePostedZip {
-	public static void main(String[] args) throws IOException {
-		String restAPIstr =
-			"http://localhost:8080/rest/xbrl/" + 
-			"instance-no-formula-link.xml" +
-			"/validation/xbrl" +
-			"?media=text" +
-			"&import=assertionsHtmlSchemaLoc.xml" +
-			"&formulaAsserResultCounts";
-		URL url = new URL(restAPIstr);
-		HttpURLConnection conn =
-		      (HttpURLConnection) url.openConnection();
-		conn.setRequestMethod("POST");
-		conn.setRequestProperty("Content-Type",
-				"application/zip");
-		conn.setDoOutput(true);
-	    //Send request
-		File zipFile = new File("C:/temp/test-assertion-example.zip");
-		InputStream is = new FileInputStream(zipFile);
-		byte[] zipFileBytes = new byte[1000000];
-		int countRead = is.read(zipFileBytes, 0, 1000000);
-		is.close();
-
-		DataOutputStream wr = new DataOutputStream (
-				conn.getOutputStream ());
-		wr.write(zipFileBytes, 0, countRead);
-		wr.flush ();
-		wr.close ();
-		
-		if (conn.getResponseCode() != 200) {
-		    throw new IOException(conn.getResponseMessage());
-		}
-
-		// Buffer the result into a string
-		BufferedReader rd = new BufferedReader(
-		      new InputStreamReader(conn.getInputStream()));
-		StringBuilder sb = new StringBuilder();
-		String line;
-		while ((line = rd.readLine()) != null) {
-		    sb.append(line);
-			System.out.println(line);
-		}
-		rd.close();
-		conn.disconnect();
-	}
-}

arelle/examples/LoadValidateWebService.java

@@ -1,34 +0,0 @@
-import java.io.BufferedReader;
-import java.io.IOException;
-import java.io.InputStreamReader;
-import java.io.PrintStream;
-import java.net.HttpURLConnection;
-import java.net.URL;
-
-public class LoadValidateWebService {
-	public static void main(String[] args) throws IOException {
-		String restAPIstr =
-			"http://localhost:8080/rest/xbrl/" + 
-			"C:/Users/John%20Doe/Samples/instance0010000.xbrl" +
-			"/validation/xbrl?media=text";
-		URL url = new URL(restAPIstr);
-		HttpURLConnection conn =
-		      (HttpURLConnection) url.openConnection();
-
-		if (conn.getResponseCode() != 200) {
-		    throw new IOException(conn.getResponseMessage());
-		}
-
-		// Buffer the result into a string
-		BufferedReader rd = new BufferedReader(
-		      new InputStreamReader(conn.getInputStream()));
-		StringBuilder sb = new StringBuilder();
-		String line;
-		while ((line = rd.readLine()) != null) {
-		    sb.append(line);
-			System.out.println(line);
-		}
-		rd.close();
-		conn.disconnect();
-	}
-}

arelle/examples/SaveTableToExelle.py

@@ -1,140 +0,0 @@
-'''
-This module is an example to convert Html Tables into Xlsx (Excel) tables
-Preconfigured here to use SEC Edgar Rendering R files as input
-
-See COPYRIGHT.md for copyright information.
-'''
-import os, sys
-import regex as re
-from lxml import etree, html
-from openpyxl.workbook import Workbook
-from openpyxl.worksheet import ColumnDimension
-from openpyxl.cell import get_column_letter
-from openpyxl.style import Alignment
-
-class Report():
-    def __init__(self, longName, shortName, htmlFileName):
-        self.longName = longName
-        self.shortName = shortName
-        self.htmlFileName = htmlFileName
-    def __repr__(self):
-        return ("report(longName='{}', shortName='{}', htmlFileName='{}')"
-                .format(self.longName, self.shortName, self.htmlFileName))
-
-def intCol(elt, attrName, default=None):
-    try:
-        return int(elt.get(attrName, default))
-    except (TypeError, ValueError):
-        return default
-
-numberPattern = re.compile(r"\s*([$]\s*)?[(]?\s*[+-]?[0-9,]+([.][0-9]*)?[)-]?\s*$")
-displayNonePattern = re.compile(r"\s*display:\s*none;")
-
-def saveTableToExelle(rFilesDir):
-
-    # get reports from FilingSummary
-    reports = []
-    try:
-        fsdoc = etree.parse(os.path.join(rFilesDir, "FilingSummary.xml"))
-        for rElt in fsdoc.iter(tag="Report"):
-            reports.append(Report(rElt.findtext("LongName"),
-                                  rElt.findtext("ShortName"),
-                                  rElt.findtext("HtmlFileName")))
-    except (EnvironmentError,
-            etree.LxmlError) as err:
-        print("FilingSummary.xml: directory {0} error: {1}".format(rFilesDir, err))
-
-    wb = Workbook(encoding='utf-8')
-    # remove predefined sheets
-    for sheetName in wb.get_sheet_names():
-        ws = wb.get_sheet_by_name(sheetName)
-        if ws is not None:
-            wb.remove_sheet(ws)
-
-    sheetNames = set() # prevent duplicates
-
-    for reportNum, report in enumerate(reports):
-        sheetName = report.shortName[:31]  # max length 31 for excel title
-        if sheetName in sheetNames:
-            sheetName = sheetName[:31-len(str(reportNum))] + str(reportNum)
-        sheetNames.add(sheetName)
-        ws = wb.create_sheet(title=sheetName)
-
-        try:
-            # doesn't detect utf-8 encoding the normal way, pass it a string
-            #htmlSource = ''
-            #with open(os.path.join(rFilesDir, report.htmlFileName), 'rt', encoding='utf-8') as fh:
-            #    htmlSource = fh.read()
-            #rdoc = html.document_fromstring(htmlSource)
-            rdoc = html.parse(os.path.join(rFilesDir, report.htmlFileName))
-            row = -1
-            mergedAreas = {}  # colNumber: (colspan,lastrow)
-            for tableElt in rdoc.iter(tag="table"):
-                # skip pop up tables
-                if tableElt.get("class") ==  "authRefData":
-                    continue
-                if tableElt.getparent().tag == "div":
-                    style = tableElt.getparent().get("style")
-                    if style and displayNonePattern.match(style):
-                        continue
-                colWidths = {}
-                for rowNum, trElt in enumerate(tableElt.iter(tag="tr")):
-                    # remove passed mergedAreas
-                    for mergeCol in [col
-                                     for col, mergedArea in mergedAreas.items()
-                                     if mergedArea[1] > rowNum]:
-                        del mergedAreas[mergeCol]
-                    col = 0
-                    for coltag in ("th", "td"):
-                        for cellElt in trElt.iter(tag=coltag):
-                            if col == 0:
-                                row += 1 # new row
-                            if col in mergedAreas:
-                                col += mergedAreas[col][0] - 1
-                            text = cellElt.text_content()
-                            colspan = intCol(cellElt, "colspan", 1)
-                            rowspan = intCol(cellElt, "rowspan", 1)
-                            #if col not in colWidths:
-                            #    colWidths[col] = 10.0 # some kind of default width
-                            for elt in cellElt.iter():
-                                style = elt.get("style")
-                                if style and "width:" in style:
-                                    try:
-                                        kw, sep, width = style.partition("width:")
-                                        if "px" in width:
-                                            width, sep, kw = width.partition("px")
-                                            width = float(width) * 0.67777777
-                                        else:
-                                            width = float(width)
-                                        colWidths[col] = width
-                                    except ValueError:
-                                        pass
-                            if rowspan > 1:
-                                mergedAreas[col] = (colspan, row + rowspan - 1)
-                            cell = ws.cell(row=row,column=col)
-                            if text:
-                                cell.value = text
-                                if numberPattern.match(text):
-                                    cell.style.alignment.horizontal = Alignment.HORIZONTAL_RIGHT
-                                else:
-                                    cell.style.alignment.wrap_text = True
-                            if colspan > 1 or rowspan > 1:
-                                ws.merge_cells(start_row=row, end_row=row+rowspan-1, start_column=col, end_column=col+colspan-1)
-                            cell.style.alignment.vertical = Alignment.VERTICAL_TOP
-                            if coltag == "th":
-                                cell.style.alignment.horizontal = Alignment.HORIZONTAL_CENTER
-                                cell.style.font.bold = True
-                            cell.style.font.size = 9  # some kind of default size
-                            col += colspan
-                for col, width in colWidths.items():
-                    ws.column_dimensions[get_column_letter(col+1)].width = width
-        except (EnvironmentError,
-                etree.LxmlError) as err:
-            print("{0}: directory {1} error: {2}".format(report.htmlFileName, rFilesDir, err))
-
-    wb.save(os.path.join(rFilesDir, "exelleOut.xlsx"))
-
-if __name__ == "__main__":
-
-    # test directory
-    saveTableToExelle(r"C:\Users\Herm Fischer\Documents\mvsl\projects\SEC\14.1\R-files\wpoRfiles")

arelle/examples/TR3toTR4.py

@@ -1,88 +0,0 @@
-'''
-See COPYRIGHT.md for copyright information.
-License: https://www.apache.org/licenses/LICENSE-2.0
-
-usage: python3 {tr2 or tr3 input-file} {tr4 output-file}
-'''
-
-import io, os, sys, time
-from lxml import etree
-
-if len(sys.argv) < 3:
-    print("Please enter input and output filename arguments")
-    exit(1)
-INFILE = sys.argv[1]
-OUTFILE = sys.argv[2]
-
-if not INFILE or not os.path.isfile(INFILE) or not OUTFILE:
-    print("Please enter existing input filename and output filename")
-    exit(1)
-
-xhtmlNs = "http://www.w3.org/1999/xhtml"
-ixNS = "http://www.xbrl.org/2013/inlineXBRL"
-ixEltsWithFormat = ["{{{}}}{}".format(ixNS, localName) for localName in ("denominator", "numerator", "nonFraction", "nonNumeric")]
-xhtmlRootElts = ["{{{}}}{}".format(xhtmlNs, localName) for localName in ("html", "xhtml")]
-TR2NS = "http://www.xbrl.org/inlineXBRL/transformation/2011-07-31"
-TR3NS = "http://www.xbrl.org/inlineXBRL/transformation/2015-02-26"
-TR4NS = "http://www.xbrl.org/inlineXBRL/transformation/2020-02-12"
-TR23to4 = {
-    "booleanfalse": "fixed-false",
-    "booleantrue": "fixed-true",
-    "calindaymonthyear": "date-ind-day-monthname-year-hi",
-    "datedaymonth": "date-day-month",
-    "datedaymonthdk": "date-day-monthname-da",
-    "datedaymonthen": "date-day-monthname-en",
-    "datedaymonthyear": "date-day-month-year",
-    "datedaymonthyeardk": "date-day-monthname-year-da",
-    "datedaymonthyearen": "date-day-monthname-year-en",
-    "datedaymonthyearin": "date-day-monthname-year-hi", # does not handle this: Use date-day-month-year when using Devanagari numerals for the month, otherwise use date-day-monthname-year-hi.
-    "dateerayearmonthdayjp": "date-jpn-era-year-month-day",
-    "dateerayearmonthjp": "date-jpn-era-year-month",
-    "datemonthday": "date-month-day",
-    "datemonthdayen": "date-monthname-day-en",
-    "datemonthdayyear": "date-month-day-year",
-    "datemonthdayyearen": "date-monthname-day-year-en",
-    "datemonthyear": "date-month-year",
-    "datemonthyeardk": "date-monthname-year-da",
-    "datemonthyearen": "date-monthname-year-en",
-    "datemonthyearin": "date-monthname-year-hi",
-    "dateyearmonthday": "date-year-month-day",
-    "dateyearmonthdaycjk": "date-year-month-day",
-    "dateyearmonthcjk": "date-year-month",
-    "dateyearmonthen": "date-year-monthname-en",
-    "nocontent": "fixed-empty",
-    "numcommadecimal": "num-comma-decimal",
-    "numdotdecimal": "num-dot-decimal",
-    "numdotdecimalin": "num-dot-decimal",
-    "numunitdecimal": "num-unit-decimal",
-    "numunitdecimalin": "num-unit-decimal",
-    "zerodash": "fixed-zero"
-    }
-
-print("Parsing TR3 file {}".format(INFILE))
-startedAt = time.time()
-parser = etree.XMLParser(recover=True, huge_tree=True)
-with io.open(INFILE, "rb") as fh:
-    doc = etree.parse(fh,parser=parser,base_url=INFILE)
-
-# replace format TR3 with TR4
-nsToChange = set()
-for elt in doc.iter(*ixEltsWithFormat):
-    prefix, _sep, localName = elt.get("format", "").rpartition(":")
-    if localName:
-        ns = elt.nsmap.get(prefix)
-        if ns in (TR2NS, TR3NS):
-            if localName in TR23to4:
-                elt.set("format", "ixt:" + TR23to4[localName])
-                nsToChange.add(ns)
-            else:
-                print("{} line {}: nable to convert transform {}".format(elt.tag, elt.sourceline, elt.get("format")))
-
-# replace TR2 and TR3 namespaces in any xmlns'ed element
-outXhtml = etree.tostring(doc, encoding=doc.docinfo.encoding, xml_declaration=True)
-for ns in nsToChange:
-    outXhtml = outXhtml.replace(ns.encode(), TR4NS.encode())
-
-with io.open(OUTFILE, "wb", ) as fh:
-    fh.write(outXhtml)
-print("Converted in {:.3f} secs, TR4 file {}".format(time.time()-startedAt, INFILE))