msl.package_manager.update module

Update MSL packages.

msl.package_manager.update.update(*names, **kwargs)[source]

Update MSL packages.

MSL packages can be updated from PyPI packages (only if a release has been uploaded to PyPI) or from GitHub repositories.

Note

If the MSL packages are available on PyPI then PyPI is used as the default URI to update the package. If you want to force the update to occur from the main branch of the GitHub repository then set branch='main'. If the package is not available on PyPI then the main branch is used as the default update URI.

Changed in version 2.4.0: Added the pip_options keyword argument.

Changed in version 2.5.0: Added the include_non_msl and commit keyword arguments. The default name of a repository branch changed to main.

Parameters:

  • *names – The name(s) of the MSL package(s) to update. If not specified then update all MSL packages. The msl- prefix can be omitted (e.g., 'loadlib' is equivalent to 'msl-loadlib'). Also accepts shell-style wildcards (e.g., 'pr-*').

  • **kwargs –

    • branch – str

      The name of a git branch to use to update the package(s) to.

    • commit – str

      The hash value of a git commit to use to update a package.

    • tag – str

      The name of a git tag to use to update a package.

    • update_cache – bool

      The information about the MSL packages that are available on PyPI and about the repositories that are available on GitHub are cached to use for subsequent calls to this function. After 24 hours the cache is automatically updated. Set update_cache to be True to force the cache to be updated when you call this function. Default is False.

    • yes – bool

      If True then don’t ask for confirmation before updating. The default is False (ask before updating).

    • pip_options – list of str

      Optional arguments to pass to the pip install --upgrade command, e.g., ['--upgrade-strategy', 'eager']

    • include_non_msl – bool

      If True then also update all non-MSL packages. The default is False (only update the specified MSL packages). Warning, enable this option with caution.

    Important

    If you specify a branch, commit or tag then the update will be forced.