hhblits: lib/python3.8/site-packages/pip/_internal/operations/install/wheel.py annotate

author	guerler
date	Mon, 27 Jul 2020 03:47:31 -0400
parents
children

rev	line source
0 9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	1 """Support for installing and building the "wheel" binary package format.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	2 """
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	3
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	4 # The following comment should be removed at some point in the future.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	5 # mypy: strict-optional=False
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	6
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	7 from __future__ import absolute_import
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	8
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	9 import collections
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	10 import compileall
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	11 import csv
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	12 import logging
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	13 import os.path
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	14 import re
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	15 import shutil
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	16 import stat
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	17 import sys
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	18 import warnings
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	19 from base64 import urlsafe_b64encode
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	20 from zipfile import ZipFile
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	21
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	22 from pip._vendor import pkg_resources
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	23 from pip._vendor.distlib.scripts import ScriptMaker
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	24 from pip._vendor.distlib.util import get_export_entry
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	25 from pip._vendor.six import StringIO
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	26
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	27 from pip._internal.exceptions import InstallationError
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	28 from pip._internal.locations import get_major_minor_version
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	29 from pip._internal.utils.misc import captured_stdout, ensure_dir, hash_file
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	30 from pip._internal.utils.temp_dir import TempDirectory
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	31 from pip._internal.utils.typing import MYPY_CHECK_RUNNING
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	32 from pip._internal.utils.unpacking import unpack_file
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	33 from pip._internal.utils.wheel import parse_wheel
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	34
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	35 if MYPY_CHECK_RUNNING:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	36 from email.message import Message
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	37 from typing import (
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	38 Dict, List, Optional, Sequence, Tuple, IO, Text, Any,
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	39 Iterable, Callable, Set,
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	40 )
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	41
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	42 from pip._internal.models.scheme import Scheme
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	43
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	44 InstalledCSVRow = Tuple[str, ...]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	45
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	46
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	47 logger = logging.getLogger(__name__)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	48
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	49
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	50 def normpath(src, p):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	51 # type: (str, str) -> str
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	52 return os.path.relpath(src, p).replace(os.path.sep, '/')
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	53
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	54
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	55 def rehash(path, blocksize=1 << 20):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	56 # type: (str, int) -> Tuple[str, str]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	57 """Return (encoded_digest, length) for path using hashlib.sha256()"""
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	58 h, length = hash_file(path, blocksize)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	59 digest = 'sha256=' + urlsafe_b64encode(
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	60 h.digest()
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	61 ).decode('latin1').rstrip('=')
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	62 # unicode/str python2 issues
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	63 return (digest, str(length)) # type: ignore
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	64
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	65
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	66 def open_for_csv(name, mode):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	67 # type: (str, Text) -> IO[Any]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	68 if sys.version_info[0] < 3:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	69 nl = {} # type: Dict[str, Any]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	70 bin = 'b'
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	71 else:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	72 nl = {'newline': ''} # type: Dict[str, Any]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	73 bin = ''
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	74 return open(name, mode + bin, **nl)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	75
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	76
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	77 def fix_script(path):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	78 # type: (str) -> Optional[bool]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	79 """Replace #!python with #!/path/to/python
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	80 Return True if file was changed.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	81 """
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	82 # XXX RECORD hashes will need to be updated
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	83 if os.path.isfile(path):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	84 with open(path, 'rb') as script:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	85 firstline = script.readline()
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	86 if not firstline.startswith(b'#!python'):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	87 return False
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	88 exename = sys.executable.encode(sys.getfilesystemencoding())
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	89 firstline = b'#!' + exename + os.linesep.encode("ascii")
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	90 rest = script.read()
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	91 with open(path, 'wb') as script:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	92 script.write(firstline)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	93 script.write(rest)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	94 return True
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	95 return None
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	96
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	97
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	98 def wheel_root_is_purelib(metadata):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	99 # type: (Message) -> bool
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	100 return metadata.get("Root-Is-Purelib", "").lower() == "true"
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	101
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	102
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	103 def get_entrypoints(filename):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	104 # type: (str) -> Tuple[Dict[str, str], Dict[str, str]]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	105 if not os.path.exists(filename):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	106 return {}, {}
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	107
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	108 # This is done because you can pass a string to entry_points wrappers which
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	109 # means that they may or may not be valid INI files. The attempt here is to
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	110 # strip leading and trailing whitespace in order to make them valid INI
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	111 # files.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	112 with open(filename) as fp:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	113 data = StringIO()
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	114 for line in fp:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	115 data.write(line.strip())
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	116 data.write("\n")
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	117 data.seek(0)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	118
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	119 # get the entry points and then the script names
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	120 entry_points = pkg_resources.EntryPoint.parse_map(data)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	121 console = entry_points.get('console_scripts', {})
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	122 gui = entry_points.get('gui_scripts', {})
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	123
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	124 def _split_ep(s):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	125 # type: (pkg_resources.EntryPoint) -> Tuple[str, str]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	126 """get the string representation of EntryPoint,
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	127 remove space and split on '='
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	128 """
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	129 split_parts = str(s).replace(" ", "").split("=")
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	130 return split_parts[0], split_parts[1]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	131
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	132 # convert the EntryPoint objects into strings with module:function
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	133 console = dict(_split_ep(v) for v in console.values())
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	134 gui = dict(_split_ep(v) for v in gui.values())
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	135 return console, gui
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	136
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	137
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	138 def message_about_scripts_not_on_PATH(scripts):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	139 # type: (Sequence[str]) -> Optional[str]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	140 """Determine if any scripts are not on PATH and format a warning.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	141 Returns a warning message if one or more scripts are not on PATH,
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	142 otherwise None.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	143 """
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	144 if not scripts:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	145 return None
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	146
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	147 # Group scripts by the path they were installed in
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	148 grouped_by_dir = collections.defaultdict(set) # type: Dict[str, Set[str]]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	149 for destfile in scripts:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	150 parent_dir = os.path.dirname(destfile)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	151 script_name = os.path.basename(destfile)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	152 grouped_by_dir[parent_dir].add(script_name)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	153
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	154 # We don't want to warn for directories that are on PATH.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	155 not_warn_dirs = [
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	156 os.path.normcase(i).rstrip(os.sep) for i in
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	157 os.environ.get("PATH", "").split(os.pathsep)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	158 ]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	159 # If an executable sits with sys.executable, we don't warn for it.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	160 # This covers the case of venv invocations without activating the venv.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	161 not_warn_dirs.append(os.path.normcase(os.path.dirname(sys.executable)))
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	162 warn_for = {
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	163 parent_dir: scripts for parent_dir, scripts in grouped_by_dir.items()
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	164 if os.path.normcase(parent_dir) not in not_warn_dirs
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	165 } # type: Dict[str, Set[str]]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	166 if not warn_for:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	167 return None
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	168
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	169 # Format a message
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	170 msg_lines = []
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	171 for parent_dir, dir_scripts in warn_for.items():
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	172 sorted_scripts = sorted(dir_scripts) # type: List[str]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	173 if len(sorted_scripts) == 1:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	174 start_text = "script {} is".format(sorted_scripts[0])
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	175 else:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	176 start_text = "scripts {} are".format(
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	177 ", ".join(sorted_scripts[:-1]) + " and " + sorted_scripts[-1]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	178 )
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	179
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	180 msg_lines.append(
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	181 "The {} installed in '{}' which is not on PATH."
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	182 .format(start_text, parent_dir)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	183 )
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	184
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	185 last_line_fmt = (
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	186 "Consider adding {} to PATH or, if you prefer "
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	187 "to suppress this warning, use --no-warn-script-location."
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	188 )
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	189 if len(msg_lines) == 1:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	190 msg_lines.append(last_line_fmt.format("this directory"))
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	191 else:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	192 msg_lines.append(last_line_fmt.format("these directories"))
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	193
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	194 # Add a note if any directory starts with ~
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	195 warn_for_tilde = any(
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	196 i[0] == "~" for i in os.environ.get("PATH", "").split(os.pathsep) if i
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	197 )
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	198 if warn_for_tilde:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	199 tilde_warning_msg = (
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	200 "NOTE: The current PATH contains path(s) starting with `~`, "
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	201 "which may not be expanded by all applications."
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	202 )
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	203 msg_lines.append(tilde_warning_msg)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	204
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	205 # Returns the formatted multiline message
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	206 return "\n".join(msg_lines)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	207
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	208
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	209 def sorted_outrows(outrows):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	210 # type: (Iterable[InstalledCSVRow]) -> List[InstalledCSVRow]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	211 """Return the given rows of a RECORD file in sorted order.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	212
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	213 Each row is a 3-tuple (path, hash, size) and corresponds to a record of
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	214 a RECORD file (see PEP 376 and PEP 427 for details). For the rows
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	215 passed to this function, the size can be an integer as an int or string,
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	216 or the empty string.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	217 """
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	218 # Normally, there should only be one row per path, in which case the
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	219 # second and third elements don't come into play when sorting.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	220 # However, in cases in the wild where a path might happen to occur twice,
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	221 # we don't want the sort operation to trigger an error (but still want
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	222 # determinism). Since the third element can be an int or string, we
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	223 # coerce each element to a string to avoid a TypeError in this case.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	224 # For additional background, see--
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	225 # https://github.com/pypa/pip/issues/5868
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	226 return sorted(outrows, key=lambda row: tuple(str(x) for x in row))
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	227
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	228
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	229 def get_csv_rows_for_installed(
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	230 old_csv_rows, # type: Iterable[List[str]]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	231 installed, # type: Dict[str, str]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	232 changed, # type: Set[str]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	233 generated, # type: List[str]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	234 lib_dir, # type: str
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	235 ):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	236 # type: (...) -> List[InstalledCSVRow]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	237 """
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	238 :param installed: A map from archive RECORD path to installation RECORD
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	239 path.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	240 """
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	241 installed_rows = [] # type: List[InstalledCSVRow]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	242 for row in old_csv_rows:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	243 if len(row) > 3:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	244 logger.warning(
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	245 'RECORD line has more than three elements: {}'.format(row)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	246 )
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	247 # Make a copy because we are mutating the row.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	248 row = list(row)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	249 old_path = row[0]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	250 new_path = installed.pop(old_path, old_path)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	251 row[0] = new_path
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	252 if new_path in changed:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	253 digest, length = rehash(new_path)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	254 row[1] = digest
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	255 row[2] = length
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	256 installed_rows.append(tuple(row))
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	257 for f in generated:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	258 digest, length = rehash(f)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	259 installed_rows.append((normpath(f, lib_dir), digest, str(length)))
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	260 for f in installed:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	261 installed_rows.append((installed[f], '', ''))
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	262 return installed_rows
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	263
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	264
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	265 class MissingCallableSuffix(Exception):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	266 pass
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	267
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	268
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	269 def _raise_for_invalid_entrypoint(specification):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	270 # type: (str) -> None
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	271 entry = get_export_entry(specification)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	272 if entry is not None and entry.suffix is None:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	273 raise MissingCallableSuffix(str(entry))
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	274
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	275
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	276 class PipScriptMaker(ScriptMaker):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	277 def make(self, specification, options=None):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	278 # type: (str, Dict[str, Any]) -> List[str]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	279 _raise_for_invalid_entrypoint(specification)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	280 return super(PipScriptMaker, self).make(specification, options)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	281
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	282
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	283 def install_unpacked_wheel(
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	284 name, # type: str
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	285 wheeldir, # type: str
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	286 wheel_zip, # type: ZipFile
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	287 scheme, # type: Scheme
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	288 req_description, # type: str
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	289 pycompile=True, # type: bool
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	290 warn_script_location=True # type: bool
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	291 ):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	292 # type: (...) -> None
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	293 """Install a wheel.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	294
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	295 :param name: Name of the project to install
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	296 :param wheeldir: Base directory of the unpacked wheel
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	297 :param wheel_zip: open ZipFile for wheel being installed
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	298 :param scheme: Distutils scheme dictating the install directories
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	299 :param req_description: String used in place of the requirement, for
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	300 logging
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	301 :param pycompile: Whether to byte-compile installed Python files
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	302 :param warn_script_location: Whether to check that scripts are installed
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	303 into a directory on PATH
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	304 :raises UnsupportedWheel:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	305 * when the directory holds an unpacked wheel with incompatible
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	306 Wheel-Version
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	307 * when the .dist-info dir does not match the wheel
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	308 """
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	309 # TODO: Investigate and break this up.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	310 # TODO: Look into moving this into a dedicated class for representing an
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	311 # installation.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	312
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	313 source = wheeldir.rstrip(os.path.sep) + os.path.sep
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	314
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	315 info_dir, metadata = parse_wheel(wheel_zip, name)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	316
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	317 if wheel_root_is_purelib(metadata):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	318 lib_dir = scheme.purelib
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	319 else:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	320 lib_dir = scheme.platlib
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	321
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	322 subdirs = os.listdir(source)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	323 data_dirs = [s for s in subdirs if s.endswith('.data')]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	324
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	325 # Record details of the files moved
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	326 # installed = files copied from the wheel to the destination
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	327 # changed = files changed while installing (scripts #! line typically)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	328 # generated = files newly generated during the install (script wrappers)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	329 installed = {} # type: Dict[str, str]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	330 changed = set()
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	331 generated = [] # type: List[str]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	332
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	333 # Compile all of the pyc files that we're going to be installing
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	334 if pycompile:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	335 with captured_stdout() as stdout:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	336 with warnings.catch_warnings():
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	337 warnings.filterwarnings('ignore')
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	338 compileall.compile_dir(source, force=True, quiet=True)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	339 logger.debug(stdout.getvalue())
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	340
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	341 def record_installed(srcfile, destfile, modified=False):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	342 # type: (str, str, bool) -> None
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	343 """Map archive RECORD paths to installation RECORD paths."""
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	344 oldpath = normpath(srcfile, wheeldir)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	345 newpath = normpath(destfile, lib_dir)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	346 installed[oldpath] = newpath
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	347 if modified:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	348 changed.add(destfile)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	349
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	350 def clobber(
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	351 source, # type: str
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	352 dest, # type: str
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	353 is_base, # type: bool
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	354 fixer=None, # type: Optional[Callable[[str], Any]]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	355 filter=None # type: Optional[Callable[[str], bool]]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	356 ):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	357 # type: (...) -> None
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	358 ensure_dir(dest) # common for the 'include' path
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	359
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	360 for dir, subdirs, files in os.walk(source):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	361 basedir = dir[len(source):].lstrip(os.path.sep)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	362 destdir = os.path.join(dest, basedir)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	363 if is_base and basedir == '':
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	364 subdirs[:] = [s for s in subdirs if not s.endswith('.data')]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	365 for f in files:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	366 # Skip unwanted files
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	367 if filter and filter(f):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	368 continue
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	369 srcfile = os.path.join(dir, f)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	370 destfile = os.path.join(dest, basedir, f)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	371 # directory creation is lazy and after the file filtering above
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	372 # to ensure we don't install empty dirs; empty dirs can't be
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	373 # uninstalled.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	374 ensure_dir(destdir)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	375
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	376 # copyfile (called below) truncates the destination if it
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	377 # exists and then writes the new contents. This is fine in most
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	378 # cases, but can cause a segfault if pip has loaded a shared
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	379 # object (e.g. from pyopenssl through its vendored urllib3)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	380 # Since the shared object is mmap'd an attempt to call a
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	381 # symbol in it will then cause a segfault. Unlinking the file
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	382 # allows writing of new contents while allowing the process to
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	383 # continue to use the old copy.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	384 if os.path.exists(destfile):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	385 os.unlink(destfile)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	386
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	387 # We use copyfile (not move, copy, or copy2) to be extra sure
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	388 # that we are not moving directories over (copyfile fails for
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	389 # directories) as well as to ensure that we are not copying
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	390 # over any metadata because we want more control over what
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	391 # metadata we actually copy over.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	392 shutil.copyfile(srcfile, destfile)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	393
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	394 # Copy over the metadata for the file, currently this only
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	395 # includes the atime and mtime.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	396 st = os.stat(srcfile)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	397 if hasattr(os, "utime"):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	398 os.utime(destfile, (st.st_atime, st.st_mtime))
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	399
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	400 # If our file is executable, then make our destination file
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	401 # executable.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	402 if os.access(srcfile, os.X_OK):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	403 st = os.stat(srcfile)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	404 permissions = (
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	405 st.st_mode \| stat.S_IXUSR \| stat.S_IXGRP \| stat.S_IXOTH
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	406 )
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	407 os.chmod(destfile, permissions)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	408
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	409 changed = False
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	410 if fixer:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	411 changed = fixer(destfile)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	412 record_installed(srcfile, destfile, changed)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	413
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	414 clobber(source, lib_dir, True)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	415
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	416 dest_info_dir = os.path.join(lib_dir, info_dir)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	417
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	418 # Get the defined entry points
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	419 ep_file = os.path.join(dest_info_dir, 'entry_points.txt')
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	420 console, gui = get_entrypoints(ep_file)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	421
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	422 def is_entrypoint_wrapper(name):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	423 # type: (str) -> bool
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	424 # EP, EP.exe and EP-script.py are scripts generated for
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	425 # entry point EP by setuptools
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	426 if name.lower().endswith('.exe'):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	427 matchname = name[:-4]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	428 elif name.lower().endswith('-script.py'):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	429 matchname = name[:-10]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	430 elif name.lower().endswith(".pya"):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	431 matchname = name[:-4]
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	432 else:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	433 matchname = name
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	434 # Ignore setuptools-generated scripts
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	435 return (matchname in console or matchname in gui)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	436
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	437 for datadir in data_dirs:
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	438 fixer = None
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	439 filter = None
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	440 for subdir in os.listdir(os.path.join(wheeldir, datadir)):
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	441 fixer = None
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	442 if subdir == 'scripts':
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	443 fixer = fix_script
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	444 filter = is_entrypoint_wrapper
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	445 source = os.path.join(wheeldir, datadir, subdir)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	446 dest = getattr(scheme, subdir)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	447 clobber(source, dest, False, fixer=fixer, filter=filter)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	448
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	449 maker = PipScriptMaker(None, scheme.scripts)
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	450
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	451 # Ensure old scripts are overwritten.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	452 # See https://github.com/pypa/pip/issues/1800
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	453 maker.clobber = True
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	454
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	455 # Ensure we don't generate any variants for scripts because this is almost
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	456 # never what somebody wants.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	457 # See https://bitbucket.org/pypa/distlib/issue/35/
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	458 maker.variants = {''}
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	459
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	460 # This is required because otherwise distlib creates scripts that are not
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	461 # executable.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	462 # See https://bitbucket.org/pypa/distlib/issue/32/
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	463 maker.set_mode = True
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	464
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	465 scripts_to_generate = []
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	466
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	467 # Special case pip and setuptools to generate versioned wrappers
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	468 #
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	469 # The issue is that some projects (specifically, pip and setuptools) use
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	470 # code in setup.py to create "versioned" entry points - pip2.7 on Python
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	471 # 2.7, pip3.3 on Python 3.3, etc. But these entry points are baked into
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	472 # the wheel metadata at build time, and so if the wheel is installed with
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	473 # a different version of Python the entry points will be wrong. The
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	474 # correct fix for this is to enhance the metadata to be able to describe
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	475 # such versioned entry points, but that won't happen till Metadata 2.0 is
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	476 # available.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	477 # In the meantime, projects using versioned entry points will either have
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	478 # incorrect versioned entry points, or they will not be able to distribute
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	479 # "universal" wheels (i.e., they will need a wheel per Python version).
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	480 #
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	481 # Because setuptools and pip are bundled with _ensurepip and virtualenv,
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	482 # we need to use universal wheels. So, as a stopgap until Metadata 2.0, we
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	483 # override the versioned entry points in the wheel and generate the
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	484 # correct ones. This code is purely a short-term measure until Metadata 2.0
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	485 # is available.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	486 #
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	487 # To add the level of hack in this section of code, in order to support
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	488 # ensurepip this code will look for an ``ENSUREPIP_OPTIONS`` environment
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	489 # variable which will control which version scripts get installed.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	490 #
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	491 # ENSUREPIP_OPTIONS=altinstall
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	492 # - Only pipX.Y and easy_install-X.Y will be generated and installed
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	493 # ENSUREPIP_OPTIONS=install
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	494 # - pipX.Y, pipX, easy_install-X.Y will be generated and installed. Note
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	495 # that this option is technically if ENSUREPIP_OPTIONS is set and is
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	496 # not altinstall
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	497 # DEFAULT
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	498 # - The default behavior is to install pip, pipX, pipX.Y, easy_install
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	499 # and easy_install-X.Y.
9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44" guerler parents: diff changeset	500 pip_script = console.pop('pip', None)

0

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

1 """Support for installing and building the "wheel" binary package format.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

