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

arelle/examples/plugin/validateSchemaLxml.py

@@ -1,156 +0,0 @@
-'''
-Save DTS is an example of a plug-in to both GUI menu and command line/web service
-that will save the files of a DTS into a zip file.
-
-See COPYRIGHT.md for copyright information.
-'''
-
-import threading
-from arelle.Version import authorLabel, copyrightLabel
-from lxml import etree
-
-def validateSchemaWithLxml(modelXbrl, cntlr=None):
-    class schemaResolver(etree.Resolver):
-        def resolve(self, url, id, context):
-            if url.startswith("file:///__"):
-                url = importedFilepaths[int(url[10:])]
-            filepath = modelXbrl.modelManager.cntlr.webCache.getfilename(url)
-            return self.resolve_filename(filepath, context)
-
-    entryDocument = modelXbrl.modelDocument
-    # test of schema validation using lxml (trial experiment, commented out for production use)
-    from arelle import ModelDocument
-    imports = []
-    importedNamespaces = set()
-    importedFilepaths = []
-
-    '''
-    for mdlSchemaDoc in entryDocument.referencesDocument.keys():
-        if (mdlSchemaDoc.type == ModelDocument.Type.SCHEMA and
-            mdlSchemaDoc.targetNamespace not in importedNamespaces):
-            # actual file won't pass through properly, fake with table reference
-            imports.append('<xsd:import namespace="{0}" schemaLocation="file:///__{1}"/>'.format(
-                mdlSchemaDoc.targetNamespace, len(importedFilepaths)))
-            importedNamespaces.add(mdlSchemaDoc.targetNamespace)
-            importedFilepaths.append(mdlSchemaDoc.filepath)
-    '''
-
-    def importReferences(referencingDocument):
-        for mdlSchemaDoc in referencingDocument.referencesDocument.keys():
-            if (mdlSchemaDoc.type == ModelDocument.Type.SCHEMA and
-                mdlSchemaDoc.targetNamespace not in importedNamespaces):
-                importedNamespaces.add(mdlSchemaDoc.targetNamespace)
-                importReferences(mdlSchemaDoc)  # do dependencies first
-                # actual file won't pass through properly, fake with table reference
-                imports.append('<xsd:import namespace="{0}" schemaLocation="file:///__{1}"/>'.format(
-                    mdlSchemaDoc.targetNamespace, len(importedFilepaths)))
-                importedFilepaths.append(mdlSchemaDoc.filepath)
-    importReferences(entryDocument)
-    # add schemas used in xml validation but not DTS discovered
-    for mdlDoc in modelXbrl.urlDocs.values():
-        if mdlDoc.type in (ModelDocument.Type.INSTANCE, ModelDocument.Type.LINKBASE):
-            schemaLocation = mdlDoc.xmlRootElement.get("{http://www.w3.org/2001/XMLSchema-instance}schemaLocation")
-            if schemaLocation:
-                ns = None
-                for entry in schemaLocation.split():
-                    if ns is None:
-                        ns = entry
-                    else:
-                        if ns not in importedNamespaces:
-                            imports.append('<xsd:import namespace="{0}" schemaLocation="file:///__{1}"/>'.format(
-                                ns, len(importedFilepaths)))
-                            importedNamespaces.add(ns)
-                            importedFilepaths.append(entry)
-                        ns = None
-    schemaXml = '<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">\n{0}</xsd:schema>\n'.format(
-                   '\n'.join(imports))
-    # trace schema files referenced
-    with open("c:\\temp\\test.xml", "w") as fh:
-        fh.write(schemaXml)
-    modelXbrl.modelManager.showStatus(_("lxml validator loading xml schema"))
-    schema_root = etree.XML(schemaXml)
-    import time
-    startedAt = time.time()
-    parser = etree.XMLParser()
-    parser.resolvers.add(schemaResolver())
-    schemaDoc = etree.fromstring(schemaXml, parser=parser, base_url=entryDocument.filepath+"-dummy-import.xsd")
-    schema = etree.XMLSchema(schemaDoc)
-    from arelle.Locale import format_string
-    modelXbrl.info("info:lxmlSchemaValidator", format_string(modelXbrl.modelManager.locale,
-                                 _("schema loaded in %.2f secs"),
-                                        time.time() - startedAt))
-    modelXbrl.modelManager.showStatus(_("lxml schema validating"))
-    # check instance documents and linkbases (sort for inst doc before linkbases, and in file name order)
-    for mdlDoc in sorted(modelXbrl.urlDocs.values(), key=lambda mdlDoc: (-mdlDoc.type, mdlDoc.filepath)):
-        if mdlDoc.type in (ModelDocument.Type.INSTANCE, ModelDocument.Type.LINKBASE):
-            startedAt = time.time()
-            docXmlTree = etree.parse(mdlDoc.filepath)
-            modelXbrl.info("info:lxmlSchemaValidator", format_string(modelXbrl.modelManager.locale,
-                                                _("schema validated in %.3f secs"),
-                                                time.time() - startedAt),
-                                                modelDocument=mdlDoc)
-            if not schema.validate(docXmlTree):
-                for error in schema.error_log:
-                    modelXbrl.error("lxmlSchema:{0}".format(error.type_name.lower()),
-                            error.message,
-                            modelDocument=mdlDoc,
-                            sourceLine=error.line)
-    modelXbrl.modelManager.showStatus(_("lxml validation done"), clearAfter=3000)
-
-    if cntlr is not None:
-        # if using GUI controller, not cmd line or web service, select the errors window when done
-        cntlr.uiThreadQueue.put((cntlr.logSelect, []))
-
-def validateSchemaWithLxmlMenuEntender(cntlr, validationmenu):
-    # Insert as 2nd menu item for the lxml schema validation
-    validationmenu.insert_command(1, label="Validate schema with lxml",
-                                  underline=0,
-                                  command=lambda: validateSchemaWithLxmlMenuCommand(cntlr) )
-
-def validateSchemaWithLxmlMenuCommand(cntlr):
-    # save DTS menu item has been invoked
-    if cntlr.modelManager is None or cntlr.modelManager.modelXbrl is None:
-        cntlr.addToLog(_("No taxonomy loaded."))
-        return
-    # do the schema validation in background (and afterwards focus on GUI messages pane)
-    thread = threading.Thread(target=lambda dts=cntlr.modelManager.modelXbrl, c=cntlr: validateSchemaWithLxml(dts, c))
-    thread.daemon = True
-    thread.start()
-
-def validateSchemaWithLxmlCommandLineOptionExtender(parser):
-    # extend command line options with a save DTS option
-    parser.add_option("--validateSchemaWithLxml",
-                      action="store_true",
-                      dest="validateSchemaLxml",
-                      help=_("Validate the schema with lxml (experimental)"))
-
-def validateSchemaWithLxmlCommandLineXbrlRun(cntlr, options, modelXbrl, *args, **kwargs):
-    # extend XBRL-loaded run processing for this option
-    if getattr(options, "validateSchemaLxml", False):
-        if cntlr.modelManager is None or cntlr.modelManager.modelXbrl is None:
-            cntlr.addToLog(_("No taxonomy loaded."))
-            return
-        validateSchemaWithLxml(cntlr.modelManager.modelXbrl)
-
-
-'''
-   Do not use _( ) in pluginInfo itself (it is applied later, after loading
-'''
-
-__pluginInfo__ = {
-    'name': 'Validate Schema with Lxml',
-    'version': '0.9',
-    'description': "This plug-in provides schema validation using lxml.  As of 2012-05 "
-                    " lxml does not properly schema validate XBRL schemas, which is why"
-                    " it is provided in a plug-in instead of the main build.  "
-                    "For the GUI, this feature is inserted to the tools->validation menu 2nd position.  "
-                    "This is an experimental feature, not suitable for XBRL production use until lxml"
-                    " schema validation becomes reliable for XBRL schemas.",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'CntlrWinMain.Menu.Validation': validateSchemaWithLxmlMenuEntender,
-    'CntlrCmdLine.Options': validateSchemaWithLxmlCommandLineOptionExtender,
-    'CntlrCmdLine.Xbrl.Run': validateSchemaWithLxmlCommandLineXbrlRun,
-}

