| Dir : /proc/self/root/opt/saltstack/salt/lib/python3.10/site-packages/salt/states/ |
| Server: Linux ngx353.inmotionhosting.com 4.18.0-553.22.1.lve.1.el8.x86_64 #1 SMP Tue Oct 8 15:52:54 UTC 2024 x86_64 IP: 209.182.202.254 |
| Dir : //proc/self/root/opt/saltstack/salt/lib/python3.10/site-packages/salt/states/pip_state.py |
"""
Installation of Python Packages Using pip
=========================================
These states manage system installed python packages. Note that pip must be
installed for these states to be available, so pip states should include a
requisite to a pkg.installed state for the package which provides pip
(``python-pip`` in most cases). Example:
.. code-block:: yaml
python-pip:
pkg.installed
virtualenvwrapper:
pip.installed:
- require:
- pkg: python-pip
"""
import logging
import re
import sys
import types
import salt.utils.data
import salt.utils.versions
from salt.exceptions import CommandExecutionError, CommandNotFoundError
try:
import pkg_resources
HAS_PKG_RESOURCES = True
except ImportError:
HAS_PKG_RESOURCES = False
# pylint: disable=import-error
def purge_pip():
"""
Purge pip and its sub-modules
"""
# Remove references to the loaded pip module above so reloading works
if "pip" not in sys.modules:
return
pip_related_entries = [
(k, v)
for (k, v) in sys.modules.items()
if getattr(v, "__module__", "").startswith("pip.")
or (isinstance(v, types.ModuleType) and v.__name__.startswith("pip."))
]
for name, entry in pip_related_entries:
sys.modules.pop(name)
del entry
if "pip" in globals():
del globals()["pip"]
if "pip" in locals():
del locals()["pip"]
sys_modules_pip = sys.modules.pop("pip", None)
if sys_modules_pip is not None:
del sys_modules_pip
def pip_has_internal_exceptions_mod(ver):
"""
True when the pip version has the `pip._internal.exceptions` module
"""
return salt.utils.versions.compare(
ver1=ver,
oper=">=",
ver2="10.0",
)
def pip_has_exceptions_mod(ver):
"""
True when the pip version has the `pip.exceptions` module
"""
if pip_has_internal_exceptions_mod(ver):
return False
return salt.utils.versions.compare(ver1=ver, oper=">=", ver2="1.0")
try:
import pip
HAS_PIP = True
except ImportError:
HAS_PIP = False
purge_pip()
if HAS_PIP is True:
if not hasattr(purge_pip, "__pip_ver__"):
purge_pip.__pip_ver__ = pip.__version__
elif purge_pip.__pip_ver__ != pip.__version__:
purge_pip()
import pip
purge_pip.__pip_ver__ = pip.__version__
if salt.utils.versions.compare(ver1=pip.__version__, oper=">=", ver2="10.0"):
from pip._internal.exceptions import ( # pylint: disable=E0611,E0401
InstallationError,
)
elif salt.utils.versions.compare(ver1=pip.__version__, oper=">=", ver2="1.0"):
from pip.exceptions import InstallationError # pylint: disable=E0611,E0401
else:
InstallationError = ValueError
# pylint: enable=import-error
logger = logging.getLogger(__name__)
# Define the module's virtual name
__virtualname__ = "pip"
def _from_line(*args, **kwargs):
import pip
if salt.utils.versions.compare(ver1=pip.__version__, oper=">=", ver2="18.1"):
import pip._internal.req.constructors # pylint: disable=E0611,E0401
return pip._internal.req.constructors.install_req_from_line(*args, **kwargs)
elif salt.utils.versions.compare(ver1=pip.__version__, oper=">=", ver2="10.0"):
import pip._internal.req # pylint: disable=E0611,E0401
return pip._internal.req.InstallRequirement.from_line(*args, **kwargs)
else:
import pip.req # pylint: disable=E0611,E0401
return pip.req.InstallRequirement.from_line(*args, **kwargs)
def __virtual__():
"""
Only load if the pip module is available in __salt__
"""
if HAS_PKG_RESOURCES is False:
return False, "The pkg_resources python library is not installed"
if "pip.list" in __salt__:
return __virtualname__
return False
def _fulfills_version_spec(version, version_spec):
"""
Check version number against version specification info and return a
boolean value based on whether or not the version number meets the
specified version.
"""
for oper, spec in version_spec:
if oper is None:
continue
if not salt.utils.versions.compare(
ver1=version, oper=oper, ver2=spec, cmp_func=_pep440_version_cmp
):
return False
return True
def _check_pkg_version_format(pkg):
"""
Takes a package name and version specification (if any) and checks it using
the pip library.
"""
ret = {"result": False, "comment": None, "prefix": None, "version_spec": None}
if not HAS_PIP:
ret["comment"] = (
"An importable Python pip module is required but could not be "
"found on your system. This usually means that the system's pip "
"package is not installed properly."
)
return ret
from_vcs = False
try:
# Get the requirement object from the pip library
try:
# With pip < 1.2, the __version__ attribute does not exist and
# vcs+URL urls are not properly parsed.
# The next line is meant to trigger an AttributeError and
# handle lower pip versions
logger.debug("Installed pip version: %s", pip.__version__)
install_req = _from_line(pkg)
except AttributeError:
logger.debug("Installed pip version is lower than 1.2")
supported_vcs = ("git", "svn", "hg", "bzr")
if pkg.startswith(supported_vcs):
for vcs in supported_vcs:
if pkg.startswith(vcs):
from_vcs = True
install_req = _from_line(pkg.split(f"{vcs}+")[-1])
break
else:
install_req = _from_line(pkg)
except (ValueError, InstallationError) as exc:
ret["result"] = False
if not from_vcs and "=" in pkg and "==" not in pkg:
ret["comment"] = (
"Invalid version specification in package {}. '=' is "
"not supported, use '==' instead.".format(pkg)
)
return ret
ret["comment"] = "pip raised an exception while parsing '{}': {}".format(
pkg, exc
)
return ret
if install_req.req is None:
# This is most likely an url and there's no way to know what will
# be installed before actually installing it.
ret["result"] = True
ret["prefix"] = ""
ret["version_spec"] = []
else:
ret["result"] = True
try:
ret["prefix"] = install_req.req.project_name
ret["version_spec"] = install_req.req.specs
except Exception: # pylint: disable=broad-except
ret["prefix"] = re.sub("[^A-Za-z0-9.]+", "-", install_req.name)
if hasattr(install_req, "specifier"):
specifier = install_req.specifier
else:
specifier = install_req.req.specifier
ret["version_spec"] = [(spec.operator, spec.version) for spec in specifier]
return ret
def _check_if_installed(
prefix,
state_pkg_name,
version_spec,
ignore_installed,
force_reinstall,
upgrade,
user,
cwd,
bin_env,
env_vars,
index_url,
extra_index_url,
pip_list=False,
**kwargs,
):
"""
Takes a package name and version specification (if any) and checks it is
installed
Keyword arguments include:
pip_list: optional dict of installed pip packages, and their versions,
to search through to check if the package is installed. If not
provided, one will be generated in this function by querying the
system.
Returns:
result: None means the command failed to run
result: True means the package is installed
result: False means the package is not installed
"""
ret = {"result": False, "comment": None}
# If we are not passed a pip list, get one:
pip_list = salt.utils.data.CaseInsensitiveDict(
pip_list
or __salt__["pip.list"](
prefix, bin_env=bin_env, user=user, cwd=cwd, env_vars=env_vars, **kwargs
)
)
# If the package was already installed, check
# the ignore_installed and force_reinstall flags
if ignore_installed is False and prefix in pip_list:
if force_reinstall is False and not upgrade:
# Check desired version (if any) against currently-installed
if (
any(version_spec)
and _fulfills_version_spec(pip_list[prefix], version_spec)
) or (not any(version_spec)):
ret["result"] = True
ret["comment"] = "Python package {} was already installed".format(
state_pkg_name
)
return ret
if force_reinstall is False and upgrade:
# Check desired version (if any) against currently-installed
include_alpha = False
include_beta = False
include_rc = False
if any(version_spec):
for spec in version_spec:
if "a" in spec[1]:
include_alpha = True
if "b" in spec[1]:
include_beta = True
if "rc" in spec[1]:
include_rc = True
available_versions = __salt__["pip.list_all_versions"](
prefix,
bin_env=bin_env,
include_alpha=include_alpha,
include_beta=include_beta,
include_rc=include_rc,
user=user,
cwd=cwd,
index_url=index_url,
extra_index_url=extra_index_url,
)
desired_version = ""
if any(version_spec) and available_versions:
for version in reversed(available_versions):
if _fulfills_version_spec(version, version_spec):
desired_version = version
break
elif available_versions:
desired_version = available_versions[-1]
if not desired_version:
ret["result"] = True
ret["comment"] = (
"Python package {} was already "
"installed and\nthe available upgrade "
"doesn't fulfills the version "
"requirements".format(prefix)
)
return ret
if _pep440_version_cmp(pip_list[prefix], desired_version) == 0:
ret["result"] = True
ret["comment"] = "Python package {} was already installed".format(
state_pkg_name
)
return ret
return ret
def _pep440_version_cmp(pkg1, pkg2, ignore_epoch=False):
"""
Compares two version strings using pkg_resources.parse_version.
Return -1 if version1 < version2, 0 if version1 ==version2,
and 1 if version1 > version2. Return None if there was a problem
making the comparison.
"""
if HAS_PKG_RESOURCES is False:
logger.warning(
"The pkg_resources packages was not loaded. Please install setuptools."
)
return None
def normalize(x):
return str(x).split("!", 1)[-1] if ignore_epoch else str(x)
pkg1 = normalize(pkg1)
pkg2 = normalize(pkg2)
try:
if pkg_resources.parse_version(pkg1) < pkg_resources.parse_version(pkg2):
return -1
if pkg_resources.parse_version(pkg1) == pkg_resources.parse_version(pkg2):
return 0
if pkg_resources.parse_version(pkg1) > pkg_resources.parse_version(pkg2):
return 1
except Exception as exc: # pylint: disable=broad-except
logger.exception(
'Comparison of package versions "%s" and "%s" failed: %s', pkg1, pkg2, exc
)
return None
def installed(
name,
pkgs=None,
pip_bin=None,
requirements=None,
bin_env=None,
use_wheel=False,
no_use_wheel=False,
log=None,
proxy=None,
timeout=None,
repo=None,
editable=None,
find_links=None,
index_url=None,
extra_index_url=None,
no_index=False,
mirrors=None,
build=None,
target=None,
download=None,
download_cache=None,
source=None,
upgrade=False,
force_reinstall=False,
ignore_installed=False,
exists_action=None,
no_deps=False,
no_install=False,
no_download=False,
install_options=None,
global_options=None,
user=None,
cwd=None,
pre_releases=False,
cert=None,
allow_all_external=False,
allow_external=None,
allow_unverified=None,
process_dependency_links=False,
env_vars=None,
use_vt=False,
trusted_host=None,
no_cache_dir=False,
cache_dir=None,
no_binary=None,
extra_args=None,
**kwargs,
):
"""
Make sure the package is installed
name
The name of the python package to install. You can also specify version
numbers here using the standard operators ``==, >=, <=``. If
``requirements`` or ``pkgs`` is given, this parameter will be ignored.
Example:
.. code-block:: yaml
django:
pip.installed:
- name: django >= 1.6, <= 1.7
- require:
- pkg: python-pip
Installs the latest Django version greater than 1.6 but less
than 1.7.
pkgs
A list of python packages to install. This let you install multiple
packages at the same time.
Example:
.. code-block:: yaml
django-and-psycopg2:
pip.installed:
- pkgs:
- django >= 1.6, <= 1.7
- psycopg2 >= 2.8.4
- require:
- pkg: python-pip
Installs the latest Django version greater than 1.6 but less than 1.7
and the latest psycopg2 greater than 2.8.4 at the same time.
requirements
Path to a pip requirements file. If the path begins with salt://
the file will be transferred from the master file server.
user
The user under which to run pip
use_wheel : False
Prefer wheel archives (requires pip>=1.4)
no_use_wheel : False
Force to not use wheel archives (requires pip>=1.4)
no_binary
Force to not use binary packages (requires pip >= 7.0.0)
Accepts either :all: to disable all binary packages, :none: to empty the set,
or a list of one or more packages
Example:
.. code-block:: yaml
django:
pip.installed:
- no_binary: ':all:'
flask:
pip.installed:
- no_binary:
- itsdangerous
- click
log
Log file where a complete (maximum verbosity) record will be kept
proxy
Specify a proxy in the form
user:passwd@proxy.server:port. Note that the
user:password@ is optional and required only if you
are behind an authenticated proxy. If you provide
user@proxy.server:port then you will be prompted for a
password.
timeout
Set the socket timeout (default 15 seconds)
editable
install something editable (i.e.
git+https://github.com/worldcompany/djangoembed.git#egg=djangoembed)
find_links
URL to look for packages at
index_url
Base URL of Python Package Index
extra_index_url
Extra URLs of package indexes to use in addition to ``index_url``
no_index
Ignore package index
mirrors
Specific mirror URL(s) to query (automatically adds --use-mirrors)
build
Unpack packages into ``build`` dir
target
Install packages into ``target`` dir
download
Download packages into ``download`` instead of installing them
download_cache
Cache downloaded packages in ``download_cache`` dir
source
Check out ``editable`` packages into ``source`` dir
upgrade
Upgrade all packages to the newest available version
force_reinstall
When upgrading, reinstall all packages even if they are already
up-to-date.
ignore_installed
Ignore the installed packages (reinstalling instead)
exists_action
Default action when a path already exists: (s)witch, (i)gnore, (w)ipe,
(b)ackup
no_deps
Ignore package dependencies
no_install
Download and unpack all packages, but don't actually install them
no_cache_dir:
Disable the cache.
cwd
Current working directory to run pip from
pre_releases
Include pre-releases in the available versions
cert
Provide a path to an alternate CA bundle
allow_all_external
Allow the installation of all externally hosted files
allow_external
Allow the installation of externally hosted files (comma separated list)
allow_unverified
Allow the installation of insecure and unverifiable files (comma separated list)
process_dependency_links
Enable the processing of dependency links
env_vars
Add or modify environment variables. Useful for tweaking build steps,
such as specifying INCLUDE or LIBRARY paths in Makefiles, build scripts or
compiler calls. This must be in the form of a dictionary or a mapping.
Example:
.. code-block:: yaml
django:
pip.installed:
- name: django_app
- env_vars:
CUSTOM_PATH: /opt/django_app
VERBOSE: True
use_vt
Use VT terminal emulation (see output while installing)
trusted_host
Mark this host as trusted, even though it does not have valid or any
HTTPS.
bin_env : None
Absolute path to a virtual environment directory or absolute path to
a pip executable. The example below assumes a virtual environment
has been created at ``/foo/.virtualenvs/bar``.
Example:
.. code-block:: yaml
django:
pip.installed:
- name: django >= 1.6, <= 1.7
- bin_env: /foo/.virtualenvs/bar
- require:
- pkg: python-pip
Or
Example:
.. code-block:: yaml
django:
pip.installed:
- name: django >= 1.6, <= 1.7
- bin_env: /foo/.virtualenvs/bar/bin/pip
- require:
- pkg: python-pip
.. admonition:: Attention
The following arguments are deprecated, do not use.
pip_bin : None
Deprecated, use ``bin_env``
.. versionchanged:: 0.17.0
``use_wheel`` option added.
install_options
Extra arguments to be supplied to the setup.py install command.
If you are using an option with a directory path, be sure to use
absolute path.
Example:
.. code-block:: yaml
django:
pip.installed:
- name: django
- install_options:
- --prefix=/blah
- require:
- pkg: python-pip
global_options
Extra global options to be supplied to the setup.py call before the
install command.
.. versionadded:: 2014.1.3
.. admonition:: Attention
As of Salt 0.17.0 the pip state **needs** an importable pip module.
This usually means having the system's pip package installed or running
Salt from an active `virtualenv`_.
The reason for this requirement is because ``pip`` already does a
pretty good job parsing its own requirements. It makes no sense for
Salt to do ``pip`` requirements parsing and validation before passing
them to the ``pip`` library. It's functionality duplication and it's
more error prone.
.. admonition:: Attention
Please set ``reload_modules: True`` to have the salt minion
import this module after installation.
Example:
.. code-block:: yaml
pyopenssl:
pip.installed:
- name: pyOpenSSL
- reload_modules: True
- exists_action: i
extra_args
pip keyword and positional arguments not yet implemented in salt
.. code-block:: yaml
pandas:
pip.installed:
- name: pandas
- extra_args:
- --latest-pip-kwarg: param
- --latest-pip-arg
.. warning::
If unsupported options are passed here that are not supported in a
minion's version of pip, a `No such option error` will be thrown.
.. _`virtualenv`: http://www.virtualenv.org/en/latest/
If you are using onedir packages and you need to install python packages into
the system python environment, you must provide the pip_bin or
bin_env to the pip state module.
.. code-block:: yaml
lib-foo:
pip.installed:
- pip_bin: /usr/bin/pip3
lib-bar:
pip.installed:
- bin_env: /usr/bin/python3
"""
if pip_bin and not bin_env:
bin_env = pip_bin
# If pkgs is present, ignore name
if pkgs:
if not isinstance(pkgs, list):
return {
"name": name,
"result": False,
"changes": {},
"comment": "pkgs argument must be formatted as a list",
}
else:
pkgs = [name]
# Assumption: If `pkg` is not an `string`, it's a `collections.OrderedDict`
# prepro = lambda pkg: pkg if type(pkg) == str else \
# ' '.join((pkg.items()[0][0], pkg.items()[0][1].replace(',', ';')))
# pkgs = ','.join([prepro(pkg) for pkg in pkgs])
def prepro(pkg):
return (
pkg
if isinstance(pkg, str)
else " ".join((pkg.items()[0][0], pkg.items()[0][1]))
)
pkgs = [prepro(pkg) for pkg in pkgs]
ret = {"name": ";".join(pkgs), "result": None, "comment": "", "changes": {}}
try:
cur_version = __salt__["pip.version"](bin_env)
except (CommandNotFoundError, CommandExecutionError) as err:
ret["result"] = False
ret["comment"] = f"Error installing '{name}': {err}"
return ret
# Check that the pip binary supports the 'use_wheel' option
if use_wheel:
min_version = "1.4"
max_version = "9.0.3"
too_low = salt.utils.versions.compare(
ver1=cur_version, oper="<", ver2=min_version
)
too_high = salt.utils.versions.compare(
ver1=cur_version, oper=">", ver2=max_version
)
if too_low or too_high:
ret["result"] = False
ret["comment"] = (
"The 'use_wheel' option is only supported in "
"pip between {} and {}. The version of pip detected "
"was {}.".format(min_version, max_version, cur_version)
)
return ret
# Check that the pip binary supports the 'no_use_wheel' option
if no_use_wheel:
min_version = "1.4"
max_version = "9.0.3"
too_low = salt.utils.versions.compare(
ver1=cur_version, oper="<", ver2=min_version
)
too_high = salt.utils.versions.compare(
ver1=cur_version, oper=">", ver2=max_version
)
if too_low or too_high:
ret["result"] = False
ret["comment"] = (
"The 'no_use_wheel' option is only supported in "
"pip between {} and {}. The version of pip detected "
"was {}.".format(min_version, max_version, cur_version)
)
return ret
# Check that the pip binary supports the 'no_binary' option
if no_binary:
min_version = "7.0.0"
too_low = salt.utils.versions.compare(
ver1=cur_version, oper="<", ver2=min_version
)
if too_low:
ret["result"] = False
ret["comment"] = (
"The 'no_binary' option is only supported in "
"pip {} and newer. The version of pip detected "
"was {}.".format(min_version, cur_version)
)
return ret
# Get the packages parsed name and version from the pip library.
# This only is done when there is no requirements or editable parameter.
pkgs_details = []
if pkgs and not (requirements or editable):
comments = []
for pkg in iter(pkgs):
out = _check_pkg_version_format(pkg)
if out["result"] is False:
ret["result"] = False
comments.append(out["comment"])
elif out["result"] is True:
pkgs_details.append((out["prefix"], pkg, out["version_spec"]))
if ret["result"] is False:
ret["comment"] = "\n".join(comments)
return ret
# If the user does not exist, stop here with error:
if user and "user.info" in __salt__ and not __salt__["user.info"](user):
# The user does not exists, exit with result set to False
ret["result"] = False
ret["comment"] = f"User {user} does not exist"
return ret
# If a requirements file is specified, only install the contents of the
# requirements file. Similarly, using the --editable flag with pip should
# also ignore the "name" and "pkgs" parameters.
target_pkgs = []
already_installed_comments = []
if requirements or editable:
comments = []
# Append comments if this is a dry run.
if __opts__["test"]:
ret["result"] = None
if requirements:
# TODO: Check requirements file against currently-installed
# packages to provide more accurate state output.
comments.append(
f"Requirements file '{requirements}' will be processed."
)
if editable:
comments.append(
"Package will be installed in editable mode (i.e. "
'setuptools "develop mode") from {}.'.format(editable)
)
ret["comment"] = " ".join(comments)
return ret
# No requirements case.
# Check pre-existence of the requested packages.
else:
# Attempt to pre-cache the current pip list
try:
pip_list = __salt__["pip.list"](
bin_env=bin_env, user=user, cwd=cwd, env_vars=env_vars
)
# If we fail, then just send False, and we'll try again in the next function call
except Exception as exc: # pylint: disable=broad-except
logger.exception(
"Pre-caching of PIP packages during states.pip.installed failed by exception from pip.list: %s",
exc,
)
pip_list = False
for prefix, state_pkg_name, version_spec in pkgs_details:
if prefix:
out = _check_if_installed(
prefix,
state_pkg_name,
version_spec,
ignore_installed,
force_reinstall,
upgrade,
user,
cwd,
bin_env,
env_vars,
index_url,
extra_index_url,
pip_list,
**kwargs,
)
# If _check_if_installed result is None, something went wrong with
# the command running. This way we keep stateful output.
if out["result"] is None:
ret["result"] = False
ret["comment"] = out["comment"]
return ret
else:
out = {"result": False, "comment": None}
result = out["result"]
# The package is not present. Add it to the pkgs to install.
if result is False:
# Replace commas (used for version ranges) with semicolons
# (which are not supported) in name so it does not treat
# them as multiple packages.
target_pkgs.append((prefix, state_pkg_name.replace(",", ";")))
# Append comments if this is a dry run.
if __opts__["test"]:
# If there is more than one package, compute
# the total amount and exit
if len(pkgs_details) > 1:
msg = "Python package(s) set to be installed:"
for pkg in pkgs_details:
msg += "\n"
msg += pkg[1]
ret["comment"] = msg
else:
msg = "Python package {0} is set to be installed"
ret["comment"] = msg.format(state_pkg_name)
ret["result"] = None
return ret
# The package is already present and will not be reinstalled.
elif result is True:
# Append comment stating its presence
already_installed_comments.append(out["comment"])
# The command pip.list failed. Abort.
elif result is None:
ret["result"] = None
ret["comment"] = out["comment"]
return ret
# No packages to install.
if not target_pkgs:
ret["result"] = True
aicomms = "\n".join(already_installed_comments)
last_line = "All specified packages are already installed" + (
" and up-to-date" if upgrade else ""
)
ret["comment"] = aicomms + ("\n" if aicomms else "") + last_line
return ret
# Construct the string that will get passed to the install call
pkgs_str = ",".join([state_name for _, state_name in target_pkgs])
# Call to install the package. Actual installation takes place here
pip_install_call = __salt__["pip.install"](
pkgs=f"{pkgs_str}" if pkgs_str else "",
requirements=requirements,
bin_env=bin_env,
use_wheel=use_wheel,
no_use_wheel=no_use_wheel,
no_binary=no_binary,
log=log,
proxy=proxy,
timeout=timeout,
editable=editable,
find_links=find_links,
index_url=index_url,
extra_index_url=extra_index_url,
no_index=no_index,
mirrors=mirrors,
build=build,
target=target,
download=download,
download_cache=download_cache,
source=source,
upgrade=upgrade,
force_reinstall=force_reinstall,
ignore_installed=ignore_installed,
exists_action=exists_action,
no_deps=no_deps,
no_install=no_install,
no_download=no_download,
install_options=install_options,
global_options=global_options,
user=user,
cwd=cwd,
pre_releases=pre_releases,
cert=cert,
allow_all_external=allow_all_external,
allow_external=allow_external,
allow_unverified=allow_unverified,
process_dependency_links=process_dependency_links,
saltenv=__env__,
env_vars=env_vars,
use_vt=use_vt,
trusted_host=trusted_host,
no_cache_dir=no_cache_dir,
extra_args=extra_args,
disable_version_check=True,
**kwargs,
)
if pip_install_call and pip_install_call.get("retcode", 1) == 0:
ret["result"] = True
if requirements or editable:
comments = []
if requirements:
PIP_REQUIREMENTS_NOCHANGE = [
"Requirement already satisfied",
"Requirement already up-to-date",
"Requirement not upgraded",
"Collecting",
"Cloning",
"Cleaning up...",
"Looking in indexes",
]
for line in pip_install_call.get("stdout", "").split("\n"):
if not any(
[line.strip().startswith(x) for x in PIP_REQUIREMENTS_NOCHANGE]
):
ret["changes"]["requirements"] = True
if ret["changes"].get("requirements"):
comments.append(
"Successfully processed requirements file {}.".format(
requirements
)
)
else:
comments.append("Requirements were already installed.")
if editable:
comments.append(
"Package successfully installed from VCS checkout {}.".format(
editable
)
)
ret["changes"]["editable"] = True
ret["comment"] = " ".join(comments)
else:
# Check that the packages set to be installed were installed.
# Create comments reporting success and failures
pkg_404_comms = []
already_installed_packages = set()
for line in pip_install_call.get("stdout", "").split("\n"):
# Output for already installed packages:
# 'Requirement already up-to-date: jinja2 in /usr/local/lib/python2.7/dist-packages\nCleaning up...'
if line.startswith("Requirement already up-to-date: "):
package = line.split(":", 1)[1].split()[0]
already_installed_packages.add(package.lower())
for prefix, state_name in target_pkgs:
# Case for packages that are not an URL
if prefix:
pipsearch = salt.utils.data.CaseInsensitiveDict(
__salt__["pip.list"](
prefix,
bin_env,
user=user,
cwd=cwd,
env_vars=env_vars,
**kwargs,
)
)
# If we didn't find the package in the system after
# installing it report it
if not pipsearch:
pkg_404_comms.append(
"There was no error installing package '{}' "
"although it does not show when calling "
"'pip.freeze'.".format(pkg)
)
else:
if (
prefix in pipsearch
and prefix.lower() not in already_installed_packages
):
ver = pipsearch[prefix]
ret["changes"][f"{prefix}=={ver}"] = "Installed"
# Case for packages that are an URL
else:
ret["changes"][f"{state_name}==???"] = "Installed"
# Set comments
aicomms = "\n".join(already_installed_comments)
succ_comm = (
"All packages were successfully installed"
if not pkg_404_comms
else "\n".join(pkg_404_comms)
)
ret["comment"] = aicomms + ("\n" if aicomms else "") + succ_comm
return ret
elif pip_install_call:
ret["result"] = False
if "stdout" in pip_install_call:
error = "Error: {} {}".format(
pip_install_call["stdout"], pip_install_call["stderr"]
)
else:
error = "Error: {}".format(pip_install_call["comment"])
if requirements or editable:
comments = []
if requirements:
comments.append(f'Unable to process requirements file "{requirements}"')
if editable:
comments.append(f"Unable to install from VCS checkout {editable}.")
comments.append(error)
ret["comment"] = " ".join(comments)
else:
pkgs_str = ", ".join([state_name for _, state_name in target_pkgs])
aicomms = "\n".join(already_installed_comments)
error_comm = f"Failed to install packages: {pkgs_str}. {error}"
ret["comment"] = aicomms + ("\n" if aicomms else "") + error_comm
else:
ret["result"] = False
ret["comment"] = "Could not install package"
return ret
def removed(
name,
requirements=None,
bin_env=None,
log=None,
proxy=None,
timeout=None,
user=None,
cwd=None,
use_vt=False,
):
"""
Make sure that a package is not installed.
name
The name of the package to uninstall
user
The user under which to run pip
bin_env : None
the pip executable or virtualenenv to use
use_vt
Use VT terminal emulation (see output while installing)
"""
ret = {"name": name, "result": None, "comment": "", "changes": {}}
try:
pip_list = __salt__["pip.list"](bin_env=bin_env, user=user, cwd=cwd)
except (CommandExecutionError, CommandNotFoundError) as err:
ret["result"] = False
ret["comment"] = f"Error uninstalling '{name}': {err}"
return ret
if name not in pip_list:
ret["result"] = True
ret["comment"] = "Package is not installed."
return ret
if __opts__["test"]:
ret["result"] = None
ret["comment"] = f"Package {name} is set to be removed"
return ret
if __salt__["pip.uninstall"](
pkgs=name,
requirements=requirements,
bin_env=bin_env,
log=log,
proxy=proxy,
timeout=timeout,
user=user,
cwd=cwd,
use_vt=use_vt,
):
ret["result"] = True
ret["changes"][name] = "Removed"
ret["comment"] = "Package was successfully removed."
else:
ret["result"] = False
ret["comment"] = "Could not remove package."
return ret
def uptodate(name, bin_env=None, user=None, cwd=None, use_vt=False):
"""
.. versionadded:: 2015.5.0
Verify that the system is completely up to date.
name
The name has no functional value and is only used as a tracking
reference
user
The user under which to run pip
bin_env
the pip executable or virtualenenv to use
use_vt
Use VT terminal emulation (see output while installing)
"""
ret = {"name": name, "changes": {}, "result": False, "comment": "Failed to update."}
try:
packages = __salt__["pip.list_upgrades"](bin_env=bin_env, user=user, cwd=cwd)
except Exception as e: # pylint: disable=broad-except
ret["comment"] = str(e)
return ret
if not packages:
ret["comment"] = "System is already up-to-date."
ret["result"] = True
return ret
elif __opts__["test"]:
ret["comment"] = "System update will be performed"
ret["result"] = None
return ret
updated = __salt__["pip.upgrade"](
bin_env=bin_env, user=user, cwd=cwd, use_vt=use_vt
)
if updated.get("result") is False:
ret.update(updated)
elif updated:
ret["changes"] = updated
ret["comment"] = "Upgrade successful."
ret["result"] = True
else:
ret["comment"] = "Upgrade failed."
return ret