# {py:mod}`arelle.formula.ValidateFormula`

```{py:module} arelle.formula.ValidateFormula
```

```{autodoc2-docstring} arelle.formula.ValidateFormula
:allowtitles:
```

## Module Contents

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`checkBaseSet <arelle.formula.ValidateFormula.checkBaseSet>`
  - ```{autodoc2-docstring} arelle.formula.ValidateFormula.checkBaseSet
    :summary:
    ```
* - {py:obj}`executeCallTest <arelle.formula.ValidateFormula.executeCallTest>`
  - ```{autodoc2-docstring} arelle.formula.ValidateFormula.executeCallTest
    :summary:
    ```
* - {py:obj}`validate <arelle.formula.ValidateFormula.validate>`
  - ```{autodoc2-docstring} arelle.formula.ValidateFormula.validate
    :summary:
    ```
* - {py:obj}`customFunctionSignatures <arelle.formula.ValidateFormula.customFunctionSignatures>`
  - ```{autodoc2-docstring} arelle.formula.ValidateFormula.customFunctionSignatures
    :summary:
    ```
* - {py:obj}`evaluateModelVariableSet <arelle.formula.ValidateFormula.evaluateModelVariableSet>`
  - ```{autodoc2-docstring} arelle.formula.ValidateFormula.evaluateModelVariableSet
    :summary:
    ```
* - {py:obj}`logAssertionResultCounts <arelle.formula.ValidateFormula.logAssertionResultCounts>`
  - ```{autodoc2-docstring} arelle.formula.ValidateFormula.logAssertionResultCounts
    :summary:
    ```
* - {py:obj}`checkVariablesScopeVisibleQnames <arelle.formula.ValidateFormula.checkVariablesScopeVisibleQnames>`
  - ```{autodoc2-docstring} arelle.formula.ValidateFormula.checkVariablesScopeVisibleQnames
    :summary:
    ```
* - {py:obj}`checkFilterAspectModel <arelle.formula.ValidateFormula.checkFilterAspectModel>`
  - ```{autodoc2-docstring} arelle.formula.ValidateFormula.checkFilterAspectModel
    :summary:
    ```
* - {py:obj}`checkFormulaRules <arelle.formula.ValidateFormula.checkFormulaRules>`
  - ```{autodoc2-docstring} arelle.formula.ValidateFormula.checkFormulaRules
    :summary:
    ```
* - {py:obj}`checkTableRules <arelle.formula.ValidateFormula.checkTableRules>`
  - ```{autodoc2-docstring} arelle.formula.ValidateFormula.checkTableRules
    :summary:
    ```
* - {py:obj}`checkDefinitionNodeRules <arelle.formula.ValidateFormula.checkDefinitionNodeRules>`
  - ```{autodoc2-docstring} arelle.formula.ValidateFormula.checkDefinitionNodeRules
    :summary:
    ```
* - {py:obj}`checkValidationMessages <arelle.formula.ValidateFormula.checkValidationMessages>`
  - ```{autodoc2-docstring} arelle.formula.ValidateFormula.checkValidationMessages
    :summary:
    ```
* - {py:obj}`checkMessageExpressions <arelle.formula.ValidateFormula.checkMessageExpressions>`
  - ```{autodoc2-docstring} arelle.formula.ValidateFormula.checkMessageExpressions
    :summary:
    ```
* - {py:obj}`checkValidationMessageVariables <arelle.formula.ValidateFormula.checkValidationMessageVariables>`
  - ```{autodoc2-docstring} arelle.formula.ValidateFormula.checkValidationMessageVariables
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`formulaIdWhitespacesSeparatedPattern <arelle.formula.ValidateFormula.formulaIdWhitespacesSeparatedPattern>`
  - ```{autodoc2-docstring} arelle.formula.ValidateFormula.formulaIdWhitespacesSeparatedPattern
    :summary:
    ```
* - {py:obj}`arcroleChecks <arelle.formula.ValidateFormula.arcroleChecks>`
  - ```{autodoc2-docstring} arelle.formula.ValidateFormula.arcroleChecks
    :summary:
    ```
````

### API

````{py:data} formulaIdWhitespacesSeparatedPattern
:canonical: arelle.formula.ValidateFormula.formulaIdWhitespacesSeparatedPattern
:value: >
   'compile(...)'

```{autodoc2-docstring} arelle.formula.ValidateFormula.formulaIdWhitespacesSeparatedPattern
```

````

`````{py:exception} FormulaValidationException()
:canonical: arelle.formula.ValidateFormula.FormulaValidationException