2 """

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

3

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

4 # The following comment should be removed at some point in the future.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

5 # mypy: strict-optional=False

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

6

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

7 from __future__ import absolute_import

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

8

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

9 import collections

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

10 import compileall

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

11 import csv

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

12 import logging

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

13 import os.path

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

14 import re

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

15 import shutil

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

16 import stat

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

17 import sys

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

18 import warnings

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

19 from base64 import urlsafe_b64encode

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

20 from zipfile import ZipFile

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

21

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

22 from pip._vendor import pkg_resources

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

23 from pip._vendor.distlib.scripts import ScriptMaker

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

24 from pip._vendor.distlib.util import get_export_entry

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

25 from pip._vendor.six import StringIO

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

26

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

27 from pip._internal.exceptions import InstallationError

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

28 from pip._internal.locations import get_major_minor_version

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

29 from pip._internal.utils.misc import captured_stdout, ensure_dir, hash_file

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

30 from pip._internal.utils.temp_dir import TempDirectory

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

31 from pip._internal.utils.typing import MYPY_CHECK_RUNNING

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

32 from pip._internal.utils.unpacking import unpack_file

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

33 from pip._internal.utils.wheel import parse_wheel

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

34

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

35 if MYPY_CHECK_RUNNING:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

36 from email.message import Message

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

37 from typing import (

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

38 Dict, List, Optional, Sequence, Tuple, IO, Text, Any,

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

39 Iterable, Callable, Set,

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

40 )

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

41

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

42 from pip._internal.models.scheme import Scheme

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

43

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

44 InstalledCSVRow = Tuple[str, ...]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

45

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

46

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

47 logger = logging.getLogger(__name__)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

48

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

49

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

50 def normpath(src, p):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

51 # type: (str, str) -> str

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

52 return os.path.relpath(src, p).replace(os.path.sep, '/')

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

53

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

54

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

55 def rehash(path, blocksize=1 << 20):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

56 # type: (str, int) -> Tuple[str, str]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

57 """Return (encoded_digest, length) for path using hashlib.sha256()"""

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

58 h, length = hash_file(path, blocksize)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

59 digest = 'sha256=' + urlsafe_b64encode(

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

60 h.digest()

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

61 ).decode('latin1').rstrip('=')

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

62 # unicode/str python2 issues

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

63 return (digest, str(length)) # type: ignore

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

64

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

65

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

66 def open_for_csv(name, mode):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

67 # type: (str, Text) -> IO[Any]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

68 if sys.version_info[0] < 3:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

69 nl = {} # type: Dict[str, Any]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

70 bin = 'b'

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

71 else:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

72 nl = {'newline': ''} # type: Dict[str, Any]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

73 bin = ''

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

74 return open(name, mode + bin, **nl)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

75

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

76

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

77 def fix_script(path):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

78 # type: (str) -> Optional[bool]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

79 """Replace #!python with #!/path/to/python

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

