From 48a020b6d57f190f01efd1ba5b2809c31175b0a8 Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Sun, 4 Feb 2018 10:54:53 -0500 Subject: [PATCH 1/9] lazy load pip Signed-off-by: Kenneth Reitz --- pipenv/cli.py | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/pipenv/cli.py b/pipenv/cli.py index 099d1920..a976d619 100644 --- a/pipenv/cli.py +++ b/pipenv/cli.py @@ -1,4 +1,5 @@ # -*- coding: utf-8 -*- + import contextlib import codecs import os @@ -19,16 +20,13 @@ 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 ( @@ -230,6 +228,8 @@ def ensure_latest_pip(): def import_requirements(r=None, dev=False): + import pip + from pip.req.req_file import parse_requirements # 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. @@ -395,6 +395,7 @@ def ensure_python(three=None, python=None): sys.exit(1) def activate_pyenv(): + import pip """Adds all pyenv installations to the PATH.""" if PYENV_INSTALLED: if PYENV_ROOT: @@ -1214,7 +1215,7 @@ def do_purge(bare=False, downloads=False, allow_global=False, verbose=False): return freeze = delegator.run('"{0}" freeze'.format(which_pip(allow_global=allow_global))).out - + # Remove comments from the output, if any. installed = [line for line in freeze.splitlines() if not line.lstrip().startswith('#')] @@ -1326,6 +1327,7 @@ 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 ): + import pip if verbose: click.echo(crayons.normal('Installing {0!r}'.format(package_name), bold=True), err=True) @@ -1764,6 +1766,7 @@ def install( skip_lock=False, verbose=False, requirements=False, sequential=False, pre=False, code=False, deploy=False ): + import pip # Automatically use an activated virtualenv. if PIPENV_USE_SYSTEM: From c67f0cd6bfa92a112adcac9dd2d8e34d3c73038c Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Sun, 4 Feb 2018 11:12:31 -0500 Subject: [PATCH 2/9] lazy load utils pip too Signed-off-by: Kenneth Reitz --- pipenv/utils.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/pipenv/utils.py b/pipenv/utils.py index 1addfad4..94480279 100644 --- a/pipenv/utils.py +++ b/pipenv/utils.py @@ -9,7 +9,6 @@ import logging import click import crayons import delegator -import pip import parse import requirements import fuzzywuzzy.process @@ -271,6 +270,7 @@ packages = [ def get_requirement(dep): + import pip """Pre-clean requirement strings passed to the requirements parser. Ensures that we can accept both local and relative paths, file and VCS URIs, @@ -454,6 +454,7 @@ def prepare_pip_source_args(sources, pip_args=None): def actually_resolve_reps(deps, index_lookup, markers_lookup, project, sources, verbose, clear, pre): + import pip class PipCommand(pip.basecommand.Command): """Needed for pip-tools.""" @@ -864,6 +865,8 @@ def is_vcs(pipfile_entry): def is_installable_file(path): + import pip + """Determine if a path can potentially be installed""" if hasattr(path, 'keys') and any(key for key in path.keys() if key in ['file', 'path']): path = urlparse(path['file']).path if 'file' in path else path['path'] @@ -901,6 +904,7 @@ def is_file(package): def pep440_version(version): """Normalize version to PEP 440 standards""" + import pip # Use pip built-in version parser. return str(pip.index.parse_version(version)) From 63a2cfc542b71c6bd6c0de62d891dd98999ca51a Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Sun, 4 Feb 2018 14:09:32 -0500 Subject: [PATCH 3/9] refactor Signed-off-by: Kenneth Reitz --- pipenv/cli.py | 2318 ++--------------------------------------------- pipenv/core.py | 2321 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 2386 insertions(+), 2253 deletions(-) create mode 100644 pipenv/core.py diff --git a/pipenv/cli.py b/pipenv/cli.py index a976d619..07c14ce6 100644 --- a/pipenv/cli.py +++ b/pipenv/cli.py @@ -1,59 +1,17 @@ -# -*- 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 pipfile -import pipdeptree -import semver -import flake8.main.cli -from pipreqs import pipreqs -from blindspin import spinner -from urllib3.exceptions import InsecureRequestWarning 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_file, merge_deps, resolve_deps, shellquote, is_vcs, - python_version, suggest_package, find_windows_executable, is_file, - prepare_pip_source_args, temp_environ, is_valid_url, download_file, - get_requirement, need_update_check, touch_update_stamp -) -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_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 +from .__version__ import __version__ + +from . import environments +from .environments import * xyzzy = """ _______ __ __ @@ -70,1531 +28,9 @@ $$/ $$/ $$$$$$$/ $$$$$$$/ $$/ $$/ $/ $$/ $$/ """ -# 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_mday == 30)) or ((now.tm_mon == 10) and (now.tm_mday == 31)): - INSTALL_LABEL = 'šŸŽƒ ' - - # Christmas easter-egg. - elif ((now.tm_mon == 12) and (now.tm_mday == 24)) or ((now.tm_mon == 12) and (now.tm_mday == 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: - # If the project doesn't exist yet, check current directory for a .env file - project_directory = project.project_directory or '.' - - denv = dotenv.find_dotenv(PIPENV_DOTENV_LOCATION or os.sep.join([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: - touch_update_stamp() - r = requests.get('https://pypi.python.org/pypi/pipenv/json', timeout=0.5) - latest = max(map(semver.parse_version_info, r.json()['releases'].keys())) - 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.""" - touch_update_stamp() - 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 = max(map(semver.parse_version_info, r.json()['releases'].keys())) - 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'] - - os.environ['PIP_PYTHON_VERSION'] = str('.'.join(map(str, sys.version_info[:3]))) - os.environ['PIP_PYTHON_PATH'] = str(sys.executable) - - 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): - import pip - from pip.req.req_file import parse_requirements - # 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 ', '--index-url ')): - 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) - pkg_names = pipreqs.get_pkg_names(rs) - return [proper_case(r) for r in pkg_names] - except Exception: - return [] - - -def ensure_pipfile(validate=True, skip_requirements=False): - """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 and not skip_requirements: - 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(): - import pip - """Adds all pyenv installations to the PATH.""" - if PYENV_INSTALLED: - if PYENV_ROOT: - pyenv_paths = {} - for found in glob( - '{0}{1}versions{1}*'.format( - PYENV_ROOT, - os.sep - ) - ): - pyenv_paths[os.path.split(found)[1]] = '{0}{1}bin'.format(found, os.sep) - - for version_str, pyenv_path in pyenv_paths.items(): - version = pip._vendor.packaging.version.parse(version_str) - if version.is_prerelease and pyenv_paths.get(version.base_version): - continue - add_to_path(pyenv_path) - 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.14', - # '3.1': '3.1.5', - # '3.2': '3.2.6', - '3.3': '3.3.7', - '3.4': '3.4.7', - '3.5': '3.5.4', - '3.6': '3.6.4', - } - 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 - ) - sys.exit(1) - - return path_to_python - - -def ensure_virtualenv(three=None, python=None, site_packages=False): - """Creates a virtualenv, if one doesn't exist.""" - - def abort(): - sys.exit(1) - - 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): - - USING_DEFAULT_PYTHON = False - - # Ensure python is installed before deleting existing virtual env - ensure_python(three=three, python=python) - - click.echo(crayons.red('Virtualenv already exists!'), err=True) - # If VIRTUAL_ENV is set, there is a possibility that we are - # going to remove the active virtualenv that the user cares - # about, so confirm first. - if 'VIRTUAL_ENV' in os.environ: - if not (PIPENV_YES or click.confirm('Remove existing virtualenv?', default=True)): - abort() - click.echo(crayons.normal(u'Removing existing virtualenvā€¦', bold=True), err=True) - - # 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, deploy=False, skip_requirements=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 deploy: - click.echo( - ' {0} will surely fail.' - ''.format(crayons.red('$ pipenv check')), - err=True - ) - else: - click.echo(crayons.red('Deploy aborted.'), err=True) - sys.exit(1) - - # Ensure the Pipfile exists. - ensure_pipfile(validate=validate, skip_requirements=skip_requirements) - - -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.strip())) - - 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_file(project._lockfile) - else: - with open(project.lockfile_location) as f: - lockfile = split_file(simplejson.load(f)) - - if not bare: - click.echo( - crayons.normal( - u'Installing dependencies from Pipfile.lock ({0})ā€¦'.format( - lockfile['_meta'].get('hash', {}).get('sha256')[-6:] - ), - bold=True - ) - ) - - # Allow pip to resolve dependencies when in skip-lock mode. - no_deps = (not skip_lock) - - deps_list, dev_deps_list = merge_deps( - lockfile, - project, - dev=dev, - requirements=requirements, - ignore_hashes=ignore_hashes, - blocking=blocking, - only=only - ) - failed_deps_list = [] - if requirements: - # Output only default dependencies - if not dev: - click.echo('\n'.join(d[0] for d in deps_list)) - sys.exit(0) - - # Output only dev dependencies - if dev: - click.echo('\n'.join(d[0] for d in dev_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, block 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=block, - 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) - ), err=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, - allow_global=system - ) - - # 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 - - if vcs_deps: - for line in pip_freeze.strip().split('\n'): - # if the line doesn't match a vcs dependency in the Pipfile, - # ignore it - if not any(dep in line for dep in vcs_deps): - continue - - 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, - allow_global=system - ) - - # 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) - try: - lockfile['_meta']['host-environment-markers'] = simplejson.loads(c.out) - except ValueError: - click.echo(crayons.red("An unexpected error occurred while accessing your virtualenv's python installation!")) - click.echo('Please run $ {0} to re-create your environment.'.format(crayons.red('pipenv --rm'))) - sys.exit(1) - - # 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 ({0})!'.format( - lockfile['_meta'].get('hash', {}).get('sha256')[-6:] - ), - 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 PIPENV_SHELL and 'fish' in PIPENV_SHELL: - suffix = '.fish' - - # Support for csh shell. - if PIPENV_SHELL and '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 - - # Remove comments from the output, if any. - installed = [line for line in freeze.splitlines() if not line.lstrip().startswith('#')] - - # 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, pre=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: - - old_hash = lockfile['_meta'].get('hash', {}).get('sha256')[-6:] - new_hash = p.hash[-6:] - if deploy: - click.echo( - crayons.red( - 'Your Pipfile.lock ({0}) is out of date. Expected: ({1}).'.format( - old_hash, - new_hash - ) - ) - ) - click.echo(crayons.normal('Aborting deploy.', bold=True), err=True) - sys.exit(1) - else: - click.echo( - crayons.red( - u'Pipfile.lock ({0}) out of date, updating to ({1})ā€¦'.format( - old_hash, - new_hash - ), - bold=True), - err=True - ) - - do_lock(system=system, pre=pre) - - # 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, pre=pre) - - 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 and not deploy: - 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 -): - import pip - - 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. - try: - req = get_requirement(package_name.split('--hash')[0].split('--trusted-host')[0]).vcs - except (pip._vendor.pyparsing.ParseException, ValueError) as e: - click.echo('{0}: {1}'.format(crayons.red('WARNING'), e), err=True) - click.echo( - '{0}... You will have to reinstall any packages that failed to install.'.format( - crayons.red('ABORTING INSTALL') - ), err=True - ) - click.echo( - 'You may have to manually run {0} when you are finished.'.format( - crayons.normal('pipenv lock', bold=True) - ) - ) - sys.exit(1) - if req: - no_deps = False - - # Don't specify a source directory when using --system. - if not allow_global and ('PIP_SRC' not in os.environ): - 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']) - - for p in ('pip', 'pip2', 'pip3'): - where = system_which(p) - if where: - return where - - return which('pip') - - -def system_which(command, mult=False): - """Emulates the system's which. Returns None if 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 vulnerabilities: - $ {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' PS: You have excellent taste!') - else: - click.echo(u' PS: You have excellent taste! āœØ šŸ° āœØ') - - CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help']) @@ -1619,21 +55,22 @@ def cli( python=False, help=False, update=False, jumbotron=False, py=False, site_packages=False, envs=False, man=False, completion=False ): + from . import core if jumbotron: # Awesome sauce. click.echo(crayons.normal(xyzzy, bold=True)) if not update: - if need_update_check(): + if core.need_update_check(): # Spun off in background thread, not unlike magic. - check_for_updates() + core.check_for_updates() else: # Update pip to latest version. - ensure_latest_pip() + core.ensure_latest_pip() # Upgrade self to latest version. - ensure_latest_self() + core.ensure_latest_self() sys.exit() @@ -1651,9 +88,9 @@ def cli( sys.exit(0) if man: - if system_which('man'): + if core.system_which('man'): path = os.sep.join([os.path.dirname(__file__), 'pipenv.1']) - os.execle(system_which('man'), 'man', path, os.environ) + os.execle(core.system_which('man'), 'man', path, os.environ) else: click.echo('man does not appear to be available on your system.', err=True) @@ -1668,26 +105,26 @@ def cli( )) sys.exit(0) - warn_in_virtualenv() + core.warn_in_virtualenv() if ctx.invoked_subcommand is None: # --where was passed... if where: - do_where(bare=True) + core.do_where(bare=True) sys.exit(0) elif py: - do_py() + core.do_py() sys.exit() # --venv was passed... elif venv: # There is no virtualenv yet. - if not project.virtualenv_exists: + if not core.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) + click.echo(core.project.virtualenv_location) sys.exit(0) # --rm was passed... @@ -1701,8 +138,8 @@ def cli( ) ) sys.exit(1) - if project.virtualenv_exists: - loc = project.virtualenv_location + if core.project.virtualenv_exists: + loc = core.project.virtualenv_location click.echo( crayons.normal( u'{0} ({1})ā€¦'.format( @@ -1712,9 +149,9 @@ def cli( ) ) - with spinner(): + with core.spinner(): # Remove the virtualenv. - cleanup_virtualenv(bare=True) + core.cleanup_virtualenv(bare=True) sys.exit(0) else: click.echo( @@ -1727,20 +164,14 @@ def cli( # --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) + core.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())) + click.echo(core.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(short_help="Installs provided packages and adds them to Pipfile, or (if none is given), installs all packages.", context_settings=dict( ignore_unknown_options=True, @@ -1766,184 +197,14 @@ def install( skip_lock=False, verbose=False, requirements=False, sequential=False, pre=False, code=False, deploy=False ): - import pip - - # Automatically use an activated virtualenv. - if PIPENV_USE_SYSTEM: - system = True - - # Don't search for requirements.txt files if the user provides one - skip_requirements = True if requirements else False - - concurrent = (not sequential) - - # Ensure that virtualenv is available. - ensure_project(three=three, python=python, system=system, warn=True, deploy=deploy, skip_requirements=skip_requirements) - - # Load the --pre settings from the Pipfile. - if not pre: - pre = project.settings.get('allow_prereleases') - - remote = requirements and is_valid_url(requirements) - # Check if the file is remote or not - if remote: - fd, temp_reqs = tempfile.mkstemp(prefix='pipenv-', suffix='-requirement.txt') - requirements_url = requirements - - # Download requirements file - click.echo(crayons.normal(u'Remote requirements file provided! Downloadingā€¦',bold=True),err=True) - try: - download_file(requirements, temp_reqs) - except IOError: - click.echo( - crayons.red( - u'Unable to find requirements file at {0}.'.format(crayons.normal(requirements)) - ), - err=True - ) - sys.exit(1) - # Replace the url with the temporary requirements file - requirements = temp_reqs - remote = True - - if requirements: - error, traceback = None, None - click.echo(crayons.normal(u'Requirements file provided! Importing into Pipfileā€¦', bold=True), err=True) - try: - import_requirements(r=project.path_to(requirements), dev=dev) - except (UnicodeDecodeError, pip.exceptions.PipError) as e: - # Don't print the temp file path if remote since it will be deleted. - req_path = requirements_url if remote else project.path_to(requirements) - error = (u'Unexpected syntax in {0}. Are you sure this is a ' - 'requirements.txt style file?'.format(req_path)) - traceback = e - except AssertionError as e: - error = (u'Requirements file doesn\'t appear to exist. Please ensure the file exists in your ' - 'project directory or you provided the correct path.') - traceback = e - finally: - # If requirements file was provided by remote url delete the temporary file - if remote: - os.close(fd) # Close for windows to allow file cleanup. - os.remove(project.path_to(temp_reqs)) - - if error and traceback: - click.echo(crayons.red(error)) - click.echo(crayons.blue(str(traceback)), err=True) - sys.exit(1) - - 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)]) - - # Capture . argument and assign it to nothing - if package_name == '.': - package_name = False - - # 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 any(op in package_names[0] for op in '!=<>~'): - 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: - # Update project settings with pre preference. - if pre: - project.update_settings({'allow_prereleases': pre}) - - do_init(dev=dev, allow_global=system, ignore_pipfile=ignore_pipfile, system=system, skip_lock=skip_lock, verbose=verbose, concurrent=concurrent, deploy=deploy, pre=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. - try: - converted = convert_deps_from_pip(package_name) - except ValueError as e: - click.echo('{0}: {1}'.format(crayons.red('WARNING'), e)) - sys.exit(1) - - key = [k for k in converted.keys()][0] - if is_vcs(key) or 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-dependencies 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) - - click.echo( - '{0} {1} {2} {3}{4}'.format( - crayons.normal('Adding', bold=True), - crayons.green(package_name, bold=True), - crayons.normal("to Pipfile's", bold=True), - crayons.red('[dev-packages]' if dev else '[packages]', bold=True), - crayons.normal('ā€¦', bold=True), - ) - ) - - # 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) + from . import core + core.do_install( + package_name=package_name, more_packages=more_packages, dev=dev, + three=three, python=python, system=system, lock=lock, + ignore_pipfile=ignore_pipfile, skip_lock=skip_lock, verbose=verbose, + requirements=requirements, sequential=sequential, pre=pre, code=code, + deploy=deploy + ) @click.command(short_help="Un-installs a provided package and removes it from Pipfile.") @@ -1960,93 +221,13 @@ def uninstall( package_name=False, more_packages=False, three=None, python=False, system=False, lock=False, all_dev=False, all=False, verbose=False ): + from . import core + core.do_uninstall( + package_name=package_name, more_packages=more_packages, three=three, + python=python, system=system, lock=lock, all_dev=all_dev, all=all, + verbose=verbose + ) - # Automatically use an activated virtualenv. - if PIPENV_USE_SYSTEM: - system = True - - # Ensure that virtualenv is available. - ensure_project(three=three, python=python) - - # Load the --pre settings from the Pipfile. - pre = project.settings.get('pre') - - 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 all_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 all_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'.format( - which_pip(allow_global=system), - package_name - ) - if verbose: - click.echo('$ {0}'.format(cmd)) - - c = delegator.run(cmd) - - 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, pre=pre) @click.command(short_help="Generates Pipfile.lock.") @@ -2058,119 +239,20 @@ def uninstall( @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, dev=False, clear=False, pre=False): + from . import core # Ensure that virtualenv is available. - ensure_project(three=three, python=python) + core.ensure_project(three=three, python=python) # Load the --pre settings from the Pipfile. if not pre: - pre = project.settings.get('pre') + pre = core.project.settings.get('pre') if requirements: - do_init(dev=dev, requirements=requirements) + core.do_init(dev=dev, requirements=requirements) - do_lock(verbose=verbose, clear=clear, pre=pre) + core.do_lock(verbose=verbose, clear=clear, pre=pre) -def do_shell(three=None, python=False, fancy=False, shell_args=None): - - # Ensure that virtualenv is available. - ensure_project(three=three, python=python, validate=False) - - # 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: - if PIPENV_SHELL: - shell = os.path.abspath(PIPENV_SHELL) - else: - 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}). Use {1} to leave.'.format( - crayons.red(shell), - crayons.normal("'exit'", bold=True) - ), bold=True - ), err=True - ) - - cmd = "{0} -i'".format(shell) - args = [] - - # Standard (properly configured shell) mode: - else: - if PIPENV_VENV_IN_PROJECT: - # use .venv as the target virtualenv name - workon_name = '.venv' - else: - workon_name = project.virtualenv_name - - cmd = 'pew' - args = ["workon", workon_name] - - # Grab current terminal dimensions to replace the hardcoded default - # dimensions of pexpect - terminal_dimensions = get_terminal_size() - - try: - with temp_environ(): - if PIPENV_VENV_IN_PROJECT: - os.environ['WORKON_HOME'] = project.project_directory - - c = pexpect.spawn( - cmd, - args, - dimensions=( - terminal_dimensions.lines, - terminal_dimensions.columns - ) - ) - - # Windows! - except AttributeError: - import subprocess - # Tell pew to use the project directory as its workon_home - with temp_environ(): - if PIPENV_VENV_IN_PROJECT: - os.environ['WORKON_HOME'] = project.project_directory - 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(short_help="Spawns a shell within the virtualenv.", context_settings=dict( ignore_unknown_options=True, @@ -2182,7 +264,7 @@ def do_shell(three=None, python=False, fancy=False, shell_args=None): @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): - + from . import core # Prevent user from activating nested environments. if 'PIPENV_ACTIVE' in os.environ: # If PIPENV_ACTIVE is set, VIRTUAL_ENV should always be set too. @@ -2198,28 +280,13 @@ def shell(three=None, python=False, fancy=False, shell_args=None, anyway=False): sys.exit(1) # Load .env file. - load_dot_env() + core.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 - ) + core.do_shell(three=three, python=python, fancy=fancy, shell_args=shell_args) @click.command( @@ -2286,102 +353,8 @@ def run(command, args, three=None, python=False): @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', project.path_to(style)] + list(args) - flake8.main.cli.main() - exit() - - if unused: - deps_required = [k for k in project.packages.keys()] - deps_needed = 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) + from . import core + core.do_check(three=three, python=python, unused=unused, style=style, args=args) @click.command(short_help=u"Displays currentlyā€“installed dependency graph information.") @@ -2389,73 +362,8 @@ def check(three=None, python=False, unused=False, style=False, args=None): @click.option('--json', is_flag=True, default=False, help="Output JSON.") @click.option('--reverse', is_flag=True, default=False, help="Reversed dependency graph.") def graph(bare=False, json=False, reverse=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) - - if reverse and json: - click.echo( - u'{0}: {1}'.format( - crayons.red('Warning', bold=True), - u'Using both --reverse and --json together is not supported. ' - u'Please select one of the two options.', - ), err=True - ) - sys.exit(1) - - flag = '' - if json: - flag = '--json' - if reverse: - flag = '--reverse' - - cmd = '"{0}" {1} {2}'.format( - python_path, - shellquote(pipdeptree.__file__.rstrip('cdo')), - flag - ) - - # 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 as top level. - if line.split('==')[0] in BAD_PACKAGES and not reverse: - 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) + from . import core + core.do_graph(bare=bare, json=json, reverse=reverse) @click.command(short_help="View a given module in your editor.", name="open") @@ -2463,11 +371,11 @@ def graph(bare=False, json=False, reverse=False): @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): - + from . import core # Ensure that virtualenv is available. - ensure_project(three=three, python=python, validate=False) + core.ensure_project(three=three, python=python, validate=False) - c = delegator.run('{0} -c "import {1}; print({1}.__file__);"'.format(which('python'), module)) + c = delegator.run('{0} -c "import {1}; print({1}.__file__);"'.format(core.which('python'), module)) try: assert c.return_code == 0 @@ -2496,115 +404,18 @@ def run_open(module, three=None, python=None): @click.option('--clear', is_flag=True, default=False, help="Clear the dependency cache.") @click.option('--sequential', is_flag=True, default=False, help="Install dependencies one-at-a-time, instead of concurrently.") @click.pass_context -def update(ctx, dev=False, three=None, python=None, dry_run=False, bare=False, dont_upgrade=False, user=False, verbose=False, clear=False, unused=False, package_name=None, sequential=False): - - # Ensure that virtualenv is available. - ensure_project(three=three, python=python, validate=False) - - concurrent = (not sequential) - - # --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'] - latest = result['version'] - - try: - installed = 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)) - - if not package_name: - click.echo( - crayons.normal(u'Updating all dependencies from Pipfileā€¦', bold=True) - ) - - pre = project.settings.get('allow_prereleases') - - # Purge. - do_purge() - - # Lock. - do_lock(clear=clear, pre=pre) - - # Install everything. - do_init(dev=dev, verbose=verbose, concurrent=concurrent) - - click.echo( - crayons.green('All dependencies are now up-to-date!') - ) - else: - - if package_name in project.all_packages: - - click.echo( - u'Uninstalling {0}ā€¦'.format( - crayons.green(package_name) - ) - ) - - cmd = '"{0}" uninstall {1} -y'.format(which_pip(), package_name) - c = delegator.run(cmd) - - try: - assert c.return_code == 0 - except AssertionError: - click.echo() - click.echo(crayons.blue(c.err)) - # sys.exit(1) - - p_name = convert_deps_to_pip({package_name: project.all_packages[package_name]}, r=False) - ctx.invoke(install, package_name=p_name[0]) - - else: - click.echo( - '{0} was not found in your {1}!'.format( - crayons.green(package_name), - crayons.normal('Pipfile', bold=True) - ) - ) +def update( + ctx, dev=False, three=None, python=None, dry_run=False, bare=False, + dont_upgrade=False, user=False, verbose=False, clear=False, unused=False, + package_name=None, sequential=False +): + from . import core + core.do_update( + ctx=ctx, install=install, dev=dev, three=three, python=python, dry_run=dry_run, + bare=bare, dont_upgrade=dont_upgrade, user=user, verbose=verbose, + clear=clear, unused=unused, package_name=package_name, + sequential=sequential + ) # Install click commands. @@ -2618,6 +429,7 @@ 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]) diff --git a/pipenv/core.py b/pipenv/core.py new file mode 100644 index 00000000..52ec6f12 --- /dev/null +++ b/pipenv/core.py @@ -0,0 +1,2321 @@ +# -*- 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 pipfile +import pipdeptree +import semver +import flake8.main.cli +from pipreqs import pipreqs +from blindspin import spinner +from urllib3.exceptions import InsecureRequestWarning +from .project import Project +from .utils import ( + convert_deps_from_pip, convert_deps_to_pip, is_required_version, + proper_case, pep423_name, split_file, merge_deps, resolve_deps, shellquote, is_vcs, + python_version, suggest_package, find_windows_executable, is_file, + prepare_pip_source_args, temp_environ, is_valid_url, download_file, + get_requirement, need_update_check, touch_update_stamp +) +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_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_mday == 30)) or ((now.tm_mon == 10) and (now.tm_mday == 31)): + INSTALL_LABEL = 'šŸŽƒ ' + + # Christmas easter-egg. + elif ((now.tm_mon == 12) and (now.tm_mday == 24)) or ((now.tm_mon == 12) and (now.tm_mday == 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: + # If the project doesn't exist yet, check current directory for a .env file + project_directory = project.project_directory or '.' + + denv = dotenv.find_dotenv(PIPENV_DOTENV_LOCATION or os.sep.join([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: + touch_update_stamp() + r = requests.get('https://pypi.python.org/pypi/pipenv/json', timeout=0.5) + latest = max(map(semver.parse_version_info, r.json()['releases'].keys())) + 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.""" + touch_update_stamp() + 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 = max(map(semver.parse_version_info, r.json()['releases'].keys())) + 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'] + + os.environ['PIP_PYTHON_VERSION'] = str('.'.join(map(str, sys.version_info[:3]))) + os.environ['PIP_PYTHON_PATH'] = str(sys.executable) + + 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): + import pip + from pip.req.req_file import parse_requirements + # 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 ', '--index-url ')): + 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) + pkg_names = pipreqs.get_pkg_names(rs) + return [proper_case(r) for r in pkg_names] + except Exception: + return [] + + +def ensure_pipfile(validate=True, skip_requirements=False): + """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 and not skip_requirements: + 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(): + import pip + """Adds all pyenv installations to the PATH.""" + if PYENV_INSTALLED: + if PYENV_ROOT: + pyenv_paths = {} + for found in glob( + '{0}{1}versions{1}*'.format( + PYENV_ROOT, + os.sep + ) + ): + pyenv_paths[os.path.split(found)[1]] = '{0}{1}bin'.format(found, os.sep) + + for version_str, pyenv_path in pyenv_paths.items(): + version = pip._vendor.packaging.version.parse(version_str) + if version.is_prerelease and pyenv_paths.get(version.base_version): + continue + add_to_path(pyenv_path) + 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.14', + # '3.1': '3.1.5', + # '3.2': '3.2.6', + '3.3': '3.3.7', + '3.4': '3.4.7', + '3.5': '3.5.4', + '3.6': '3.6.4', + } + 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 + ) + sys.exit(1) + + return path_to_python + + +def ensure_virtualenv(three=None, python=None, site_packages=False): + """Creates a virtualenv, if one doesn't exist.""" + + def abort(): + sys.exit(1) + + 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): + + USING_DEFAULT_PYTHON = False + + # Ensure python is installed before deleting existing virtual env + ensure_python(three=three, python=python) + + click.echo(crayons.red('Virtualenv already exists!'), err=True) + # If VIRTUAL_ENV is set, there is a possibility that we are + # going to remove the active virtualenv that the user cares + # about, so confirm first. + if 'VIRTUAL_ENV' in os.environ: + if not (PIPENV_YES or click.confirm('Remove existing virtualenv?', default=True)): + abort() + click.echo(crayons.normal(u'Removing existing virtualenvā€¦', bold=True), err=True) + + # 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, deploy=False, skip_requirements=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 deploy: + click.echo( + ' {0} will surely fail.' + ''.format(crayons.red('$ pipenv check')), + err=True + ) + else: + click.echo(crayons.red('Deploy aborted.'), err=True) + sys.exit(1) + + # Ensure the Pipfile exists. + ensure_pipfile(validate=validate, skip_requirements=skip_requirements) + + +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.strip())) + + 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_file(project._lockfile) + else: + with open(project.lockfile_location) as f: + lockfile = split_file(simplejson.load(f)) + + if not bare: + click.echo( + crayons.normal( + u'Installing dependencies from Pipfile.lock ({0})ā€¦'.format( + lockfile['_meta'].get('hash', {}).get('sha256')[-6:] + ), + bold=True + ) + ) + + # Allow pip to resolve dependencies when in skip-lock mode. + no_deps = (not skip_lock) + + deps_list, dev_deps_list = merge_deps( + lockfile, + project, + dev=dev, + requirements=requirements, + ignore_hashes=ignore_hashes, + blocking=blocking, + only=only + ) + failed_deps_list = [] + if requirements: + # Output only default dependencies + if not dev: + click.echo('\n'.join(d[0] for d in deps_list)) + sys.exit(0) + + # Output only dev dependencies + if dev: + click.echo('\n'.join(d[0] for d in dev_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, block 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=block, + 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) + ), err=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, + allow_global=system + ) + + # 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 + + if vcs_deps: + for line in pip_freeze.strip().split('\n'): + # if the line doesn't match a vcs dependency in the Pipfile, + # ignore it + if not any(dep in line for dep in vcs_deps): + continue + + 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, + allow_global=system + ) + + # 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) + try: + lockfile['_meta']['host-environment-markers'] = simplejson.loads(c.out) + except ValueError: + click.echo(crayons.red("An unexpected error occurred while accessing your virtualenv's python installation!")) + click.echo('Please run $ {0} to re-create your environment.'.format(crayons.red('pipenv --rm'))) + sys.exit(1) + + # 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 ({0})!'.format( + lockfile['_meta'].get('hash', {}).get('sha256')[-6:] + ), + 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 PIPENV_SHELL and 'fish' in PIPENV_SHELL: + suffix = '.fish' + + # Support for csh shell. + if PIPENV_SHELL and '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 + + # Remove comments from the output, if any. + installed = [line for line in freeze.splitlines() if not line.lstrip().startswith('#')] + + # 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, pre=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: + + old_hash = lockfile['_meta'].get('hash', {}).get('sha256')[-6:] + new_hash = p.hash[-6:] + if deploy: + click.echo( + crayons.red( + 'Your Pipfile.lock ({0}) is out of date. Expected: ({1}).'.format( + old_hash, + new_hash + ) + ) + ) + click.echo(crayons.normal('Aborting deploy.', bold=True), err=True) + sys.exit(1) + else: + click.echo( + crayons.red( + u'Pipfile.lock ({0}) out of date, updating to ({1})ā€¦'.format( + old_hash, + new_hash + ), + bold=True), + err=True + ) + + do_lock(system=system, pre=pre) + + # 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, pre=pre) + + 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 and not deploy: + 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 +): + import pip + + 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. + try: + req = get_requirement(package_name.split('--hash')[0].split('--trusted-host')[0]).vcs + except (pip._vendor.pyparsing.ParseException, ValueError) as e: + click.echo('{0}: {1}'.format(crayons.red('WARNING'), e), err=True) + click.echo( + '{0}... You will have to reinstall any packages that failed to install.'.format( + crayons.red('ABORTING INSTALL') + ), err=True + ) + click.echo( + 'You may have to manually run {0} when you are finished.'.format( + crayons.normal('pipenv lock', bold=True) + ) + ) + sys.exit(1) + if req: + no_deps = False + + # Don't specify a source directory when using --system. + if not allow_global and ('PIP_SRC' not in os.environ): + 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']) + + for p in ('pip', 'pip2', 'pip3'): + where = system_which(p) + if where: + return where + + return which('pip') + + +def system_which(command, mult=False): + """Emulates the system's which. Returns None if 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 vulnerabilities: + $ {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' PS: You have excellent taste!') + else: + click.echo(u' PS: You have excellent taste! āœØ šŸ° āœØ') + + + + + +def do_py(system=False): + try: + click.echo(which('python', allow_global=system)) + except AttributeError: + click.echo(crayons.red('No project found!')) + + + +def do_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 +): + import pip + + # Automatically use an activated virtualenv. + if PIPENV_USE_SYSTEM: + system = True + + # Don't search for requirements.txt files if the user provides one + skip_requirements = True if requirements else False + + concurrent = (not sequential) + + # Ensure that virtualenv is available. + ensure_project(three=three, python=python, system=system, warn=True, deploy=deploy, skip_requirements=skip_requirements) + + # Load the --pre settings from the Pipfile. + if not pre: + pre = project.settings.get('allow_prereleases') + + remote = requirements and is_valid_url(requirements) + # Check if the file is remote or not + if remote: + fd, temp_reqs = tempfile.mkstemp(prefix='pipenv-', suffix='-requirement.txt') + requirements_url = requirements + + # Download requirements file + click.echo(crayons.normal(u'Remote requirements file provided! Downloadingā€¦', bold=True), err=True) + try: + download_file(requirements, temp_reqs) + except IOError: + click.echo( + crayons.red( + u'Unable to find requirements file at {0}.'.format(crayons.normal(requirements)) + ), + err=True + ) + sys.exit(1) + # Replace the url with the temporary requirements file + requirements = temp_reqs + remote = True + + if requirements: + error, traceback = None, None + click.echo(crayons.normal(u'Requirements file provided! Importing into Pipfileā€¦', bold=True), err=True) + try: + import_requirements(r=project.path_to(requirements), dev=dev) + except (UnicodeDecodeError, pip.exceptions.PipError) as e: + # Don't print the temp file path if remote since it will be deleted. + req_path = requirements_url if remote else project.path_to(requirements) + error = (u'Unexpected syntax in {0}. Are you sure this is a ' + 'requirements.txt style file?'.format(req_path)) + traceback = e + except AssertionError as e: + error = (u'Requirements file doesn\'t appear to exist. Please ensure the file exists in your ' + 'project directory or you provided the correct path.') + traceback = e + finally: + # If requirements file was provided by remote url delete the temporary file + if remote: + os.close(fd) # Close for windows to allow file cleanup. + os.remove(project.path_to(temp_reqs)) + + if error and traceback: + click.echo(crayons.red(error)) + click.echo(crayons.blue(str(traceback)), err=True) + sys.exit(1) + + 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)]) + + # Capture . argument and assign it to nothing + if package_name == '.': + package_name = False + + # 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 any(op in package_names[0] for op in '!=<>~'): + 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: + # Update project settings with pre preference. + if pre: + project.update_settings({'allow_prereleases': pre}) + + do_init(dev=dev, allow_global=system, ignore_pipfile=ignore_pipfile, system=system, skip_lock=skip_lock, verbose=verbose, concurrent=concurrent, deploy=deploy, pre=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. + try: + converted = convert_deps_from_pip(package_name) + except ValueError as e: + click.echo('{0}: {1}'.format(crayons.red('WARNING'), e)) + sys.exit(1) + + key = [k for k in converted.keys()][0] + if is_vcs(key) or 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-dependencies 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) + + click.echo( + '{0} {1} {2} {3}{4}'.format( + crayons.normal('Adding', bold=True), + crayons.green(package_name, bold=True), + crayons.normal("to Pipfile's", bold=True), + crayons.red('[dev-packages]' if dev else '[packages]', bold=True), + crayons.normal('ā€¦', bold=True), + ) + ) + + # 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) + + +def do_uninstall( + package_name=False, more_packages=False, three=None, python=False, + system=False, lock=False, all_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) + + # Load the --pre settings from the Pipfile. + pre = project.settings.get('pre') + + 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 all_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 all_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'.format( + which_pip(allow_global=system), + package_name + ) + if verbose: + click.echo('$ {0}'.format(cmd)) + + c = delegator.run(cmd) + + 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, pre=pre) + + +def do_shell(three=None, python=False, fancy=False, shell_args=None): + + # Ensure that virtualenv is available. + ensure_project(three=three, python=python, validate=False) + + # 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: + if PIPENV_SHELL: + shell = os.path.abspath(PIPENV_SHELL) + else: + 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}). Use {1} to leave.'.format( + crayons.red(shell), + crayons.normal("'exit'", bold=True) + ), bold=True + ), err=True + ) + + cmd = "{0} -i'".format(shell) + args = [] + + # Standard (properly configured shell) mode: + else: + if PIPENV_VENV_IN_PROJECT: + # use .venv as the target virtualenv name + workon_name = '.venv' + else: + workon_name = project.virtualenv_name + + cmd = 'pew' + args = ["workon", workon_name] + + # Grab current terminal dimensions to replace the hardcoded default + # dimensions of pexpect + terminal_dimensions = get_terminal_size() + + try: + with temp_environ(): + if PIPENV_VENV_IN_PROJECT: + os.environ['WORKON_HOME'] = project.project_directory + + c = pexpect.spawn( + cmd, + args, + dimensions=( + terminal_dimensions.lines, + terminal_dimensions.columns + ) + ) + + # Windows! + except AttributeError: + import subprocess + # Tell pew to use the project directory as its workon_home + with temp_environ(): + if PIPENV_VENV_IN_PROJECT: + os.environ['WORKON_HOME'] = project.project_directory + 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) + + +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 + ) + + +def do_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 + + +def do_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', project.path_to(style)] + list(args) + flake8.main.cli.main() + exit() + + if unused: + deps_required = [k for k in project.packages.keys()] + deps_needed = 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) + + +def do_graph(bare=False, json=False, reverse=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) + + if reverse and json: + click.echo( + u'{0}: {1}'.format( + crayons.red('Warning', bold=True), + u'Using both --reverse and --json together is not supported. ' + u'Please select one of the two options.', + ), err=True + ) + sys.exit(1) + + flag = '' + if json: + flag = '--json' + if reverse: + flag = '--reverse' + + cmd = '"{0}" {1} {2}'.format( + python_path, + shellquote(pipdeptree.__file__.rstrip('cdo')), + flag + ) + + # 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 as top level. + if line.split('==')[0] in BAD_PACKAGES and not reverse: + 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) + + +def do_update(ctx, install, dev=False, three=None, python=None, dry_run=False, bare=False, dont_upgrade=False, user=False, verbose=False, clear=False, unused=False, package_name=None, sequential=False): + + # Ensure that virtualenv is available. + ensure_project(three=three, python=python, validate=False) + + concurrent = (not sequential) + + # --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'] + latest = result['version'] + + try: + installed = 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)) + + if not package_name: + click.echo( + crayons.normal(u'Updating all dependencies from Pipfileā€¦', bold=True) + ) + + pre = project.settings.get('allow_prereleases') + + # Purge. + do_purge() + + # Lock. + do_lock(clear=clear, pre=pre) + + # Install everything. + do_init(dev=dev, verbose=verbose, concurrent=concurrent) + + click.echo( + crayons.green('All dependencies are now up-to-date!') + ) + else: + + if package_name in project.all_packages: + + click.echo( + u'Uninstalling {0}ā€¦'.format( + crayons.green(package_name) + ) + ) + + cmd = '"{0}" uninstall {1} -y'.format(which_pip(), package_name) + c = delegator.run(cmd) + + try: + assert c.return_code == 0 + except AssertionError: + click.echo() + click.echo(crayons.blue(c.err)) + # sys.exit(1) + + p_name = convert_deps_to_pip({package_name: project.all_packages[package_name]}, r=False) + ctx.invoke(install, package_name=p_name[0]) + + else: + click.echo( + '{0} was not found in your {1}!'.format( + crayons.green(package_name), + crayons.normal('Pipfile', bold=True) + ) + ) \ No newline at end of file From 8d3a34d45e5097d9c3ff283dc6e0fbb2e40816b6 Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Sun, 4 Feb 2018 14:12:06 -0500 Subject: [PATCH 4/9] cleanup refactor Signed-off-by: Kenneth Reitz --- pipenv/cli.py | 40 ++-------------------------------------- 1 file changed, 2 insertions(+), 38 deletions(-) diff --git a/pipenv/cli.py b/pipenv/cli.py index 07c14ce6..55152f1f 100644 --- a/pipenv/cli.py +++ b/pipenv/cli.py @@ -303,44 +303,8 @@ def shell(three=None, python=False, fancy=False, shell_args=None, anyway=False): @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 + from . import core + core.do_run(command=command, args=args, three=three, python=python) @click.command(short_help="Checks for security vulnerabilities and against PEP 508 markers provided in Pipfile.", context_settings=dict( From f21897770a15fb294b7b82807d9a0b43c3d09db4 Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Sun, 4 Feb 2018 14:14:28 -0500 Subject: [PATCH 5/9] futher cleanup of refactor Signed-off-by: Kenneth Reitz --- pipenv/core.py | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/pipenv/core.py b/pipenv/core.py index 52ec6f12..1798f8cc 100644 --- a/pipenv/core.py +++ b/pipenv/core.py @@ -37,7 +37,6 @@ from .utils import ( ) 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_TIMEOUT, PIPENV_SKIP_VALIDATION, @@ -54,20 +53,6 @@ if sys.version_info < (3, 3): else: from shutil import get_terminal_size -xyzzy = """ - _______ __ __ -/ \ / | / | -$$$$$$$ |$$/ ______ ______ _______ __ __ $$ | -$$ |__$$ |/ | / \ / \ / \ / \ / |$$ | -$$ $$/ $$ |/$$$$$$ |/$$$$$$ |$$$$$$$ |$$ \ /$$/ $$ | -$$$$$$$/ $$ |$$ | $$ |$$ $$ |$$ | $$ | $$ /$$/ $$/ -$$ | $$ |$$ |__$$ |$$$$$$$$/ $$ | $$ | $$ $$/ __ -$$ | $$ |$$ $$/ $$ |$$ | $$ | $$$/ / | -$$/ $$/ $$$$$$$/ $$$$$$$/ $$/ $$/ $/ $$/ - $$ | - $$ | - $$/ -""" # Packages that should be ignored later. BAD_PACKAGES = ( From 4c83c9ea2ba0c167a6e454d6eb1aa3494dc92c9f Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Sun, 4 Feb 2018 14:16:53 -0500 Subject: [PATCH 6/9] declare an encoding Signed-off-by: Kenneth Reitz --- pipenv/cli.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pipenv/cli.py b/pipenv/cli.py index 55152f1f..94477626 100644 --- a/pipenv/cli.py +++ b/pipenv/cli.py @@ -1,7 +1,8 @@ +# -*- coding: utf-8 -*- + import os import sys - import click import click_completion import crayons From 9c4482649b5e341295373bcf0d535fa5b1469bb8 Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Sun, 4 Feb 2018 14:19:07 -0500 Subject: [PATCH 7/9] fix tests Signed-off-by: Kenneth Reitz --- tests/test_pipenv.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/tests/test_pipenv.py b/tests/test_pipenv.py index ef9f1ed1..d48b0f56 100644 --- a/tests/test_pipenv.py +++ b/tests/test_pipenv.py @@ -7,7 +7,7 @@ import json import pytest -from pipenv.cli import activate_virtualenv +from pipenv.core import activate_virtualenv from pipenv.utils import temp_environ, get_windows_path, mkdir_p, normalize_drive from pipenv.vendor import toml from pipenv.vendor import delegator @@ -267,7 +267,7 @@ records = "*" assert c.return_code != 0 c = p.pipenv('run python -c "import tablib"') assert c.return_code == 0 - + @pytest.mark.run @pytest.mark.uninstall @@ -318,10 +318,10 @@ records = "*" with PipenvInstance() as p: c = p.pipenv('install --dev requests pytest') assert c.return_code == 0 - + c = p.pipenv('install tpfd') assert c.return_code == 0 - + assert 'tpfd' in p.pipfile['packages'] assert 'requests' in p.pipfile['dev-packages'] assert 'pytest' in p.pipfile['dev-packages'] @@ -342,7 +342,7 @@ records = "*" c = p.pipenv('run python -m requests.help') assert c.return_code > 0 - + c = p.pipenv('run python -c "import tpfd"') assert c.return_code == 0 @@ -608,7 +608,7 @@ requests = {version = "*", os_name = "== 'splashwear'"} assert 'tablib' in p.lockfile['default'] assert 'git' in p.lockfile['default']['tablib'] assert p.lockfile['default']['tablib']['git'] == 'git://github.com/kennethreitz/tablib.git' - assert 'ref' in p.lockfile['default']['tablib'] + assert 'ref' in p.lockfile['default']['tablib'] @pytest.mark.run @pytest.mark.alt @@ -945,7 +945,7 @@ records = {extras = ["pandas"], version = "==0.5.2"} def test_resolve_system_python_no_virtualenv(self): """Ensure we don't error out when we are in a folder off of / and doing an install using --system, which used to cause the resolver and PIP_PYTHON_PATH to point at /bin/python - + Sample dockerfile: FROM python:3.6-alpine3.6 From 35629babb01f131b21f234416d0d9a71345d4dc9 Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Sun, 4 Feb 2018 14:23:05 -0500 Subject: [PATCH 8/9] fix legacy tests Signed-off-by: Kenneth Reitz --- tests/test_legacy.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_legacy.py b/tests/test_legacy.py index a9c1df5e..cb9a0e3b 100644 --- a/tests/test_legacy.py +++ b/tests/test_legacy.py @@ -2,7 +2,7 @@ import os from mock import patch, Mock, PropertyMock -from pipenv.cli import ( +from pipenv.core import ( pip_install, pip_download ) From 3cf44caf4d69d2fe32142ed43ff0362935015b31 Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Sun, 4 Feb 2018 14:53:34 -0500 Subject: [PATCH 9/9] improvements Signed-off-by: Kenneth Reitz --- pipenv/core.py | 1 + pipenv/utils.py | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/pipenv/core.py b/pipenv/core.py index 1798f8cc..8822f73d 100644 --- a/pipenv/core.py +++ b/pipenv/core.py @@ -104,6 +104,7 @@ project = Project() def load_dot_env(): + """Loads .env file into sys.environ.""" if not PIPENV_DONT_LOAD_ENV: # If the project doesn't exist yet, check current directory for a .env file project_directory = project.project_directory or '.' diff --git a/pipenv/utils.py b/pipenv/utils.py index 94480279..c9c214cb 100644 --- a/pipenv/utils.py +++ b/pipenv/utils.py @@ -10,7 +10,6 @@ import click import crayons import delegator import parse -import requirements import fuzzywuzzy.process import requests import six @@ -271,6 +270,7 @@ packages = [ def get_requirement(dep): import pip + import requirements """Pre-clean requirement strings passed to the requirements parser. Ensures that we can accept both local and relative paths, file and VCS URIs, @@ -852,6 +852,7 @@ def is_required_version(version, specified_version): def is_vcs(pipfile_entry): + import requirements """Determine if dictionary entry from Pipfile is for a vcs dependency.""" if hasattr(pipfile_entry, 'keys'):