Skip to main content

Update Service

Main update service orchestrator.

Classes​

UpdateService​

Main service for handling updates.

Methods​

check_for_updates​
check_for_updates(self, use_cache: bool = True) -> Dict[str, Any]

Check for available updates.

Parameters:

  • use_cache (bool, optional) - Default: True

Returns: Dict

clear_cache​
clear_cache(self) -> None

Clear the version check cache.

force_check​
force_check(self) -> Dict[str, Any]

Force a fresh version check, bypassing cache.

Returns: Dict

get_installation_info​
get_installation_info(self) -> Dict[str, Any]

Get detailed installation and update information.

Returns: Dict

Returns a combined dict containing canonical keys including: - method - supports_auto_update along with version and environment details.

perform_update​
perform_update(self, target_version: Optional[str] = None, force: bool = False, dry_run: bool = False) -> bool

Perform update installation.

Parameters:

  • target_version (Optional, optional) - Specific version to install
  • force (bool, optional) - Force update even if already up to date - Default: False
  • dry_run (bool, optional) - Show what would be done without doing it - Default: False

Returns: bool

show_installation_info​
show_installation_info(self) -> None

Display detailed installation and update information.

show_update_notification​
show_update_notification(self, quiet: bool = False, force_check: bool = False) -> bool

Show update notification if updates are available.

Parameters:

  • quiet (bool, optional) - Only show notification if update is available - Default: False
  • force_check (bool, optional) - Skip cache and force fresh check - Default: False

Returns: bool