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

arelle/examples/plugin/testcaseCalc11ValidateSetup.py

@@ -1,32 +0,0 @@
-'''
-This plug-in removes xmlns="http://www.w3.org/1999/xhtml" from
-escaped html in text content of expected instance facts for inline XBRL text facts
-
-(c) Copyright 2019 Mark V Systems Limited, All rights reserved.
-'''
-try:
-    import regex as re
-except ImportError:
-    import re
-from arelle.XhtmlValidate import htmlEltUriAttrs, resolveHtmlUri
-from arelle.ValidateXbrlCalcs import ValidateCalcsMode as CalcsMode
-
-def testcaseVariationLoaded(testInstance, testcaseInstance, modelTestcaseVariation):
-    for result in modelTestcaseVariation.iter("{*}result"):
-        for n, v in result.attrib.items():
-            if n.endswith("mode"):
-                if v == "round-to-nearest":
-                    testInstance.modelManager.validateCalcs = CalcsMode.ROUND_TO_NEAREST
-                elif v == "truncate":
-                    testInstance.modelManager.validateCalcs = CalcsMode.TRUNCATION
-
-__pluginInfo__ = {
-    'name': 'Testcase obtain expected calc 11 mode from variation/result@mode',
-    'version': '0.9',
-    'description': "This plug-in removes xxx.  ",
-    'license': 'Apache-2',
-    'author': 'Mark V Systems Limited',
-    'copyright': '(c) Copyright 2019 Mark V Systems Limited, All rights reserved.',
-    # classes of mount points (required)
-    'TestcaseVariation.Xbrl.Loaded': testcaseVariationLoaded,
-}

arelle/examples/plugin/testcaseIxExpectedHtmlFixup.py

@@ -1,45 +0,0 @@
-'''
-This plug-in removes xmlns="http://www.w3.org/1999/xhtml" from
-escaped html in text content of expected instance facts for inline XBRL text facts
-
-It also provides an error code when a testcase variation does not load any iXBRL document.
-
-See COPYRIGHT.md for copyright information.
-'''
-import regex as re
-from arelle.ModelDocument import Type
-from arelle.Version import authorLabel, copyrightLabel
-from arelle.XhtmlValidate import htmlEltUriAttrs, resolveHtmlUri
-
-def variationInstanceLoaded(testcaseInstance, variationInstance, extraErrors, inputDTSes, *args, **kwargs):
-    # test case variations which have xhtml documents which are not inline blissfully load as unrecognized plain xml
-    # provide an error code that no iXBRL document was loaded so test case script can honor variation's expectation that this is an error
-    for inputDTS in inputDTSes.values():
-        for ixds in inputDTS:
-            if ixds.modelDocument.type not in (Type.INLINEXBRL, Type.INLINEXBRLDOCUMENTSET):
-                extraErrors.append( "NotAnIxbrlDocument" )
-
-def expectedInstanceLoaded(expectedInstance, outputInstanceToCompare):
-    for f in expectedInstance.facts:
-        if not f.isNumeric and f.text and "http://www.w3.org/1999/xhtml" in f.text:
-            f.text = re.sub(r"""(<[^>]+)\s+xmlns=["']http://www.w3.org/1999/xhtml["']""",r"\1", f.text)
-
-    # fixup relative urls in fact footnotes
-    for elt in expectedInstance.modelDocument.xmlRootElement.iterdescendants(tag="{http://www.w3.org/1999/xhtml}*"):
-        for n in htmlEltUriAttrs.get(elt.localName, ()):
-            v = elt.get(n)
-            if v:
-                v = resolveHtmlUri(elt, n, v).replace(" ", "%20")
-                elt.set(n, v)
-
-__pluginInfo__ = {
-    'name': 'Testcase fixup escaped html xmlns',
-    'version': '0.9',
-    'description': "This plug-in removes xxx.  ",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'TestcaseVariation.Validated': variationInstanceLoaded,
-    'TestcaseVariation.ExpectedInstance.Loaded': expectedInstanceLoaded,
-}

