146 lines
4.4 KiB
Python
146 lines
4.4 KiB
Python
#!/usr/bin/env python
|
|
# coding: utf-8
|
|
|
|
# Copyright 2014-2015 Canonical Limited.
|
|
#
|
|
# This file is part of charm-helpers.
|
|
#
|
|
# charm-helpers is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Lesser General Public License version 3 as
|
|
# published by the Free Software Foundation.
|
|
#
|
|
# charm-helpers is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Lesser General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser General Public License
|
|
# along with charm-helpers. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
import os
|
|
import subprocess
|
|
import sys
|
|
|
|
from charmhelpers.fetch import apt_install, apt_update
|
|
from charmhelpers.core.hookenv import charm_dir, log
|
|
|
|
__author__ = "Jorge Niedbalski <jorge.niedbalski@canonical.com>"
|
|
|
|
|
|
def pip_execute(*args, **kwargs):
|
|
"""Overriden pip_execute() to stop sys.path being changed.
|
|
|
|
The act of importing main from the pip module seems to cause add wheels
|
|
from the /usr/share/python-wheels which are installed by various tools.
|
|
This function ensures that sys.path remains the same after the call is
|
|
executed.
|
|
"""
|
|
try:
|
|
_path = sys.path
|
|
try:
|
|
from pip import main as _pip_execute
|
|
except ImportError:
|
|
apt_update()
|
|
apt_install('python-pip')
|
|
from pip import main as _pip_execute
|
|
_pip_execute(*args, **kwargs)
|
|
finally:
|
|
sys.path = _path
|
|
|
|
|
|
def parse_options(given, available):
|
|
"""Given a set of options, check if available"""
|
|
for key, value in sorted(given.items()):
|
|
if not value:
|
|
continue
|
|
if key in available:
|
|
yield "--{0}={1}".format(key, value)
|
|
|
|
|
|
def pip_install_requirements(requirements, constraints=None, **options):
|
|
"""Install a requirements file.
|
|
|
|
:param constraints: Path to pip constraints file.
|
|
http://pip.readthedocs.org/en/stable/user_guide/#constraints-files
|
|
"""
|
|
command = ["install"]
|
|
|
|
available_options = ('proxy', 'src', 'log', )
|
|
for option in parse_options(options, available_options):
|
|
command.append(option)
|
|
|
|
command.append("-r {0}".format(requirements))
|
|
if constraints:
|
|
command.append("-c {0}".format(constraints))
|
|
log("Installing from file: {} with constraints {} "
|
|
"and options: {}".format(requirements, constraints, command))
|
|
else:
|
|
log("Installing from file: {} with options: {}".format(requirements,
|
|
command))
|
|
pip_execute(command)
|
|
|
|
|
|
def pip_install(package, fatal=False, upgrade=False, venv=None, **options):
|
|
"""Install a python package"""
|
|
if venv:
|
|
venv_python = os.path.join(venv, 'bin/pip')
|
|
command = [venv_python, "install"]
|
|
else:
|
|
command = ["install"]
|
|
|
|
available_options = ('proxy', 'src', 'log', 'index-url', )
|
|
for option in parse_options(options, available_options):
|
|
command.append(option)
|
|
|
|
if upgrade:
|
|
command.append('--upgrade')
|
|
|
|
if isinstance(package, list):
|
|
command.extend(package)
|
|
else:
|
|
command.append(package)
|
|
|
|
log("Installing {} package with options: {}".format(package,
|
|
command))
|
|
if venv:
|
|
subprocess.check_call(command)
|
|
else:
|
|
pip_execute(command)
|
|
|
|
|
|
def pip_uninstall(package, **options):
|
|
"""Uninstall a python package"""
|
|
command = ["uninstall", "-q", "-y"]
|
|
|
|
available_options = ('proxy', 'log', )
|
|
for option in parse_options(options, available_options):
|
|
command.append(option)
|
|
|
|
if isinstance(package, list):
|
|
command.extend(package)
|
|
else:
|
|
command.append(package)
|
|
|
|
log("Uninstalling {} package with options: {}".format(package,
|
|
command))
|
|
pip_execute(command)
|
|
|
|
|
|
def pip_list():
|
|
"""Returns the list of current python installed packages
|
|
"""
|
|
return pip_execute(["list"])
|
|
|
|
|
|
def pip_create_virtualenv(path=None):
|
|
"""Create an isolated Python environment."""
|
|
apt_install('python-virtualenv')
|
|
|
|
if path:
|
|
venv_path = path
|
|
else:
|
|
venv_path = os.path.join(charm_dir(), 'venv')
|
|
|
|
if not os.path.exists(venv_path):
|
|
subprocess.check_call(['virtualenv', venv_path])
|