# {py:mod}`arelle.ModelTestcaseObject`

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

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

## Module Contents

### Classes

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

* - {py:obj}`ModelTestcaseVariation <arelle.ModelTestcaseObject.ModelTestcaseVariation>`
  - ```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation
    :summary:
    ```
````

### Functions

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

* - {py:obj}`testcaseVariationsByTarget <arelle.ModelTestcaseObject.testcaseVariationsByTarget>`
  - ```{autodoc2-docstring} arelle.ModelTestcaseObject.testcaseVariationsByTarget
    :summary:
    ```
````

### Data

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

* - {py:obj}`TXMY_PKG_SRC_ELTS <arelle.ModelTestcaseObject.TXMY_PKG_SRC_ELTS>`
  - ```{autodoc2-docstring} arelle.ModelTestcaseObject.TXMY_PKG_SRC_ELTS
    :summary:
    ```
````

### API

````{py:data} TXMY_PKG_SRC_ELTS
:canonical: arelle.ModelTestcaseObject.TXMY_PKG_SRC_ELTS
:value: >
   ('metadata', 'catalog', 'taxonomy')

```{autodoc2-docstring} arelle.ModelTestcaseObject.TXMY_PKG_SRC_ELTS
```

````

````{py:function} testcaseVariationsByTarget(testcaseVariations: list[ModelTestcaseVariation]) -> collections.abc.Generator[ModelTestcaseVariation, None, None]
:canonical: arelle.ModelTestcaseObject.testcaseVariationsByTarget

```{autodoc2-docstring} arelle.ModelTestcaseObject.testcaseVariationsByTarget
```
````

`````{py:class} ModelTestcaseVariation
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation

Bases: {py:obj}`arelle.ModelObject.ModelObject`

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation
```

````{py:attribute} errors
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.errors
:type: list[str] | None
:value: >
   None

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.errors
```

````

````{py:attribute} userExpectedErrors
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.userExpectedErrors
:type: list[dict[str, int]]
:value: >
   None

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.userExpectedErrors
```

````

````{py:attribute} readMeFirstElements
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.readMeFirstElements
:type: list[arelle.ModelObject.ModelObject | None]
:value: >
   None

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.readMeFirstElements
```

````

````{py:method} init(modelDocument: arelle.ModelDocument.ModelDocument) -> None
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.init

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.init
```

````

````{py:property} id
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.id
:type: str

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.id
```

````

````{py:property} name
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.name
:type: str | None

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.name
```

````

````{py:property} description
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.description
:type: str | None

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.description
```

````

````{py:property} reference
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.reference
:type: str | None

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.reference
```

````

````{py:property} readMeFirstUris
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.readMeFirstUris
:type: list[str | tuple[arelle.ModelValue.QName | str, str]]

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.readMeFirstUris
```

````

````{py:property} dataUris
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.dataUris
:type: collections.defaultdict[str, list[str]]

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.dataUris
```

````

````{py:property} parameters
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.parameters
:type: dict[arelle.ModelValue.QName | None, tuple[arelle.ModelValue.QName | None, str | None]]

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.parameters
```

````

````{py:property} resultIsVersioningReport
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.resultIsVersioningReport
:type: bool

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.resultIsVersioningReport
```

````

````{py:property} versioningReportUri
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.versioningReportUri
:type: str | None

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.versioningReportUri
```

````

````{py:property} resultIsXbrlInstance
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.resultIsXbrlInstance
:type: bool

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.resultIsXbrlInstance
```

````

````{py:property} resultXbrlInstanceUri
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.resultXbrlInstanceUri
:type: str | None

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.resultXbrlInstanceUri
```

````

````{py:property} resultIsInfoset
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.resultIsInfoset
:type: bool

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.resultIsInfoset
```

````

````{py:property} resultInfosetUri
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.resultInfosetUri
:type: str | None

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.resultInfosetUri
```

````

````{py:property} resultIsTable
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.resultIsTable
:type: bool

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.resultIsTable
```

````

````{py:property} resultTableUri
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.resultTableUri
:type: str | None

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.resultTableUri
```

````

````{py:property} resultIsTaxonomyPackage
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.resultIsTaxonomyPackage
:type: bool

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.resultIsTaxonomyPackage
```

````

````{py:property} variationDiscoversDTS
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.variationDiscoversDTS
:type: bool

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.variationDiscoversDTS
```

````

````{py:property} cfcnCall
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.cfcnCall
:type: tuple[str, arelle.ModelObject.ModelObject] | None

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.cfcnCall
```

````

````{py:property} cfcnTest
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.cfcnTest
:type: tuple[str, arelle.ModelObject.ModelObject] | None

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.cfcnTest
```

````

````{py:property} expected
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.expected
:type: str | list[arelle.ModelValue.QName | str] | dict[str, tuple[int, int]] | None

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.expected
```

````

````{py:property} expectedWarnings
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.expectedWarnings
:type: list[str] | None

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.expectedWarnings
```

````

````{py:property} match
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.match
:type: str | None

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.match
```

````

````{py:property} expectedCount
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.expectedCount
:type: typing.Any

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.expectedCount
```

````

````{py:property} expectedReportCount
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.expectedReportCount
:type: int | None

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.expectedReportCount
```

````

````{py:property} severityLevel
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.severityLevel
:type: int

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.severityLevel
```

````

````{py:property} blockedMessageCodes
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.blockedMessageCodes
:type: str | None

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.blockedMessageCodes
```

````

````{py:property} expectedVersioningReport
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.expectedVersioningReport
:type: None

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.expectedVersioningReport
```

````

````{py:property} propertyView
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.propertyView
:type: list[tuple[str, str | None]]

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.propertyView
```

````

````{py:method} setUserExpectedErrors(testcaseExpectedErrors: dict[str, dict[str, int]], useFileSource: arelle.FileSource.FileSource | None) -> list[dict[str, int]]
:canonical: arelle.ModelTestcaseObject.ModelTestcaseVariation.setUserExpectedErrors

```{autodoc2-docstring} arelle.ModelTestcaseObject.ModelTestcaseVariation.setUserExpectedErrors
```

````

`````