80 Return True if file was changed.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

81 """

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

82 # XXX RECORD hashes will need to be updated

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

83 if os.path.isfile(path):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

84 with open(path, 'rb') as script:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

85 firstline = script.readline()

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

86 if not firstline.startswith(b'#!python'):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

87 return False

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

88 exename = sys.executable.encode(sys.getfilesystemencoding())

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

89 firstline = b'#!' + exename + os.linesep.encode("ascii")

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

90 rest = script.read()

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

91 with open(path, 'wb') as script:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

92 script.write(firstline)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

93 script.write(rest)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

94 return True

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

95 return None

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

96

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

97

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

98 def wheel_root_is_purelib(metadata):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

99 # type: (Message) -> bool

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

100 return metadata.get("Root-Is-Purelib", "").lower() == "true"

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

101

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

102

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

103 def get_entrypoints(filename):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

104 # type: (str) -> Tuple[Dict[str, str], Dict[str, str]]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

105 if not os.path.exists(filename):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

106 return {}, {}

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

107

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

108 # This is done because you can pass a string to entry_points wrappers which

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

109 # means that they may or may not be valid INI files. The attempt here is to

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

110 # strip leading and trailing whitespace in order to make them valid INI

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

111 # files.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

112 with open(filename) as fp:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

113 data = StringIO()

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

114 for line in fp:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

115 data.write(line.strip())

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

116 data.write("\n")

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

117 data.seek(0)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

118

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

119 # get the entry points and then the script names

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

120 entry_points = pkg_resources.EntryPoint.parse_map(data)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

121 console = entry_points.get('console_scripts', {})

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

122 gui = entry_points.get('gui_scripts', {})

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

123

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

124 def _split_ep(s):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

125 # type: (pkg_resources.EntryPoint) -> Tuple[str, str]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

126 """get the string representation of EntryPoint,

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