arelle/examples/plugin/validateTableInfoset.py

@@ -1,52 +0,0 @@
-'''
-This is an example of a plug-in to both GUI menu and command line/web service
-that will provide an option to replace behavior of table linkbase validation to
-generate vs diff table linkbase infoset files.
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle.Version import authorLabel, copyrightLabel
-
-def validateTableInfosetMenuEntender(cntlr, validateMenu):
-    # Extend menu with an item for the save infoset plugin
-    cntlr.modelManager.generateTableInfoset = cntlr.config.setdefault("generateTableInfoset",False)
-    from tkinter import BooleanVar
-    generateTableInfoset = BooleanVar(value=cntlr.modelManager.generateTableInfoset)
-    def setTableInfosetOption(*args):
-        cntlr.config["generateTableInfoset"] = cntlr.modelManager.generateTableInfoset = generateTableInfoset.get()
-    generateTableInfoset.trace("w", setTableInfosetOption)
-    validateMenu.add_checkbutton(label=_("Generate table infosets (instead of diffing them)"),
-                                 underline=0,
-                                 variable=generateTableInfoset, onvalue=True, offvalue=False)
-
-def validateTableInfosetCommandLineOptionExtender(parser):
-    # extend command line options with a save DTS option
-    parser.add_option("--generate-table-infoset",
-                      action="store_true",
-                      dest="generateTableInfoset",
-                      help=_("Generate table instance infosets (instead of diffing them)."))
-
-def validateTableInfosetCommandLineXbrlLoaded(cntlr, options, modelXbrl, *args, **kwargs):
-    cntlr.modelManager.generateTableInfoset = getattr(options, "generateTableInfoset", False)
-
-def validateTableInfoset(modelXbrl, resultTableUri):
-    diffToFile = not getattr(modelXbrl.modelManager, 'generateTableInfoset', False)
-    from arelle import ViewFileRenderedGrid
-    ViewFileRenderedGrid.viewRenderedGrid(modelXbrl,
-                                          resultTableUri,
-                                          diffToFile=diffToFile)  # false to save infoset files
-    return True # blocks standard behavior in validate.py
-
-__pluginInfo__ = {
-    'name': 'Validate Table Infoset (Optional behavior)',
-    'version': '0.9',
-    'description': "This plug-in adds a feature modify batch validation of table linkbase to save, versus diff, infoset files.  ",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'CntlrWinMain.Menu.Validation': validateTableInfosetMenuEntender,
-    'CntlrCmdLine.Options': validateTableInfosetCommandLineOptionExtender,
-    'CntlrCmdLine.Xbrl.Loaded': validateTableInfosetCommandLineXbrlLoaded,
-    'Validate.TableInfoset': validateTableInfoset,
-}

arelle/examples/us-gaap-dei-docType-extraction-frm.xml

@@ -1,90 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<!-- linkbase with prefix declarations used below, including us-gaap's of 2008-2011 -->
-<link:linkbase
-  xmlns:link="http://www.xbrl.org/2003/linkbase" 
-  xmlns:xbrli="http://www.xbrl.org/2003/instance" 
-  xmlns:xlink="http://www.w3.org/1999/xlink" 
-  xmlns:generic="http://xbrl.org/2008/generic"
-  xmlns:validation="http://xbrl.org/2008/validation"
-  xmlns:va="http://xbrl.org/2008/assertion/value"
-  xmlns:variable="http://xbrl.org/2008/variable"
-  xmlns:cf="http://xbrl.org/2008/filter/concept"
-  xmlns:gf="http://xbrl.org/2008/filter/general"
-  xmlns:msg="http://xbrl.org/2010/message"
-  xmlns:xfi="http://www.xbrl.org/2008/function/instance" 
-  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-  xmlns:dei-08="http://xbrl.us/dei/2008-03-31"
-  xmlns:dei-09="http://xbrl.us/dei/2009-01-31"
-  xmlns:dei-11="http://xbrl.sec.gov/dei/2011-01-31"
-  xmlns:xbrldt="http://xbrl.org/2005/xbrldt" 
-xsi:schemaLocation="
-  http://www.xbrl.org/2003/linkbase http://www.xbrl.org/2003/xbrl-linkbase-2003-12-31.xsd
-  http://xbrl.org/2008/generic http://www.xbrl.org/2008/generic-link.xsd
-  http://xbrl.org/2008/assertion/value http://www.xbrl.org/2008/value-assertion.xsd
-  http://xbrl.org/2008/variable http://www.xbrl.org/2008/variable.xsd
-  http://xbrl.org/2008/filter/concept http://www.xbrl.org/2008/concept-filter.xsd
-  http://xbrl.org/2008/filter/general http://www.xbrl.org/2008/general-filter.xsd
-  http://xbrl.org/2010/message http://www.xbrl.org/2010/generic-message.xsd
-  ">
-  
-  <!-- arcroleRef's for arcroles used in the example -->
-  <link:arcroleRef arcroleURI="http://xbrl.org/arcrole/2008/variable-set" xlink:href="http://www.xbrl.org/2008/variable.xsd#variable-set" xlink:type="simple"/>
-  <link:arcroleRef arcroleURI="http://xbrl.org/arcrole/2008/variable-filter" xlink:href="http://www.xbrl.org/2008/variable.xsd#variable-filter" xlink:type="simple"/>
-  <link:arcroleRef arcroleURI="http://xbrl.org/arcrole/2010/assertion-satisfied-message" xlink:href="http://www.xbrl.org/2010/validation-message.xsd#assertion-satisfied-message" xlink:type="simple"/>
-  <link:arcroleRef arcroleURI="http://xbrl.org/arcrole/2010/assertion-unsatisfied-message" xlink:href="http://www.xbrl.org/2010/validation-message.xsd#assertion-unsatisfied-message" xlink:type="simple"/>
-  <link:roleRef roleURI="http://www.xbrl.org/2008/role/link" xlink:href="http://www.xbrl.org/2008/generic-link.xsd#standard-link-role" xlink:type="simple"/>
-
-  <generic:link xlink:type="extended"
-    xlink:role="http://www.xbrl.org/2008/role/link">
-
-    <!-- a value assertion that is always true, so that every filing will match
-         and produce an assertion message with the DEI document type found -->
-    <va:valueAssertion xlink:type="resource"
-      xlink:label="extract-DEI-DocumentType"
-      id="extract-Document-Type"
-      test="true()"
-      aspectModel="dimensional" implicitFiltering="true"/>
-
-    <!-- the message, providing the DEI document type, for each filing that has one -->
-    <msg:message xlink:type="resource" xlink:label="DEI-document-type-message" 
-      xlink:role="http://www.xbrl.org/2010/role/message" 
-      xml:lang="en">DEI document type is {
-          $docType
-      }</msg:message>   
-         
-    <!-- arc from value assertion to the message -->
-    <generic:arc xlink:type="arc" xlink:arcrole="http://xbrl.org/arcrole/2010/assertion-satisfied-message"
-      xlink:from="extract-DEI-DocumentType" xlink:to="DEI-document-type-message" order="1.0"/>
-      
-    <!-- arc from the value assertion to the variable which is the document type -->
-    <variable:variableArc xlink:type="arc" xlink:arcrole="http://xbrl.org/arcrole/2008/variable-set" 
-     name="docType" xlink:from="extract-DEI-DocumentType" xlink:to="vDocType"/>
-    
-    <!-- filter for document type, by concept name, and 'required context' (all dimensions defaulted) -->
-    <variable:variableFilterArc xlink:type="arc" xlink:arcrole="http://xbrl.org/arcrole/2008/variable-filter"
-        complement="false" cover="true" xlink:from="vDocType" xlink:to="fDocType"/>
-                
-    <variable:factVariable xlink:type="resource" bindAsSequence="false"
-       xlink:label="vDocType"  />
-    
-    <!-- filter accepts 2009, 2009, or 2011 document type concept -->
-    <cf:conceptName xlink:type="resource" xlink:label="fDocType">
-       <cf:concept>
-          <cf:qname>dei-08:DocumentType</cf:qname>
-       </cf:concept>
-       <cf:concept>
-          <cf:qname>dei-09:DocumentType</cf:qname>
-       </cf:concept>
-       <cf:concept>
-          <cf:qname>dei-11:DocumentType</cf:qname>
-       </cf:concept>
-    </cf:conceptName>
-    
-    <!-- EFM's required context means all dimensions absent (defaulted, segment must be empty -->
-    <gf:general xlink:type="resource" xlink:label="fDocType"
-     test="empty( xfi:segment(.) )" />
-       
-  </generic:link>
-
-</link:linkbase>

arelle/examples/us-gaap-dei-ratio-cash-frm.xml

@@ -1,150 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<link:linkbase
-  xmlns:link="http://www.xbrl.org/2003/linkbase" 
-  xmlns:xbrli="http://www.xbrl.org/2003/instance" 
-  xmlns:xlink="http://www.w3.org/1999/xlink" 
-  xmlns:generic="http://xbrl.org/2008/generic"
-  xmlns:va="http://xbrl.org/2008/assertion/value"
-  xmlns:variable="http://xbrl.org/2008/variable"
-  xmlns:cf="http://xbrl.org/2008/filter/concept"
-  xmlns:gf="http://xbrl.org/2008/filter/general"
-  xmlns:pf="http://xbrl.org/2008/filter/period"
-  xmlns:acf="http://xbrl.org/2010/filter/aspect-cover" 
-  xmlns:msg="http://xbrl.org/2010/message"
-  xmlns:xfi="http://www.xbrl.org/2008/function/instance" 
-  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-  xmlns:dei-11="http://xbrl.sec.gov/dei/2011-01-31"
-  xmlns:us-gaap-11="http://fasb.org/us-gaap/2011-01-31"
-  xmlns:xbrldt="http://xbrl.org/2005/xbrldt" 
-xsi:schemaLocation="
-  http://www.xbrl.org/2003/linkbase http://www.xbrl.org/2003/xbrl-linkbase-2003-12-31.xsd
-  http://xbrl.org/2008/generic http://www.xbrl.org/2008/generic-link.xsd
-  http://xbrl.org/2008/assertion/value http://www.xbrl.org/2008/value-assertion.xsd
-  http://xbrl.org/2008/variable http://www.xbrl.org/2008/variable.xsd
-  http://xbrl.org/2008/filter/concept http://www.xbrl.org/2008/concept-filter.xsd
-  http://xbrl.org/2008/filter/general http://www.xbrl.org/2008/general-filter.xsd
-  http://xbrl.org/2008/filter/period http://www.xbrl.org/2008/period-filter.xsd
-  http://xbrl.org/2010/filter/aspect-cover http://www.xbrl.org/2010/aspect-cover-filter.xsd
-  http://xbrl.org/2010/message http://www.xbrl.org/2010/generic-message.xsd
-  ">
-  
-  <link:arcroleRef arcroleURI="http://xbrl.org/arcrole/2008/variable-set" xlink:href="http://www.xbrl.org/2008/variable.xsd#variable-set" xlink:type="simple"/>
-  <link:arcroleRef arcroleURI="http://xbrl.org/arcrole/2008/variable-filter" xlink:href="http://www.xbrl.org/2008/variable.xsd#variable-filter" xlink:type="simple"/>
-  <link:arcroleRef arcroleURI="http://xbrl.org/arcrole/2010/assertion-satisfied-message" xlink:href="http://www.xbrl.org/2010/validation-message.xsd#assertion-satisfied-message" xlink:type="simple"/>
-  <link:arcroleRef arcroleURI="http://xbrl.org/arcrole/2010/assertion-unsatisfied-message" xlink:href="http://www.xbrl.org/2010/validation-message.xsd#assertion-unsatisfied-message" xlink:type="simple"/>
-  <link:roleRef roleURI="http://www.xbrl.org/2008/role/link" xlink:href="http://www.xbrl.org/2008/generic-link.xsd#standard-link-role" xlink:type="simple"/>
-
-  <generic:link xlink:type="extended"
-    xlink:role="http://www.xbrl.org/2008/role/link">
-
-    <va:valueAssertion xlink:type="resource"
-      xlink:label="cash-ratio"
-      id="cash-ratio"
-      test="true()"
-      aspectModel="dimensional" implicitFiltering="true"/>
-
-    <msg:message xlink:type="resource" xlink:label="cash-ratio-message" 
-      xlink:role="http://www.xbrl.org/2010/role/message" 
-      xml:lang="en">Cash ratio {
-          if ($currentLiabilities ne 0) then
-             (($cash + $marketableSecurities) div $currentLiabilities)
-          else
-             'not available'
-      }, Current ratio {
-          if ($currentLiabilities ne 0) then
-             ($currentAssets div $currentLiabilities)
-          else
-             'not available'
-          
-      }</msg:message>   
-         
-    <generic:arc xlink:type="arc" xlink:arcrole="http://xbrl.org/arcrole/2010/assertion-satisfied-message"
-      xlink:from="cash-ratio" xlink:to="cash-ratio-message" order="1.0"/>
-      
-    <!-- fact variable, arcs, and filters for document type, restricted to 10-K or 10-Q -->           
-    <variable:factVariable xlink:type="resource" bindAsSequence="false"
-       xlink:label="vDocType"  />
-    <variable:variableArc xlink:type="arc" xlink:arcrole="http://xbrl.org/arcrole/2008/variable-set" 
-     name="docType" xlink:from="cash-ratio" xlink:to="vDocType"/>
-    <variable:variableFilterArc xlink:type="arc" xlink:arcrole="http://xbrl.org/arcrole/2008/variable-filter"
-        complement="false" cover="true" xlink:from="vDocType" xlink:to="fDocType"/>
-    <cf:conceptName xlink:type="resource" xlink:label="fDocType">
-       <cf:concept>
-          <cf:qname>dei-11:DocumentType</cf:qname>
-       </cf:concept>
-    </cf:conceptName>
-    
-    <!-- EFM's required context means all dimensions absent (defaulted)
-         and only bind for a 10-K/10-Q filing (don't bind for other form types) -->
-    <gf:general xlink:type="resource" xlink:label="fDocType"
-     test="empty( xfi:segment(.) ) and index-of(('10-K', '10-Q'), .) " />
-
-    <!-- must cover unit because this variable is a string type -->
-    <acf:aspectCover xlink:type="resource" xlink:label="fDocType">
-      <acf:aspect>unit</acf:aspect>
-    </acf:aspectCover>
-
-    <!-- cash -->
-    <variable:factVariable xlink:type="resource" bindAsSequence="false"
-       xlink:label="vCash"  />
-    <variable:variableArc xlink:type="arc" xlink:arcrole="http://xbrl.org/arcrole/2008/variable-set" 
-     name="cash" xlink:from="cash-ratio" xlink:to="vCash"/>
-    <variable:variableFilterArc xlink:type="arc" xlink:arcrole="http://xbrl.org/arcrole/2008/variable-filter"
-        complement="false" cover="true" xlink:from="vCash" xlink:to="fCash"/>
-    <cf:conceptName xlink:type="resource" xlink:label="fCash">
-       <cf:concept>
-          <cf:qname>us-gaap-11:Cash</cf:qname>
-       </cf:concept>
-       <cf:concept>
-          <cf:qname>us-gaap-11:CashAndCashEquivalentsAtCarryingValue</cf:qname>
-       </cf:concept>
-    </cf:conceptName>
-    <!--  Must match period-end of documentType period -->
-    <pf:instantDuration xlink:type="resource" xlink:label="fCash" boundary="end" variable="docType" />
-     
-    <!-- marketable securities -->
-    <variable:factVariable xlink:type="resource" bindAsSequence="false" fallbackValue="0"
-       xlink:label="vMarketableSecurities"  />
-    <variable:variableArc xlink:type="arc" xlink:arcrole="http://xbrl.org/arcrole/2008/variable-set" 
-     name="marketableSecurities" xlink:from="cash-ratio" xlink:to="vMarketableSecurities"/>
-    <variable:variableFilterArc xlink:type="arc" xlink:arcrole="http://xbrl.org/arcrole/2008/variable-filter"
-        complement="false" cover="true" xlink:from="vMarketableSecurities" xlink:to="fMarketableSecurities"/>
-    <cf:conceptName xlink:type="resource" xlink:label="fMarketableSecurities">
-       <cf:concept>
-          <cf:qname>us-gaap-11:MarketableSecuritiesCurrent</cf:qname>
-       </cf:concept>
-    </cf:conceptName>
-    <pf:instantDuration xlink:type="resource" xlink:label="fCash" boundary="end" variable="docType" />
-     
-    <!-- current liabilities -->
-    <variable:factVariable xlink:type="resource" bindAsSequence="false" fallbackValue="0"
-       xlink:label="vCurrentLiabilities"  />
-    <variable:variableArc xlink:type="arc" xlink:arcrole="http://xbrl.org/arcrole/2008/variable-set" 
-     name="currentLiabilities" xlink:from="cash-ratio" xlink:to="vCurrentLiabilities"/>
-    <variable:variableFilterArc xlink:type="arc" xlink:arcrole="http://xbrl.org/arcrole/2008/variable-filter"
-        complement="false" cover="true" xlink:from="vCurrentLiabilities" xlink:to="fCurrentLiabilities"/>
-    <cf:conceptName xlink:type="resource" xlink:label="fCurrentLiabilities">
-       <cf:concept>
-          <cf:qname>us-gaap-11:LiabilitiesCurrent</cf:qname>
-       </cf:concept>
-    </cf:conceptName>
-    <pf:instantDuration xlink:type="resource" xlink:label="fCurrentLiabilities" boundary="end" variable="docType" />
-     
-    <!-- current assets -->
-    <variable:factVariable xlink:type="resource" bindAsSequence="false" fallbackValue="0"
-       xlink:label="vCurrentAssets"  />
-    <variable:variableArc xlink:type="arc" xlink:arcrole="http://xbrl.org/arcrole/2008/variable-set" 
-     name="currentAssets" xlink:from="cash-ratio" xlink:to="vCurrentAssets"/>
-    <variable:variableFilterArc xlink:type="arc" xlink:arcrole="http://xbrl.org/arcrole/2008/variable-filter"
-        complement="false" cover="true" xlink:from="vCurrentAssets" xlink:to="fCurrentAssets"/>
-    <cf:conceptName xlink:type="resource" xlink:label="fCurrentAssets">
-       <cf:concept>
-          <cf:qname>us-gaap-11:AssetsCurrent</cf:qname>
-       </cf:concept>
-    </cf:conceptName>
-    <pf:instantDuration xlink:type="resource" xlink:label="fCurrentAssets" boundary="end" variable="docType" />
-       
-  </generic:link>
-
-</link:linkbase>

arelle/plugin/functionsXmlCreation.py

@@ -1,106 +0,0 @@
-'''
-Sample custom functions plugin for formula XML Element, Attribute creation functions
-
->>> note that this function has been renamed xfi:create-element and moved to FunctionXfi.py <<<
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle import XbrlUtil
-from arelle.formula import XPathContext
-from arelle.ModelValue import qname, QName
-from arelle.ModelInstanceObject import ModelDimensionValue, XmlUtil
-from arelle.FunctionUtil import qnameArg, nodeArg, atomicArg
-from arelle.Version import authorLabel, copyrightLabel
-from arelle import XmlValidate
-from lxml import etree
-
-'''
-Create an XML element in a "scratchpad" in-memory XML document, to behave like the results
-of an fn:doc() that would provide XML elements which can be consumed by formula typed
-dimension and OCC constructs.
-
-The element may be created with attributes and descendant elements, as needed.
-
-xfxc:element(
-    qname,  // qname of element
-    (name-value pairs for creating attributes if any),
-    value, if any, otherwise () or ''
-    optional nested elements (e.g., xfc:element( ) ... of child nodes)
-    )
-
-Attributes may be pairs of string name, value, or pairs of QName, value when attribute
-name is qualified.
-
-A function definition is required in the formula linkbase:
-<variable:function name="xfxc:element" output="element()" xlink:type="resource" xlink:label="cust-fn-xfxc-create">
-  <variable:input type="xs:QName" />  <!-- qname of element to create -->
-  <variable:input type="xs:anyAtomicType*" /> <!-- sequence of name, value pairs for creating attributes (name can be string or QName) -->
-  <variable:input type="xs:anyAtomicType" /> <!-- optional value, () or '' if none -->
-  <variable:input type="element()*" /> <!-- optional sequence of child elements, this parameter can be omitted if no child elements -->
-</variable:function>
-'''
-def  xfxc_element(xc, p, contextItem, args):
-    if not 2 <= len(args) <= 4: raise XPathContext.FunctionNumArgs()
-    qn = qnameArg(xc, p, args, 0, 'QName', emptyFallback=None)
-    attrArg = args[1] if isinstance(args[1],(list,tuple)) else (args[1],)
-    # attributes have to be pairs
-    if attrArg:
-        if len(attrArg) & 1 or any(not isinstance(attrArg[i], (QName, str))
-                                   for i in range(0, len(attrArg),2)):
-            raise XPathContext.FunctionArgType(1,"((xs:qname|xs:string),xs:anyAtomicValue)", errCode="xfxce:AttributesNotNameValuePairs")
-        else:
-            attrParam = [(attrArg[i],attrArg[i+1]) # need name-value pairs for XmlUtil function
-                         for i in range(0, len(attrArg),2)]
-    else:
-        attrParam = None
-
-    value = atomicArg(xc, p, args, 2, "xs:anyAtomicType", emptyFallback='')
-    if not value: # be sure '' is None so no text node is created
-        value = None
-    if len(args) < 4:
-        childElements = None
-    else:
-        childElements = xc.flattenSequence(args[3])
-
-    # scratchpad instance document emulates fn:doc( ) to hold XML nodes
-    scratchpadXmlDocUrl = "http://www.xbrl.org/2012/function/creation/xml_scratchpad.xml"
-    if scratchpadXmlDocUrl in xc.modelXbrl.urlDocs:
-        modelDocument = xc.modelXbrl.urlDocs[scratchpadXmlDocUrl]
-    else:
-        # create scratchpad xml document
-        # this will get the fake instance document in the list of modelXbrl docs so that it is garbage collected
-        from arelle import ModelDocument
-        modelDocument = ModelDocument.create(xc.modelXbrl,
-                                             ModelDocument.Type.UnknownXML,
-                                             scratchpadXmlDocUrl,
-                                             initialXml="<xfc:dummy xmlns:xfc='http://www.xbrl.org/2012/function/creation'/>")
-
-    newElement = XmlUtil.addChild(modelDocument.xmlRootElement,
-                                  qn,
-                                  attributes=attrParam,
-                                  text=value)
-    if childElements:
-        for element in childElements:
-            if isinstance(element, etree.ElementBase):
-                newElement.append(element)
-
-    # node myst be validated for use in instance creation (typed dimension references)
-    XmlValidate.validate(xc.modelXbrl, newElement)
-
-    return newElement
-
-def xfxcFunctions():
-    return {
-        qname("{http://www.xbrl.org/2012/function/xml-creation}xfxc:element"): xfxc_element,
-    }
-
-__pluginInfo__ = {
-    'name': 'Formula Xml Creation Functions',
-    'version': '1.0',
-    'description': "This plug-in adds a custom function to create xml elements, such as for typed dimensions, implemented by a plug-in.  ",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'Formula.CustomFunctions': xfxcFunctions,
-}