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

arelle/examples/plugin/functionsCustom.py

@@ -1,59 +0,0 @@
-'''
-Sample custom functions plugin for formula custom functions
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle import XbrlUtil
-from arelle.formula import XPathContext
-from arelle.ModelValue import qname
-from arelle.ModelInstanceObject import ModelDimensionValue
-from arelle.Version import authorLabel, copyrightLabel
-from decimal import Decimal
-
-# custom function for test case 22015 v01, same as in FunctionCustom.py
-def  test_22015v01_my_fn_PDxEV(xc, p, contextItem, args):
-    if len(args) != 2: raise XPathContext.FunctionNumArgs()
-    PDseq = args[0] if isinstance(args[0],(list,tuple)) else (args[0],)
-    EVseq = args[1] if isinstance(args[1],(list,tuple)) else (args[1],)
-    dimQname = qname("{http://www.example.com/wgt-avg}ExposuresDimension")
-    PDxEV = []
-    for pd in PDseq:
-        if pd.context is not None:
-            pdDim = pd.context.dimValue(dimQname)
-            for ev in EVseq:
-                if ev.context is not None:
-                    evDim = ev.context.dimValue(dimQname)
-                    if pdDim is not None and isinstance(pdDim,ModelDimensionValue):
-                        dimEqual =  pdDim.isEqualTo(evDim, equalMode=XbrlUtil.S_EQUAL2)
-                    elif evDim is not None and isinstance(evDim,ModelDimensionValue):
-                        dimEqual =  evDim.isEqualTo(pdDim, equalMode=XbrlUtil.S_EQUAL2)
-                    else:
-                        dimEqual = (pdDim == evDim)
-                    if dimEqual:
-                        PDxEV.append(pd.xValue * ev.xValue)
-                        # type promotion required
-                        if isinstance(pdX,Decimal) and isinstance(evX,float):
-                            pdX = float(pdX)
-                        elif isinstance(evX,Decimal) and isinstance(pdX,float):
-                            pdX = float(evX)
-                        PDxEV.append(pdX * evX)
-                        break
-    return PDxEV
-
-# returns dict of function QName and method executing the function
-def customFunctions():
-    return {
-        # sample function included for formula tests
-        qname("{http://www.example.com/wgt-avg/function}my-fn:PDxEV"): test_22015v01_my_fn_PDxEV
-    }
-
-__pluginInfo__ = {
-    'name': 'Custom Formula Functions (example)',
-    'version': '1.0',
-    'description': "This plug-in adds a custom function implemented by a plug-in.  ",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'Formula.CustomFunctions': customFunctions,
-}

arelle/examples/plugin/hello_dolly.py

@@ -1,64 +0,0 @@
-'''
-Hello dolly is a simple "Hello world" to demonstrate how plug-ins
-are written for Arelle
-
-See COPYRIGHT.md for copyright information.
-'''
-from __future__ import print_function
-from arelle.Version import copyrightLabel
-from random import randint
-
-
-LYRICS =  ["I said hello, dolly,......well, hello, dolly", \
-            "It's so nice to have you back where you belong ", \
-            "You're lookin' swell, dolly.......i can tell, dolly ", \
-            "You're still glowin'...you're still crowin'...you're still goin' strong ", \
-            "I feel that room swayin'......while the band's playin' ", \
-            "One of your old favourite songs from way back when ", \
-            "So..... take her wrap, fellas.......find her an empty lap, fellas ", \
-            "Dolly'll never go away again"
-            ]
-
-def randomLyric():
-    ''' A random lyrics.'''
-    return LYRICS[randint(0, len(LYRICS) - 1)]
-
-def helloMenuEntender(cntlr, menu):
-    menu.add_command(label="Hello Dolly", underline=0, command=lambda: helloMenuCommand(cntlr, "Hello Dolly") )
-
-def helloMenuCommand(cntlr, label):
-    hello_dolly = randomLyric();
-    cntlr.addToLog(hello_dolly)
-    import tkinter
-    tkinter.messagebox.showinfo(label, hello_dolly, parent=cntlr.parent)
-
-def helloCommandLineOptionExtender(parser):
-    parser.add_option("--hello_dolly",
-                      action="store_true",
-                      dest="hello_dolly",
-                      help=_('Print a random lyric from "Hello, Dolly"'))
-
-def helloCommandLineUtilityRun(cntlr, options, **kwargs):
-    if getattr(options, "hello_dolly", False):
-        hello_dolly = randomLyric();
-        try:
-            cntlr.addToLog("[info] " + hello_dolly)
-        except:
-            print(hello_dolly)
-
-
-__pluginInfo__ = {
-    'name': 'Hello Dolly',
-    'version': '0.9',
-    'description': "This is not just a plug-in, it symbolizes the hope and enthusiasm "
-                    "of an entire generation summed up in two words sung most famously "
-                    "by Louis Armstrong: Hello, Dolly. When activated you will randomly "
-                    "see a lyric from Hello, Dolly.",
-    'license': 'Apache-2',
-    'author': 'R\xe9gis D\xce9camps',
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'CntlrWinMain.Menu.Tools': helloMenuEntender,
-    'CntlrCmdLine.Options': helloCommandLineOptionExtender,
-    'CntlrCmdLine.Utility.Run': helloCommandLineUtilityRun,
-}

arelle/examples/plugin/hello_i18n.pot

@@ -1,26 +0,0 @@
-# Arelle
-# Copyright (C) 2011 MarkV System
-# This file is distributed under the same license as the Arelle package.
-# R�gis D�camps <regis.decamps@acp.banque-france.fr>, 2011.
-#
-#, fuzzy
-msgid ""
-msgstr ""
-"Project-Id-Version: PACKAGE VERSION\n"
-"Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2012-01-04 18:08+0100\n"
-"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
-"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
-"Language-Team: LANGUAGE <LL@li.org>\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=CHARSET\n"
-"Content-Transfer-Encoding: 8bit\n"
-
-#: hello_i18n.py:28
-msgid "Hello World"
-msgstr ""
-
-#: hello_i18n.py:31
-msgid "Prints 'Hello world'"
-msgstr ""
-

arelle/examples/plugin/hello_i18n.py

@@ -1,32 +0,0 @@
-'''
-Hello dolly is a simple "Hello world" to demonstrate how plug-ins
-are written for Arelle
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle.Version import copyrightLabel
-
-def menuEntender(cntlr, menu):
-    menu.add_command(label="Hello i18n", underline=0, command=lambda: menuCommand(cntlr) )
-
-def menuCommand(cntlr):
-    i10L_world = _("Hello World");
-    cntlr.addToLog(i10L_world)
-    import tkinter
-    tkinter.messagebox.showinfo(_("Prints 'Hello World'"), i10L_world, parent=cntlr.parent)
-
-'''
-   Do not use _( ) in pluginInfo itself (it is applied later, after loading
-'''
-__pluginInfo__ = {
-    'name': 'Hello i18n',
-    'version': '0.9',
-    'description': '''Minimal plug-in that demonstrates i18n internationalization by localized gettext.''',
-    'localeURL': "locale",
-    'localeDomain': 'hello_i18n',
-    'license': 'Apache-2',
-    'author': 'R\u00e9gis D\u00e9camps',
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'CntlrWinMain.Menu.Tools': menuEntender
-}