127 remove space and split on '='

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

128 """

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

129 split_parts = str(s).replace(" ", "").split("=")

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

130 return split_parts[0], split_parts[1]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

131

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

132 # convert the EntryPoint objects into strings with module:function

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

133 console = dict(_split_ep(v) for v in console.values())

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

134 gui = dict(_split_ep(v) for v in gui.values())

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

135 return console, gui

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

136

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

137

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

138 def message_about_scripts_not_on_PATH(scripts):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

139 # type: (Sequence[str]) -> Optional[str]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

140 """Determine if any scripts are not on PATH and format a warning.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

141 Returns a warning message if one or more scripts are not on PATH,

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

142 otherwise None.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

143 """

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

144 if not scripts:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

145 return None

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

146

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

147 # Group scripts by the path they were installed in

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

148 grouped_by_dir = collections.defaultdict(set) # type: Dict[str, Set[str]]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

149 for destfile in scripts:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

150 parent_dir = os.path.dirname(destfile)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

151 script_name = os.path.basename(destfile)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

152 grouped_by_dir[parent_dir].add(script_name)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

153

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

154 # We don't want to warn for directories that are on PATH.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

155 not_warn_dirs = [

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

156 os.path.normcase(i).rstrip(os.sep) for i in

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

157 os.environ.get("PATH", "").split(os.pathsep)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

158 ]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

159 # If an executable sits with sys.executable, we don't warn for it.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

160 # This covers the case of venv invocations without activating the venv.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

161 not_warn_dirs.append(os.path.normcase(os.path.dirname(sys.executable)))

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

162 warn_for = {

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

163 parent_dir: scripts for parent_dir, scripts in grouped_by_dir.items()

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

164 if os.path.normcase(parent_dir) not in not_warn_dirs

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

165 } # type: Dict[str, Set[str]]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

166 if not warn_for:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

167 return None

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

168

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

169 # Format a message

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

170 msg_lines = []

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

171 for parent_dir, dir_scripts in warn_for.items():

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

172 sorted_scripts = sorted(dir_scripts) # type: List[str]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

173 if len(sorted_scripts) == 1:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

174 start_text = "script {} is".format(sorted_scripts[0])

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

175 else:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

176 start_text = "scripts {} are".format(

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

177 ", ".join(sorted_scripts[:-1]) + " and " + sorted_scripts[-1]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

178 )

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

179

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

180 msg_lines.append(

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

181 "The {} installed in '{}' which is not on PATH."

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

182 .format(start_text, parent_dir)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

183 )

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

184

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

185 last_line_fmt = (

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

186 "Consider adding {} to PATH or, if you prefer "

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

187 "to suppress this warning, use --no-warn-script-location."

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

188 )

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

189 if len(msg_lines) == 1:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

190 msg_lines.append(last_line_fmt.format("this directory"))

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

191 else:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

192 msg_lines.append(last_line_fmt.format("these directories"))

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

193

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

194 # Add a note if any directory starts with ~

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

195 warn_for_tilde = any(

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

196 i[0] == "~" for i in os.environ.get("PATH", "").split(os.pathsep) if i

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

197 )

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

198 if warn_for_tilde:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

199 tilde_warning_msg = (

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

200 "NOTE: The current PATH contains path(s) starting with `~`, "

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

201 "which may not be expanded by all applications."

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

202 )

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

203 msg_lines.append(tilde_warning_msg)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

204

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

205 # Returns the formatted multiline message

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

206 return "\n".join(msg_lines)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

207

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

208

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

209 def sorted_outrows(outrows):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

210 # type: (Iterable[InstalledCSVRow]) -> List[InstalledCSVRow]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

211 """Return the given rows of a RECORD file in sorted order.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

