# {py:mod}`arelle.Updater`

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

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

## Module Contents

### Classes

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

* - {py:obj}`ArelleVersion <arelle.Updater.ArelleVersion>`
  - ```{autodoc2-docstring} arelle.Updater.ArelleVersion
    :summary:
    ```
* - {py:obj}`ArelleRelease <arelle.Updater.ArelleRelease>`
  - ```{autodoc2-docstring} arelle.Updater.ArelleRelease
    :summary:
    ```
````

### Functions

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

* - {py:obj}`checkForUpdates <arelle.Updater.checkForUpdates>`
  - ```{autodoc2-docstring} arelle.Updater.checkForUpdates
    :summary:
    ```
* - {py:obj}`_checkForUpdates <arelle.Updater._checkForUpdates>`
  - ```{autodoc2-docstring} arelle.Updater._checkForUpdates
    :summary:
    ```
* - {py:obj}`_getLatestArelleRelease <arelle.Updater._getLatestArelleRelease>`
  - ```{autodoc2-docstring} arelle.Updater._getLatestArelleRelease
    :summary:
    ```
* - {py:obj}`_getArelleReleaseDownloadUrl <arelle.Updater._getArelleReleaseDownloadUrl>`
  - ```{autodoc2-docstring} arelle.Updater._getArelleReleaseDownloadUrl
    :summary:
    ```
* - {py:obj}`_getArelleReleaseDownloadUrlByFileExtension <arelle.Updater._getArelleReleaseDownloadUrlByFileExtension>`
  - ```{autodoc2-docstring} arelle.Updater._getArelleReleaseDownloadUrlByFileExtension
    :summary:
    ```
* - {py:obj}`_checkUpdateUrl <arelle.Updater._checkUpdateUrl>`
  - ```{autodoc2-docstring} arelle.Updater._checkUpdateUrl
    :summary:
    ```
* - {py:obj}`_parseVersion <arelle.Updater._parseVersion>`
  - ```{autodoc2-docstring} arelle.Updater._parseVersion
    :summary:
    ```
* - {py:obj}`_backgroundDownload <arelle.Updater._backgroundDownload>`
  - ```{autodoc2-docstring} arelle.Updater._backgroundDownload
    :summary:
    ```
* - {py:obj}`_download <arelle.Updater._download>`
  - ```{autodoc2-docstring} arelle.Updater._download
    :summary:
    ```
* - {py:obj}`_install <arelle.Updater._install>`
  - ```{autodoc2-docstring} arelle.Updater._install
    :summary:
    ```
* - {py:obj}`_showInfo <arelle.Updater._showInfo>`
  - ```{autodoc2-docstring} arelle.Updater._showInfo
    :summary:
    ```
* - {py:obj}`_showWarning <arelle.Updater._showWarning>`
  - ```{autodoc2-docstring} arelle.Updater._showWarning
    :summary:
    ```
````

### Data

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

* - {py:obj}`_ <arelle.Updater._>`
  - ```{autodoc2-docstring} arelle.Updater._
    :summary:
    ```
* - {py:obj}`_MESSAGE_HEADER <arelle.Updater._MESSAGE_HEADER>`
  - ```{autodoc2-docstring} arelle.Updater._MESSAGE_HEADER
    :summary:
    ```
* - {py:obj}`_SEMVER_PATTERN <arelle.Updater._SEMVER_PATTERN>`
  - ```{autodoc2-docstring} arelle.Updater._SEMVER_PATTERN
    :summary:
    ```
* - {py:obj}`_UPDATE_URL <arelle.Updater._UPDATE_URL>`
  - ```{autodoc2-docstring} arelle.Updater._UPDATE_URL
    :summary:
    ```
````

### API

````{py:data} _
:canonical: arelle.Updater._
:type: arelle.typing.TypeGetText
:value: >
   None

```{autodoc2-docstring} arelle.Updater._
```

````

````{py:data} _MESSAGE_HEADER
:canonical: arelle.Updater._MESSAGE_HEADER
:value: >
   'arelle™ - Updater'

```{autodoc2-docstring} arelle.Updater._MESSAGE_HEADER
```

````

````{py:data} _SEMVER_PATTERN
:canonical: arelle.Updater._SEMVER_PATTERN
:value: >
   'compile(...)'

```{autodoc2-docstring} arelle.Updater._SEMVER_PATTERN
```

````

````{py:data} _UPDATE_URL
:canonical: arelle.Updater._UPDATE_URL
:value: >
   'https://api.github.com/repos/Arelle/Arelle/releases/latest'

```{autodoc2-docstring} arelle.Updater._UPDATE_URL
```

````