arelle/examples/plugin/importTestChild1.py

@@ -1,21 +0,0 @@
-'''
-pluginPackages test case
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle.Version import authorLabel, copyrightLabel
-
-def foo():
-    print ("imported unpackaged plug-in child 1")
-
-__pluginInfo__ = {
-    'name': 'Unpackaged Listed Import Child 1',
-    'version': '0.9',
-    'description': "This is a unpackaged child plugin.",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'Import.Unpackaged.Entry2': foo,
-    # imported plugins
-}

arelle/examples/plugin/importTestChild2.py

@@ -1,22 +0,0 @@
-'''
-pluginPackages test case
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle.Version import authorLabel, copyrightLabel
-
-def foo():
-    print ("imported unpackaged plug-in child 2")
-
-__pluginInfo__ = {
-    'name': 'Unpackaged Listed Import Child 2',
-    'version': '0.9',
-    'description': "This is a unpackaged child plugin.",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'Import.Unpackaged.Entry3': foo,
-    # import plugins
-    'import': ('importTestGrandchild1.py', 'importTestGrandchild2.py')
-}

arelle/examples/plugin/importTestGrandchild1.py

@@ -1,21 +0,0 @@
-'''
-pluginPackages test case
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle.Version import authorLabel, copyrightLabel
-
-def foo():
-    print ("imported unpackaged plug-in grandchild 1")
-
-__pluginInfo__ = {
-    'name': 'Unpackaged Listed Import Grandchild 1.1',
-    'version': '0.9',
-    'description': "This is a packages-containing unpackaged child plugin.",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'Import.Unpackaged.Entry4': foo,
-    # imported plugins
-}

arelle/examples/plugin/importTestGrandchild2.py

@@ -1,21 +0,0 @@
-'''
-pluginPackages test case
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle.Version import authorLabel, copyrightLabel
-
-def foo():
-    print ("imported unpackaged plug-in grandchild 2")
-
-__pluginInfo__ = {
-    'name': 'Unpackaged Listed Import Grandchild 1.2',
-    'version': '0.9',
-    'description': "This is a packages-containing child plugin.",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'Import.Unpackaged.Entry5': foo,
-    # imported plugins
-}

