`arelle.Updater`¶

See COPYRIGHT.md for copyright information.

Module Contents¶

Classes¶

`ArelleVersion`
`ArelleRelease`

Functions¶

`checkForUpdates`
`_checkForUpdates`
`_getLatestArelleRelease`
`_getArelleReleaseDownloadUrl`
`_getArelleReleaseDownloadUrlByFileExtension`
`_checkUpdateUrl`
`_parseVersion`
`_backgroundDownload`
`_download`
`_install`
`_showInfo`
`_showWarning`

Data¶

`_`
`_MESSAGE_HEADER`
`_SEMVER_PATTERN`
`_UPDATE_URL`

API¶

arelle.Updater._: arelle.typing.TypeGetText¶: None

arelle.Updater._MESSAGE_HEADER¶: ‘arelle™ - Updater’

arelle.Updater._SEMVER_PATTERN¶: ‘compile(…)’

arelle.Updater._UPDATE_URL¶: ‘https://api.github.com/repos/Arelle/Arelle/releases/latest’

class arelle.Updater.ArelleVersion¶

major: int¶: None

minor: int¶: None

patch: int¶: None

__str__() → str¶

class arelle.Updater.ArelleRelease¶

version: arelle.Updater.ArelleVersion¶: None

downloadUrl: str | None¶: None

arelle.Updater.checkForUpdates(cntlr: arelle.CntlrWinMain.CntlrWinMain) → None¶

arelle.Updater._checkForUpdates(cntlr: arelle.CntlrWinMain.CntlrWinMain) → None¶

arelle.Updater._getLatestArelleRelease(cntlr: arelle.CntlrWinMain.CntlrWinMain) → arelle.Updater.ArelleRelease¶

arelle.Updater._getArelleReleaseDownloadUrl(assets: list[dict[str, Any]]) → str | None¶

arelle.Updater._getArelleReleaseDownloadUrlByFileExtension(assets: list[dict[str, Any]], fileExtension: str) → str | None¶

arelle.Updater._checkUpdateUrl(cntlr: arelle.CntlrWinMain.CntlrWinMain, arelleRelease: arelle.Updater.ArelleRelease) → None¶

arelle.Updater._parseVersion(versionStr: str) → arelle.Updater.ArelleVersion¶

arelle.Updater._backgroundDownload(cntlr: arelle.CntlrWinMain.CntlrWinMain, arelleRelease: arelle.Updater.ArelleRelease) → None¶

arelle.Updater._download(cntlr: arelle.CntlrWinMain.CntlrWinMain, arelleRelease: arelle.Updater.ArelleRelease) → None¶

arelle.Updater._install(cntlr: arelle.CntlrWinMain.CntlrWinMain, filepath: str) → None¶

arelle.Updater._showInfo(cntlr: arelle.CntlrWinMain.CntlrWinMain, msg: str) → None¶

arelle.Updater._showWarning(cntlr: arelle.CntlrWinMain.CntlrWinMain, msg: str) → None¶