iblrig.version_management.check_upgrade_prerequisites

iblrig.version_management.check_upgrade_prerequisites(exception_handler=None, *args, **kwargs)[source]

Check prerequisites for upgrading IBLRIG.

This function verifies the prerequisites necessary for upgrading IBLRIG. It checks for internet connectivity, whether the IBLRIG installation is managed through Git, and whether the script is running within the IBLRIG virtual environment.

Parameters:

  • exception_handler (Callable, optional) – An optional callable that handles exceptions if raised during the check. If provided, it will be called with the exception as the first argument, followed by any additional positional arguments (*args), and any additional keyword arguments (**kwargs).

  • *args (Additional positional arguments) – Any additional positional arguments needed by the exception_handler callable.

  • **kwargs (Additional keyword arguments) – Any additional keyword arguments needed by the exception_handler callable.

Raises:

  • ConnectionError – If there is no connection to the internet.

  • RuntimeError – If the IBLRIG installation is not managed through Git, or if the script is not running within the IBLRIG virtual environment.

Parameters:

exception_handler (Callable | None)

Return type:

None