arelle/examples/plugin/importTestImported1.py

@@ -1,23 +0,0 @@
-'''
-pluginPackages test case
-
-See COPYRIGHT.md for copyright information.
-'''
-# this module would raise system error due to PEP 366 after python 3.4.3
-from . import importTestImported11
-from arelle.Version import authorLabel, copyrightLabel
-
-def foo():
-    print ("imported unpackaged plug-in relative imported 1")
-
-__pluginInfo__ = {
-    'name': 'Unpackaged Relative Import 1',
-    'version': '0.9',
-    'description': "This is a unpackaged relative imported plugin.",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'Import.Unpackaged.Entry6': foo,
-    # imported plugins
-}

arelle/examples/plugin/importTestImported11.py

@@ -1,22 +0,0 @@
-'''
-pluginPackages test case
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle.Version import authorLabel, copyrightLabel
-# this module would raise system error due to PEP 366 after python 3.4.3
-
-def foo():
-    print ("imported unpackaged plug-in imported relative 1.1")
-
-__pluginInfo__ = {
-    'name': 'Unpackaged Relative Import 1.1',
-    'version': '0.9',
-    'description': "This is a packages-containing unpackaged imported plugin.",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'Import.Unpackaged.Entry7': foo,
-    # imported plugins
-}

arelle/examples/plugin/importTestParent.py

@@ -1,48 +0,0 @@
-'''
-pluginPackages test case
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle.PluginManager import pluginClassMethods
-from arelle.Version import authorLabel, copyrightLabel
-# . relative import only works inside a package now, see https://www.python.org/dev/peps/pep-0366/
-# following two imports raise system error due to PEP 366 after python 3.4.3
-# from . import importTestImported1
-# from .importTestImported1 import foo
-
-def parentMenuEntender(cntlr, menu):
-    menu.add_command(label="Unpackaged Parent exercise descendants", underline=0, command=lambda: parentMenuCommand(cntlr) )
-
-def parentMenuCommand(cntl):
-    for i in range(1,100):
-        for pluginMethod in pluginClassMethods("Import.Unpackaged.Entry{}".format(i)):
-            pluginMethod()
-
-def parentCommandLineOptionExtender(parser):
-    parser.add_option("--unpackageParentImportExample",
-                      action="store_true",
-                      dest="unpackageParentImportExample",
-                      help=_('Test that unpackaged imported plug-ins were actually loaded and activated"'))
-
-def parentCommandLineUtilityRun(cntlr, options, **kwargs):
-    if options.unpackageParentImportExample:
-        parentMenuCommand(cntlr)
-
-def foo():
-    print ("parent of imported unpackaged plug-ins")
-
-__pluginInfo__ = {
-    'name': 'Import Test Unpackaged Parent',
-    'version': '0.9',
-    'description': "This is a imports-containing unpackaged parent plugin.",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'CntlrWinMain.Menu.Tools': parentMenuEntender,
-    'CntlrCmdLine.Options': parentCommandLineOptionExtender,
-    'CntlrCmdLine.Utility.Run': parentCommandLineUtilityRun,
-    'Import.Unpackaged.Entry1': foo,
-    # imported plugins
-    'import': ('importTestChild1.py', 'importTestChild2.py', "module_import_subtree")
-}

