mirror of
https://github.com/kennethreitz/pipenv.git
synced 2026-06-05 22:50:18 +00:00
2402 lines
82 KiB
Python
2402 lines
82 KiB
Python
# -*- coding: utf-8 -*-
|
||
import contextlib
|
||
import codecs
|
||
import os
|
||
import sys
|
||
import shutil
|
||
import signal
|
||
import time
|
||
import tempfile
|
||
from glob import glob
|
||
import json as simplejson
|
||
|
||
import urllib3
|
||
import background
|
||
import click
|
||
import click_completion
|
||
import crayons
|
||
import dotenv
|
||
import delegator
|
||
import pexpect
|
||
import requests
|
||
import pip
|
||
import pipfile
|
||
import pipdeptree
|
||
import requirements
|
||
import semver
|
||
import flake8.main.cli
|
||
|
||
from pipreqs import pipreqs
|
||
from blindspin import spinner
|
||
from urllib3.exceptions import InsecureRequestWarning
|
||
from pip.req.req_file import parse_requirements
|
||
from click_didyoumean import DYMCommandCollection
|
||
|
||
from .project import Project
|
||
from .utils import (
|
||
convert_deps_from_pip, convert_deps_to_pip, is_required_version,
|
||
proper_case, pep423_name, split_vcs, resolve_deps, shellquote, is_vcs,
|
||
python_version, suggest_package, find_windows_executable, is_file,
|
||
prepare_pip_source_args
|
||
)
|
||
from .__version__ import __version__
|
||
from . import pep508checker, progress
|
||
from . import environments
|
||
from .environments import (
|
||
PIPENV_COLORBLIND, PIPENV_NOSPIN, PIPENV_SHELL_FANCY,
|
||
PIPENV_VENV_IN_PROJECT, PIPENV_USE_SYSTEM, PIPENV_TIMEOUT,
|
||
PIPENV_SKIP_VALIDATION, PIPENV_HIDE_EMOJIS, PIPENV_INSTALL_TIMEOUT,
|
||
PYENV_ROOT, PYENV_INSTALLED, PIPENV_YES, PIPENV_DONT_LOAD_ENV,
|
||
PIPENV_DEFAULT_PYTHON_VERSION, PIPENV_MAX_SUBPROCESS,
|
||
PIPENV_DONT_USE_PYENV, SESSION_IS_INTERACTIVE, PIPENV_USE_SYSTEM,
|
||
PIPENV_DOTENV_LOCATION, PIPENV_SHELL
|
||
)
|
||
|
||
# Backport required for earlier versions of Python.
|
||
if sys.version_info < (3, 3):
|
||
from backports.shutil_get_terminal_size import get_terminal_size
|
||
else:
|
||
from shutil import get_terminal_size
|
||
|
||
xyzzy = """
|
||
_______ __ __
|
||
/ \ / | / |
|
||
$$$$$$$ |$$/ ______ ______ _______ __ __ $$ |
|
||
$$ |__$$ |/ | / \ / \ / \ / \ / |$$ |
|
||
$$ $$/ $$ |/$$$$$$ |/$$$$$$ |$$$$$$$ |$$ \ /$$/ $$ |
|
||
$$$$$$$/ $$ |$$ | $$ |$$ $$ |$$ | $$ | $$ /$$/ $$/
|
||
$$ | $$ |$$ |__$$ |$$$$$$$$/ $$ | $$ | $$ $$/ __
|
||
$$ | $$ |$$ $$/ $$ |$$ | $$ | $$$/ / |
|
||
$$/ $$/ $$$$$$$/ $$$$$$$/ $$/ $$/ $/ $$/
|
||
$$ |
|
||
$$ |
|
||
$$/
|
||
"""
|
||
|
||
# Packages that should be ignored later.
|
||
BAD_PACKAGES = (
|
||
'setuptools', 'pip', 'wheel', 'six', 'packaging', 'distribute'
|
||
'pyparsing', 'appdirs',
|
||
)
|
||
|
||
# Are we using the default Python?
|
||
USING_DEFAULT_PYTHON = True
|
||
|
||
if not PIPENV_HIDE_EMOJIS:
|
||
now = time.localtime()
|
||
|
||
# Halloween easter-egg.
|
||
if ((now.tm_mon == 10) and (now.tm_day == 30)) or ((now.tm_mon == 10) and (now.tm_day == 31)):
|
||
INSTALL_LABEL = '🎃 '
|
||
|
||
# Christmas easter-egg.
|
||
elif ((now.tm_mon == 12) and (now.tm_day == 24)) or ((now.tm_mon == 12) and (now.tm_day == 25)):
|
||
INSTALL_LABEL = '🎅 '
|
||
|
||
else:
|
||
INSTALL_LABEL = '🐍 '
|
||
|
||
INSTALL_LABEL2 = crayons.normal('☤ ', bold=True)
|
||
STARTING_LABEL = ' '
|
||
else:
|
||
INSTALL_LABEL = ' '
|
||
INSTALL_LABEL2 = ' '
|
||
STARTING_LABEL = ' '
|
||
|
||
# Enable shell completion.
|
||
click_completion.init()
|
||
|
||
# Disable colors, for the soulless.
|
||
if PIPENV_COLORBLIND:
|
||
crayons.disable()
|
||
|
||
# Disable spinner, for cleaner build logs (the unworthy).
|
||
if PIPENV_NOSPIN:
|
||
@contextlib.contextmanager # noqa: F811
|
||
def spinner():
|
||
yield
|
||
|
||
# Disable warnings for Python 2.6.
|
||
urllib3.disable_warnings(InsecureRequestWarning)
|
||
|
||
project = Project()
|
||
|
||
|
||
def load_dot_env():
|
||
if not PIPENV_DONT_LOAD_ENV:
|
||
denv = dotenv.find_dotenv(PIPENV_DOTENV_LOCATION or os.sep.join([project.project_directory, '.env']))
|
||
if os.path.isfile(denv):
|
||
click.echo(crayons.normal('Loading .env environment variables…', bold=True), err=True)
|
||
dotenv.load_dotenv(denv, override=True)
|
||
|
||
|
||
def add_to_path(p):
|
||
"""Adds a given path to the PATH."""
|
||
if p not in os.environ['PATH']:
|
||
os.environ['PATH'] = '{0}{1}{2}'.format(p, os.pathsep, os.environ['PATH'])
|
||
|
||
|
||
@background.task
|
||
def check_for_updates():
|
||
"""Background thread -- beautiful, isn't it?"""
|
||
try:
|
||
r = requests.get('https://pypi.python.org/pypi/pipenv/json', timeout=0.5)
|
||
latest = sorted([semver.parse_version_info(v) for v in list(r.json()['releases'].keys())])[-1]
|
||
current = semver.parse_version_info(__version__)
|
||
|
||
if latest > current:
|
||
click.echo('{0}: {1} is now available. You get bonus points for upgrading ($ {})!'.format(
|
||
crayons.green('Courtesy Notice'),
|
||
crayons.yellow('Pipenv {v.major}.{v.minor}.{v.patch}'.format(v=latest)),
|
||
crayons.red('pipenv --update')
|
||
), err=True)
|
||
except Exception:
|
||
pass
|
||
|
||
|
||
def ensure_latest_self(user=False):
|
||
"""Updates Pipenv to latest version, cleverly."""
|
||
try:
|
||
r = requests.get('https://pypi.python.org/pypi/pipenv/json', timeout=2)
|
||
except requests.RequestException as e:
|
||
click.echo(crayons.red(e))
|
||
sys.exit(1)
|
||
latest = sorted([semver.parse_version_info(v) for v in list(r.json()['releases'].keys())])[-1]
|
||
current = semver.parse_version_info(__version__)
|
||
|
||
if current < latest:
|
||
|
||
import site
|
||
|
||
click.echo('{0}: {1} is now available. Automatically upgrading!'.format(
|
||
crayons.green('Courtesy Notice'),
|
||
crayons.yellow('Pipenv {v.major}.{v.minor}.{v.patch}'.format(v=latest)),
|
||
), err=True)
|
||
|
||
# Resolve user site, enable user mode automatically.
|
||
if site.ENABLE_USER_SITE and site.USER_SITE in sys.modules['pipenv'].__file__:
|
||
args = ['install', '--user', '--upgrade', 'pipenv', '--no-cache']
|
||
else:
|
||
args = ['install', '--upgrade', 'pipenv', '--no-cache']
|
||
|
||
sys.modules['pip'].main(args)
|
||
|
||
click.echo('{0} to {1}!'.format(
|
||
crayons.green('Pipenv updated'),
|
||
crayons.yellow('{v.major}.{v.minor}.{v.patch}'.format(v=latest))
|
||
))
|
||
else:
|
||
click.echo(crayons.green('All good!'))
|
||
|
||
|
||
def cleanup_virtualenv(bare=True):
|
||
"""Removes the virtualenv directory from the system."""
|
||
|
||
if not bare:
|
||
click.echo(crayons.red('Environment creation aborted.'))
|
||
|
||
try:
|
||
# Delete the virtualenv.
|
||
shutil.rmtree(project.virtualenv_location, ignore_errors=True)
|
||
except OSError as e:
|
||
click.echo(e)
|
||
|
||
|
||
def ensure_latest_pip():
|
||
"""Updates pip to the latest version."""
|
||
|
||
# Ensure that pip is installed.
|
||
try:
|
||
c = delegator.run('"{0}" install pip'.format(which_pip()))
|
||
|
||
# Check if version is out of date.
|
||
if 'however' in c.err:
|
||
# If version is out of date, update.
|
||
click.echo(crayons.normal(u'Pip is out of date… updating to latest.', bold=True))
|
||
|
||
windows = '-m' if os.name == 'nt' else ''
|
||
|
||
c = delegator.run('"{0}" install {1} pip --upgrade'.format(which_pip()), windows, block=False)
|
||
click.echo(crayons.blue(c.out))
|
||
except AttributeError:
|
||
pass
|
||
|
||
|
||
def import_requirements(r=None, dev=False):
|
||
# Parse requirements.txt file with Pip's parser.
|
||
# Pip requires a `PipSession` which is a subclass of requests.Session.
|
||
# Since we're not making any network calls, it's initialized to nothing.
|
||
|
||
if r:
|
||
assert os.path.isfile(r)
|
||
|
||
# Default path, if none is provided.
|
||
if r is None:
|
||
r = project.requirements_location
|
||
|
||
with open(r, 'r') as f:
|
||
contents = f.read()
|
||
|
||
indexes = []
|
||
# Find and add extra indexes.
|
||
for line in contents.split('\n'):
|
||
if line.startswith(('-i ', '--index ')):
|
||
indexes.append(line.split()[1])
|
||
|
||
reqs = [f for f in parse_requirements(r, session=pip._vendor.requests)]
|
||
|
||
for package in reqs:
|
||
if package.name not in BAD_PACKAGES:
|
||
if package.link is not None:
|
||
package_string = (
|
||
'-e {0}'.format(
|
||
package.link
|
||
) if package.editable else str(package.link)
|
||
)
|
||
project.add_package_to_pipfile(package_string, dev=dev)
|
||
else:
|
||
project.add_package_to_pipfile(str(package.req), dev=dev)
|
||
|
||
for index in indexes:
|
||
project.add_index_to_pipfile(index)
|
||
|
||
project.recase_pipfile()
|
||
|
||
|
||
def ensure_environment():
|
||
# Skip this on Windows...
|
||
if os.name != 'nt':
|
||
if 'LANG' not in os.environ:
|
||
click.echo(
|
||
'{0}: the environment variable {1} is not set!'
|
||
'\nWe recommend setting this in {2} (or equivalent) for '
|
||
'proper expected behavior.'.format(
|
||
crayons.red('Warning', bold=True),
|
||
crayons.normal('LANG', bold=True),
|
||
crayons.green('~/.profile')
|
||
), err=True
|
||
)
|
||
|
||
|
||
def import_from_code(path='.'):
|
||
rs = []
|
||
try:
|
||
for r in pipreqs.get_all_imports(path):
|
||
if r not in BAD_PACKAGES:
|
||
rs.append(r)
|
||
return [proper_case(r) for r in rs]
|
||
except Exception:
|
||
return []
|
||
|
||
|
||
def ensure_pipfile(validate=True):
|
||
"""Creates a Pipfile for the project, if it doesn't exist."""
|
||
|
||
global USING_DEFAULT_PYTHON
|
||
|
||
# Assert Pipfile exists.
|
||
if project.pipfile_is_empty:
|
||
|
||
# If there's a requirements file, but no Pipfile...
|
||
if project.requirements_exists:
|
||
click.echo(crayons.normal(u'Requirements.txt found, instead of Pipfile! Converting…', bold=True))
|
||
|
||
# Create a Pipfile...
|
||
python = which('python') if not USING_DEFAULT_PYTHON else False
|
||
project.create_pipfile(python=python)
|
||
|
||
with spinner():
|
||
# Import requirements.txt.
|
||
import_requirements()
|
||
|
||
# Warn the user of side-effects.
|
||
click.echo(
|
||
u'{0}: Your {1} now contains pinned versions, if your {2} did. \n'
|
||
'We recommend updating your {1} to specify the {3} version, instead.'
|
||
''.format(
|
||
crayons.red('Warning', bold=True),
|
||
crayons.normal('Pipfile', bold=True),
|
||
crayons.normal('requirements.txt', bold=True),
|
||
crayons.normal('"*"', bold=True)
|
||
)
|
||
)
|
||
|
||
else:
|
||
click.echo(crayons.normal(u'Creating a Pipfile for this project…', bold=True), err=True)
|
||
|
||
# Create the pipfile if it doesn't exist.
|
||
python = which('python') if not USING_DEFAULT_PYTHON else False
|
||
project.create_pipfile(python=python)
|
||
|
||
# Validate the Pipfile's contents.
|
||
if validate and project.virtualenv_exists and not PIPENV_SKIP_VALIDATION:
|
||
# Ensure that Pipfile is using proper casing.
|
||
p = project.parsed_pipfile
|
||
changed = ensure_proper_casing(pfile=p)
|
||
|
||
# Write changes out to disk.
|
||
if changed:
|
||
click.echo(crayons.normal(u'Fixing package names in Pipfile…', bold=True), err=True)
|
||
project.write_toml(p)
|
||
|
||
|
||
def find_a_system_python(python):
|
||
"""Finds a system python, given a version (e.g. 2 / 2.7 / 3.6.2), or a full path."""
|
||
if python.startswith('py'):
|
||
return system_which(python)
|
||
elif os.path.isabs(python):
|
||
return python
|
||
else:
|
||
possibilities = [
|
||
'python',
|
||
'python{0}'.format(python[0]),
|
||
]
|
||
if len(python) >= 2:
|
||
possibilities.extend(
|
||
[
|
||
'python{0}{1}'.format(python[0], python[2]),
|
||
'python{0}.{1}'.format(python[0], python[2]),
|
||
'python{0}.{1}m'.format(python[0], python[2])
|
||
]
|
||
)
|
||
|
||
# Reverse the list, so we find specific ones first.
|
||
possibilities = reversed(possibilities)
|
||
|
||
for possibility in possibilities:
|
||
# Windows compatibility.
|
||
if os.name == 'nt':
|
||
possibility = '{0}.exe'.format(possibility)
|
||
|
||
pythons = system_which(possibility, mult=True)
|
||
|
||
for p in pythons:
|
||
version = python_version(p)
|
||
if (version or '').startswith(python):
|
||
return p
|
||
|
||
|
||
def ensure_python(three=None, python=None):
|
||
|
||
def abort():
|
||
click.echo(
|
||
'You can specify specific versions of Python with:\n {0}'.format(
|
||
crayons.red('$ pipenv --python {0}'.format(os.sep.join(('path', 'to', 'python'))))
|
||
), err=True
|
||
)
|
||
sys.exit(1)
|
||
|
||
def activate_pyenv():
|
||
"""Adds all pyenv installations to the PATH."""
|
||
if PYENV_INSTALLED:
|
||
if PYENV_ROOT:
|
||
for found in glob(
|
||
'{0}{1}versions{1}*{1}bin'.format(
|
||
PYENV_ROOT,
|
||
os.sep
|
||
)
|
||
):
|
||
add_to_path(found)
|
||
else:
|
||
click.echo(
|
||
'{0}: PYENV_ROOT is not set. New python paths will '
|
||
'probably not be exported properly after installation.'
|
||
''.format(
|
||
crayons.red('Warning', bold=True),
|
||
), err=True
|
||
)
|
||
|
||
|
||
global USING_DEFAULT_PYTHON
|
||
|
||
# Add pyenv paths to PATH.
|
||
activate_pyenv()
|
||
|
||
path_to_python = None
|
||
USING_DEFAULT_PYTHON = (three is None and not python)
|
||
|
||
# Find out which python is desired.
|
||
if not python:
|
||
python = convert_three_to_python(three, python)
|
||
|
||
if not python:
|
||
python = project.required_python_version
|
||
|
||
if not python:
|
||
python = PIPENV_DEFAULT_PYTHON_VERSION
|
||
|
||
if python:
|
||
path_to_python = find_a_system_python(python)
|
||
|
||
if not path_to_python and python is not None:
|
||
# We need to install Python.
|
||
click.echo(
|
||
u'{0}: Python {1} {2}'.format(
|
||
crayons.red('Warning', bold=True),
|
||
crayons.blue(python),
|
||
u'was not found on your system…',
|
||
), err=True
|
||
)
|
||
# Pyenv is installed
|
||
if not PYENV_INSTALLED:
|
||
abort()
|
||
else:
|
||
if (not PIPENV_DONT_USE_PYENV) and (SESSION_IS_INTERACTIVE):
|
||
version_map = {
|
||
# TODO: Keep this up to date!
|
||
# These versions appear incompatible with pew:
|
||
# '2.5': '2.5.6',
|
||
'2.6': '2.6.9',
|
||
'2.7': '2.7.13',
|
||
# '3.1': '3.1.5',
|
||
# '3.2': '3.2.6',
|
||
'3.3': '3.3.6',
|
||
'3.4': '3.4.7',
|
||
'3.5': '3.5.4',
|
||
'3.6': '3.6.2',
|
||
}
|
||
try:
|
||
if len(python.split('.')) == 2:
|
||
# Find the latest version of Python available.
|
||
|
||
version = version_map[python]
|
||
else:
|
||
version = python
|
||
except KeyError:
|
||
abort()
|
||
|
||
s = (
|
||
'{0} {1} {2}'.format(
|
||
'Would you like us to install',
|
||
crayons.green('CPython {0}'.format(version)),
|
||
'with pyenv?'
|
||
)
|
||
)
|
||
|
||
# Prompt the user to continue...
|
||
if not (PIPENV_YES or click.confirm(s, default=True)):
|
||
abort()
|
||
else:
|
||
|
||
# Tell the user we're installing Python.
|
||
click.echo(
|
||
u'{0} {1} {2} {3}{4}'.format(
|
||
crayons.normal(u'Installing', bold=True),
|
||
crayons.green(u'CPython {0}'.format(version), bold=True),
|
||
crayons.normal(u'with pyenv', bold=True),
|
||
crayons.normal(u'(this may take a few minutes)'),
|
||
crayons.normal(u'…', bold=True)
|
||
)
|
||
)
|
||
|
||
with spinner():
|
||
# Install Python.
|
||
c = delegator.run(
|
||
'pyenv install {0} -s'.format(version),
|
||
timeout=PIPENV_INSTALL_TIMEOUT,
|
||
block=False
|
||
)
|
||
|
||
# Wait until the process has finished...
|
||
c.block()
|
||
|
||
try:
|
||
assert c.return_code == 0
|
||
except AssertionError:
|
||
click.echo(u'Something went wrong…')
|
||
click.echo(crayons.blue(c.err), err=True)
|
||
|
||
# Print the results, in a beautiful blue...
|
||
click.echo(crayons.blue(c.out), err=True)
|
||
|
||
# Add new paths to PATH.
|
||
activate_pyenv()
|
||
|
||
# Find the newly installed Python, hopefully.
|
||
path_to_python = find_a_system_python(version)
|
||
|
||
try:
|
||
assert python_version(path_to_python) == version
|
||
except AssertionError:
|
||
click.echo(
|
||
'{0}: The Python you just installed is not available on your {1}, apparently.'
|
||
''.format(
|
||
crayons.red('Warning', bold=True),
|
||
crayons.normal('PATH', bold=True)
|
||
), err=True
|
||
)
|
||
|
||
return path_to_python
|
||
|
||
|
||
def ensure_virtualenv(three=None, python=None, site_packages=False):
|
||
"""Creates a virtualenv, if one doesn't exist."""
|
||
|
||
global USING_DEFAULT_PYTHON
|
||
|
||
if not project.virtualenv_exists:
|
||
try:
|
||
# Ensure environment variables are set properly.
|
||
ensure_environment()
|
||
|
||
# Ensure Python is available.
|
||
python = ensure_python(three=three, python=python)
|
||
|
||
# Create the virtualenv.
|
||
# Abort if --system (or running in a virtualenv).
|
||
if PIPENV_USE_SYSTEM:
|
||
click.echo(
|
||
crayons.red(
|
||
'You are attempting to re-create a virtualenv that '
|
||
'Pipenv did not create. Aborting.'
|
||
)
|
||
)
|
||
sys.exit(1)
|
||
do_create_virtualenv(python=python, site_packages=site_packages)
|
||
|
||
except KeyboardInterrupt:
|
||
# If interrupted, cleanup the virtualenv.
|
||
cleanup_virtualenv(bare=False)
|
||
sys.exit(1)
|
||
|
||
# If --three, --two, or --python were passed...
|
||
elif (python) or (three is not None) or (site_packages is not False):
|
||
click.echo(crayons.red('Virtualenv already exists!'), err=True)
|
||
click.echo(crayons.normal(u'Removing existing virtualenv…', bold=True), err=True)
|
||
|
||
USING_DEFAULT_PYTHON = False
|
||
|
||
# Remove the virtualenv.
|
||
cleanup_virtualenv(bare=True)
|
||
|
||
# Call this function again.
|
||
ensure_virtualenv(three=three, python=python, site_packages=site_packages)
|
||
|
||
|
||
def ensure_project(three=None, python=None, validate=True, system=False, warn=True, site_packages=False):
|
||
"""Ensures both Pipfile and virtualenv exist for the project."""
|
||
|
||
if not project.pipfile_exists:
|
||
project.touch_pipfile()
|
||
|
||
# Skip virtualenv creation when --system was used.
|
||
if not system:
|
||
ensure_virtualenv(three=three, python=python, site_packages=site_packages)
|
||
|
||
if warn:
|
||
# Warn users if they are using the wrong version of Python.
|
||
if project.required_python_version:
|
||
|
||
path_to_python = which('python')
|
||
|
||
if project.required_python_version not in (python_version(path_to_python) or ''):
|
||
click.echo(
|
||
'{0}: Your Pipfile requires {1} {2}, '
|
||
'but you are using {3} ({4}).'.format(
|
||
crayons.red('Warning', bold=True),
|
||
crayons.normal('python_version', bold=True),
|
||
crayons.blue(project.required_python_version),
|
||
crayons.blue(python_version(path_to_python)),
|
||
crayons.green(shorten_path(path_to_python))
|
||
), err=True
|
||
)
|
||
# if not project.lockfile_exists:
|
||
# click.echo('Pipfile.lock does not exist. Aborting.')
|
||
# sys.exit(1)
|
||
click.echo(
|
||
' {0} will surely fail.'
|
||
''.format(crayons.red('$ pipenv check')),
|
||
err=True
|
||
)
|
||
|
||
# Ensure the Pipfile exists.
|
||
ensure_pipfile(validate=validate)
|
||
|
||
|
||
def ensure_proper_casing(pfile):
|
||
"""Ensures proper casing of Pipfile packages, writes changes to disk."""
|
||
|
||
casing_changed = proper_case_section(pfile.get('packages', {}))
|
||
casing_changed |= proper_case_section(pfile.get('dev-packages', {}))
|
||
|
||
return casing_changed
|
||
|
||
|
||
def proper_case_section(section):
|
||
"""Verify proper casing is retrieved, when available, for each
|
||
dependency in the section.
|
||
"""
|
||
|
||
# Casing for section.
|
||
changed_values = False
|
||
unknown_names = [k for k in section.keys() if k not in set(project.proper_names)]
|
||
|
||
# Replace each package with proper casing.
|
||
for dep in unknown_names:
|
||
try:
|
||
# Get new casing for package name.
|
||
new_casing = proper_case(dep)
|
||
except IOError:
|
||
# Unable to normalize package name.
|
||
continue
|
||
|
||
if new_casing != dep:
|
||
changed_values = True
|
||
project.register_proper_name(new_casing)
|
||
|
||
# Replace old value with new value.
|
||
old_value = section[dep]
|
||
section[new_casing] = old_value
|
||
del section[dep]
|
||
|
||
# Return whether or not values have been changed.
|
||
return changed_values
|
||
|
||
|
||
def shorten_path(location, bold=False):
|
||
"""Returns a visually shorter representation of a given system path."""
|
||
original = location
|
||
short = os.sep.join([s[0] if len(s) > (len('2long4')) else s for s in location.split(os.sep)])
|
||
short = short.split(os.sep)
|
||
short[-1] = original.split(os.sep)[-1]
|
||
if bold:
|
||
short[-1] = str(crayons.normal(short[-1], bold=True))
|
||
|
||
return os.sep.join(short)
|
||
# return short
|
||
|
||
|
||
def do_where(virtualenv=False, bare=True):
|
||
"""Executes the where functionality."""
|
||
|
||
if not virtualenv:
|
||
location = project.pipfile_location
|
||
|
||
# Shorten the virtual display of the path to the virtualenv.
|
||
if not bare:
|
||
location = shorten_path(location)
|
||
|
||
if not location:
|
||
click.echo(
|
||
'No Pipfile present at project home. Consider running '
|
||
'{0} first to automatically generate a Pipfile for you.'
|
||
''.format(crayons.green('`pipenv install`')), err=True)
|
||
elif not bare:
|
||
click.echo(
|
||
'Pipfile found at {0}.\n Considering this to be the project home.'
|
||
''.format(crayons.green(location)), err=True)
|
||
pass
|
||
else:
|
||
click.echo(project.project_directory)
|
||
|
||
else:
|
||
location = project.virtualenv_location
|
||
|
||
if not bare:
|
||
click.echo('Virtualenv location: {0}'.format(crayons.green(location)), err=True)
|
||
else:
|
||
click.echo(location)
|
||
|
||
|
||
def do_install_dependencies(
|
||
dev=False, only=False, bare=False, requirements=False, allow_global=False,
|
||
ignore_hashes=False, skip_lock=False, verbose=False, concurrent=True
|
||
):
|
||
""""Executes the install functionality."""
|
||
|
||
def cleanup_procs(procs, concurrent):
|
||
for c in procs:
|
||
|
||
if concurrent:
|
||
c.block()
|
||
|
||
if 'Ignoring' in c.out:
|
||
click.echo(crayons.yellow(c.out))
|
||
|
||
if verbose:
|
||
click.echo(crayons.blue(c.out or c.err))
|
||
|
||
# The Installation failed...
|
||
if c.return_code != 0:
|
||
|
||
# Save the Failed Dependency for later.
|
||
failed_deps_list.append((c.dep, c.ignore_hash))
|
||
|
||
# Alert the user.
|
||
click.echo(
|
||
'{0} {1}! Will try again.'.format(
|
||
crayons.red('An error occurred while installing'),
|
||
crayons.green(c.dep.split('--hash')[0].strip())
|
||
)
|
||
)
|
||
|
||
if requirements:
|
||
bare = True
|
||
|
||
blocking = (not concurrent)
|
||
|
||
# Load the lockfile if it exists, or if only is being used (e.g. lock is being used).
|
||
if skip_lock or only or not project.lockfile_exists:
|
||
if not bare:
|
||
click.echo(crayons.normal(u'Installing dependencies from Pipfile…', bold=True))
|
||
lockfile = split_vcs(project._lockfile)
|
||
else:
|
||
if not bare:
|
||
click.echo(crayons.normal(u'Installing dependencies from Pipfile.lock…', bold=True))
|
||
with open(project.lockfile_location) as f:
|
||
lockfile = split_vcs(simplejson.load(f))
|
||
|
||
# Allow pip to resolve dependencies when in skip-lock mode.
|
||
no_deps = (not skip_lock)
|
||
|
||
deps = {}
|
||
vcs_deps = {}
|
||
|
||
# Add development deps if --dev was passed.
|
||
if dev:
|
||
deps.update(lockfile['develop'])
|
||
vcs_deps.update(lockfile.get('develop-vcs', {}))
|
||
|
||
# Install default dependencies, always.
|
||
deps.update(lockfile['default'] if not only else {})
|
||
vcs_deps.update(lockfile.get('default-vcs', {}))
|
||
|
||
if ignore_hashes:
|
||
# Remove hashes from generated requirements.
|
||
for k, v in deps.items():
|
||
if 'hash' in v:
|
||
del v['hash']
|
||
|
||
# Convert the deps to pip-compatible arguments.
|
||
deps_list = [(d, ignore_hashes) for d in convert_deps_to_pip(deps, project, r=False, include_index=True)]
|
||
failed_deps_list = []
|
||
|
||
if len(vcs_deps):
|
||
deps_list.extend((d, True) for d in convert_deps_to_pip(vcs_deps, project, r=False))
|
||
|
||
# --requirements was passed.
|
||
if requirements:
|
||
click.echo('\n'.join(d[0] for d in deps_list))
|
||
sys.exit(0)
|
||
|
||
procs = []
|
||
|
||
deps_list_bar = progress.bar(deps_list, label=INSTALL_LABEL if os.name != 'nt' else '')
|
||
|
||
for dep, ignore_hash in deps_list_bar:
|
||
if len(procs) < PIPENV_MAX_SUBPROCESS:
|
||
# Use a specific index, if specified.
|
||
index = None
|
||
if ' -i ' in dep:
|
||
dep, index = dep.split(' -i ')
|
||
dep = '{0} {1}'.format(dep, ' '.join(index.split()[1:])).strip()
|
||
index = index.split()[0]
|
||
|
||
# Install the module.
|
||
c = pip_install(
|
||
dep,
|
||
ignore_hashes=ignore_hash,
|
||
allow_global=allow_global,
|
||
no_deps=no_deps,
|
||
verbose=verbose,
|
||
block=blocking,
|
||
index=index
|
||
)
|
||
|
||
c.dep = dep
|
||
c.ignore_hash = ignore_hash
|
||
|
||
procs.append(c)
|
||
|
||
if len(procs) >= PIPENV_MAX_SUBPROCESS or len(procs) == len(deps_list):
|
||
cleanup_procs(procs, concurrent)
|
||
procs = []
|
||
|
||
cleanup_procs(procs, concurrent)
|
||
|
||
# Iterate over the hopefully-poorly-packaged dependencies...
|
||
if failed_deps_list:
|
||
|
||
click.echo(crayons.normal(u'Installing initially–failed dependencies…', bold=True))
|
||
|
||
for dep, ignore_hash in progress.bar(failed_deps_list, label=INSTALL_LABEL2):
|
||
index = None
|
||
if ' -i ' in dep:
|
||
dep, index = dep.split(' -i ')
|
||
dep = '{0} {1}'.format(dep, ' '.join(index.split()[1:])).strip()
|
||
index = index.split()[0]
|
||
|
||
# Install the module.
|
||
c = pip_install(
|
||
dep,
|
||
ignore_hashes=ignore_hash,
|
||
allow_global=allow_global,
|
||
no_deps=no_deps,
|
||
verbose=verbose,
|
||
index=index
|
||
)
|
||
|
||
# The Installation failed...
|
||
if c.return_code != 0:
|
||
|
||
# We echo both c.out and c.err because pip returns error details on out.
|
||
click.echo(crayons.blue(format_pip_output(c.out)))
|
||
click.echo(crayons.blue(format_pip_error(c.err)), err=True)
|
||
|
||
# Return the subprocess' return code.
|
||
sys.exit(c.return_code)
|
||
else:
|
||
click.echo('{0} {1}{2}'.format(
|
||
crayons.green('Success installing'),
|
||
crayons.green(dep.split('--hash')[0].strip()),
|
||
crayons.green('!')
|
||
))
|
||
|
||
|
||
def convert_three_to_python(three, python):
|
||
"""Converts a Three flag into a Python flag, and raises customer warnings
|
||
in the process, if needed.
|
||
"""
|
||
|
||
if not python:
|
||
if three is False:
|
||
return '2'
|
||
|
||
elif three is True:
|
||
return '3'
|
||
else:
|
||
return python
|
||
|
||
|
||
def do_create_virtualenv(python=None, site_packages=False):
|
||
"""Creates a virtualenv."""
|
||
|
||
click.echo(crayons.normal(u'Creating a virtualenv for this project…', bold=True), err=True)
|
||
|
||
# The user wants the virtualenv in the project.
|
||
if PIPENV_VENV_IN_PROJECT:
|
||
cmd = ['virtualenv', project.virtualenv_location, '--prompt=({0})'.format(project.name)]
|
||
|
||
# Pass site-packages flag to virtualenv, if desired...
|
||
if site_packages:
|
||
cmd = [cmd] + ['--system-site-packages']
|
||
else:
|
||
# Default: use pew.
|
||
cmd = ['pew', 'new', project.virtualenv_name, '-d']
|
||
|
||
# Pass a Python version to virtualenv, if needed.
|
||
if python:
|
||
click.echo(u'{0} {1} {2}'.format(
|
||
crayons.normal('Using', bold=True),
|
||
crayons.red(python, bold=True),
|
||
crayons.normal(u'to create virtualenv…', bold=True)
|
||
))
|
||
|
||
# Use virtualenv's -p python.
|
||
if python:
|
||
cmd = cmd + ['-p', python]
|
||
|
||
# Actually create the virtualenv.
|
||
with spinner():
|
||
try:
|
||
c = delegator.run(cmd, block=False, timeout=PIPENV_TIMEOUT)
|
||
except OSError:
|
||
click.echo(
|
||
'{0}: it looks like {1} is not in your {2}. '
|
||
'We cannot continue until this is resolved.'
|
||
''.format(
|
||
crayons.red('Warning', bold=True),
|
||
crayons.red(cmd[0]),
|
||
crayons.normal('PATH', bold=True)
|
||
), err=True
|
||
)
|
||
sys.exit(1)
|
||
|
||
click.echo(crayons.blue(c.out), err=True)
|
||
|
||
# Enable site-packages, if desired...
|
||
if not PIPENV_VENV_IN_PROJECT and site_packages:
|
||
|
||
click.echo(crayons.normal(u'Making site-packages available…', bold=True), err=True)
|
||
|
||
os.environ['VIRTUAL_ENV'] = project.virtualenv_location
|
||
delegator.run('pipenv run pew toggleglobalsitepackages')
|
||
del os.environ['VIRTUAL_ENV']
|
||
|
||
# Say where the virtualenv is.
|
||
do_where(virtualenv=True, bare=False)
|
||
|
||
|
||
def parse_download_fname(fname, name):
|
||
fname, fextension = os.path.splitext(fname)
|
||
|
||
if fextension == '.whl':
|
||
fname = '-'.join(fname.split('-')[:-3])
|
||
|
||
if fname.endswith('.tar'):
|
||
fname, _ = os.path.splitext(fname)
|
||
|
||
# Substring out package name (plus dash) from file name to get version.
|
||
version = fname[len(name) + 1:]
|
||
|
||
# Ignore implicit post releases in version number.
|
||
if '-' in version and version.split('-')[1].isdigit():
|
||
version = version.split('-')[0]
|
||
|
||
return version
|
||
|
||
|
||
def get_downloads_info(names_map, section):
|
||
info = []
|
||
|
||
p = project.parsed_pipfile
|
||
|
||
for fname in os.listdir(project.download_location):
|
||
# Get name from filename mapping.
|
||
name = list(convert_deps_from_pip(names_map[fname]))[0]
|
||
# Get the version info from the filenames.
|
||
version = parse_download_fname(fname, name)
|
||
|
||
# Get the hash of each file.
|
||
cmd = '"{0}" hash "{1}"'.format(
|
||
which_pip(),
|
||
os.sep.join([project.download_location, fname])
|
||
)
|
||
|
||
c = delegator.run(cmd)
|
||
hash = c.out.split('--hash=')[1].strip()
|
||
|
||
# Verify we're adding the correct version from Pipfile
|
||
# and not one from a dependency.
|
||
specified_version = p[section].get(name, '')
|
||
if is_required_version(version, specified_version):
|
||
info.append(dict(name=name, version=version, hash=hash))
|
||
|
||
return info
|
||
|
||
|
||
def do_lock(verbose=False, system=False, clear=False, pre=False):
|
||
"""Executes the freeze functionality."""
|
||
|
||
project.destroy_lockfile()
|
||
|
||
# Alert the user of progress.
|
||
click.echo(
|
||
u'{0} {1} {2}'.format(
|
||
crayons.normal('Locking'),
|
||
crayons.red('[dev-packages]'),
|
||
crayons.normal('dependencies…')
|
||
),
|
||
err=True
|
||
)
|
||
|
||
# Create the lockfile.
|
||
lockfile = project._lockfile
|
||
|
||
# Cleanup lockfile.
|
||
for section in ('default', 'develop'):
|
||
for k, v in lockfile[section].copy().items():
|
||
if not hasattr(v, 'keys'):
|
||
del lockfile[section][k]
|
||
|
||
# Resolve dev-package dependencies, with pip-tools.
|
||
deps = convert_deps_to_pip(project.dev_packages, project, r=False, include_index=True)
|
||
results = resolve_deps(
|
||
deps,
|
||
sources=project.sources,
|
||
verbose=verbose,
|
||
python=python_version(which('python', allow_global=system)),
|
||
clear=clear,
|
||
which=which,
|
||
which_pip=which_pip,
|
||
project=project,
|
||
pre=pre
|
||
)
|
||
|
||
# Add develop dependencies to lockfile.
|
||
for dep in results:
|
||
# Add version information to lockfile.
|
||
lockfile['develop'].update({dep['name']: {'version': '=={0}'.format(dep['version'])}})
|
||
|
||
# Add Hashes to lockfile
|
||
lockfile['develop'][dep['name']]['hashes'] = dep['hashes']
|
||
|
||
# Add index metadata to lockfile.
|
||
if 'index' in dep:
|
||
lockfile['develop'][dep['name']]['index'] = dep['index']
|
||
|
||
# Add PEP 508 specifier metadata to lockfile.
|
||
if 'markers' in dep:
|
||
lockfile['develop'][dep['name']]['markers'] = dep['markers']
|
||
|
||
# Add refs for VCS installs.
|
||
# TODO: be smarter about this.
|
||
vcs_deps = convert_deps_to_pip(project.vcs_dev_packages, project, r=False)
|
||
pip_freeze = delegator.run('{0} freeze'.format(which_pip())).out
|
||
|
||
for dep in vcs_deps:
|
||
for line in pip_freeze.strip().split('\n'):
|
||
try:
|
||
installed = convert_deps_from_pip(line)
|
||
name = list(installed.keys())[0]
|
||
|
||
if is_vcs(installed[name]):
|
||
lockfile['develop'].update(installed)
|
||
|
||
except IndexError:
|
||
pass
|
||
|
||
# Alert the user of progress.
|
||
click.echo(
|
||
u'{0} {1} {2}'.format(
|
||
crayons.normal('Locking'),
|
||
crayons.red('[packages]'),
|
||
crayons.normal('dependencies…')
|
||
),
|
||
err=True
|
||
)
|
||
|
||
# Resolve package dependencies, with pip-tools.
|
||
deps = convert_deps_to_pip(project.packages, project, r=False, include_index=True)
|
||
results = resolve_deps(
|
||
deps,
|
||
sources=project.sources,
|
||
verbose=verbose,
|
||
python=python_version(which('python', allow_global=system)),
|
||
which=which,
|
||
which_pip=which_pip,
|
||
project=project,
|
||
pre=pre
|
||
)
|
||
|
||
# Add default dependencies to lockfile.
|
||
for dep in results:
|
||
# Add version information to lockfile.
|
||
lockfile['default'].update({dep['name']: {'version': '=={0}'.format(dep['version'])}})
|
||
|
||
# Add Hashes to lockfile
|
||
lockfile['default'][dep['name']]['hashes'] = dep['hashes']
|
||
|
||
# Add index metadata to lockfile.
|
||
if 'index' in dep:
|
||
lockfile['default'][dep['name']]['index'] = dep['index']
|
||
|
||
# Add PEP 508 specifier metadata to lockfile.
|
||
if 'markers' in dep:
|
||
lockfile['default'][dep['name']]['markers'] = dep['markers']
|
||
|
||
# Add refs for VCS installs.
|
||
# TODO: be smarter about this.
|
||
vcs_deps = convert_deps_to_pip(project.vcs_packages, project, r=False)
|
||
pip_freeze = delegator.run('{0} freeze'.format(which_pip())).out
|
||
|
||
for dep in vcs_deps:
|
||
for line in pip_freeze.strip().split('\n'):
|
||
try:
|
||
installed = convert_deps_from_pip(line)
|
||
name = list(installed.keys())[0]
|
||
|
||
if is_vcs(installed[name]):
|
||
# Convert name to PEP 432 name.
|
||
installed = {pep423_name(name): installed[name]}
|
||
|
||
lockfile['default'].update(installed)
|
||
except IndexError:
|
||
pass
|
||
|
||
# Run the PEP 508 checker in the virtualenv, add it to the lockfile.
|
||
cmd = '"{0}" {1}'.format(which('python', allow_global=system), shellquote(pep508checker.__file__.rstrip('cdo')))
|
||
c = delegator.run(cmd)
|
||
lockfile['_meta']['host-environment-markers'] = simplejson.loads(c.out)
|
||
|
||
# Write out the lockfile.
|
||
with open(project.lockfile_location, 'w') as f:
|
||
simplejson.dump(lockfile, f, indent=4, separators=(',', ': '), sort_keys=True)
|
||
# Write newline at end of document. GH Issue #319.
|
||
f.write('\n')
|
||
|
||
click.echo('{0}'.format(crayons.normal('Updated Pipfile.lock!', bold=True)), err=True)
|
||
|
||
|
||
def activate_virtualenv(source=True):
|
||
"""Returns the string to activate a virtualenv."""
|
||
|
||
# Suffix for other shells.
|
||
suffix = ''
|
||
|
||
# Support for fish shell.
|
||
if 'fish' in PIPENV_SHELL:
|
||
suffix = '.fish'
|
||
|
||
# Support for csh shell.
|
||
if 'csh' in PIPENV_SHELL:
|
||
suffix = '.csh'
|
||
|
||
# Escape any spaces located within the virtualenv path to allow
|
||
# for proper activation.
|
||
venv_location = project.virtualenv_location.replace(' ', r'\ ')
|
||
|
||
if source:
|
||
return 'source {0}/bin/activate{1}'.format(venv_location, suffix)
|
||
else:
|
||
return '{0}/bin/activate'.format(venv_location)
|
||
|
||
|
||
def do_activate_virtualenv(bare=False):
|
||
"""Executes the activate virtualenv functionality."""
|
||
# Check for environment marker, and skip if it's set.
|
||
if 'PIPENV_ACTIVE' not in os.environ:
|
||
if not bare:
|
||
click.echo('To activate this project\'s virtualenv, run the following:\n $ {0}'.format(
|
||
crayons.red('pipenv shell'))
|
||
)
|
||
else:
|
||
click.echo(activate_virtualenv())
|
||
|
||
|
||
def do_purge(bare=False, downloads=False, allow_global=False, verbose=False):
|
||
"""Executes the purge functionality."""
|
||
|
||
if downloads:
|
||
if not bare:
|
||
click.echo(crayons.normal(u'Clearing out downloads directory…', bold=True))
|
||
shutil.rmtree(project.download_location)
|
||
return
|
||
|
||
freeze = delegator.run('"{0}" freeze'.format(which_pip(allow_global=allow_global))).out
|
||
installed = freeze.split()
|
||
|
||
# Remove setuptools and friends from installed, if present.
|
||
for package_name in BAD_PACKAGES:
|
||
for i, package in enumerate(installed):
|
||
if package.startswith(package_name):
|
||
del installed[i]
|
||
|
||
actually_installed = []
|
||
|
||
for package in installed:
|
||
try:
|
||
dep = convert_deps_from_pip(package)
|
||
except AssertionError:
|
||
dep = None
|
||
|
||
if dep and not is_vcs(dep):
|
||
|
||
dep = [k for k in dep.keys()][0]
|
||
# TODO: make this smarter later.
|
||
if not dep.startswith('-e ') and not dep.startswith('git+'):
|
||
actually_installed.append(dep)
|
||
|
||
if not bare:
|
||
click.echo(u'Found {0} installed package(s), purging…'.format(len(actually_installed)))
|
||
command = '"{0}" uninstall {1} -y'.format(which_pip(allow_global=allow_global), ' '.join(actually_installed))
|
||
|
||
if verbose:
|
||
click.echo('$ {0}'.format(command))
|
||
|
||
c = delegator.run(command)
|
||
|
||
if not bare:
|
||
click.echo(crayons.blue(c.out))
|
||
click.echo(crayons.green('Environment now purged and fresh!'))
|
||
|
||
|
||
def do_init(
|
||
dev=False, requirements=False, allow_global=False, ignore_pipfile=False,
|
||
skip_lock=False, verbose=False, system=False, concurrent=True, deploy=False
|
||
):
|
||
"""Executes the init functionality."""
|
||
|
||
if not system:
|
||
if not project.virtualenv_exists:
|
||
try:
|
||
do_create_virtualenv()
|
||
except KeyboardInterrupt:
|
||
cleanup_virtualenv(bare=False)
|
||
sys.exit(1)
|
||
|
||
# Ensure the Pipfile exists.
|
||
ensure_pipfile()
|
||
|
||
# Write out the lockfile if it doesn't exist, but not if the Pipfile is being ignored
|
||
if (project.lockfile_exists and not ignore_pipfile) and not skip_lock:
|
||
|
||
# Open the lockfile.
|
||
with codecs.open(project.lockfile_location, 'r') as f:
|
||
lockfile = simplejson.load(f)
|
||
|
||
# Update the lockfile if it is out-of-date.
|
||
p = pipfile.load(project.pipfile_location)
|
||
|
||
# Check that the hash of the Lockfile matches the lockfile's hash.
|
||
if not lockfile['_meta'].get('hash', {}).get('sha256') == p.hash:
|
||
if deploy:
|
||
click.echo(crayons.red('Your Pipfile.lock is out of date. Aborting deploy.'))
|
||
sys.exit(1)
|
||
else:
|
||
click.echo(crayons.red(u'Pipfile.lock out of date, updating…', bold=True), err=True)
|
||
|
||
do_lock(system=system)
|
||
|
||
# Write out the lockfile if it doesn't exist.
|
||
if not project.lockfile_exists and not skip_lock:
|
||
click.echo(crayons.normal(u'Pipfile.lock not found, creating…', bold=True), err=True)
|
||
do_lock(system=system)
|
||
|
||
do_install_dependencies(dev=dev, requirements=requirements, allow_global=allow_global,
|
||
skip_lock=skip_lock, verbose=verbose, concurrent=concurrent)
|
||
|
||
# Activate virtualenv instructions.
|
||
if not allow_global:
|
||
do_activate_virtualenv()
|
||
|
||
|
||
def pip_install(
|
||
package_name=None, r=None, allow_global=False, ignore_hashes=False,
|
||
no_deps=True, verbose=False, block=True, index=None, pre=False
|
||
):
|
||
|
||
if verbose:
|
||
click.echo(crayons.normal('Installing {0!r}'.format(package_name), bold=True), err=True)
|
||
|
||
# Create files for hash mode.
|
||
if (not ignore_hashes) and (r is None):
|
||
r = tempfile.mkstemp(prefix='pipenv-', suffix='-requirement.txt')[1]
|
||
with open(r, 'w') as f:
|
||
f.write(package_name)
|
||
|
||
# Install dependencies when a package is a VCS dependency.
|
||
if [x for x in requirements.parse(package_name.split('--hash')[0].split('--trusted-host')[0])][0].vcs:
|
||
no_deps = False
|
||
|
||
# Don't specify a source directory when using --system.
|
||
if not allow_global:
|
||
src = '--src {0}'.format(project.virtualenv_src_location)
|
||
else:
|
||
src = ''
|
||
else:
|
||
src = ''
|
||
|
||
# Try installing for each source in project.sources.
|
||
if index:
|
||
sources = [{'url': index}]
|
||
else:
|
||
sources = project.sources
|
||
|
||
for source in sources:
|
||
if r:
|
||
install_reqs = ' -r {0}'.format(r)
|
||
elif package_name.startswith('-e '):
|
||
install_reqs = ' -e "{0}"'.format(package_name.split('-e ')[1])
|
||
else:
|
||
install_reqs = ' "{0}"'.format(package_name)
|
||
|
||
# Skip hash-checking mode, when appropriate.
|
||
if r:
|
||
with open(r) as f:
|
||
if '--hash' not in f.read():
|
||
ignore_hashes = True
|
||
else:
|
||
if '--hash' not in install_reqs:
|
||
ignore_hashes = True
|
||
|
||
verbose_flag = '--verbose' if verbose else ''
|
||
|
||
if not ignore_hashes:
|
||
install_reqs += ' --require-hashes'
|
||
|
||
no_deps = '--no-deps' if no_deps else ''
|
||
pre = '--pre' if pre else ''
|
||
|
||
quoted_pip = which_pip(allow_global=allow_global)
|
||
quoted_pip = shellquote(quoted_pip)
|
||
|
||
pip_command = '{0} install {4} {5} {6} {3} {1} {2} --exists-action w'.format(
|
||
quoted_pip,
|
||
install_reqs,
|
||
' '.join(prepare_pip_source_args([source])),
|
||
no_deps,
|
||
pre,
|
||
src,
|
||
verbose_flag
|
||
)
|
||
|
||
if verbose:
|
||
click.echo('$ {0}'.format(pip_command), err=True)
|
||
|
||
c = delegator.run(pip_command, block=block)
|
||
if c.return_code == 0:
|
||
break
|
||
|
||
# Return the result of the first one that runs ok, or the last one that didn't work.
|
||
return c
|
||
|
||
|
||
def pip_download(package_name):
|
||
for source in project.sources:
|
||
cmd = '"{0}" download "{1}" -i {2} -d {3}'.format(
|
||
which_pip(),
|
||
package_name,
|
||
source['url'],
|
||
project.download_location
|
||
)
|
||
c = delegator.run(cmd)
|
||
if c.return_code == 0:
|
||
break
|
||
return c
|
||
|
||
|
||
def which(command, location=None, allow_global=False):
|
||
if location is None:
|
||
location = project.virtualenv_location
|
||
|
||
if not allow_global:
|
||
if os.name == 'nt':
|
||
p = find_windows_executable(os.path.join(location, 'Scripts'), command)
|
||
else:
|
||
p = os.sep.join([location] + ['bin/{0}'.format(command)])
|
||
else:
|
||
if command == 'python':
|
||
p = sys.executable
|
||
|
||
return p
|
||
|
||
|
||
def which_pip(allow_global=False):
|
||
"""Returns the location of virtualenv-installed pip."""
|
||
if allow_global:
|
||
if 'VIRTUAL_ENV' in os.environ:
|
||
return which('pip', location=os.environ['VIRTUAL_ENV'])
|
||
return system_which('pip')
|
||
|
||
return which('pip')
|
||
|
||
|
||
def system_which(command, mult=False):
|
||
"""Emulates the system's which. Returns None is not found."""
|
||
|
||
_which = 'which -a' if not os.name == 'nt' else 'where'
|
||
|
||
c = delegator.run('{0} {1}'.format(_which, command))
|
||
try:
|
||
# Which Not found...
|
||
if c.return_code == 127:
|
||
click.echo(
|
||
'{}: the {} system utility is required for Pipenv to find Python installations properly.'
|
||
'\n Please install it.'.format(
|
||
crayons.red('Warning', bold=True),
|
||
crayons.red(_which)
|
||
), err=True
|
||
)
|
||
assert c.return_code == 0
|
||
except AssertionError:
|
||
return None if not mult else []
|
||
|
||
result = c.out.strip() or c.err.strip()
|
||
|
||
if mult:
|
||
return result.split('\n')
|
||
else:
|
||
return result.split('\n')[0]
|
||
|
||
|
||
def format_help(help):
|
||
"""Formats the help string."""
|
||
help = help.replace('Options:', str(crayons.normal('Options:', bold=True)))
|
||
|
||
help = help.replace('Usage: pipenv', str('Usage: {0}'.format(crayons.normal('pipenv', bold=True))))
|
||
|
||
help = help.replace(' graph', str(crayons.green(' graph')))
|
||
help = help.replace(' open', str(crayons.green(' open')))
|
||
help = help.replace(' check', str(crayons.green(' check')))
|
||
help = help.replace(' uninstall', str(crayons.yellow(' uninstall', bold=True)))
|
||
help = help.replace(' install', str(crayons.yellow(' install', bold=True)))
|
||
help = help.replace(' lock', str(crayons.red(' lock', bold=True)))
|
||
help = help.replace(' run', str(crayons.blue(' run')))
|
||
help = help.replace(' shell', str(crayons.blue(' shell', bold=True)))
|
||
help = help.replace(' update', str(crayons.yellow(' update')))
|
||
|
||
additional_help = """
|
||
Usage Examples:
|
||
Create a new project using Python 3.6, specifically:
|
||
$ {1}
|
||
|
||
Install all dependencies for a project (including dev):
|
||
$ {2}
|
||
|
||
Create a lockfile containing pre-releases:
|
||
$ {6}
|
||
|
||
Show a graph of your installed dependencies:
|
||
$ {4}
|
||
|
||
Check your installed dependencies for security vulnerabilties:
|
||
$ {7}
|
||
|
||
Install a local setup.py into your virtual environment/Pipfile:
|
||
$ {5}
|
||
|
||
Commands:""".format(
|
||
crayons.red('pipenv --three'),
|
||
crayons.red('pipenv --python 3.6'),
|
||
crayons.red('pipenv install --dev'),
|
||
crayons.red('pipenv lock'),
|
||
crayons.red('pipenv graph'),
|
||
crayons.red('pipenv install -e .'),
|
||
crayons.red('pipenv lock --pre'),
|
||
crayons.red('pipenv check'),
|
||
)
|
||
|
||
help = help.replace('Commands:', additional_help)
|
||
|
||
return help
|
||
|
||
|
||
def format_pip_error(error):
|
||
error = error.replace('Expected', str(crayons.green('Expected', bold=True)))
|
||
error = error.replace('Got', str(crayons.red('Got', bold=True)))
|
||
error = error.replace('THESE PACKAGES DO NOT MATCH THE HASHES FROM THE REQUIREMENTS FILE', str(crayons.red('THESE PACKAGES DO NOT MATCH THE HASHES FROM Pipfile.lock!', bold=True)))
|
||
error = error.replace('someone may have tampered with them', str(crayons.red('someone may have tampered with them')))
|
||
|
||
error = error.replace('option to pip install', 'option to \'pipenv install\'')
|
||
return error
|
||
|
||
|
||
def format_pip_output(out, r=None):
|
||
def gen(out):
|
||
for line in out.split('\n'):
|
||
# Remove requirements file information from pip output.
|
||
if '(from -r' in line:
|
||
yield line[:line.index('(from -r')]
|
||
else:
|
||
yield line
|
||
|
||
out = '\n'.join([l for l in gen(out)])
|
||
return out
|
||
|
||
|
||
# |\/| /\ |) [- ]3 `/
|
||
# . . .-. . . . . .-. .-. . . .-. .-. .-. .-. .-.
|
||
# |< |- |\| |\| |- | |-| |( |- | | /
|
||
# ' ` `-' ' ` ' ` `-' ' ' ` ' ' `-' `-' ' `-'
|
||
|
||
def warn_in_virtualenv():
|
||
if PIPENV_USE_SYSTEM:
|
||
# Only warn if pipenv isn't already active.
|
||
if 'PIPENV_ACTIVE' not in os.environ:
|
||
click.echo(
|
||
'{0}: Pipenv found itself running within a virtual environment, '
|
||
'so it will automatically use that environment, instead of '
|
||
'creating its own for any project.'.format(
|
||
crayons.green('Courtesy Notice')
|
||
), err=True
|
||
)
|
||
|
||
def kr_easter_egg(package_name):
|
||
if package_name in ['requests', 'maya', 'crayons', 'delegator.py', 'records', 'tablib', 'background', 'clint']:
|
||
|
||
# Windows built-in terminal lacks proper emoji taste.
|
||
if PIPENV_HIDE_EMOJIS:
|
||
click.echo(u'P.S. You have excellent taste!')
|
||
else:
|
||
click.echo(u'P.S. You have excellent taste! ✨ 🍰 ✨')
|
||
|
||
|
||
CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
|
||
|
||
|
||
@click.group(invoke_without_command=True, context_settings=CONTEXT_SETTINGS)
|
||
@click.option('--update', is_flag=True, default=False, help="Update Pipenv & pip to latest.")
|
||
@click.option('--where', is_flag=True, default=False, help="Output project home information.")
|
||
@click.option('--venv', is_flag=True, default=False, help="Output virtualenv information.")
|
||
@click.option('--py', is_flag=True, default=False, help="Output Python interpreter information.")
|
||
@click.option('--envs', is_flag=True, default=False, help="Output Environment Variable options.")
|
||
@click.option('--rm', is_flag=True, default=False, help="Remove the virtualenv.")
|
||
@click.option('--bare', is_flag=True, default=False, help="Minimal output.")
|
||
@click.option('--completion', is_flag=True, default=False, help="Output completion (to be eval'd).")
|
||
@click.option('--man', is_flag=True, default=False, help="Display manpage.")
|
||
@click.option('--three/--two', is_flag=True, default=None, help="Use Python 3/2 when creating virtualenv.")
|
||
@click.option('--python', default=False, nargs=1, help="Specify which version of Python virtualenv should use.")
|
||
@click.option('--site-packages', is_flag=True, default=False, help="Enable site-packages for the virtualenv.")
|
||
@click.option('--jumbotron', is_flag=True, default=False, help="An easter egg, effectively.")
|
||
@click.version_option(prog_name=crayons.yellow('pipenv'), version=__version__)
|
||
@click.pass_context
|
||
def cli(
|
||
ctx, where=False, venv=False, rm=False, bare=False, three=False,
|
||
python=False, help=False, update=False, jumbotron=False, py=False,
|
||
site_packages=False, envs=False, man=False, completion=False
|
||
):
|
||
|
||
if jumbotron:
|
||
# Awesome sauce.
|
||
click.echo(crayons.normal(xyzzy, bold=True))
|
||
|
||
if not update:
|
||
# Spun off in background thread, not unlike magic.
|
||
check_for_updates()
|
||
else:
|
||
# Update pip to latest version.
|
||
ensure_latest_pip()
|
||
|
||
# Upgrade self to latest version.
|
||
ensure_latest_self()
|
||
|
||
sys.exit()
|
||
|
||
if completion:
|
||
try:
|
||
os.environ['_PIPENV_COMPLETE'] = 'source-{0}'.format(PIPENV_SHELL.split(os.sep)[-1])
|
||
except KeyError:
|
||
click.echo(
|
||
'Please ensure that the {0} environment variable '
|
||
'is set.'.format(crayons.normal('SHELL', bold=True)), err=True)
|
||
sys.exit(1)
|
||
|
||
c = delegator.run('pipenv')
|
||
click.echo(c.out)
|
||
sys.exit(0)
|
||
|
||
if man:
|
||
if system_which('man'):
|
||
path = os.sep.join([os.path.dirname(__file__), 'pipenv.1'])
|
||
os.execle(system_which('man'), 'man', path, os.environ)
|
||
else:
|
||
click.echo('man does not appear to be available on your system.', err=True)
|
||
|
||
if envs:
|
||
click.echo('The following environment variables can be set, to do various things:\n')
|
||
for key in environments.__dict__:
|
||
if key.startswith('PIPENV'):
|
||
click.echo(' - {0}'.format(crayons.normal(key, bold=True)))
|
||
|
||
click.echo('\nYou can learn more at:\n {0}'.format(
|
||
crayons.green('http://docs.pipenv.org/en/latest/advanced.html#configuration-with-environment-variables')
|
||
))
|
||
sys.exit(0)
|
||
|
||
warn_in_virtualenv()
|
||
|
||
if ctx.invoked_subcommand is None:
|
||
# --where was passed...
|
||
if where:
|
||
do_where(bare=True)
|
||
sys.exit(0)
|
||
|
||
elif py:
|
||
do_py()
|
||
sys.exit()
|
||
|
||
# --venv was passed...
|
||
elif venv:
|
||
# There is no virtualenv yet.
|
||
if not project.virtualenv_exists:
|
||
click.echo(crayons.red('No virtualenv has been created for this project yet!'), err=True)
|
||
sys.exit(1)
|
||
else:
|
||
click.echo(project.virtualenv_location)
|
||
sys.exit(0)
|
||
|
||
# --rm was passed...
|
||
elif rm:
|
||
# Abort if --system (or running in a virtualenv).
|
||
if PIPENV_USE_SYSTEM:
|
||
click.echo(
|
||
crayons.red(
|
||
'You are attempting to remove a virtualenv that '
|
||
'Pipenv did not create. Aborting.'
|
||
)
|
||
)
|
||
sys.exit(1)
|
||
if project.virtualenv_exists:
|
||
loc = project.virtualenv_location
|
||
click.echo(
|
||
crayons.normal(
|
||
u'{0} ({1})…'.format(
|
||
crayons.normal('Removing virtualenv', bold=True),
|
||
crayons.green(loc)
|
||
)
|
||
)
|
||
)
|
||
|
||
with spinner():
|
||
# Remove the virtualenv.
|
||
cleanup_virtualenv(bare=True)
|
||
sys.exit(0)
|
||
else:
|
||
click.echo(
|
||
crayons.red(
|
||
'No virtualenv has been created for this project yet!',
|
||
bold=True
|
||
), err=True
|
||
)
|
||
sys.exit(1)
|
||
|
||
# --two / --three was passed...
|
||
if (python or three is not None) or site_packages:
|
||
ensure_project(three=three, python=python, warn=True, site_packages=site_packages)
|
||
|
||
# Check this again before exiting for empty ``pipenv`` command.
|
||
elif ctx.invoked_subcommand is None:
|
||
# Display help to user, if no commands were passed.
|
||
click.echo(format_help(ctx.get_help()))
|
||
|
||
|
||
def do_py(system=False):
|
||
try:
|
||
click.echo(which('python', allow_global=system))
|
||
except AttributeError:
|
||
click.echo(crayons.red('No project found!'))
|
||
|
||
|
||
@click.command(help="Installs provided packages and adds them to Pipfile, or (if none is given), installs all packages.", context_settings=dict(
|
||
ignore_unknown_options=True,
|
||
allow_extra_args=True
|
||
))
|
||
@click.argument('package_name', default=False)
|
||
@click.argument('more_packages', nargs=-1)
|
||
@click.option('--dev', '-d', is_flag=True, default=False, help="Install package(s) in [dev-packages].")
|
||
@click.option('--three/--two', is_flag=True, default=None, help="Use Python 3/2 when creating virtualenv.")
|
||
@click.option('--python', default=False, nargs=1, help="Specify which version of Python virtualenv should use.")
|
||
@click.option('--system', is_flag=True, default=False, help="System pip management.")
|
||
@click.option('--requirements', '-r', nargs=1, default=False, help="Import a requirements.txt file.")
|
||
@click.option('--code', '-c', nargs=1, default=False, help="Import from codebase.")
|
||
@click.option('--verbose', is_flag=True, default=False, help="Verbose mode.")
|
||
@click.option('--ignore-pipfile', is_flag=True, default=False, help="Ignore Pipfile when installing, using the Pipfile.lock.")
|
||
@click.option('--sequential', is_flag=True, default=False, help="Install dependencies one-at-a-time, instead of concurrently.")
|
||
@click.option('--skip-lock', is_flag=True, default=False, help=u"Ignore locking mechanisms when installing—use the Pipfile, instead.")
|
||
@click.option('--deploy', is_flag=True, default=False, help=u"Abort if the Pipfile.lock is out–of–date.")
|
||
@click.option('--pre', is_flag=True, default=False, help=u"Allow pre–releases.")
|
||
def install(
|
||
package_name=False, more_packages=False, dev=False, three=False,
|
||
python=False, system=False, lock=True, ignore_pipfile=False,
|
||
skip_lock=False, verbose=False, requirements=False, sequential=False,
|
||
pre=False, code=False, deploy=False
|
||
):
|
||
|
||
# Automatically use an activated virtualenv.
|
||
if PIPENV_USE_SYSTEM:
|
||
system = True
|
||
|
||
concurrent = (not sequential)
|
||
|
||
# Ensure that virtualenv is available.
|
||
ensure_project(three=three, python=python, system=system, warn=True)
|
||
|
||
# Load the --pre settings from the Pipfile.
|
||
if not pre:
|
||
pre = project.settings.get('allow_prereleases')
|
||
|
||
if requirements:
|
||
click.echo(crayons.normal(u'Requirements file provided! Importing into Pipfile…', bold=True), err=True)
|
||
import_requirements(r=requirements, dev=dev)
|
||
|
||
if code:
|
||
click.echo(crayons.normal(u'Discovering imports from local codebase…', bold=True))
|
||
for req in import_from_code(code):
|
||
click.echo(' Found {0}!'.format(crayons.green(req)))
|
||
project.add_package_to_pipfile(req)
|
||
|
||
# Capture -e argument and assign it to following package_name.
|
||
more_packages = list(more_packages)
|
||
if package_name == '-e':
|
||
package_name = ' '.join([package_name, more_packages.pop(0)])
|
||
|
||
# Allow more than one package to be provided.
|
||
package_names = [package_name, ] + more_packages
|
||
|
||
# Suggest a better package name, if appropriate.
|
||
if len(package_names) == 1:
|
||
# This can be False...
|
||
if package_names[0]:
|
||
if not package_names[0].startswith('-e '):
|
||
if not is_file(package_names[0]):
|
||
if not (
|
||
('==' in package_names[0]) or
|
||
('>=' in package_names[0]) or
|
||
('<=' in package_names[0])
|
||
):
|
||
suggested_package = suggest_package(package_names[0])
|
||
if suggested_package:
|
||
if str(package_names[0].lower()) != str(suggested_package.lower()):
|
||
if PIPENV_YES or click.confirm(
|
||
'Did you mean {0}?'.format(
|
||
crayons.normal(suggested_package, bold=True)
|
||
),
|
||
default=True
|
||
):
|
||
package_names[0] = suggested_package
|
||
|
||
# Install all dependencies, if none was provided.
|
||
if package_name is False:
|
||
|
||
do_init(dev=dev, allow_global=system, ignore_pipfile=ignore_pipfile, system=system, skip_lock=skip_lock, verbose=verbose, concurrent=concurrent, deploy=deploy)
|
||
|
||
# Update project settings with pre preference.
|
||
if pre:
|
||
project.update_settings({'allow_prereleases': pre})
|
||
|
||
sys.exit(0)
|
||
|
||
for package_name in package_names:
|
||
click.echo(crayons.normal(u'Installing {0}…'.format(crayons.green(package_name, bold=True)), bold=True))
|
||
|
||
# pip install:
|
||
with spinner():
|
||
c = pip_install(package_name, ignore_hashes=True, allow_global=system, no_deps=False, verbose=verbose, pre=pre)
|
||
|
||
# Warn if --editable wasn't passed.
|
||
converted = convert_deps_from_pip(package_name)
|
||
key = [k for k in converted.keys()][0]
|
||
if is_vcs(converted[key]) and not converted[key].get('editable'):
|
||
click.echo(
|
||
'{0}: You installed a VCS dependency in non–editable mode. '
|
||
'This will work fine, but sub-depdendencies will not be resolved by {1}.'
|
||
'\n To enable this sub–dependency functionality, specify that this dependency is editable.'
|
||
''.format(
|
||
crayons.red('Warning', bold=True),
|
||
crayons.red('$ pipenv lock')
|
||
)
|
||
)
|
||
|
||
click.echo(crayons.blue(format_pip_output(c.out)))
|
||
|
||
# Ensure that package was successfully installed.
|
||
try:
|
||
assert c.return_code == 0
|
||
except AssertionError:
|
||
click.echo(
|
||
'{0} An error occurred while installing {1}!'.format(
|
||
crayons.red('Error: ', bold=True),
|
||
crayons.green(package_name)
|
||
), err=True)
|
||
click.echo(crayons.blue(format_pip_error(c.err)), err=True)
|
||
sys.exit(1)
|
||
|
||
if dev:
|
||
click.echo(crayons.normal(u'Adding {0} to Pipfile\'s {1}…'.format(
|
||
crayons.green(package_name),
|
||
crayons.red('[dev-packages]')
|
||
)))
|
||
else:
|
||
click.echo(crayons.normal(u'Adding {0} to Pipfile\'s {1}…'.format(
|
||
crayons.green(package_name),
|
||
crayons.red('[packages]')
|
||
)))
|
||
|
||
# Add the package to the Pipfile.
|
||
try:
|
||
project.add_package_to_pipfile(package_name, dev)
|
||
except ValueError as e:
|
||
click.echo('{0} {1}'.format(crayons.red('ERROR (PACKAGE NOT INSTALLED):'), e))
|
||
|
||
# Update project settings with pre preference.
|
||
if pre:
|
||
project.update_settings({'allow_prereleases': pre})
|
||
|
||
# Ego boost.
|
||
kr_easter_egg(package_name)
|
||
|
||
if lock and not skip_lock:
|
||
do_lock(system=system, pre=pre)
|
||
|
||
|
||
@click.command(help="Un-installs a provided package and removes it from Pipfile.")
|
||
@click.argument('package_name', default=False)
|
||
@click.argument('more_packages', nargs=-1)
|
||
@click.option('--three/--two', is_flag=True, default=None, help="Use Python 3/2 when creating virtualenv.")
|
||
@click.option('--python', default=False, nargs=1, help="Specify which version of Python virtualenv should use.")
|
||
@click.option('--system', is_flag=True, default=False, help="System pip management.")
|
||
@click.option('--verbose', is_flag=True, default=False, help="Verbose mode.")
|
||
@click.option('--lock', is_flag=True, default=True, help="Lock afterwards.")
|
||
@click.option('--dev', '-d', is_flag=True, default=False, help="Un-install all package from [dev-packages].")
|
||
@click.option('--all', is_flag=True, default=False, help="Purge all package(s) from virtualenv. Does not edit Pipfile.")
|
||
def uninstall(
|
||
package_name=False, more_packages=False, three=None, python=False,
|
||
system=False, lock=False, dev=False, all=False, verbose=False
|
||
):
|
||
|
||
# Automatically use an activated virtualenv.
|
||
if PIPENV_USE_SYSTEM:
|
||
system = True
|
||
|
||
# Ensure that virtualenv is available.
|
||
ensure_project(three=three, python=python)
|
||
|
||
package_names = (package_name,) + more_packages
|
||
pipfile_remove = True
|
||
|
||
# Un-install all dependencies, if --all was provided.
|
||
if all is True:
|
||
click.echo(
|
||
crayons.normal(u'Un-installing all packages from virtualenv…', bold=True)
|
||
)
|
||
do_purge(allow_global=system, verbose=verbose)
|
||
sys.exit(0)
|
||
|
||
# Uninstall [dev-packages], if --dev was provided.
|
||
if dev:
|
||
if 'dev-packages' not in project.parsed_pipfile:
|
||
click.echo(
|
||
crayons.normal('No {0} to uninstall.'.format(
|
||
crayons.red('[dev-packages]')), bold=True
|
||
)
|
||
)
|
||
sys.exit(0)
|
||
|
||
click.echo(
|
||
crayons.normal(u'Un-installing {0}…'.format(
|
||
crayons.red('[dev-packages]')), bold=True
|
||
)
|
||
)
|
||
package_names = project.parsed_pipfile['dev-packages']
|
||
package_names = package_names.keys()
|
||
|
||
if package_name is False and not dev:
|
||
click.echo(crayons.red('No package provided!'), err=True)
|
||
sys.exit(1)
|
||
|
||
for package_name in package_names:
|
||
|
||
click.echo(u'Un-installing {0}…'.format(
|
||
crayons.green(package_name))
|
||
)
|
||
|
||
cmd = '"{0}" uninstall {1} -y'
|
||
if verbose:
|
||
click.echo('$ {0}').format(cmd)
|
||
|
||
c = delegator.run(cmd.format(
|
||
which_pip(allow_global=system),
|
||
package_name
|
||
))
|
||
|
||
click.echo(crayons.blue(c.out))
|
||
|
||
if pipfile_remove:
|
||
norm_name = pep423_name(package_name)
|
||
|
||
in_dev_packages = (norm_name in project._pipfile.get('dev-packages', {}))
|
||
in_packages = (norm_name in project._pipfile.get('packages', {}))
|
||
|
||
if not in_dev_packages and not in_packages:
|
||
click.echo(
|
||
'No package {0} to remove from Pipfile.'.format(
|
||
crayons.green(package_name)
|
||
)
|
||
)
|
||
continue
|
||
|
||
click.echo(
|
||
u'Removing {0} from Pipfile…'.format(
|
||
crayons.green(package_name)
|
||
)
|
||
)
|
||
|
||
# Remove package from both packages and dev-packages.
|
||
project.remove_package_from_pipfile(package_name, dev=True)
|
||
project.remove_package_from_pipfile(package_name, dev=False)
|
||
|
||
if lock:
|
||
do_lock(system=system)
|
||
|
||
|
||
@click.command(help="Generates Pipfile.lock.")
|
||
@click.option('--three/--two', is_flag=True, default=None, help="Use Python 3/2 when creating virtualenv.")
|
||
@click.option('--python', default=False, nargs=1, help="Specify which version of Python virtualenv should use.")
|
||
@click.option('--verbose', is_flag=True, default=False, help="Verbose mode.")
|
||
@click.option('--requirements', '-r', is_flag=True, default=False, help="Generate output compatible with requirements.txt.")
|
||
@click.option('--clear', is_flag=True, default=False, help="Clear the dependency cache.")
|
||
@click.option('--pre', is_flag=True, default=False, help=u"Allow pre–releases.")
|
||
def lock(three=None, python=False, verbose=False, requirements=False, clear=False, pre=False):
|
||
|
||
# Ensure that virtualenv is available.
|
||
ensure_project(three=three, python=python)
|
||
|
||
# Load the --pre settings from the Pipfile.
|
||
if not pre:
|
||
pre = project.settings.get('pre')
|
||
|
||
|
||
if requirements:
|
||
do_init(dev=True, requirements=requirements)
|
||
|
||
do_lock(verbose=verbose, clear=clear, pre=pre)
|
||
|
||
|
||
def do_shell(three=None, python=False, fancy=False, shell_args=None):
|
||
|
||
# Set an environment variable, so we know we're in the environment.
|
||
os.environ['PIPENV_ACTIVE'] = '1'
|
||
|
||
compat = (not fancy)
|
||
|
||
# Support shell compatibility mode.
|
||
if PIPENV_SHELL_FANCY:
|
||
compat = False
|
||
|
||
# Compatibility mode:
|
||
if compat:
|
||
try:
|
||
shell = os.path.abspath(PIPENV_SHELL)
|
||
except KeyError:
|
||
click.echo(
|
||
crayons.red(
|
||
'Please ensure that the {0} environment variable '
|
||
'is set before activating shell.'.format(crayons.normal('SHELL', bold=True))
|
||
), err=True
|
||
)
|
||
sys.exit(1)
|
||
|
||
click.echo(
|
||
crayons.normal(
|
||
'Spawning environment shell ({0}).'.format(
|
||
crayons.red(shell)
|
||
), bold=True
|
||
), err=True
|
||
)
|
||
|
||
cmd = "{0} -i'".format(shell)
|
||
args = []
|
||
|
||
# Standard (properly configured shell) mode:
|
||
else:
|
||
cmd = 'pew'
|
||
args = ["workon", project.virtualenv_name]
|
||
|
||
# Grab current terminal dimensions to replace the hardcoded default
|
||
# dimensions of pexpect
|
||
terminal_dimensions = get_terminal_size()
|
||
|
||
try:
|
||
c = pexpect.spawn(
|
||
cmd,
|
||
args,
|
||
dimensions=(
|
||
terminal_dimensions.lines,
|
||
terminal_dimensions.columns
|
||
)
|
||
)
|
||
|
||
# Windows!
|
||
except AttributeError:
|
||
import subprocess
|
||
p = subprocess.Popen([cmd] + list(args), shell=True, universal_newlines=True)
|
||
p.communicate()
|
||
sys.exit(p.returncode)
|
||
|
||
# Activate the virtualenv if in compatibility mode.
|
||
if compat:
|
||
c.sendline(activate_virtualenv())
|
||
|
||
# Send additional arguments to the subshell.
|
||
if shell_args:
|
||
c.sendline(' '.join(shell_args))
|
||
|
||
# Handler for terminal resizing events
|
||
# Must be defined here to have the shell process in its context, since we
|
||
# can't pass it as an argument
|
||
def sigwinch_passthrough(sig, data):
|
||
terminal_dimensions = get_terminal_size()
|
||
c.setwinsize(terminal_dimensions.lines, terminal_dimensions.columns)
|
||
signal.signal(signal.SIGWINCH, sigwinch_passthrough)
|
||
|
||
# Interact with the new shell.
|
||
c.interact(escape_character=None)
|
||
c.close()
|
||
sys.exit(c.exitstatus)
|
||
|
||
|
||
@click.command(help="Spawns a shell within the virtualenv.", context_settings=dict(
|
||
ignore_unknown_options=True,
|
||
allow_extra_args=True
|
||
))
|
||
@click.option('--three/--two', is_flag=True, default=None, help="Use Python 3/2 when creating virtualenv.")
|
||
@click.option('--python', default=False, nargs=1, help="Specify which version of Python virtualenv should use.")
|
||
@click.option('--fancy', is_flag=True, default=False, help="Run in shell in fancy mode (for elegantly configured shells).")
|
||
@click.option('--anyway', is_flag=True, default=False, help="Always spawn a subshell, even if one is already spawned.")
|
||
@click.argument('shell_args', nargs=-1)
|
||
def shell(three=None, python=False, fancy=False, shell_args=None, anyway=False):
|
||
|
||
# Prevent user from activating nested environments.
|
||
if 'PIPENV_ACTIVE' in os.environ:
|
||
# If PIPENV_ACTIVE is set, VIRTUAL_ENV should always be set too.
|
||
venv_name = os.environ.get('VIRTUAL_ENV', 'UNKNOWN_VIRTUAL_ENVIRONMENT')
|
||
|
||
if not anyway:
|
||
click.echo('{0} {1} {2}\nNo action taken to avoid nested environments.'.format(
|
||
crayons.normal('Shell for'),
|
||
crayons.green(venv_name, bold=True),
|
||
crayons.normal('already activated.', bold=True)
|
||
), err=True)
|
||
|
||
sys.exit(1)
|
||
|
||
# Ensure that virtualenv is available.
|
||
ensure_project(three=three, python=python, validate=False)
|
||
|
||
# Load .env file.
|
||
load_dot_env()
|
||
|
||
# Use fancy mode for Windows.
|
||
if os.name == 'nt':
|
||
fancy = True
|
||
|
||
do_shell(three=three, python=python, fancy=fancy, shell_args=shell_args)
|
||
|
||
|
||
def inline_activate_virtualenv():
|
||
try:
|
||
activate_this = which('activate_this.py')
|
||
with open(activate_this) as f:
|
||
code = compile(f.read(), activate_this, 'exec')
|
||
exec(code, dict(__file__=activate_this))
|
||
# Catch all errors, just in case.
|
||
except Exception:
|
||
click.echo(
|
||
u'{0}: There was an unexpected error while activating your virtualenv. Continuing anyway…'
|
||
''.format(crayons.red('Warning', bold=True)),
|
||
err=True
|
||
)
|
||
|
||
|
||
@click.command(help="Spawns a command installed into the virtualenv.", context_settings=dict(
|
||
ignore_unknown_options=True,
|
||
allow_extra_args=True
|
||
))
|
||
@click.argument('command')
|
||
@click.argument('args', nargs=-1)
|
||
@click.option('--three/--two', is_flag=True, default=None, help="Use Python 3/2 when creating virtualenv.")
|
||
@click.option('--python', default=False, nargs=1, help="Specify which version of Python virtualenv should use.")
|
||
def run(command, args, three=None, python=False):
|
||
|
||
# Ensure that virtualenv is available.
|
||
ensure_project(three=three, python=python, validate=False)
|
||
|
||
load_dot_env()
|
||
|
||
# Separate out things that were passed in as a string.
|
||
_c = list(command.split())
|
||
command = _c.pop(0)
|
||
if _c:
|
||
args = list(args)
|
||
for __c in reversed(_c):
|
||
args.insert(0, __c)
|
||
|
||
# Activate virtualenv under the current interpreter's environment
|
||
inline_activate_virtualenv()
|
||
|
||
# Windows!
|
||
if os.name == 'nt':
|
||
import subprocess
|
||
p = subprocess.Popen([command] + list(args), shell=True, universal_newlines=True)
|
||
p.communicate()
|
||
sys.exit(p.returncode)
|
||
else:
|
||
command_path = system_which(command)
|
||
if not command_path:
|
||
click.echo(
|
||
'{0}: the command {1} could not be found within {2}.'
|
||
''.format(
|
||
crayons.red('Error', bold=True),
|
||
crayons.red(command),
|
||
crayons.normal('PATH', bold=True)
|
||
), err=True
|
||
)
|
||
sys.exit(1)
|
||
|
||
# Execute the command.
|
||
os.execl(command_path, command_path, *args)
|
||
pass
|
||
|
||
|
||
@click.command(help="Checks for security vulnerabilities and against PEP 508 markers provided in Pipfile.", context_settings=dict(
|
||
ignore_unknown_options=True,
|
||
allow_extra_args=True
|
||
))
|
||
@click.option('--three/--two', is_flag=True, default=None, help="Use Python 3/2 when creating virtualenv.")
|
||
@click.option('--python', default=False, nargs=1, help="Specify which version of Python virtualenv should use.")
|
||
@click.option('--unused', nargs=1, default=False, help="Given a code path, show potentially unused dependencies.")
|
||
@click.option('--style', nargs=1, default=False, help="Given a code path, show Flake8 errors.")
|
||
@click.argument('args', nargs=-1)
|
||
def check(three=None, python=False, unused=False, style=False, args=None):
|
||
|
||
# Ensure that virtualenv is available.
|
||
ensure_project(three=three, python=python, validate=False, warn=False)
|
||
|
||
if not args:
|
||
args = []
|
||
|
||
if style:
|
||
sys.argv = ['magic', style] + list(args)
|
||
flake8.main.cli.main()
|
||
exit()
|
||
|
||
if unused:
|
||
deps_required = [k for k in project.packages.keys()]
|
||
deps_needed = [k.lower() for k in import_from_code(unused)]
|
||
|
||
for dep in deps_needed:
|
||
try:
|
||
deps_required.remove(dep)
|
||
except ValueError:
|
||
pass
|
||
|
||
if deps_required:
|
||
click.echo(crayons.normal('The following dependencies appear unused, and may be safe for removal:'))
|
||
for dep in deps_required:
|
||
click.echo(' - {0}'.format(crayons.green(dep)))
|
||
sys.exit(1)
|
||
else:
|
||
sys.exit(0)
|
||
|
||
click.echo(
|
||
crayons.normal(u'Checking PEP 508 requirements…', bold=True)
|
||
)
|
||
|
||
# Run the PEP 508 checker in the virtualenv.
|
||
c = delegator.run('"{0}" {1}'.format(which('python'), shellquote(pep508checker.__file__.rstrip('cdo'))))
|
||
results = simplejson.loads(c.out)
|
||
|
||
# Load the pipfile.
|
||
p = pipfile.Pipfile.load(project.pipfile_location)
|
||
|
||
failed = False
|
||
# Assert each specified requirement.
|
||
for marker, specifier in p.data['_meta']['requires'].items():
|
||
|
||
if marker in results:
|
||
try:
|
||
assert results[marker] == specifier
|
||
except AssertionError:
|
||
failed = True
|
||
click.echo(
|
||
'Specifier {0} does not match {1} ({2}).'
|
||
''.format(
|
||
crayons.green(marker),
|
||
crayons.blue(specifier),
|
||
crayons.red(results[marker])
|
||
), err=True
|
||
)
|
||
if failed:
|
||
click.echo(crayons.red('Failed!'), err=True)
|
||
sys.exit(1)
|
||
else:
|
||
click.echo(crayons.green('Passed!'))
|
||
|
||
click.echo(
|
||
crayons.normal(u'Checking installed package safety…', bold=True)
|
||
)
|
||
|
||
path = pep508checker.__file__.rstrip('cdo')
|
||
path = os.sep.join(__file__.split(os.sep)[:-1] + ['patched', 'safety.zip'])
|
||
|
||
c = delegator.run('"{0}" {1} check --json'.format(which('python'), shellquote(path)))
|
||
try:
|
||
results = simplejson.loads(c.out)
|
||
except ValueError:
|
||
click.echo('An error occurred:', err=True)
|
||
click.echo(c.err, err=True)
|
||
sys.exit(1)
|
||
|
||
for (package, resolved, installed, description, vuln) in results:
|
||
click.echo(
|
||
'{0}: {1} {2} resolved ({3} installed)!'.format(
|
||
crayons.normal(vuln, bold=True),
|
||
crayons.green(package),
|
||
crayons.red(resolved, bold=False),
|
||
crayons.red(installed, bold=True)
|
||
)
|
||
)
|
||
|
||
click.echo('{0}'.format(description))
|
||
click.echo()
|
||
|
||
if not results:
|
||
click.echo(crayons.green('All good!'))
|
||
else:
|
||
sys.exit(1)
|
||
|
||
|
||
|
||
@click.command(help=u"Displays currently–installed dependency graph information.")
|
||
@click.option('--bare', is_flag=True, default=False, help="Minimal output.")
|
||
@click.option('--json', is_flag=True, default=False, help="Output JSON.")
|
||
def graph(bare=False, json=False):
|
||
try:
|
||
python_path = which('python')
|
||
except AttributeError:
|
||
click.echo(
|
||
u'{0}: {1}'.format(
|
||
crayons.red('Warning', bold=True),
|
||
u'Unable to display currently–installed dependency graph information here. '
|
||
u'Please run within a Pipenv project.',
|
||
), err=True
|
||
)
|
||
sys.exit(1)
|
||
|
||
j = '--json' if json else ''
|
||
|
||
cmd = '"{0}" {1} {2}'.format(
|
||
python_path,
|
||
shellquote(pipdeptree.__file__.rstrip('cdo')),
|
||
j
|
||
)
|
||
|
||
# Run dep-tree.
|
||
c = delegator.run(cmd)
|
||
|
||
if not bare:
|
||
|
||
if json:
|
||
data = []
|
||
for d in simplejson.loads(c.out):
|
||
|
||
if d['package']['key'] not in BAD_PACKAGES:
|
||
data.append(d)
|
||
|
||
click.echo(simplejson.dumps(data, indent=4))
|
||
sys.exit(0)
|
||
else:
|
||
for line in c.out.split('\n'):
|
||
|
||
# Ignore bad packages.
|
||
if line.split('==')[0] in BAD_PACKAGES:
|
||
continue
|
||
|
||
# Bold top-level packages.
|
||
if not line.startswith(' '):
|
||
click.echo(crayons.normal(line, bold=True))
|
||
|
||
# Echo the rest.
|
||
else:
|
||
click.echo(crayons.normal(line, bold=False))
|
||
else:
|
||
click.echo(c.out)
|
||
|
||
# Return its return code.
|
||
sys.exit(c.return_code)
|
||
|
||
@click.command(help="View a given module in your editor.", name="open")
|
||
@click.option('--three/--two', is_flag=True, default=None, help="Use Python 3/2 when creating virtualenv.")
|
||
@click.option('--python', default=False, nargs=1, help="Specify which version of Python virtualenv should use.")
|
||
@click.argument('module', nargs=1)
|
||
def run_open(module, three=None, python=None):
|
||
|
||
# Ensure that virtualenv is available.
|
||
ensure_project(three=three, python=python, validate=False)
|
||
|
||
c = delegator.run('{0} -c "import {1}; print({1}.__file__);"'.format(which('python'), module))
|
||
|
||
try:
|
||
assert c.return_code == 0
|
||
except AssertionError:
|
||
click.echo(crayons.red('Module not found!'))
|
||
sys.exit(1)
|
||
|
||
if '__init__.py' in c.out:
|
||
p = os.path.dirname(c.out.strip().rstrip('cdo'))
|
||
else:
|
||
p = c.out.strip().rstrip('cdo')
|
||
|
||
click.echo(crayons.normal('Opening {0!r} in your EDITOR.'.format(p), bold=True))
|
||
click.edit(filename=p)
|
||
sys.exit(0)
|
||
|
||
|
||
|
||
@click.command(help="Uninstalls all packages, and re-installs package(s) in [packages] to latest compatible versions.")
|
||
@click.option('--verbose', '-v', is_flag=True, default=False, help="Verbose mode.")
|
||
@click.option('--dev', '-d', is_flag=True, default=False, help="Additionally install package(s) in [dev-packages].")
|
||
@click.option('--three/--two', is_flag=True, default=None, help="Use Python 3/2 when creating virtualenv.")
|
||
@click.option('--python', default=False, nargs=1, help="Specify which version of Python virtualenv should use.")
|
||
@click.option('--dry-run', is_flag=True, default=False, help="Just output outdated packages.")
|
||
@click.option('--bare', is_flag=True, default=False, help="Minimal output.")
|
||
@click.option('--clear', is_flag=True, default=False, help="Clear the dependency cache.")
|
||
def update(dev=False, three=None, python=None, dry_run=False, bare=False, dont_upgrade=False, user=False, verbose=False, clear=False, unused=False):
|
||
|
||
# Ensure that virtualenv is available.
|
||
ensure_project(three=three, python=python, validate=False)
|
||
|
||
# --dry-run:
|
||
if dry_run:
|
||
# dont_upgrade = True
|
||
updates = False
|
||
|
||
# Dev packages
|
||
if not bare:
|
||
click.echo(crayons.normal(u'Checking dependencies…', bold=True), err=True)
|
||
|
||
packages = project.packages
|
||
if dev:
|
||
packages.update(project.dev_packages)
|
||
|
||
installed_packages = {}
|
||
deps = convert_deps_to_pip(packages, project, r=False)
|
||
c = delegator.run('{0} freeze'.format(which_pip()))
|
||
|
||
for r in c.out.strip().split('\n'):
|
||
result = convert_deps_from_pip(r)
|
||
try:
|
||
installed_packages[list(result.keys())[0].lower()] = result[list(result.keys())[0]][len('=='):]
|
||
except TypeError:
|
||
pass
|
||
|
||
# Resolve dependency tree.
|
||
for result in resolve_deps(deps, sources=project.sources, clear=clear, which=which, which_pip=which_pip, project=project):
|
||
|
||
name = result['name']
|
||
installed = result['version']
|
||
|
||
try:
|
||
latest = installed_packages[name]
|
||
if installed != latest:
|
||
if not bare:
|
||
click.echo(
|
||
'{0}=={1} is available ({2} installed)!'
|
||
''.format(crayons.normal(name, bold=True), latest, installed)
|
||
)
|
||
else:
|
||
click.echo(
|
||
'{0}=={1}'.format(name, latest)
|
||
)
|
||
updates = True
|
||
except KeyError:
|
||
pass
|
||
|
||
if not updates and not bare:
|
||
click.echo(
|
||
crayons.green('All good!')
|
||
)
|
||
|
||
sys.exit(int(updates))
|
||
|
||
click.echo(
|
||
crayons.normal(u'Updating all dependencies from Pipfile…', bold=True)
|
||
)
|
||
|
||
do_purge()
|
||
do_init(dev=dev, verbose=verbose)
|
||
|
||
click.echo(
|
||
crayons.green('All dependencies are now up-to-date!')
|
||
)
|
||
|
||
|
||
# Install click commands.
|
||
cli.add_command(graph)
|
||
cli.add_command(install)
|
||
cli.add_command(uninstall)
|
||
cli.add_command(update)
|
||
cli.add_command(lock)
|
||
cli.add_command(check)
|
||
cli.add_command(shell)
|
||
cli.add_command(run)
|
||
cli.add_command(run_open)
|
||
|
||
# Only invoke the "did you mean" when an argument wasn't passed (it breaks those).
|
||
if '-' not in ''.join(sys.argv) and len(sys.argv) > 1:
|
||
cli = DYMCommandCollection(sources=[cli])
|
||
|
||
if __name__ == '__main__':
|
||
cli()
|