212

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

213 Each row is a 3-tuple (path, hash, size) and corresponds to a record of

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

214 a RECORD file (see PEP 376 and PEP 427 for details). For the rows

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

215 passed to this function, the size can be an integer as an int or string,

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

216 or the empty string.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

217 """

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

218 # Normally, there should only be one row per path, in which case the

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

219 # second and third elements don't come into play when sorting.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

220 # However, in cases in the wild where a path might happen to occur twice,

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

221 # we don't want the sort operation to trigger an error (but still want

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

222 # determinism). Since the third element can be an int or string, we

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

223 # coerce each element to a string to avoid a TypeError in this case.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

224 # For additional background, see--

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

225 # https://github.com/pypa/pip/issues/5868

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

226 return sorted(outrows, key=lambda row: tuple(str(x) for x in row))

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

227

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

228

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

229 def get_csv_rows_for_installed(

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

230 old_csv_rows, # type: Iterable[List[str]]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

231 installed, # type: Dict[str, str]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

232 changed, # type: Set[str]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

233 generated, # type: List[str]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

234 lib_dir, # type: str

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

235 ):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

236 # type: (...) -> List[InstalledCSVRow]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

237 """

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

238 :param installed: A map from archive RECORD path to installation RECORD

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

239 path.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

240 """

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

241 installed_rows = [] # type: List[InstalledCSVRow]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

242 for row in old_csv_rows:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

243 if len(row) > 3:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

244 logger.warning(

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

245 'RECORD line has more than three elements: {}'.format(row)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

246 )

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

247 # Make a copy because we are mutating the row.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

248 row = list(row)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

249 old_path = row[0]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

250 new_path = installed.pop(old_path, old_path)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

251 row[0] = new_path

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

252 if new_path in changed:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

253 digest, length = rehash(new_path)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

254 row[1] = digest

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

255 row[2] = length

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

256 installed_rows.append(tuple(row))

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

257 for f in generated:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

258 digest, length = rehash(f)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

259 installed_rows.append((normpath(f, lib_dir), digest, str(length)))

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

260 for f in installed:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

261 installed_rows.append((installed[f], '', ''))

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

262 return installed_rows

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

263

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

264

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

265 class MissingCallableSuffix(Exception):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

266 pass

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

267

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

268

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

269 def _raise_for_invalid_entrypoint(specification):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

270 # type: (str) -> None

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

271 entry = get_export_entry(specification)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

272 if entry is not None and entry.suffix is None:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

273 raise MissingCallableSuffix(str(entry))

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

274

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

275

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

276 class PipScriptMaker(ScriptMaker):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

277 def make(self, specification, options=None):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

278 # type: (str, Dict[str, Any]) -> List[str]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

279 _raise_for_invalid_entrypoint(specification)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

280 return super(PipScriptMaker, self).make(specification, options)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

281

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

282

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

283 def install_unpacked_wheel(

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

284 name, # type: str

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

285 wheeldir, # type: str

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

286 wheel_zip, # type: ZipFile

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

287 scheme, # type: Scheme

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

288 req_description, # type: str

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

289 pycompile=True, # type: bool

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

290 warn_script_location=True # type: bool

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

291 ):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

292 # type: (...) -> None

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

293 """Install a wheel.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