arelle/examples/plugin/locale/fr/LC_MESSAGES/hello_i18n.po

@@ -1,25 +0,0 @@
-# Arelle
-# Copyright (C) 2011 MarkV System
-# This file is distributed under the same license as the Arelle package.
-# R�gis D�camps <regis.decamps@acp.banque-france.fr>, 2012.
-#
-#, fuzzy
-msgid ""
-msgstr ""
-"Project-Id-Version: 0.1\n"
-"Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2012-01-04 18:04+0100\n"
-"PO-Revision-Date: 2012-01-04 18:04+0100\n"
-"Last-Translator: Regis Decamps <regis.decamps@acp.banque-france.fr>\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-
-#: hello.py:11 hello.py:16
-msgid "Hello World"
-msgstr "Bonjour tout le monde"
-
-#: hello.py:28
-msgid "Prints 'Hello world'"
-msgstr "Affiche 'Bonjour tout le monde'"
-

arelle/examples/plugin/packagedImportTest/__init__.py

@@ -1,47 +0,0 @@
-'''
-pluginPackages test case
-
-See COPYRIGHT.md for copyright information.
-'''
-from os import path
-from arelle.PluginManager import pluginClassMethods
-from arelle.Version import authorLabel, copyrightLabel
-from . import importTestImported1
-from .importTestImported1 import foo
-
-def parentMenuEntender(cntlr, menu):
-    menu.add_command(label="Packaged Parent exercise descendants", underline=0, command=lambda: parentMenuCommand(cntlr) )
-
-def parentMenuCommand(cntl):
-    for i in range(1,100):
-        for pluginMethod in pluginClassMethods("Import.Packaged.Entry{}".format(i)):
-            pluginMethod()
-
-def parentCommandLineOptionExtender(parser):
-    parser.add_option("--packagedParentImportExample",
-                      action="store_true",
-                      dest="packagedParentImportExample",
-                      help=_('Test that imported plug-ins were actually loaded and activated"'))
-
-def parentCommandLineUtilityRun(cntlr, options, **kwargs):
-    if options.packagedParentImportExample:
-        parentMenuCommand(cntlr)
-
-def foo():
-    print ("parent (__init__) of imported packaged plug-ins")
-
-__pluginInfo__ = {
-    'name': 'Import Test Package Parent',
-    'version': '0.9',
-    'description': "This is a imports-containing packaged (__init__) plugin.",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'CntlrWinMain.Menu.Tools': parentMenuEntender,
-    'CntlrCmdLine.Options': parentCommandLineOptionExtender,
-    'CntlrCmdLine.Utility.Run': parentCommandLineUtilityRun,
-    'Import.Packaged.Entry1': foo,
-    # imported plugins
-    'import': ('importTestChild1.py', 'importTestChild2.py', "module_import_subtree")
-}

arelle/examples/plugin/packagedImportTest/importTestChild1.py

