# {py:mod}`arelle.Validate`

```{py:module} arelle.Validate
```

```{autodoc2-docstring} arelle.Validate
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`Validate <arelle.Validate.Validate>`
  - ```{autodoc2-docstring} arelle.Validate.Validate
    :summary:
    ```
* - {py:obj}`ValidationLogListener <arelle.Validate.ValidationLogListener>`
  -
````

### Functions

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

* - {py:obj}`validate <arelle.Validate.validate>`
  - ```{autodoc2-docstring} arelle.Validate.validate
    :summary:
    ```
````

### Data

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

* - {py:obj}`commaSpaceSplitPattern <arelle.Validate.commaSpaceSplitPattern>`
  - ```{autodoc2-docstring} arelle.Validate.commaSpaceSplitPattern
    :summary:
    ```
````

### API

````{py:function} validate(modelXbrl: arelle.ModelXbrl.ModelXbrl) -> None
:canonical: arelle.Validate.validate

```{autodoc2-docstring} arelle.Validate.validate
```
````

`````{py:exception} ValidationException(message: str, severity: str, code: str)
:canonical: arelle.Validate.ValidationException

Bases: {py:obj}`Exception`

````{py:method} add_note()
:canonical: arelle.Validate.ValidationException.add_note

````

```{py:class} args
:canonical: arelle.Validate.ValidationException.args

```

````{py:method} with_traceback()
:canonical: arelle.Validate.ValidationException.with_traceback

````

`````

````{py:data} commaSpaceSplitPattern
:canonical: arelle.Validate.commaSpaceSplitPattern
:value: >
   'compile(...)'

```{autodoc2-docstring} arelle.Validate.commaSpaceSplitPattern
```

````

`````{py:class} Validate(modelXbrl: arelle.ModelXbrl.ModelXbrl)
:canonical: arelle.Validate.Validate

```{autodoc2-docstring} arelle.Validate.Validate
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.Validate.Validate.__init__
```

````{py:attribute} useFileSource
:canonical: arelle.Validate.Validate.useFileSource
:type: arelle.FileSource.FileSource | None
:value: >
   None

```{autodoc2-docstring} arelle.Validate.Validate.useFileSource
```

````

````{py:method} filterTestcaseVariation(modelTestcaseVariation: arelle.ModelTestcaseObject.ModelTestcaseVariation) -> bool
:canonical: arelle.Validate.Validate.filterTestcaseVariation

```{autodoc2-docstring} arelle.Validate.Validate.filterTestcaseVariation
```

````

````{py:method} close() -> None
:canonical: arelle.Validate.Validate.close

```{autodoc2-docstring} arelle.Validate.Validate.close
```

````

````{py:method} validate() -> None
:canonical: arelle.Validate.Validate.validate

```{autodoc2-docstring} arelle.Validate.Validate.validate
```

````

````{py:method} validateRssFeed() -> None
:canonical: arelle.Validate.Validate.validateRssFeed

```{autodoc2-docstring} arelle.Validate.Validate.validateRssFeed
```

````

````{py:method} validateTestcase(testcase: arelle.ModelDocument.ModelDocument) -> None
:canonical: arelle.Validate.Validate.validateTestcase

```{autodoc2-docstring} arelle.Validate.Validate.validateTestcase
```

````

````{py:method} noErrorCodes(modelTestcaseVariationActual: typing.Iterable[typing.Any]) -> bool
:canonical: arelle.Validate.Validate.noErrorCodes

```{autodoc2-docstring} arelle.Validate.Validate.noErrorCodes
```

````

````{py:method} determineTestStatus(modelTestcaseVariation: arelle.ModelTestcaseObject.ModelTestcaseVariation, errors: arelle.ErrorManager.ErrorsType, validateModelCount: int | None = None) -> None
:canonical: arelle.Validate.Validate.determineTestStatus

```{autodoc2-docstring} arelle.Validate.Validate.determineTestStatus
```

````

`````

`````{py:class} ValidationLogListener(logView: typing.Any)
:canonical: arelle.Validate.ValidationLogListener

Bases: {py:obj}`logging.Handler`

````{py:method} flush() -> None
:canonical: arelle.Validate.ValidationLogListener.flush

```{autodoc2-docstring} arelle.Validate.ValidationLogListener.flush
```

````

````{py:method} emit(logRecord: logging.LogRecord) -> None
:canonical: arelle.Validate.ValidationLogListener.emit

````

````{py:method} get_name()
:canonical: arelle.Validate.ValidationLogListener.get_name

````

````{py:method} set_name(name)
:canonical: arelle.Validate.ValidationLogListener.set_name

````

````{py:attribute} name
:canonical: arelle.Validate.ValidationLogListener.name
:value: >
   'property(...)'

````

````{py:method} createLock()
:canonical: arelle.Validate.ValidationLogListener.createLock

````

````{py:method} acquire()
:canonical: arelle.Validate.ValidationLogListener.acquire

````

````{py:method} release()
:canonical: arelle.Validate.ValidationLogListener.release

````

````{py:method} setLevel(level)
:canonical: arelle.Validate.ValidationLogListener.setLevel

````

````{py:method} format(record)
:canonical: arelle.Validate.ValidationLogListener.format

````

````{py:method} handle(record)
:canonical: arelle.Validate.ValidationLogListener.handle

````

````{py:method} setFormatter(fmt)
:canonical: arelle.Validate.ValidationLogListener.setFormatter

````

````{py:method} close()
:canonical: arelle.Validate.ValidationLogListener.close

````

````{py:method} handleError(record)
:canonical: arelle.Validate.ValidationLogListener.handleError

````

````{py:method} addFilter(filter)
:canonical: arelle.Validate.ValidationLogListener.addFilter

````

````{py:method} removeFilter(filter)
:canonical: arelle.Validate.ValidationLogListener.removeFilter

````

````{py:method} filter(record)
:canonical: arelle.Validate.ValidationLogListener.filter

````

`````