294

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

295 :param name: Name of the project to install

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

296 :param wheeldir: Base directory of the unpacked wheel

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

297 :param wheel_zip: open ZipFile for wheel being installed

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

298 :param scheme: Distutils scheme dictating the install directories

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

299 :param req_description: String used in place of the requirement, for

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

300 logging

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

301 :param pycompile: Whether to byte-compile installed Python files

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

302 :param warn_script_location: Whether to check that scripts are installed

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

303 into a directory on PATH

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

304 :raises UnsupportedWheel:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

305 * when the directory holds an unpacked wheel with incompatible

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

306 Wheel-Version

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

307 * when the .dist-info dir does not match the wheel

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

308 """

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

309 # TODO: Investigate and break this up.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

310 # TODO: Look into moving this into a dedicated class for representing an

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

311 # installation.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

312

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

313 source = wheeldir.rstrip(os.path.sep) + os.path.sep

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

314

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

315 info_dir, metadata = parse_wheel(wheel_zip, name)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

316

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

317 if wheel_root_is_purelib(metadata):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

318 lib_dir = scheme.purelib

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

319 else:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

320 lib_dir = scheme.platlib

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

321

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

322 subdirs = os.listdir(source)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

323 data_dirs = [s for s in subdirs if s.endswith('.data')]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

324

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

325 # Record details of the files moved

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

326 # installed = files copied from the wheel to the destination

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

327 # changed = files changed while installing (scripts #! line typically)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

328 # generated = files newly generated during the install (script wrappers)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

329 installed = {} # type: Dict[str, str]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

330 changed = set()

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

331 generated = [] # type: List[str]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

332

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

333 # Compile all of the pyc files that we're going to be installing

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

334 if pycompile:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

335 with captured_stdout() as stdout:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

336 with warnings.catch_warnings():

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

337 warnings.filterwarnings('ignore')

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

338 compileall.compile_dir(source, force=True, quiet=True)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

339 logger.debug(stdout.getvalue())

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

340

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

341 def record_installed(srcfile, destfile, modified=False):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

342 # type: (str, str, bool) -> None

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

343 """Map archive RECORD paths to installation RECORD paths."""

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

344 oldpath = normpath(srcfile, wheeldir)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

345 newpath = normpath(destfile, lib_dir)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

346 installed[oldpath] = newpath

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

347 if modified:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

348 changed.add(destfile)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

349

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

350 def clobber(

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

351 source, # type: str

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

352 dest, # type: str

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

353 is_base, # type: bool

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

354 fixer=None, # type: Optional[Callable[[str], Any]]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

355 filter=None # type: Optional[Callable[[str], bool]]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

356 ):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

357 # type: (...) -> None

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

358 ensure_dir(dest) # common for the 'include' path

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

359

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

360 for dir, subdirs, files in os.walk(source):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

361 basedir = dir[len(source):].lstrip(os.path.sep)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

362 destdir = os.path.join(dest, basedir)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

363 if is_base and basedir == '':

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

364 subdirs[:] = [s for s in subdirs if not s.endswith('.data')]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

365 for f in files:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

366 # Skip unwanted files

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

367 if filter and filter(f):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

368 continue

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

369 srcfile = os.path.join(dir, f)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

370 destfile = os.path.join(dest, basedir, f)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

371 # directory creation is lazy and after the file filtering above

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

372 # to ensure we don't install empty dirs; empty dirs can't be

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

373 # uninstalled.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

374 ensure_dir(destdir)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

375

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

376 # copyfile (called below) truncates the destination if it

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

377 # exists and then writes the new contents. This is fine in most

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

378 # cases, but can cause a segfault if pip has loaded a shared

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

379 # object (e.g. from pyopenssl through its vendored urllib3)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

380 # Since the shared object is mmap'd an attempt to call a

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

381 # symbol in it will then cause a segfault. Unlinking the file

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

382 # allows writing of new contents while allowing the process to

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

383 # continue to use the old copy.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

384 if os.path.exists(destfile):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

385 os.unlink(destfile)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

386

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

387 # We use copyfile (not move, copy, or copy2) to be extra sure

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

388 # that we are not moving directories over (copyfile fails for

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

389 # directories) as well as to ensure that we are not copying

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

390 # over any metadata because we want more control over what

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

391 # metadata we actually copy over.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

392 shutil.copyfile(srcfile, destfile)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

393

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

394 # Copy over the metadata for the file, currently this only

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

395 # includes the atime and mtime.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

396 st = os.stat(srcfile)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

397 if hasattr(os, "utime"):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

398 os.utime(destfile, (st.st_atime, st.st_mtime))

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

399

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

400 # If our file is executable, then make our destination file

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

401 # executable.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

402 if os.access(srcfile, os.X_OK):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

403 st = os.stat(srcfile)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

404 permissions = (

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

405 st.st_mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

406 )

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

407 os.chmod(destfile, permissions)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

408

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

409 changed = False

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

410 if fixer:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

411 changed = fixer(destfile)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

412 record_installed(srcfile, destfile, changed)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

413

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

414 clobber(source, lib_dir, True)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

415

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

416 dest_info_dir = os.path.join(lib_dir, info_dir)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

417

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

418 # Get the defined entry points

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

419 ep_file = os.path.join(dest_info_dir, 'entry_points.txt')

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

420 console, gui = get_entrypoints(ep_file)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

421

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

422 def is_entrypoint_wrapper(name):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

423 # type: (str) -> bool

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

424 # EP, EP.exe and EP-script.py are scripts generated for

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

425 # entry point EP by setuptools

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

426 if name.lower().endswith('.exe'):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

427 matchname = name[:-4]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

428 elif name.lower().endswith('-script.py'):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

429 matchname = name[:-10]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

430 elif name.lower().endswith(".pya"):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

431 matchname = name[:-4]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

432 else:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

433 matchname = name

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

434 # Ignore setuptools-generated scripts

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

435 return (matchname in console or matchname in gui)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

436

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

437 for datadir in data_dirs:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

438 fixer = None

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

439 filter = None

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

440 for subdir in os.listdir(os.path.join(wheeldir, datadir)):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

441 fixer = None

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

442 if subdir == 'scripts':

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

443 fixer = fix_script

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

444 filter = is_entrypoint_wrapper

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

445 source = os.path.join(wheeldir, datadir, subdir)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

446 dest = getattr(scheme, subdir)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

447 clobber(source, dest, False, fixer=fixer, filter=filter)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

448

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

449 maker = PipScriptMaker(None, scheme.scripts)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

450

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

451 # Ensure old scripts are overwritten.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

452 # See https://github.com/pypa/pip/issues/1800

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

453 maker.clobber = True

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

454

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

455 # Ensure we don't generate any variants for scripts because this is almost

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

456 # never what somebody wants.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

457 # See https://bitbucket.org/pypa/distlib/issue/35/

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

458 maker.variants = {''}

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

459

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

460 # This is required because otherwise distlib creates scripts that are not

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

461 # executable.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

462 # See https://bitbucket.org/pypa/distlib/issue/32/

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

463 maker.set_mode = True

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

464

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

465 scripts_to_generate = []

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

466

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

467 # Special case pip and setuptools to generate versioned wrappers

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

468 #

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

469 # The issue is that some projects (specifically, pip and setuptools) use

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

470 # code in setup.py to create "versioned" entry points - pip2.7 on Python

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

471 # 2.7, pip3.3 on Python 3.3, etc. But these entry points are baked into

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

472 # the wheel metadata at build time, and so if the wheel is installed with

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

473 # a *different* version of Python the entry points will be wrong. The

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

474 # correct fix for this is to enhance the metadata to be able to describe

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

475 # such versioned entry points, but that won't happen till Metadata 2.0 is

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

476 # available.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

477 # In the meantime, projects using versioned entry points will either have

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

478 # incorrect versioned entry points, or they will not be able to distribute

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

479 # "universal" wheels (i.e., they will need a wheel per Python version).

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

480 #

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

481 # Because setuptools and pip are bundled with _ensurepip and virtualenv,

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

482 # we need to use universal wheels. So, as a stopgap until Metadata 2.0, we

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

483 # override the versioned entry points in the wheel and generate the

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

484 # correct ones. This code is purely a short-term measure until Metadata 2.0

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

485 # is available.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

486 #

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

487 # To add the level of hack in this section of code, in order to support

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

488 # ensurepip this code will look for an ``ENSUREPIP_OPTIONS`` environment

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

489 # variable which will control which version scripts get installed.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

490 #

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

491 # ENSUREPIP_OPTIONS=altinstall

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

492 # - Only pipX.Y and easy_install-X.Y will be generated and installed

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

493 # ENSUREPIP_OPTIONS=install

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

494 # - pipX.Y, pipX, easy_install-X.Y will be generated and installed. Note

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

495 # that this option is technically if ENSUREPIP_OPTIONS is set and is

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

496 # not altinstall

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

497 # DEFAULT

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

498 # - The default behavior is to install pip, pipX, pipX.Y, easy_install

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

499 # and easy_install-X.Y.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

500 pip_script = console.pop('pip', None)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

501 if pip_script:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

502 if "ENSUREPIP_OPTIONS" not in os.environ:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

503 scripts_to_generate.append('pip = ' + pip_script)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

504

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

505 if os.environ.get("ENSUREPIP_OPTIONS", "") != "altinstall":

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

506 scripts_to_generate.append(

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

507 'pip%s = %s' % (sys.version_info[0], pip_script)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

508 )

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

509

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

510 scripts_to_generate.append(

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

511 'pip%s = %s' % (get_major_minor_version(), pip_script)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

512 )

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

513 # Delete any other versioned pip entry points

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

514 pip_ep = [k for k in console if re.match(r'pip(\d(\.\d)?)?$', k)]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

515 for k in pip_ep:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

516 del console[k]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

517 easy_install_script = console.pop('easy_install', None)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

518 if easy_install_script:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

519 if "ENSUREPIP_OPTIONS" not in os.environ:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

520 scripts_to_generate.append(

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

521 'easy_install = ' + easy_install_script

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

522 )

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

523

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

524 scripts_to_generate.append(

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

525 'easy_install-%s = %s' % (

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

526 get_major_minor_version(), easy_install_script

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

527 )

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

528 )

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

529 # Delete any other versioned easy_install entry points

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

530 easy_install_ep = [

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

531 k for k in console if re.match(r'easy_install(-\d\.\d)?$', k)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

532 ]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

533 for k in easy_install_ep:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

534 del console[k]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

535

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

536 # Generate the console and GUI entry points specified in the wheel

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

537 scripts_to_generate.extend(

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

538 '%s = %s' % kv for kv in console.items()

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

539 )

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

540

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

541 gui_scripts_to_generate = [

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

542 '%s = %s' % kv for kv in gui.items()

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

543 ]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

544

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

545 generated_console_scripts = [] # type: List[str]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

546

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

547 try:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

548 generated_console_scripts = maker.make_multiple(scripts_to_generate)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

549 generated.extend(generated_console_scripts)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

550

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

551 generated.extend(

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

552 maker.make_multiple(gui_scripts_to_generate, {'gui': True})

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

553 )

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

554 except MissingCallableSuffix as e:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

555 entry = e.args[0]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

556 raise InstallationError(

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

557 "Invalid script entry point: {} for req: {} - A callable "

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

558 "suffix is required. Cf https://packaging.python.org/"

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

559 "specifications/entry-points/#use-for-scripts for more "

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

560 "information.".format(entry, req_description)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

561 )

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

562

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

563 if warn_script_location:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

564 msg = message_about_scripts_not_on_PATH(generated_console_scripts)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

565 if msg is not None:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

566 logger.warning(msg)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

567

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

568 # Record pip as the installer

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

569 installer = os.path.join(dest_info_dir, 'INSTALLER')

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

570 temp_installer = os.path.join(dest_info_dir, 'INSTALLER.pip')

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

571 with open(temp_installer, 'wb') as installer_file:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

572 installer_file.write(b'pip\n')

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

573 shutil.move(temp_installer, installer)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

574 generated.append(installer)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

575

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

576 # Record details of all files installed

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

577 record = os.path.join(dest_info_dir, 'RECORD')

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

578 temp_record = os.path.join(dest_info_dir, 'RECORD.pip')

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

579 with open_for_csv(record, 'r') as record_in:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

580 with open_for_csv(temp_record, 'w+') as record_out:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

581 reader = csv.reader(record_in)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

582 outrows = get_csv_rows_for_installed(

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

583 reader, installed=installed, changed=changed,

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

584 generated=generated, lib_dir=lib_dir,

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

585 )

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

586 writer = csv.writer(record_out)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

587 # Sort to simplify testing.

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

588 for row in sorted_outrows(outrows):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

589 writer.writerow(row)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

590 shutil.move(temp_record, record)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

591

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

592

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

593 def install_wheel(

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

594 name, # type: str

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

595 wheel_path, # type: str

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

596 scheme, # type: Scheme

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

597 req_description, # type: str

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

598 pycompile=True, # type: bool

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

599 warn_script_location=True, # type: bool

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

600 _temp_dir_for_testing=None, # type: Optional[str]

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

601 ):

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

602 # type: (...) -> None

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

603 with TempDirectory(

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

604 path=_temp_dir_for_testing, kind="unpacked-wheel"

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

605 ) as unpacked_dir, ZipFile(wheel_path, allowZip64=True) as z:

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

606 unpack_file(wheel_path, unpacked_dir.path)

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

607 install_unpacked_wheel(

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

608 name=name,

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

609 wheeldir=unpacked_dir.path,

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

610 wheel_zip=z,

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

611 scheme=scheme,

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

612 req_description=req_description,

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

613 pycompile=pycompile,

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

614 warn_script_location=warn_script_location,

9e54283cc701 "planemo upload commit d12c32a45bcd441307e632fca6d9af7d60289d44"

guerler

parents:

diff changeset

615 )

Mercurial > repos > guerler > hhblits

annotate lib/python3.8/site-packages/pip/_internal/operations/install/wheel.py @ 0:9e54283cc701 draft