addonStore package
Subpackages
- addonStore.models package
- Submodules
- addonStore.models.addon module
_AddonGUIModel
_AddonGUIModel.addonId
_AddonGUIModel.displayName
_AddonGUIModel.description
_AddonGUIModel.addonVersionName
_AddonGUIModel.channel
_AddonGUIModel.homepage
_AddonGUIModel.minNVDAVersion
_AddonGUIModel.lastTestedVersion
_AddonGUIModel.legacy
_AddonGUIModel.minimumNVDAVersion
_AddonGUIModel.lastTestedNVDAVersion
_AddonGUIModel._addonHandlerModel
_AddonGUIModel.name
_AddonGUIModel.listItemVMId
_AddonGUIModel.asdict()
_AddonGUIModel._abc_impl
_AddonGUIModel._is_protocol
_AddonStoreModel
_AddonStoreModel.addonId
_AddonStoreModel.displayName
_AddonStoreModel.description
_AddonStoreModel.addonVersionName
_AddonStoreModel.channel
_AddonStoreModel.homepage
_AddonStoreModel.minNVDAVersion
_AddonStoreModel.lastTestedVersion
_AddonStoreModel.legacy
_AddonStoreModel.publisher
_AddonStoreModel.license
_AddonStoreModel.licenseURL
_AddonStoreModel.sourceURL
_AddonStoreModel.URL
_AddonStoreModel.sha256
_AddonStoreModel.addonVersionNumber
_AddonStoreModel.reviewURL
_AddonStoreModel.tempDownloadPath
_AddonStoreModel.cachedDownloadPath
_AddonStoreModel.isPendingInstall
_AddonStoreModel._abc_impl
_AddonStoreModel._is_protocol
_AddonManifestModel
_AddonManifestModel.addonId
_AddonManifestModel.addonVersionName
_AddonManifestModel.channel
_AddonManifestModel.homepage
_AddonManifestModel.minNVDAVersion
_AddonManifestModel.lastTestedVersion
_AddonManifestModel.manifest
_AddonManifestModel.legacy
_AddonManifestModel.displayName
_AddonManifestModel.description
_AddonManifestModel.author
_AddonManifestModel._abc_impl
_AddonManifestModel._is_protocol
AddonManifestModel
AddonManifestModel.addonId
AddonManifestModel.addonVersionName
AddonManifestModel.channel
AddonManifestModel.homepage
AddonManifestModel.minNVDAVersion
AddonManifestModel.lastTestedVersion
AddonManifestModel.manifest
AddonManifestModel.legacy
AddonManifestModel._abc_impl
AddonManifestModel._is_protocol
InstalledAddonStoreModel
InstalledAddonStoreModel.addonId
InstalledAddonStoreModel.publisher
InstalledAddonStoreModel.addonVersionName
InstalledAddonStoreModel.channel
InstalledAddonStoreModel.homepage
InstalledAddonStoreModel.license
InstalledAddonStoreModel.licenseURL
InstalledAddonStoreModel.sourceURL
InstalledAddonStoreModel.URL
InstalledAddonStoreModel.sha256
InstalledAddonStoreModel.addonVersionNumber
InstalledAddonStoreModel.minNVDAVersion
InstalledAddonStoreModel.lastTestedVersion
InstalledAddonStoreModel.reviewURL
InstalledAddonStoreModel.legacy
InstalledAddonStoreModel.manifest
InstalledAddonStoreModel._abc_impl
InstalledAddonStoreModel._is_protocol
AddonStoreModel
AddonStoreModel.addonId
AddonStoreModel.displayName
AddonStoreModel.description
AddonStoreModel.publisher
AddonStoreModel.addonVersionName
AddonStoreModel.channel
AddonStoreModel.homepage
AddonStoreModel.license
AddonStoreModel.licenseURL
AddonStoreModel.sourceURL
AddonStoreModel.URL
AddonStoreModel.sha256
AddonStoreModel.addonVersionNumber
AddonStoreModel.minNVDAVersion
AddonStoreModel.lastTestedVersion
AddonStoreModel.reviewURL
AddonStoreModel.legacy
AddonStoreModel._abc_impl
AddonStoreModel._is_protocol
CachedAddonsModel
_createInstalledStoreModelFromData()
_createStoreModelFromData()
_createGUIModelFromManifest()
_createAddonGUICollection()
_createStoreCollectionFromJson()
- addonStore.models.channel module
- addonStore.models.status module
EnabledStatus
AvailableAddonStatus
AvailableAddonStatus.UNKNOWN
AvailableAddonStatus.PENDING_REMOVE
AvailableAddonStatus.AVAILABLE
AvailableAddonStatus.UPDATE
AvailableAddonStatus.UPDATE_INCOMPATIBLE
AvailableAddonStatus.REPLACE_SIDE_LOAD
AvailableAddonStatus.INCOMPATIBLE
AvailableAddonStatus.DOWNLOADING
AvailableAddonStatus.DOWNLOAD_FAILED
AvailableAddonStatus.DOWNLOAD_SUCCESS
AvailableAddonStatus.INSTALLING
AvailableAddonStatus.INSTALL_FAILED
AvailableAddonStatus.INSTALLED
AvailableAddonStatus.PENDING_INCOMPATIBLE_DISABLED
AvailableAddonStatus.INCOMPATIBLE_DISABLED
AvailableAddonStatus.PENDING_DISABLE
AvailableAddonStatus.DISABLED
AvailableAddonStatus.PENDING_INCOMPATIBLE_ENABLED
AvailableAddonStatus.INCOMPATIBLE_ENABLED
AvailableAddonStatus.PENDING_ENABLE
AvailableAddonStatus.ENABLED
AvailableAddonStatus.RUNNING
AvailableAddonStatus._displayStringLabels
AddonStateCategory
AddonStateCategory.PENDING_REMOVE
AddonStateCategory.PENDING_INSTALL
AddonStateCategory.DISABLED
AddonStateCategory.PENDING_ENABLE
AddonStateCategory.PENDING_DISABLE
AddonStateCategory.OVERRIDE_COMPATIBILITY
AddonStateCategory.BLOCKED
AddonStateCategory.PENDING_OVERRIDE_COMPATIBILITY
AddonStateCategory._generate_next_value_()
AddonStateCategory._new_member_()
AddonStateCategory._use_args_
AddonStateCategory._member_names_
AddonStateCategory._member_map_
AddonStateCategory._value2member_map_
AddonStateCategory._unhashable_values_
AddonStateCategory._member_type_
AddonStateCategory._value_repr_()
_StatusFilterKey
_getDownloadableStatus()
_getUpdateStatus()
_getInstalledStatus()
getStatus()
_statusFilters
SupportsAddonState
SupportsAddonState._stateHandler
SupportsAddonState.isEnabled
SupportsAddonState.isRunning
SupportsAddonState.pendingInstallPath
SupportsAddonState.installPath
SupportsAddonState.isPendingInstall
SupportsAddonState.isPendingRemove
SupportsAddonState.isDisabled
SupportsAddonState.isBlocked
SupportsAddonState._abc_impl
SupportsAddonState._is_protocol
SupportsAddonState.isPendingEnable
SupportsAddonState.minimumNVDAVersion
SupportsAddonState.lastTestedNVDAVersion
SupportsAddonState.name
SupportsAddonState.isPendingDisable
SupportsAddonState._anyPendingInstallForId
SupportsAddonState.requiresRestart
SupportsAddonState.isInstalled
- addonStore.models.version module
MajorMinorPatch
SupportsVersionCheck
SupportsVersionCheck.minimumNVDAVersion
SupportsVersionCheck.lastTestedNVDAVersion
SupportsVersionCheck.name
SupportsVersionCheck._hasOverriddenCompat
SupportsVersionCheck.overrideIncompatibility
SupportsVersionCheck.enableCompatibilityOverride()
SupportsVersionCheck.canOverrideCompatibility
SupportsVersionCheck._isTested
SupportsVersionCheck._hasGotRequiredSupport
SupportsVersionCheck.isCompatible
SupportsVersionCheck.getIncompatibleReason()
SupportsVersionCheck._abc_impl
SupportsVersionCheck._is_protocol
getAddonCompatibilityMessage()
getAddonCompatibilityConfirmationMessage()
Submodules
addonStore.dataManager module
- addonStore.dataManager.initialize()
- addonStore.dataManager.terminate()
- class addonStore.dataManager._DataManager
Bases:
object
- _cacheLatestFilename: str = '_cachedLatestAddons.json'
- _cacheCompatibleFilename: str = '_cachedCompatibleAddons.json'
- _downloadsPendingInstall: Set[Tuple[AddonListItemVM[_AddonStoreModel], PathLike]] = {}
- _downloadsPendingCompletion: Set[AddonListItemVM[_AddonStoreModel]] = {}
- terminate()
- _getLatestAddonsDataForVersion(apiVersion: str) bytes | None
- _getCacheHash() str | None
- _cacheCompatibleAddons(addonData: str, cacheHash: str | None)
- _cacheLatestAddons(addonData: str, cacheHash: str | None)
- _getCachedAddonData(cacheFilePath: str) CachedAddonsModel | None
- _updateFailureMessage = 'Add-on data update failure'
- getLatestCompatibleAddons(onDisplayableError: DisplayableError.OnDisplayableErrorT | None = None) AddonGUICollectionT
- getLatestAddons(onDisplayableError: DisplayableError.OnDisplayableErrorT | None = None) AddonGUICollectionT
- _deleteCacheInstalledAddon(addonId: str)
- _cacheInstalledAddon(addonData: AddonStoreModel)
- _getCachedInstalledAddonData(addonId: str) InstalledAddonStoreModel | None
- _addonsPendingUpdate() list[_AddonGUIModel]
- class addonStore.dataManager._InstalledAddonsCache(*args, **kwargs)
Bases:
AutoPropertyObject
- cachePropertiesByDefault = True
Specifies whether properties are cached by default; can be overridden for individual properties by setting _cache_propertyName. @type: bool
- installedAddons: CaseInsensitiveDict[AddonHandlerModel]
- installedAddonGUICollection: AddonGUICollectionT
- _get_installedAddons() CaseInsensitiveDict[AddonHandlerModel]
Add-ons that have the same ID except differ in casing cause a path collision, as add-on IDs are installed to a case insensitive path. Therefore addon IDs should be treated as case insensitive.
- _get_installedAddonGUICollection() AddonGUICollectionT
- _abc_impl = <_abc._abc_data object>
addonStore.install module
- addonStore.install._getAddonBundleToInstallIfValid(addonPath: str) AddonBundle
@param addonPath: path to the ‘nvda-addon’ file. @return: the addonBundle, if valid @raise DisplayableError if the addon bundle is invalid / incompatible.
- addonStore.install._getPreviouslyInstalledAddonById(addon: AddonBundle) AddonHandlerModel | None
- addonStore.install.installAddon(addonPath: PathLike) None
Installs the addon at path. Any error messages / warnings are presented to the user via a GUI message box. If attempting to install an addon that is pending removal, it will no longer be pending removal. @note See also L{gui.addonGui.installAddon} @raise DisplayableError on failure
addonStore.network module
- addonStore.network._LATEST_API_VER = 'latest'
A string value used in the add-on store to fetch the latest version of all add-ons, i.e include older incompatible versions.
- addonStore.network._getCurrentApiVersionForURL() str
- addonStore.network._getCacheHashURL() str
- class addonStore.network.AddonFileDownloader
Bases:
object
- OnCompleteT
alias of
Callable
[[AddonListItemVM[_AddonStoreModel]
,Optional
[PathLike
]],None
]
- download(addonData: AddonListItemVM[_AddonStoreModel], onComplete: Callable[[AddonListItemVM[_AddonStoreModel], PathLike | None], None], onDisplayableError: DisplayableError.OnDisplayableErrorT)
- _done(downloadAddonFuture: Future[PathLike | None])
- cancelAll()
- _downloadAddonToPath(addonData: AddonListItemVM[_AddonStoreModel], downloadFilePath: str) bool
@return: True if the add-on is downloaded successfully, False if the download is cancelled
- _download(listItem: AddonListItemVM[_AddonStoreModel]) PathLike | None
- static _checkChecksum(addonFilePath: str, addonData: _AddonStoreModel) bool
- static _getCacheFilenameForAddon(addonData: _AddonGUIModel) str