arelle-release 2.37.46__py3-none-any.whl → 2.38.0__py3-none-any.whl

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

@@ -1,110 +0,0 @@
-"""
-See COPYRIGHT.md for copyright information.
-"""
-from __future__ import annotations
-
-from collections.abc import Iterable
-from typing import Any, 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]:
-    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]:
-    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]:
-    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]:
-    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,59 +0,0 @@
-"""
-See COPYRIGHT.md for copyright information.
-"""
-from __future__ import annotations
-
-from collections.abc import Iterable
-from typing import Any
-
-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]:
-    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]:
-    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,
-        )

arelle/model/CommentBase.py

@@ -1,9 +0,0 @@
-"""
-See COPYRIGHT.md for copyright information.
-"""
-from __future__ import annotations
-
-
-class CommentBase:
-    def __init__(self, text: str) -> None:
-        self._text = text

arelle/model/ElementBase.py

@@ -1,11 +0,0 @@
-"""
-See COPYRIGHT.md for copyright information.
-"""
-from __future__ import annotations
-
-
-class ElementBase:
-    def __init__(self, *children: ElementBase, attrib: dict[str, str] | None = None, nsmap: dict[str, str] | None = None, **extra: str) -> None:
-        self._children = children
-        self._attrib = attrib if attrib is not None else {}
-        self._nsmap = nsmap if nsmap is not None else {}

arelle/model/PIBase.py

@@ -1,10 +0,0 @@
-"""
-See COPYRIGHT.md for copyright information.
-"""
-from __future__ import annotations
-
-
-class PIBase:
-    def __init__(self, target: str, text: str | None = None) -> None:
-        self._target = target
-        self._text = text if text is not None else ""

arelle/model/__init__.py

@@ -1,15 +0,0 @@
-"""
-See COPYRIGHT.md for copyright information.
-"""
-from arelle.BetaFeatures import newObjectModelEnabled
-
-# The if statement is negated here so that from mypy's perspective the types
-# inherit from the lxml object model until the new models are ready to be used.
-if not newObjectModelEnabled():
-    from lxml.etree import CommentBase as CommentBase
-    from lxml.etree import ElementBase as ElementBase
-    from lxml.etree import PIBase as PIBase
-else:
-    from .CommentBase import CommentBase
-    from .ElementBase import ElementBase  # type: ignore[assignment]
-    from .PIBase import PIBase

arelle/scripts-macOS/startWebServer.command

@@ -1,3 +0,0 @@
-cd `dirname $0`
-./Arelle.App/contents/MacOS/arelleCmdLine --webserver localhost:8080
-exit 

arelle/scripts-unix/startWebServer.sh

@@ -1 +0,0 @@
-./arelleCmdLine --webserver localhost:8080

arelle/scripts-windows/startWebServer.bat

@@ -1,5 +0,0 @@
-rem Start Arelle Web Server
-
-@set ARELLE=c:\Program Files\Arelle\arelleCmdLine.exe
-
-"%ARELLE%" --webserver localhost:8080