Bases: {py:obj}`Exception`

````{py:method} __repr__()
:canonical: arelle.formula.ValidateFormula.FormulaValidationException.__repr__

````

`````

````{py:data} arcroleChecks
:canonical: arelle.formula.ValidateFormula.arcroleChecks
:value: >
   None

```{autodoc2-docstring} arelle.formula.ValidateFormula.arcroleChecks
```

````

````{py:function} checkBaseSet(val, arcrole, ELR, relsSet) -> None
:canonical: arelle.formula.ValidateFormula.checkBaseSet

```{autodoc2-docstring} arelle.formula.ValidateFormula.checkBaseSet
```
````

````{py:function} executeCallTest(val, name, callTuple, testTuple) -> None
:canonical: arelle.formula.ValidateFormula.executeCallTest

```{autodoc2-docstring} arelle.formula.ValidateFormula.executeCallTest
```
````

````{py:function} validate(val, xpathContext=None, parametersOnly=False, statusMsg='', compileOnly=False) -> None
:canonical: arelle.formula.ValidateFormula.validate

```{autodoc2-docstring} arelle.formula.ValidateFormula.validate
```
````

````{py:function} customFunctionSignatures(val)
:canonical: arelle.formula.ValidateFormula.customFunctionSignatures

```{autodoc2-docstring} arelle.formula.ValidateFormula.customFunctionSignatures
```
````

````{py:function} evaluateModelVariableSet(xpathContext, formulaOptions, parameterQnames, instanceQnames, instanceDependencies, instanceProducingVariableSets, val)
:canonical: arelle.formula.ValidateFormula.evaluateModelVariableSet

```{autodoc2-docstring} arelle.formula.ValidateFormula.evaluateModelVariableSet
```
````

````{py:function} logAssertionResultCounts(val, formulaOptions, runIDs)
:canonical: arelle.formula.ValidateFormula.logAssertionResultCounts

```{autodoc2-docstring} arelle.formula.ValidateFormula.logAssertionResultCounts
```
````

````{py:function} checkVariablesScopeVisibleQnames(val, nameVariables, definedNamesSet, modelVariableSet)
:canonical: arelle.formula.ValidateFormula.checkVariablesScopeVisibleQnames

```{autodoc2-docstring} arelle.formula.ValidateFormula.checkVariablesScopeVisibleQnames
```
````

````{py:function} checkFilterAspectModel(val, variableSet, filterRelationships, xpathContext, uncoverableAspects=None)
:canonical: arelle.formula.ValidateFormula.checkFilterAspectModel

```{autodoc2-docstring} arelle.formula.ValidateFormula.checkFilterAspectModel
```
````

````{py:function} checkFormulaRules(val, formula, nameVariables)
:canonical: arelle.formula.ValidateFormula.checkFormulaRules

```{autodoc2-docstring} arelle.formula.ValidateFormula.checkFormulaRules
```
````

````{py:function} checkTableRules(val, xpathContext, table)
:canonical: arelle.formula.ValidateFormula.checkTableRules

```{autodoc2-docstring} arelle.formula.ValidateFormula.checkTableRules
```
````

````{py:function} checkDefinitionNodeRules(val, table, parent, arcrole, xpathContext)
:canonical: arelle.formula.ValidateFormula.checkDefinitionNodeRules

```{autodoc2-docstring} arelle.formula.ValidateFormula.checkDefinitionNodeRules
```
````

````{py:function} checkValidationMessages(val, modelVariableSet)
:canonical: arelle.formula.ValidateFormula.checkValidationMessages

```{autodoc2-docstring} arelle.formula.ValidateFormula.checkValidationMessages
```
````

````{py:function} checkMessageExpressions(val, message)
:canonical: arelle.formula.ValidateFormula.checkMessageExpressions

```{autodoc2-docstring} arelle.formula.ValidateFormula.checkMessageExpressions
```
````

````{py:function} checkValidationMessageVariables(val, modelVariableSet, varNames, paramNames)
:canonical: arelle.formula.ValidateFormula.checkValidationMessageVariables

```{autodoc2-docstring} arelle.formula.ValidateFormula.checkValidationMessageVariables
```
````