# {py:mod}`arelle.ModelManager`

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

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

## Module Contents

### Classes

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

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

### Functions

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

* - {py:obj}`initialize <arelle.ModelManager.initialize>`
  - ```{autodoc2-docstring} arelle.ModelManager.initialize
    :summary:
    ```
````

### API

````{py:function} initialize(cntlr: arelle.Cntlr.Cntlr) -> ModelManager
:canonical: arelle.ModelManager.initialize

```{autodoc2-docstring} arelle.ModelManager.initialize
```
````

`````{py:class} ModelManager(cntlr: arelle.Cntlr.Cntlr)
:canonical: arelle.ModelManager.ModelManager

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

```{rubric} Initialization
```

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

````{py:attribute} defaultLang
:canonical: arelle.ModelManager.ModelManager.defaultLang
:type: str
:value: >
   None

```{autodoc2-docstring} arelle.ModelManager.ModelManager.defaultLang
```

````

````{py:attribute} formulaOptions
:canonical: arelle.ModelManager.ModelManager.formulaOptions
:type: arelle.ModelFormulaObject.FormulaOptions
:value: >
   None

```{autodoc2-docstring} arelle.ModelManager.ModelManager.formulaOptions
```

````

````{py:attribute} locale
:canonical: arelle.ModelManager.ModelManager.locale
:type: arelle.typing.LocaleDict
:value: >
   None

```{autodoc2-docstring} arelle.ModelManager.ModelManager.locale
```

````

````{py:attribute} modelXbrl
:canonical: arelle.ModelManager.ModelManager.modelXbrl
:type: arelle.ModelXbrl.ModelXbrl | None
:value: >
   None

```{autodoc2-docstring} arelle.ModelManager.ModelManager.modelXbrl
```

````

````{py:method} shutdown() -> None
:canonical: arelle.ModelManager.ModelManager.shutdown

```{autodoc2-docstring} arelle.ModelManager.ModelManager.shutdown
```

````

````{py:method} setLocale() -> str | None
:canonical: arelle.ModelManager.ModelManager.setLocale

```{autodoc2-docstring} arelle.ModelManager.ModelManager.setLocale
```

````

````{py:method} addToLog(message: str, messageCode: str = '', file: str = '', refs: list[dict[str, typing.Any]] = [], level: int | str = logging.INFO) -> None
:canonical: arelle.ModelManager.ModelManager.addToLog

```{autodoc2-docstring} arelle.ModelManager.ModelManager.addToLog
```

````

````{py:method} showStatus(message: str | None = None, clearAfter: int | None = None) -> None
:canonical: arelle.ModelManager.ModelManager.showStatus

```{autodoc2-docstring} arelle.ModelManager.ModelManager.showStatus
```

````

````{py:method} viewModelObject(modelXbrl: arelle.ModelXbrl.ModelXbrl, objectId: str) -> None
:canonical: arelle.ModelManager.ModelManager.viewModelObject

```{autodoc2-docstring} arelle.ModelManager.ModelManager.viewModelObject
```

````

````{py:method} reloadViews(modelXbrl: arelle.ModelXbrl.ModelXbrl) -> None
:canonical: arelle.ModelManager.ModelManager.reloadViews

```{autodoc2-docstring} arelle.ModelManager.ModelManager.reloadViews
```

````

````{py:method} load(filesource: str | arelle.FileSource.FileSource, nextaction: str | None = None, taxonomyPackages: list[str] | None = None, **kwargs: typing.Any) -> arelle.ModelXbrl.ModelXbrl
:canonical: arelle.ModelManager.ModelManager.load

```{autodoc2-docstring} arelle.ModelManager.ModelManager.load
```

````

````{py:method} saveDTSpackage(allDTSes: bool = False) -> None
:canonical: arelle.ModelManager.ModelManager.saveDTSpackage

```{autodoc2-docstring} arelle.ModelManager.ModelManager.saveDTSpackage
```

````

````{py:method} create(newDocumentType: int | None = None, url: str | None = None, schemaRefs: list[str] | None = None, createModelDocument: bool = True, isEntry: bool = False, errorCaptureLevel: int | None = None, initialXml: str | None = None, base: str | None = None) -> arelle.ModelXbrl.ModelXbrl
:canonical: arelle.ModelManager.ModelManager.create

```{autodoc2-docstring} arelle.ModelManager.ModelManager.create
```

````

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

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

````

````{py:method} compareDTSes(versReportFile: str, writeReportFile: bool = True) -> arelle.ModelXbrl.ModelXbrl | None
:canonical: arelle.ModelManager.ModelManager.compareDTSes

```{autodoc2-docstring} arelle.ModelManager.ModelManager.compareDTSes
```

````

````{py:method} close(modelXbrl: arelle.ModelXbrl.ModelXbrl | None = None) -> None
:canonical: arelle.ModelManager.ModelManager.close

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

````

````{py:method} loadCustomTransforms() -> None
:canonical: arelle.ModelManager.ModelManager.loadCustomTransforms

```{autodoc2-docstring} arelle.ModelManager.ModelManager.loadCustomTransforms
```

````

`````