`````{py:class} ArelleVersion
:canonical: arelle.Updater.ArelleVersion

```{autodoc2-docstring} arelle.Updater.ArelleVersion
```

````{py:attribute} major
:canonical: arelle.Updater.ArelleVersion.major
:type: int
:value: >
   None

```{autodoc2-docstring} arelle.Updater.ArelleVersion.major
```

````

````{py:attribute} minor
:canonical: arelle.Updater.ArelleVersion.minor
:type: int
:value: >
   None

```{autodoc2-docstring} arelle.Updater.ArelleVersion.minor
```

````

````{py:attribute} patch
:canonical: arelle.Updater.ArelleVersion.patch
:type: int
:value: >
   None

```{autodoc2-docstring} arelle.Updater.ArelleVersion.patch
```

````

````{py:method} __str__() -> str
:canonical: arelle.Updater.ArelleVersion.__str__

````

`````

`````{py:class} ArelleRelease
:canonical: arelle.Updater.ArelleRelease

```{autodoc2-docstring} arelle.Updater.ArelleRelease
```

````{py:attribute} version
:canonical: arelle.Updater.ArelleRelease.version
:type: arelle.Updater.ArelleVersion
:value: >
   None

```{autodoc2-docstring} arelle.Updater.ArelleRelease.version
```

````

````{py:attribute} downloadUrl
:canonical: arelle.Updater.ArelleRelease.downloadUrl
:type: str | None
:value: >
   None

```{autodoc2-docstring} arelle.Updater.ArelleRelease.downloadUrl
```

````

`````

````{py:function} checkForUpdates(cntlr: arelle.CntlrWinMain.CntlrWinMain) -> None
:canonical: arelle.Updater.checkForUpdates

```{autodoc2-docstring} arelle.Updater.checkForUpdates
```
````

````{py:function} _checkForUpdates(cntlr: arelle.CntlrWinMain.CntlrWinMain) -> None
:canonical: arelle.Updater._checkForUpdates

```{autodoc2-docstring} arelle.Updater._checkForUpdates
```
````

````{py:function} _getLatestArelleRelease(cntlr: arelle.CntlrWinMain.CntlrWinMain) -> arelle.Updater.ArelleRelease
:canonical: arelle.Updater._getLatestArelleRelease

```{autodoc2-docstring} arelle.Updater._getLatestArelleRelease
```
````

````{py:function} _getArelleReleaseDownloadUrl(assets: list[dict[str, typing.Any]]) -> str | None
:canonical: arelle.Updater._getArelleReleaseDownloadUrl

```{autodoc2-docstring} arelle.Updater._getArelleReleaseDownloadUrl
```
````

````{py:function} _getArelleReleaseDownloadUrlByFileExtension(assets: list[dict[str, typing.Any]], fileExtension: str) -> str | None
:canonical: arelle.Updater._getArelleReleaseDownloadUrlByFileExtension

```{autodoc2-docstring} arelle.Updater._getArelleReleaseDownloadUrlByFileExtension
```
````

````{py:function} _checkUpdateUrl(cntlr: arelle.CntlrWinMain.CntlrWinMain, arelleRelease: arelle.Updater.ArelleRelease) -> None
:canonical: arelle.Updater._checkUpdateUrl

```{autodoc2-docstring} arelle.Updater._checkUpdateUrl
```
````

````{py:function} _parseVersion(versionStr: str) -> arelle.Updater.ArelleVersion
:canonical: arelle.Updater._parseVersion

```{autodoc2-docstring} arelle.Updater._parseVersion
```
````

````{py:function} _backgroundDownload(cntlr: arelle.CntlrWinMain.CntlrWinMain, arelleRelease: arelle.Updater.ArelleRelease) -> None
:canonical: arelle.Updater._backgroundDownload

```{autodoc2-docstring} arelle.Updater._backgroundDownload
```
````

````{py:function} _download(cntlr: arelle.CntlrWinMain.CntlrWinMain, arelleRelease: arelle.Updater.ArelleRelease) -> None
:canonical: arelle.Updater._download

```{autodoc2-docstring} arelle.Updater._download
```
````

````{py:function} _install(cntlr: arelle.CntlrWinMain.CntlrWinMain, filepath: str) -> None
:canonical: arelle.Updater._install

```{autodoc2-docstring} arelle.Updater._install
```
````

````{py:function} _showInfo(cntlr: arelle.CntlrWinMain.CntlrWinMain, msg: str) -> None
:canonical: arelle.Updater._showInfo

```{autodoc2-docstring} arelle.Updater._showInfo
```
````

````{py:function} _showWarning(cntlr: arelle.CntlrWinMain.CntlrWinMain, msg: str) -> None
:canonical: arelle.Updater._showWarning

```{autodoc2-docstring} arelle.Updater._showWarning
```
````