arelle/examples/plugin/updateTableLB.py

@@ -1,242 +0,0 @@
-'''
-Update Table Linkbase is an example of a plug-in to both GUI menu and command line/web service
-that updates a table linkbase from Eurofiling 2010 syntax to XII 2011 PWD syntax and saves it.
-
-See COPYRIGHT.md for copyright information.
-'''
-from arelle.Version import authorLabel, copyrightLabel
-
-def generateUpdatedTableLB(dts, updatedTableLinkbaseFile):
-    import os, io
-    from arelle import XmlUtil, XbrlConst
-    from arelle.ViewUtil import viewReferences, referenceURI
-    from arelle.ModelRenderingObject import ModelEuAxisCoord
-
-    if dts.fileSource.isArchive:
-        dts.error("genTblLB:outFileIsArchive",
-                 _("Updated Table Linkbase file cannot be an archive: %(tableLBOutputFile)s."),
-                 modelObject=dts, tableLBOutputFile=updatedTableLinkbaseFile)
-        return
-    tblAxisRelSet = dts.relationshipSet(XbrlConst.euTableAxis)
-    axisMbrRelSet = dts.relationshipSet(XbrlConst.euAxisMember)
-    if len(tblAxisRelSet.modelRelationships) == 0:
-        dts.error("genTblLB:noInputTables",
-                 _("DTS does not contain Eurofiling 2010 tables and axes: %(entryFile)s."),
-                 modelObject=dts, entryFile=dts.uri)
-        return
-
-    file = io.StringIO('''
-<nsmap>
-<link:linkbase
-xmlns:label="http://xbrl.org/2008/label"
-xmlns:gen="http://xbrl.org/2008/generic"
-xmlns:df="http://xbrl.org/2008/filter/dimension"
-xmlns:xlink="http://www.w3.org/1999/xlink"
-xmlns:reference="http://xbrl.org/2008/reference"
-xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-xmlns:link="http://www.xbrl.org/2003/linkbase"
-xmlns:table="http://xbrl.org/2011/table"
-xmlns:formula="http://xbrl.org/2008/formula"
-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/reference http://www.xbrl.org/2008/generic-reference.xsd
-http://xbrl.org/2008/label http://www.xbrl.org/2008/generic-label.xsd
-http://xbrl.org/2011/table http://www.xbrl.org/2011/table.xsd
-http://xbrl.org/2008/filter/dimension http://www.xbrl.org/2008/dimension-filter.xsd">
-  <link:arcroleRef arcroleURI="http://xbrl.org/arcrole/2011/table-filter" xlink:type="simple"
-   xlink:href="http://www.xbrl.org/2011/table.xsd#table-filter"/>
-  <link:arcroleRef arcroleURI="http://xbrl.org/arcrole/2011/table-axis" xlink:type="simple"
-   xlink:href="http://www.xbrl.org/2011/table.xsd#table-axis"/>
-  <link:arcroleRef arcroleURI="http://xbrl.org/arcrole/2011/axis-subtree" xlink:type="simple"
-   xlink:href="http://www.xbrl.org/2011/table.xsd#axis-subtree"/>
-  <link:arcroleRef arcroleURI="http://xbrl.org/arcrole/2011/axis-filter" xlink:type="simple"
-   xlink:href="http://www.xbrl.org/2011/filter-axis.xsd#axis-filter"/>
-</link:linkbase>
-</nsmap>
-<!--  Generated by Arelle(r) http://arelle.org -->
-'''
-     )
-    from arelle.ModelObjectFactory import parser
-    parser, parserLookupName, parserLookupClass = parser(dts,None)
-    from lxml import etree
-    xmlDocument = etree.parse(file,parser=parser,base_url=updatedTableLinkbaseFile)
-    file.close()
-    nsmapElt = xmlDocument.getroot()
-    #xmlDocument.getroot().init(self)  ## is this needed ??
-    for lbElement in  xmlDocument.iter(tag="{http://www.xbrl.org/2003/linkbase}linkbase"):
-        break
-
-    class DocObj:  # fake ModelDocument for namespaces
-        def __init__(self):
-            self.xmlRootElement = lbElement
-            self.xmlDocument = xmlDocument
-    docObj = DocObj()
-
-    numELRs = 0
-    numTables = 0
-
-    def copyAttrs(fromElt, toElt, attrTags):
-        for attr in attrTags:
-            if fromElt.get(attr):
-                toElt.set(attr, fromElt.get(attr))
-
-    def generateTable(newLinkElt, newTblElt, srcTblElt, tblAxisRelSet, axisMbrRelSet, visited):
-        if srcTblElt is not None:
-            for rel in tblAxisRelSet.fromModelObject(srcTblElt):
-                srcAxisElt = rel.toModelObject
-                if isinstance(srcAxisElt, ModelEuAxisCoord):
-                    visited.add(srcAxisElt)
-                    newAxisElt = etree.SubElement(newLinkElt, "{http://xbrl.org/2011/table}ruleAxis")
-                    copyAttrs(srcAxisElt, newAxisElt, ("id",
-                                                       "{http://www.w3.org/1999/xlink}type",
-                                                       "{http://www.w3.org/1999/xlink}label"))
-                    newAxisElt.set("abstract", "true") # always true on root element
-                    newArcElt = etree.SubElement(newLinkElt, "{http://xbrl.org/2011/table}axisArc")
-                    copyAttrs(rel, newArcElt, ("id",
-                                               "{http://www.w3.org/1999/xlink}type",
-                                               "{http://www.w3.org/1999/xlink}from",
-                                               "{http://www.w3.org/1999/xlink}to",
-                                               "order"))
-                    newArcElt.set("{http://www.w3.org/1999/xlink}arcrole", XbrlConst.tableBreakdown)
-                    newArcElt.set("axisDisposition", rel.axisDisposition)
-                    generateAxis(newLinkElt, newAxisElt, srcAxisElt, axisMbrRelSet, visited)
-                    visited.discard(srcAxisElt)
-
-    def generateAxis(newLinkElt, newAxisParentElt, srcAxisElt, axisMbrRelSet, visited):
-        for rel in axisMbrRelSet.fromModelObject(srcAxisElt):
-            tgtAxisElt = rel.toModelObject
-            if isinstance(tgtAxisElt, ModelEuAxisCoord) and tgtAxisElt not in visited:
-                visited.add(tgtAxisElt)
-                newAxisElt = etree.SubElement(newLinkElt, "{http://xbrl.org/2011/table}ruleAxis")
-                copyAttrs(tgtAxisElt, newAxisElt, ("id",
-                                                   "abstract",
-                                                   "{http://www.w3.org/1999/xlink}type",
-                                                   "{http://www.w3.org/1999/xlink}label"))
-                if tgtAxisElt.primaryItemQname:
-                    newRuleElt = etree.SubElement(newAxisElt, "{http://xbrl.org/2008/formula}concept")
-                    newQnameElt = etree.SubElement(newRuleElt, "{http://xbrl.org/2008/formula}qname")
-                    newQnameElt.text = XmlUtil.addQnameValue(docObj, tgtAxisElt.primaryItemQname)
-                for dimQname, memQname in tgtAxisElt.explicitDims:
-                    newRuleElt = etree.SubElement(newAxisElt, "{http://xbrl.org/2008/formula}explicitDimension")
-                    newRuleElt.set("dimension", XmlUtil.addQnameValue(docObj, dimQname))
-                    newMbrElt = etree.SubElement(newRuleElt, "{http://xbrl.org/2008/formula}member")
-                    newQnameElt = etree.SubElement(newMbrElt, "{http://xbrl.org/2008/formula}qname")
-                    newQnameElt.text = XmlUtil.addQnameValue(docObj, memQname)
-                newArcElt = etree.SubElement(newLinkElt, "{http://xbrl.org/2011/table}axisArc")
-                copyAttrs(rel, newArcElt, ("id",
-                                           "{http://www.w3.org/1999/xlink}type",
-                                           "{http://www.w3.org/1999/xlink}from",
-                                           "{http://www.w3.org/1999/xlink}to",
-                                           "order"))
-                newArcElt.set("{http://www.w3.org/1999/xlink}arcrole", XbrlConst.tableAxisSubtree)
-                generateAxis(newLinkElt, newAxisElt, tgtAxisElt, axisMbrRelSet, visited)
-                visited.discard(tgtAxisElt)
-
-    # sort URIs
-    linkroleUris = sorted([linkroleUri
-                           for linkroleUri in tblAxisRelSet.linkRoleUris])
-
-    firstNewLinkElt = None
-    roleRefUris = set()
-    for linkroleUri in linkroleUris:
-        numELRs += 1
-        newLinkElt = etree.SubElement(lbElement, "{http://xbrl.org/2008/generic}link")
-        newLinkElt.set("{http://www.w3.org/1999/xlink}type", "extended")
-        newLinkElt.set("{http://www.w3.org/1999/xlink}role", linkroleUri)
-        if firstNewLinkElt is None: firstNewLinkElt = newLinkElt
-        # To do: add roleRef if needed
-        tblAxisRelSet = dts.relationshipSet(XbrlConst.euTableAxis, linkroleUri)
-        axisMbrRelSet = dts.relationshipSet(XbrlConst.euAxisMember, linkroleUri)
-        for srcTblElt in tblAxisRelSet.rootConcepts:
-            if srcTblElt.tag == "{http://www.eurofiling.info/2010/rendering}table":
-                numTables += 1
-                newTblElt = etree.SubElement(newLinkElt, "{http://xbrl.org/2011/table}table")
-                newTblElt.set("aspectModel", "dimensional")
-                copyAttrs(srcTblElt, newTblElt, ("id",
-                                                 "{http://www.w3.org/1999/xlink}type",
-                                                 "{http://www.w3.org/1999/xlink}label"))
-                generateTable(newLinkElt, newTblElt, srcTblElt, tblAxisRelSet, axisMbrRelSet, set())
-
-                if linkroleUri not in roleRefUris:
-                    srcRoleRefElt = XmlUtil.descendant(srcTblElt.getroottree(), XbrlConst.link, "roleRef", "roleURI", linkroleUri)
-                    if srcRoleRefElt is not None:
-                        roleRefUris.add(linkroleUri)
-                        newRoleRefElt = etree.Element("{http://www.xbrl.org/2003/linkbase}roleRef")
-                        copyAttrs(srcRoleRefElt, newRoleRefElt, ("roleURI",
-                                                                 "{http://www.w3.org/1999/xlink}type",
-                                                                 "{http://www.w3.org/1999/xlink}href"))
-                        firstNewLinkElt.addprevious(newRoleRefElt)
-
-    fh = open(updatedTableLinkbaseFile, "w", encoding="utf-8")
-    XmlUtil.writexml(fh, xmlDocument, encoding="utf-8")
-    fh.close()
-
-    dts.info("info:updateTableLinkbase",
-             _("Updated Table Linkbase of %(entryFile)s has %(numberOfLinkroles)s linkroles, %(numberOfTables)s tables in file %(tableLBOutputFile)s."),
-             modelObject=dts,
-             entryFile=dts.uri, numberOfLinkroles=numELRs, numberOfTables=numTables, tableLBOutputFile=updatedTableLinkbaseFile)
-
-def updateTableLBMenuEntender(cntlr, menu):
-    # Extend menu with an item for the savedts plugin
-    menu.add_command(label="Update table linkbase",
-                     underline=0,
-                     command=lambda: updateTableLBMenuCommand(cntlr) )
-
-def updateTableLBMenuCommand(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
-
-        # get file name into which to save log file while in foreground thread
-    updatedTableLinkbaseFile = cntlr.uiFileDialog("save",
-                                                  title=_("arelle - Save Updated Table Linkbase file"),
-            initialdir=cntlr.config.setdefault("tableLinkbaseFileDir","."),
-            filetypes=[(_("Linkbase file .xml"), "*.xml")],
-            defaultextension=".xml")
-    if not updatedTableLinkbaseFile:
-        return False
-    import os
-    cntlr.config["tableLinkbaseFileDir"] = os.path.dirname(updatedTableLinkbaseFile)
-    cntlr.saveConfig()
-
-    try:
-        generateUpdatedTableLB(cntlr.modelManager.modelXbrl, updatedTableLinkbaseFile)
-    except Exception as ex:
-        dts = cntlr.modelManager.modelXbrl
-        dts.error("exception",
-            _("Updated table linkbase generation exception: %(error)s"), error=ex,
-            modelXbrl=dts,
-            exc_info=True)
-
-def updateTableLBCommandLineOptionExtender(parser):
-    # extend command line options with a save DTS option
-    parser.add_option("--save-updated-table-linkbase",
-                      action="store",
-                      dest="updatedTableLinkbaseFile",
-                      help=_("Update table linkbase file from Eurofiling 2010 to XII 2011 syntax."))
-
-def updateTableLBCommandLineXbrlRun(cntlr, options, modelXbrl, *args, **kwargs):
-    # extend XBRL-loaded run processing for this option
-    if getattr(options, "updatedTableLinkbaseFile", None):
-        if cntlr.modelManager is None or cntlr.modelManager.modelXbrl is None:
-            cntlr.addToLog("No taxonomy loaded.")
-            return
-        generateUpdatedTableLB(cntlr.modelManager.modelXbrl, options.updatedTableLinkbaseFile)
-
-
-__pluginInfo__ = {
-    'name': 'Update Table Linkbase',
-    'version': '0.9',
-    'description': "This plug-in updates a table linkbase from Eurofiling 2010 syntax to XII 2011 PWD syntax. "
-                   "The updated linkbase is saved to a local file.  "
-                   "Hrefs in the new file are identical the prior hrefs (not offset considering save-to directory).  ",
-    'license': 'Apache-2',
-    'author': authorLabel,
-    'copyright': copyrightLabel,
-    # classes of mount points (required)
-    'CntlrWinMain.Menu.Tools': updateTableLBMenuEntender,
-    'CntlrCmdLine.Options': updateTableLBCommandLineOptionExtender,
-    'CntlrCmdLine.Xbrl.Run': updateTableLBCommandLineXbrlRun,
-}

arelle/examples/plugin/validate/XYZ/DisclosureSystems.py

@@ -1,2 +0,0 @@
-DISCLOSURE_SYSTEM_2022 = "XYZ 2022"
-DISCLOSURE_SYSTEM_2023 = "XYZ 2023"

arelle/examples/plugin/validate/XYZ/PluginValidationDataExtension.py

@@ -1,10 +0,0 @@
-"""
-See COPYRIGHT.md for copyright information.
-"""
-from __future__ import annotations
-
-from arelle.utils.validate.PluginValidationData import PluginValidationData
-
-
-class PluginValidationDataExtension(PluginValidationData):
-    positiveFactConcepts: set[str] | None = None

arelle/examples/plugin/validate/XYZ/ValidationPluginExtension.py

@@ -1,49 +0,0 @@
-"""
-See COPYRIGHT.md for copyright information.
-"""
-from __future__ import annotations
-
-from typing import Any
-
-from arelle.ModelDocument import LoadingException, ModelDocument
-from arelle.ModelXbrl import ModelXbrl
-from arelle.ValidateXbrl import ValidateXbrl
-from arelle.typing import TypeGetText
-from arelle.utils.validate.ValidationPlugin import ValidationPlugin
-from .PluginValidationDataExtension import PluginValidationDataExtension
-
-_: TypeGetText
-
-
-class ValidationPluginExtension(ValidationPlugin):
-    def newPluginData(self, validateXbrl: ValidateXbrl) -> PluginValidationDataExtension:
-        return PluginValidationDataExtension(self.name)
-
-    def modelDocumentPullLoader(
-        self,
-        modelXbrl: ModelXbrl,
-        normalizedUri: str,
-        filepath: str,
-        isEntry: bool,
-        namespace: str | None,
-        *args: Any,
-        **kwargs: Any,
-    ) -> ModelDocument | LoadingException | None:
-        if self.disclosureSystemFromPluginSelected(modelXbrl):
-            return LoadingException(_("XYZ validation plugin is a template for new validation plugins and shouldn't be used directly."))
-        return None
-
-    def modelXbrlLoadComplete(
-        self,
-        modelXbrl: ModelXbrl,
-        *args: Any,
-        **kwargs: Any,
-    ) -> None:
-        if self.disclosureSystemFromPluginSelected(modelXbrl):
-            if modelXbrl.modelDocument is None:
-                modelXbrl.error(
-                    codes="XYZ.01.01",
-                    msg=_("An XBRL Report Package is required but could not be loaded"),
-                    modelObject=modelXbrl,
-                )
-        return None

arelle/examples/plugin/validate/XYZ/__init__.py

@@ -1,75 +0,0 @@
-"""
-See COPYRIGHT.md for copyright information.
-
-Filer Manual Guidelines: https://www.example.com/fake-xyz-filer-manual-v0.0.1.pdf
-"""
-from __future__ import annotations
-
-from pathlib import Path
-from typing import Any
-
-from arelle.ModelDocument import LoadingException, ModelDocument
-from arelle.Version import authorLabel, copyrightLabel
-from .ValidationPluginExtension import ValidationPluginExtension
-from .rules import rules01, rules02
-
-PLUGIN_NAME = "Validate XYZ"
-DISCLOSURE_SYSTEM_VALIDATION_TYPE = "XYZ"
-
-
-validationPlugin = ValidationPluginExtension(
-    name=PLUGIN_NAME,
-    disclosureSystemConfigUrl=Path(__file__).parent / "resources" / "config.xml",
-    validationTypes=[DISCLOSURE_SYSTEM_VALIDATION_TYPE],
-    validationRuleModules=[rules01, rules02],
-)
-
-
-def disclosureSystemTypes(*args: Any, **kwargs: Any) -> tuple[tuple[str, str], ...]:
-    return validationPlugin.disclosureSystemTypes
-
-
-def disclosureSystemConfigURL(*args: Any, **kwargs: Any) -> str:
-    return validationPlugin.disclosureSystemConfigURL
-
-
-def modelDocumentPullLoader(*args: Any, **kwargs: Any) -> ModelDocument | LoadingException | None:
-    return validationPlugin.modelDocumentPullLoader(*args, **kwargs)
-
-
-def modelXbrlLoadComplete(*args: Any, **kwargs: Any) -> None:
-    return validationPlugin.modelXbrlLoadComplete(*args, **kwargs)
-
-
-def validateXbrlStart(*args: Any, **kwargs: Any) -> None:
-    return validationPlugin.validateXbrlStart(*args, **kwargs)
-
-
-def validateXbrlFinally(*args: Any, **kwargs: Any) -> None:
-    return validationPlugin.validateXbrlFinally(*args, **kwargs)
-
-
-def validateXbrlDtsDocument(*args: Any, **kwargs: Any) -> None:
-    return validationPlugin.validateXbrlDtsDocument(*args, **kwargs)
-
-
-def validateFinally(*args: Any, **kwargs: Any) -> None:
-    return validationPlugin.validateFinally(*args, **kwargs)
-
-
-__pluginInfo__ = {
-    "name": PLUGIN_NAME,
-    "version": "0.0.1",
-    "description": "Example validation plugin for the fictitious XYZ taxonomy.",
-    "license": "Apache-2",
-    "author": authorLabel,
-    "copyright": copyrightLabel,
-    "DisclosureSystem.Types": disclosureSystemTypes,
-    "DisclosureSystem.ConfigURL": disclosureSystemConfigURL,
-    "ModelDocument.PullLoader": modelDocumentPullLoader,
-    "ModelXbrl.LoadComplete": modelXbrlLoadComplete,
-    "Validate.XBRL.Start": validateXbrlStart,
-    "Validate.XBRL.Finally": validateXbrlFinally,
-    "Validate.XBRL.DTS.document": validateXbrlDtsDocument,
-    "Validate.Finally": validateFinally,
-}

arelle/examples/plugin/validate/XYZ/resources/config.xml

@@ -1,16 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<DisclosureSystems
-        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-        xsi:noNamespaceSchemaLocation="../../../../config/disclosuresystems.xsd">
-    <!-- see arelle/config/disclosuresystems.xml for full comments -->
-    <DisclosureSystem
-            names="XYZ 2023|XYZ-2023|xyz-2023|XYZ|xyz"
-            description="Checks for example XYZ validation plugin for year 2023"
-            validationType="XYZ"
-    />
-    <DisclosureSystem
-            names="XYZ 2022|XYZ-2022|xyz-2022"
-            description="Checks for example XYZ validation plugin for year 2022"
-            validationType="XYZ"
-    />
-</DisclosureSystems>

arelle/examples/plugin/validate/XYZ/rules/rules01.py

@@ -1,109 +0,0 @@
-"""
-See COPYRIGHT.md for copyright information.
-"""
-from __future__ import annotations
-
-from typing import Any, Iterable, cast
-
-from arelle.ValidateXbrl import ValidateXbrl
-from arelle.XmlValidate import VALID
-from arelle.typing import TypeGetText
-from arelle.utils.PluginHooks import ValidationHook
-from arelle.utils.validate.Decorator import validation
-from arelle.utils.validate.Validation import Validation
-from ..DisclosureSystems import DISCLOSURE_SYSTEM_2022, DISCLOSURE_SYSTEM_2023
-from ..PluginValidationDataExtension import PluginValidationDataExtension
-
-_: TypeGetText
-
-
-# rule 01.01 (2022)
-@validation(
-    hook=ValidationHook.XBRL_FINALLY,
-    disclosureSystems=DISCLOSURE_SYSTEM_2022,
-)
-def rule01_01_2022(
-    pluginData: PluginValidationDataExtension,
-    val: ValidateXbrl,
-    *args: Any,
-    **kwargs: Any,
-) -> Iterable[Validation] | None:
-    if "Cash" not in val.modelXbrl.factsByLocalName:
-        yield Validation.error(
-            codes="XYZ.01.01",
-            msg=_("Cash must be reported."),
-            modelObject=val.modelXbrl,
-        )
-
-
-# rule 01.01 (2023)
-@validation(
-    hook=ValidationHook.XBRL_FINALLY,
-    disclosureSystems=DISCLOSURE_SYSTEM_2023,
-)
-def rule01_01_2023(
-    pluginData: PluginValidationDataExtension,
-    val: ValidateXbrl,
-    *args: Any,
-    **kwargs: Any,
-) -> Iterable[Validation] | None:
-    conceptLocalNamesWithPositiveFactValues = pretendExpensiveOperation(pluginData, val)
-    if "Cash" not in conceptLocalNamesWithPositiveFactValues:
-        yield Validation.warning(
-            codes="XYZ.01.01",
-            msg=_("Cash should be reported."),
-            modelObject=val.modelXbrl,
-        )
-
-
-@validation(hook=ValidationHook.FINALLY)
-def rule01_02(
-    pluginData: PluginValidationDataExtension,
-    val: ValidateXbrl,
-    *args: Any,
-    **kwargs: Any,
-) -> Iterable[Validation] | None:
-    numXbrlErrors = len(val.modelXbrl.errors)
-    if numXbrlErrors > 0:
-        yield Validation.error(
-            codes="XYZ.01.02",
-            msg=_("Invalid report %(numXbrlErrors)s errors detected."),
-            modelObject=val.modelXbrl,
-            numXbrlErrors=numXbrlErrors,
-        )
-
-
-@validation(
-    hook=ValidationHook.XBRL_FINALLY,
-    disclosureSystems=DISCLOSURE_SYSTEM_2023,
-)
-def rule01_03(
-    pluginData: PluginValidationDataExtension,
-    val: ValidateXbrl,
-    *args: Any,
-    **kwargs: Any,
-) -> Iterable[Validation] | None:
-    conceptLocalNamesWithPositiveFactValues = pretendExpensiveOperation(pluginData, val)
-    if "UnitsSold" not in conceptLocalNamesWithPositiveFactValues:
-        yield Validation.error(
-            codes="XYZ.01.03",
-            msg=_("UnitsSold must be reported."),
-            modelObject=val.modelXbrl,
-        )
-
-
-def pretendExpensiveOperation(
-    pluginData: PluginValidationDataExtension,
-    val: ValidateXbrl,
-) -> set[str]:
-    positiveFactConcepts = pluginData.positiveFactConcepts
-    if positiveFactConcepts is None:
-        positiveFactConcepts = {
-            fact.concept.name
-            for fact in val.modelXbrl.facts
-            if fact.isNumeric
-            and getattr(fact, "xValid", 0) >= VALID
-            and cast(int, fact.xValue) > 0
-        }
-        pluginData.positiveFactConcepts = positiveFactConcepts
-    return positiveFactConcepts

arelle/examples/plugin/validate/XYZ/rules/rules02.py

@@ -1,58 +0,0 @@
-"""
-See COPYRIGHT.md for copyright information.
-"""
-from __future__ import annotations
-
-from typing import Any, Iterable
-
-from arelle import XbrlConst
-from arelle.ModelDocument import ModelDocument, Type as ModelDocumentType
-from arelle.ValidateXbrl import ValidateXbrl
-from arelle.typing import TypeGetText
-from arelle.utils.PluginHooks import ValidationHook
-from arelle.utils.validate.Decorator import validation
-from arelle.utils.validate.Validation import Validation
-from ..DisclosureSystems import DISCLOSURE_SYSTEM_2022
-from ..PluginValidationDataExtension import PluginValidationDataExtension
-
-_: TypeGetText
-
-
-@validation(hook=ValidationHook.XBRL_DTS_DOCUMENT)
-def rule02_01(
-    pluginData: PluginValidationDataExtension,
-    val: ValidateXbrl,
-    modelDocument: ModelDocument,
-    isFilingDocument: bool,
-    *args: Any,
-    **kwargs: Any,
-) -> Iterable[Validation] | None:
-    if (
-        modelDocument.type == ModelDocumentType.SCHEMA
-        and modelDocument.targetNamespace is not None
-        and len(modelDocument.targetNamespace) > 100
-    ):
-        yield Validation.error(
-            codes="XYZ.02.01",
-            msg=_("TargetNamespace is too long %(namespace)s."),
-            modelObject=val.modelXbrl,
-            namespace=modelDocument.targetNamespace,
-        )
-
-
-@validation(
-    hook=ValidationHook.XBRL_FINALLY,
-    excludeDisclosureSystems=DISCLOSURE_SYSTEM_2022,
-)
-def rule02_02(
-    pluginData: PluginValidationDataExtension,
-    val: ValidateXbrl,
-    *args: Any,
-    **kwargs: Any,
-) -> Iterable[Validation] | None:
-    if val.modelXbrl.relationshipSet(XbrlConst.summationItem):
-        yield Validation.error(
-            codes="XYZ.02.02",
-            msg=_("XBRL 2.1 calculations detected. XYZ 2023 taxonomy requires calc 1.1."),
-            modelObject=val.modelXbrl,
-        )