@@ -1,21 +0,0 @@
-'''
-pluginPackages test case
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle.Version import authorLabel, copyrightLabel
-
-def foo():
-    print ("imported packaged plug-in child 1")
-
-__pluginInfo__ = {
-    'name': 'Package Listed Import Child 1',
-    'version': '0.9',
-    'description': "This is a packaged child plugin.",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'Import.Packaged.Entry2': foo,
-    # imported plugins
-}

arelle/examples/plugin/packagedImportTest/importTestChild2.py

@@ -1,22 +0,0 @@
-'''
-pluginPackages test case
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle.Version import authorLabel, copyrightLabel
-
-def foo():
-    print ("imported packaged plug-in child 2")
-
-__pluginInfo__ = {
-    'name': 'Package Listed Import Child 2',
-    'version': '0.9',
-    'description': "This is a packaged child plugin.",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'Import.Packaged.Entry3': foo,
-    # import plugins
-    'import': ('importTestGrandchild1.py', 'importTestGrandchild2.py')
-}

arelle/examples/plugin/packagedImportTest/importTestGrandchild1.py

@@ -1,21 +0,0 @@
-'''
-pluginPackages test case
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle.Version import authorLabel, copyrightLabel
-
-def foo():
-    print ("imported packaged plug-in grandchild 1")
-
-__pluginInfo__ = {
-    'name': 'Package Listed Import Grandchild 1.1',
-    'version': '0.9',
-    'description': "This is a packaged grandchild plugin.",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'Import.Packaged.Entry4': foo,
-    # imported plugins
-}

arelle/examples/plugin/packagedImportTest/importTestGrandchild2.py

@@ -1,21 +0,0 @@
-'''
-pluginPackages test case
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle.Version import authorLabel, copyrightLabel
-
-def foo():
-    print ("imported packaged plug-in grandchild 2")
-
-__pluginInfo__ = {
-    'name': 'Package Listed Import Grandchild 1.2',
-    'version': '0.9',
-    'description': "This is a packaged grandchild plugin.",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'Import.Packaged.Entry5': foo,
-    # imported plugins
-}

arelle/examples/plugin/packagedImportTest/importTestImported1.py

@@ -1,24 +0,0 @@
-'''
-pluginPackages test case
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle.Version import authorLabel, copyrightLabel
-from . import importTestImported11
-from .subdir import importTestImported111
-from .subdir.subsubdir import importTestImported1111
-
-def foo():
-    print ("imported packaged plug-in relative imported 1")
-
-__pluginInfo__ = {
-    'name': 'Package Relative Import 1',
-    'version': '0.9',
-    'description': "This is a packaged relative imported plugin.",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'Import.Packaged.Entry6': foo,
-    # imported plugins
-}

arelle/examples/plugin/packagedImportTest/importTestImported11.py

@@ -1,21 +0,0 @@
-'''
-pluginPackages test case
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle.Version import authorLabel, copyrightLabel
-
-def foo():
-    print ("imported packaged plug-in relative imported 1.1")
-
-__pluginInfo__ = {
-    'name': 'Package Relative Import 1.1',
-    'version': '0.9',
-    'description': "This is a packaged relative imported plugin.",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'Import.Packaged.Entry7': foo,
-    # imported plugins
-}

arelle/examples/plugin/packagedImportTest/subdir/importTestImported111.py

@@ -1,21 +0,0 @@
-'''
-pluginPackages test case
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle.Version import authorLabel, copyrightLabel
-
-def foo():
-    print ("imported packaged plug-in relative subdir imported 1.1/1")
-
-__pluginInfo__ = {
-    'name': 'Package Relative Import 1.1/1',
-    'version': '0.9',
-    'description': "This is a packaged relative subdir imported plugin.",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'Import.Packaged.Entry8': foo,
-    # imported plugins
-}

arelle/examples/plugin/packagedImportTest/subdir/subsubdir/importTestImported1111.py

@@ -1,21 +0,0 @@
-'''
-pluginPackages test case
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle.Version import authorLabel, copyrightLabel
-
-def foo():
-    print ("imported packaged plug-in relative subdir imported 1.1/1/1")
-
-__pluginInfo__ = {
-    'name': 'Package Relative Import 1.1/1/1',
-    'version': '0.9',
-    'description': "This is a packaged relative subsubdir imported plugin.",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'Import.Packaged.Entry8': foo,
-    # imported plugins
-}