common_utils.sh 20.9 KB
Newer Older
1
#!/bin/bash
2
# Utilities for both OSX and Docker Linux
3
# Python should be on the PATH
4
5
6
7
8
9
10
11

# Only source common_utils once
if [ -n "$COMMON_UTILS_SOURCED" ]; then
    return
fi
COMMON_UTILS_SOURCED=1

# Turn on exit-if-error
12
13
set -e

14
MULTIBUILD_DIR=$(dirname "${BASH_SOURCE[0]}")
mattip's avatar
mattip committed
15
DOWNLOADS_SDIR=downloads
mattip's avatar
mattip committed
16
PYPY_URL=https://downloads.python.org/pypy
Matthew Brett's avatar
Matthew Brett committed
17
18
# For back-compatibility.  We use the "ensurepip" module now
# instead of get-pip.py
mattip's avatar
mattip committed
19
20
GET_PIP_URL=https://bootstrap.pypa.io/get-pip.py

21
22
23
24
25
26
# Unicode width, default 32. Used here and in travis_linux_steps.sh
# In docker_build_wrap.sh it is passed in when calling "docker run"
# The docker test images also use it when choosing the python to run
# with, so it is passed in when calling "docker run" for tests.
UNICODE_WIDTH=${UNICODE_WIDTH:-32}

27
28
29
# Default Manylinux version
MB_ML_VER=${MB_ML_VER:-2014}

mattip's avatar
mattip committed
30
31
32
if [ $(uname) == "Darwin" ]; then
  IS_MACOS=1; IS_OSX=1;
else
mattip's avatar
mattip committed
33
34
  # In the manylinux_2_24 image, based on Debian9, "python" is not installed
  # so link in something for the various system calls before PYTHON_EXE is set
mattip's avatar
mattip committed
35
36
37
  which python || export PATH=/opt/python/cp39-cp39/bin:$PATH
fi

38

Matthew Brett's avatar
Matthew Brett committed
39
40
41
42
# Work round bug in travis xcode image described at
# https://github.com/direnv/direnv/issues/210
shell_session_update() { :; }

xoviat's avatar
xoviat committed
43
44
45
46
# Workaround for https://github.com/travis-ci/travis-ci/issues/8703
# suggested by Thomas K at
# https://github.com/travis-ci/travis-ci/issues/8703#issuecomment-347881274
unset -f cd
Matthew Brett's avatar
Matthew Brett committed
47
48
unset -f pushd
unset -f popd
xoviat's avatar
xoviat committed
49

xoviat's avatar
xoviat committed
50
51
52
53
54
function start_spinner {
    if [ -n "$MB_SPINNER_PID" ]; then
        return
    fi

xoviat's avatar
xoviat committed
55
    >&2 echo "Building libraries..."
56
57
    # Start a process that runs as a keep-alive
    # to avoid travis quitting if there is no output
xoviat's avatar
xoviat committed
58
    (while true; do
xoviat's avatar
xoviat committed
59
        sleep 60
xoviat's avatar
xoviat committed
60
        >&2 echo "Still building..."
xoviat's avatar
xoviat committed
61
62
    done) &
    MB_SPINNER_PID=$!
xoviat's avatar
xoviat committed
63
    disown
xoviat's avatar
xoviat committed
64
}
xoviat's avatar
xoviat committed
65

xoviat's avatar
xoviat committed
66
67
68
69
function stop_spinner {
    if [ ! -n "$MB_SPINNER_PID" ]; then
        return
    fi
70

xoviat's avatar
xoviat committed
71
72
    kill $MB_SPINNER_PID
    unset MB_SPINNER_PID
xoviat's avatar
xoviat committed
73
74

    >&2 echo "Building libraries finished."
xoviat's avatar
xoviat committed
75
}
xoviat's avatar
xoviat committed
76

77
function abspath {
78
    # Can work with any Python; need not be our installed Python.
79
80
81
    python -c "import os.path; print(os.path.abspath('$1'))"
}

82
83
function relpath {
    # Path of first input relative to second (or $PWD if not specified)
84
    # Can work with any Python; need not be our installed Python.
85
86
87
    python -c "import os.path; print(os.path.relpath('$1','${2:-$PWD}'))"
}

Matthew Brett's avatar
Matthew Brett committed
88
function realpath {
89
    # Can work with any Python; need not be our installed Python.
Matthew Brett's avatar
Matthew Brett committed
90
91
92
    python -c "import os; print(os.path.realpath('$1'))"
}

93
94
95
96
97
98
99
100
function lex_ver {
    # Echoes dot-separated version string padded with zeros
    # Thus:
    # 3.2.1 -> 003002001
    # 3     -> 003000000
    echo $1 | awk -F "." '{printf "%03d%03d%03d", $1, $2, $3}'
}

101
102
103
104
105
106
107
108
109
110
111
112
function unlex_ver {
    # Reverses lex_ver to produce major.minor.micro
    # Thus:
    # 003002001 -> 3.2.1
    # 003000000 -> 3.0.0
    echo "$((10#${1:0:3}+0)).$((10#${1:3:3}+0)).$((10#${1:6:3}+0))"
}

function strip_ver_suffix {
    echo $(unlex_ver $(lex_ver $1))
}

113
function is_function {
114
115
    # Echo "true" if input argument string is a function
    # Allow errors during "set -e" blocks.
Matthew Brett's avatar
Matthew Brett committed
116
    (set +e; $(declare -Ff "$1" > /dev/null) && echo true)
117
118
}

119
function gh_clone {
120
121
122
    git clone https://github.com/$1
}

Denver Ogaro's avatar
Denver Ogaro committed
123
124
125
126
# gh-clone was renamed to gh_clone, so we have this alias for
# backwards compatibility.
alias gh-clone=gh_clone

127
128
129
function set_opts {
    # Set options from input options string (in $- format).
    local opts=$1
mattip's avatar
mattip committed
130
    local chars="exhmBH"
131
132
133
134
135
136
    for (( i=0; i<${#chars}; i++ )); do
        char=${chars:$i:1}
        [ -n "${opts//[^${char}]/}" ] && set -$char || set +$char
    done
}

xoviat's avatar
xoviat committed
137
function suppress {
138
139
140
141
142
143
144
    # Run a command, show output only if return code not 0.
    # Takes into account state of -e option.
    # Compare
    # https://unix.stackexchange.com/questions/256120/how-can-i-suppress-output-only-if-the-command-succeeds#256122
    # Set -e stuff agonized over in
    # https://unix.stackexchange.com/questions/296526/set-e-in-a-subshell
    local tmp=$(mktemp tmp.XXXXXXXXX) || return
Matthew Brett's avatar
Matthew Brett committed
145
    local errexit_set
146
    echo "Running $@"
Matthew Brett's avatar
Matthew Brett committed
147
    if [[ $- = *e* ]]; then errexit_set=true; fi
148
    set +e
Matthew Brett's avatar
Matthew Brett committed
149
    ( if [[ -n $errexit_set ]]; then set -e; fi; "$@"  > "$tmp" 2>&1 ) ; ret=$?
150
151
    [ "$ret" -eq 0 ] || cat "$tmp"
    rm -f "$tmp"
Matthew Brett's avatar
Matthew Brett committed
152
    if [[ -n $errexit_set ]]; then set -e; fi
153
    return "$ret"
xoviat's avatar
xoviat committed
154
155
}

robbuckley's avatar
robbuckley committed
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
function expect_return {
  # Run a command, succeeding (returning 0) only if the commend returns a specified code
  # Parameters
  #   retcode   expected return code (which may be zero)
  #   command   the command called
  #
  #   any further arguments are passed to the called command
  #
  # Returns 1 if called with less than 2 arguments
  (( $# < 2 )) && echo "Must have at least 2 arguments" && return 1
  local retcode=$1
  local retval
  ( "${@:2}" ) || retval=$?
  [[ $retcode == ${retval:-0} ]] && return 0
  return ${retval:-1}
}

function cmd_notexit {
    # wraps a command, capturing its return code and preventing it
    # from exiting the shell. Handles -e / +e modes.
    # Parameters
    #    cmd - command
    #    any further parameters are passed to the wrapped command
    # If called without an argument, it will exit the shell with an error
    local cmd=$1
    if [ -z "$cmd" ];then echo "no command"; exit 1; fi
    if [[ $- = *e* ]]; then errexit_set=true; fi
    set +e
    ("${@:1}") ; retval=$?
    [[ -n $errexit_set ]] && set -e
    return $retval
}

189
190
191
function rm_mkdir {
    # Remove directory if present, then make directory
    local path=$1
192
193
    if [ -z "$path" ]; then echo "Need not-empty path"; exit 1; fi
    if [ -d "$path" ]; then rm -rf $path; fi
194
195
196
    mkdir $path
}

197
198
199
200
201
function untar {
    local in_fname=$1
    if [ -z "$in_fname" ];then echo "in_fname not defined"; exit 1; fi
    local extension=${in_fname##*.}
    case $extension in
202
203
204
        tar) tar -xf $in_fname ;;
        gz|tgz) tar -zxf $in_fname ;;
        bz2) tar -jxf $in_fname ;;
205
        zip) unzip -qq $in_fname ;;
206
207
208
        xz) if [ -n "$IS_MACOS" ]; then
              tar -xf $in_fname
            else
209
210
211
              if [[ ! $(type -P "unxz") ]]; then
                echo xz must be installed to uncompress file; exit 1
              fi
212
213
              unxz -c $in_fname | tar -xf -
            fi ;;
214
215
216
217
        *) echo Did not recognize extension $extension; exit 1 ;;
    esac
}

218
function install_rsync {
mattip's avatar
mattip committed
219
    # install rsync via package manager
mattip's avatar
mattip committed
220
    if [ -n "$IS_MACOS" ]; then
221
222
        # macOS. The colon in the next line is the null command
        :
mattip's avatar
mattip committed
223
    elif [[ $MB_ML_VER == "_2_24" ]]; then
mattip's avatar
mattip committed
224
        # debian:9 based distro
mattip's avatar
mattip committed
225
        [[ $(type -P rsync) ]] || apt-get install -y rsync
mattip's avatar
mattip committed
226
    else
mattip's avatar
mattip committed
227
        # centos based distro
mattip's avatar
mattip committed
228
        [[ $(type -P rsync) ]] || yum_install rsync
229
230
231
    fi
}

232
233
234
235
236
237
function fetch_unpack {
    # Fetch input archive name from input URL
    # Parameters
    #    url - URL from which to fetch archive
    #    archive_fname (optional) archive name
    #
238
239
    # Echos unpacked directory and file names.
    #
240
241
242
243
244
245
    # If `archive_fname` not specified then use basename from `url`
    # If `archive_fname` already present at download location, use that instead.
    local url=$1
    if [ -z "$url" ];then echo "url not defined"; exit 1; fi
    local archive_fname=${2:-$(basename $url)}
    local arch_sdir="${ARCHIVE_SDIR:-archives}"
246
247
248
249
250
251
    if [ -z "$IS_MACOS" ]; then
        local extension=${archive_fname##*.}
        if [ "$extension" == "xz" ]; then
            ensure_xz
        fi
    fi
252
253
254
    # Make the archive directory in case it doesn't exist
    mkdir -p $arch_sdir
    local out_archive="${arch_sdir}/${archive_fname}"
255
    # If the archive is not already in the archives directory, get it.
256
    if [ ! -f "$out_archive" ]; then
257
258
259
        # Source it from multibuild archives if available.
        local our_archive="${MULTIBUILD_DIR}/archives/${archive_fname}"
        if [ -f "$our_archive" ]; then
260
            ln -s $our_archive $out_archive
261
262
263
264
        else
            # Otherwise download it.
            curl -L $url > $out_archive
        fi
265
    fi
266
267
    # Unpack archive, refreshing contents, echoing dir and file
    # names.
268
    rm_mkdir arch_tmp
269
    install_rsync
270
271
272
273
    (cd arch_tmp && \
        untar ../$out_archive && \
        ls -1d * &&
        rsync --delete -ah * ..)
274
275
}

276
277
278
279
280
function clean_code {
    local repo_dir=${1:-$REPO_DIR}
    local build_commit=${2:-$BUILD_COMMIT}
    [ -z "$repo_dir" ] && echo "repo_dir not defined" && exit 1
    [ -z "$build_commit" ] && echo "build_commit not defined" && exit 1
281
282
283
284
285
    # The package $repo_dir may be a submodule. git submodules do not
    # have a .git directory. If $repo_dir is copied around, tools like
    # Versioneer which require that it be a git repository are unable
    # to determine the version.  Give submodule proper git directory
    fill_submodule "$repo_dir"
286
287
288
289
290
291
292
293
    (cd $repo_dir \
        && git fetch origin \
        && git checkout $build_commit \
        && git clean -fxd \
        && git reset --hard \
        && git submodule update --init --recursive)
}

294
295
296
297
298
function build_wheel_cmd {
    # Builds wheel with named command, puts into $WHEEL_SDIR
    #
    # Parameters:
    #     cmd  (optional, default "pip_wheel_cmd"
Andrew Murray's avatar
Andrew Murray committed
299
    #        Name of command for building wheel
300
    #     repo_dir  (optional, default $REPO_DIR)
301
302
303
304
305
306
    #
    # Depends on
    #     REPO_DIR  (or via input argument)
    #     WHEEL_SDIR  (optional, default "wheelhouse")
    #     BUILD_DEPENDS (optional, default "")
    #     MANYLINUX_URL (optional, default "") (via pip_opts function)
307
308
    local cmd=${1:-pip_wheel_cmd}
    local repo_dir=${2:-$REPO_DIR}
309
310
    [ -z "$repo_dir" ] && echo "repo_dir not defined" && exit 1
    local wheelhouse=$(abspath ${WHEEL_SDIR:-wheelhouse})
xoviat's avatar
xoviat committed
311
312
313
    start_spinner
    if [ -n "$(is_function "pre_build")" ]; then pre_build; fi
    stop_spinner
314
    if [ -n "$BUILD_DEPENDS" ]; then
Isuru Fernando's avatar
Isuru Fernando committed
315
        pip install $(pip_opts) $BUILD_DEPENDS
316
317
    fi
    (cd $repo_dir && $cmd $wheelhouse)
318
319
320
    repair_wheelhouse $wheelhouse
}

321
322
function pip_wheel_cmd {
    local abs_wheelhouse=$1
Isuru Fernando's avatar
Isuru Fernando committed
323
    pip wheel $(pip_opts) -w $abs_wheelhouse --no-deps .
324
325
326
327
328
329
330
331
332
333
}

function bdist_wheel_cmd {
    # Builds wheel with bdist_wheel, puts into wheelhouse
    #
    # It may sometimes be useful to use bdist_wheel for the wheel building
    # process.  For example, versioneer has problems with versions which are
    # fixed with bdist_wheel:
    # https://github.com/warner/python-versioneer/issues/121
    local abs_wheelhouse=$1
334
335
    check_python
    $PYTHON_EXE setup.py bdist_wheel
336
337
338
    cp dist/*.whl $abs_wheelhouse
}

339
function wrap_wheel_builder {
Isuru Fernando's avatar
Isuru Fernando committed
340
    # Wrapper for build commands, overwritten by macOS for universal2 or arm64 wheel building
341
    $@
342
343
}

344
function build_pip_wheel {
345
    # Standard wheel building command with pip wheel
346
    wrap_wheel_builder build_wheel_cmd "pip_wheel_cmd" $@
347
348
349
350
}

function build_bdist_wheel {
    # Wheel building with bdist_wheel. See bdist_wheel_cmd
351
    wrap_wheel_builder build_wheel_cmd "bdist_wheel_cmd" $@
352
353
}

354
355
function build_wheel {
    # Set default building method to pip
356
    wrap_wheel_builder build_pip_wheel $@
357
358
}

359
function build_index_wheel_cmd {
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
    # Builds wheel from some index, usually pypi
    #
    # Parameters:
    #     project_spec
    #        requirement to install, e.g. "tornado" or "tornado==4.4.1"
    #     *args
    #        Any other arguments to be passed to pip `install`  and `wheel`
    #        commands.
    #
    # Depends on
    #     WHEEL_SDIR  (optional, default "wheelhouse")
    #     BUILD_DEPENDS (optional, default "")
    #     MANYLINUX_URL (optional, default "") (via pip_opts function)
    #
    # You can also override `pip_opts` command to set indices other than pypi
    local project_spec=$1
    [ -z "$project_spec" ] && echo "project_spec not defined" && exit 1
    # Discard first argument to pass remainder to pip
    shift
    local wheelhouse=$(abspath ${WHEEL_SDIR:-wheelhouse})
xoviat's avatar
xoviat committed
380
    start_spinner
381
    if [ -n "$(is_function "pre_build")" ]; then pre_build; fi
xoviat's avatar
xoviat committed
382
    stop_spinner
383
    if [ -n "$BUILD_DEPENDS" ]; then
Isuru Fernando's avatar
Isuru Fernando committed
384
        pip install $(pip_opts) $@ $BUILD_DEPENDS
385
    fi
Isuru Fernando's avatar
Isuru Fernando committed
386
    pip wheel $(pip_opts) $@ -w $wheelhouse --no-deps $project_spec
387
388
389
    repair_wheelhouse $wheelhouse
}

390
function build_index_wheel {
391
    wrap_wheel_builder build_index_wheel_cmd $@
392
393
}

394
395
function pip_opts {
    [ -n "$MANYLINUX_URL" ] && echo "--find-links $MANYLINUX_URL"
396
}
397

Isuru Fernando's avatar
Isuru Fernando committed
398
399
400
401
402
403
function get_os {
    # Report OS as given by uname
    # Use any Python that comes to hand.
    python -c 'import platform; print(platform.uname()[0])'
}

404
405
function get_platform {
    # Report platform as given by uname
406
407
    # Use any Python that comes to hand.
    python -c 'import platform; print(platform.uname()[4])'
408
409
}

410
411
412
if [ "$(get_platform)" == x86_64 ] || \
    [ "$(get_platform)" == i686 ]; then IS_X86=1; fi

413
414
415
function get_distutils_platform {
    # Report platform as given by distutils get_platform.
    # This is the platform tag that pip will use.
416
417
    check_python
    $PYTHON_EXE -c "import distutils.util; print(distutils.util.get_platform())"
418
419
}

420
421
function install_wheel {
    # Install test dependencies and built wheel
422
    #
423
    # Pass any input flags to pip install steps
424
    #
425
    # Depends on:
426
427
428
429
    #     WHEEL_SDIR  (optional, default "wheelhouse")
    #     TEST_DEPENDS  (optional, default "")
    #     MANYLINUX_URL (optional, default "") (via pip_opts function)
    local wheelhouse=$(abspath ${WHEEL_SDIR:-wheelhouse})
430
    check_pip
431
    if [ -n "$TEST_DEPENDS" ]; then
432
        while read TEST_DEPENDENCY; do
mattip's avatar
mattip committed
433
            $PIP_CMD install $(pip_opts) $@ $TEST_DEPENDENCY
434
        done <<< "$TEST_DEPENDS"
435
    fi
436
437
438
439

    check_python
    check_pip

mattip's avatar
mattip committed
440
    $PIP_CMD install packaging
mattip's avatar
mattip committed
441
    local supported_wheels=$($PYTHON_EXE $MULTIBUILD_DIR/supported_wheels.py $wheelhouse/*.whl)
442
443
444
445
    if [ -z "$supported_wheels" ]; then
        echo "ERROR: no supported wheels found"
        exit 1
    fi
446
    # Install compatible wheel
mattip's avatar
mattip committed
447
    $PIP_CMD install $(pip_opts) $@ $supported_wheels
448
}
449
450
451
452
453
454

function install_run {
    # Depends on function `run_tests` defined in `config.sh`
    install_wheel
    mkdir tmp_for_test
    (cd tmp_for_test && run_tests)
Matthew Brett's avatar
Matthew Brett committed
455
    rmdir tmp_for_test  2>/dev/null || echo "Cannot remove tmp_for_test"
456
}
457
458
459
460

function fill_submodule {
    # Restores .git directory to submodule, if necessary
    # See:
Andrew Murray's avatar
Andrew Murray committed
461
    # https://stackoverflow.com/questions/41776331/is-there-a-way-to-reconstruct-a-git-directory-for-a-submodule
462
463
464
465
466
467
468
    local repo_dir="$1"
    [ -z "$repo_dir" ] && echo "repo_dir not defined" && exit 1
    local git_loc="$repo_dir/.git"
    # For ordinary submodule, .git is a file.
    [ -d "$git_loc" ] && return
    # Need to recreate .git directory for submodule
    local origin_url=$(cd "$repo_dir" && git config --get remote.origin.url)
Matthew Brett's avatar
Matthew Brett committed
469
470
    local repo_copy="$repo_dir-$RANDOM"
    git clone --recursive "$repo_dir" "$repo_copy"
471
    rm -rf "$repo_dir"
Matthew Brett's avatar
Matthew Brett committed
472
    mv "${repo_copy}" "$repo_dir"
473
474
    (cd "$repo_dir" && git remote set-url origin $origin_url)
}
Kyle Stewart's avatar
Kyle Stewart committed
475

mattip's avatar
mattip committed
476
# The latest versions of PyPy.
Kyle Stewart's avatar
Kyle Stewart committed
477
478
479
480
481
LATEST_PP_5p0=5.0.1
LATEST_PP_5p1=5.1.1
LATEST_PP_5p3=5.3.1
LATEST_PP_5p4=5.4.1
LATEST_PP_5p6=5.6.0
Andrew Murray's avatar
Andrew Murray committed
482
LATEST_PP_5p7=5.7.1
Andrew Murray's avatar
Andrew Murray committed
483
484
LATEST_PP_5p8=5.8.0
LATEST_PP_5p9=5.9.0
Andrew Murray's avatar
Andrew Murray committed
485
LATEST_PP_5=$LATEST_PP_5p9
Kyle Stewart's avatar
Kyle Stewart committed
486

Andrew Murray's avatar
Andrew Murray committed
487
488
489
LATEST_PP_6p0=6.0.0
LATEST_PP_6=$LATEST_PP_6p0

Andrew Murray's avatar
Andrew Murray committed
490
LATEST_PP_7p0=7.0.0
Andrew Murray's avatar
Andrew Murray committed
491
LATEST_PP_7p1=7.1.1
Andrew Murray's avatar
Andrew Murray committed
492
LATEST_PP_7p2=7.2.0
493
LATEST_PP_7p3=7.3.7
mattip's avatar
mattip committed
494
LATEST_PP_7=$LATEST_PP_7p3
Andrew Murray's avatar
Andrew Murray committed
495

Kyle Stewart's avatar
Kyle Stewart committed
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
function unroll_version {
    # Convert major or major.minor format to major.minor.micro using the above
    # values recursively
    # Parameters:
    #   $prefix : one of LATEST_PP or LATEST_PP3
    #   $version : major[.minor[.patch]]
    # Hence:
    #   LATEST_PP 5 -> 5.7.0
    #   LATEST 2.7 -> 2.7.11
    local prefix=$1
    local ver=$2
    local latest=${prefix}_${ver//./p}
    if [ -n "${!latest}" ]; then
        echo $(unroll_version ${prefix} ${!latest})
    else
        echo $ver
    fi
}

mattip's avatar
mattip committed
515
516
517
518
519
520
521
522
523
function install_pypy {
    # Installs pypy.org PyPy
    # Parameter $version
    # Version given in major or major.minor or major.minor.micro e.g
    # "3" or "3.7" or "3.7.1".
    # Uses $PLAT
    # sets $PYTHON_EXE variable to python executable

    local version=$1
524
    case "$PLAT" in
Andrew Murray's avatar
Andrew Murray committed
525
    "x86_64")  if [ -n "$IS_MACOS" ]; then
526
527
528
529
530
531
532
533
534
535
                   suffix="osx64";
               else
                   suffix="linux64";
               fi;;
    "i686")    suffix="linux32";;
    "ppc64le") suffix="ppc64le";;
    "s390x")    suffix="s390x";;
    "aarch64")  suffix="aarch64";;
    *) echo unknown platform "$PLAT"; exit 1;;
    esac
mattip's avatar
mattip committed
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555

    # Need to convert pypy-7.2 to pypy2.7-v7.2.0 and pypy3.6-7.3 to pypy3.6-v7.3.0
    local prefix=$(get_pypy_build_prefix $version)
    # since prefix is pypy3.6v7.2 or pypy2.7v7.2, grab the 4th (0-index) letter
    local major=${prefix:4:1}
    # get the pypy version 7.2.0
    local py_version=$(fill_pypy_ver $(echo $version | cut -f2 -d-))

    local py_build=$prefix$py_version-$suffix
    local py_zip=$py_build.tar.bz2
    local zip_path=$DOWNLOADS_SDIR/$py_zip
    mkdir -p $DOWNLOADS_SDIR
    wget -nv $PYPY_URL/${py_zip} -P $DOWNLOADS_SDIR
    untar $zip_path
    # bug/feature: pypy package for pypy3 only has bin/pypy3 :(
    if [ "$major" == "3" ] && [ ! -x "$py_build/bin/pypy" ]; then
        ln $py_build/bin/pypy3 $py_build/bin/pypy
    fi
    PYTHON_EXE=$(realpath $py_build/bin/pypy)
    $PYTHON_EXE -mensurepip
556
    $PYTHON_EXE -mpip install --upgrade pip setuptools wheel
mattip's avatar
mattip committed
557
558
559
560
561
562
    if [ "$major" == "3" ] && [ ! -x "$py_build/bin/pip" ]; then
        ln $py_build/bin/pip3 $py_build/bin/pip
    fi
    PIP_CMD=pip
}

Kyle Stewart's avatar
Kyle Stewart committed
563
564
565
566
567
568
569
570
571
572
573
574
function fill_pypy_ver {
    # Convert major or major.minor format to major.minor.micro
    # Parameters:
    #   $version : major[.minor[.patch]]
    # Hence:
    #   5 -> 5.7.0
    echo $(unroll_version LATEST_PP $1)
}

function get_pypy_build_prefix {
    # Return the file prefix of a PyPy file
    # Parameters:
mattip's avatar
mattip committed
575
    #   $version : pypy version number, for example pypy-7.2 or pypy3.6-7.2
Kyle Stewart's avatar
Kyle Stewart committed
576
    local version=$1
mattip's avatar
mattip committed
577
578
579
580
581
    if [[ $version =~ pypy([0-9]+)\.([0-9]+)-([0-9]+)\.([0-9]+) ]]; then
        local py_major=${BASH_REMATCH[1]}
        local py_minor=${BASH_REMATCH[2]}
        echo "pypy$py_major.$py_minor-v"
    elif [[ $version =~ ([0-9]+)\.([0-9]+) ]]; then
Kyle Stewart's avatar
Kyle Stewart committed
582
583
        local major=${BASH_REMATCH[1]}
        local minor=${BASH_REMATCH[2]}
Andrew Murray's avatar
Andrew Murray committed
584
585
586
        if (( $major > 6 )); then
            echo "pypy2.7-v"
        elif (( $major > 5 || ($major == 5 && $minor >= 3) )); then
Kyle Stewart's avatar
Kyle Stewart committed
587
588
589
590
591
            echo "pypy2-v"
        else
            echo "pypy-"
        fi
    else
mattip's avatar
mattip committed
592
        echo "error: expected version like pypy-7.2 or pypy3.6-7.2, got $1" 1>&2
Kyle Stewart's avatar
Kyle Stewart committed
593
594
595
        exit 1
    fi
}
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613

retry () {
    # Retry command (with arguments) up to 5 times
    # https://gist.github.com/fungusakafungus/1026804
    local retry_max=5
    local count=$retry_max
    while [ $count -gt 0 ]; do
        "$@" && break
        count=$(($count - 1))
        sleep 1
    done

    [ $count -eq 0 ] && {
        echo "Retry failed [$retry_max]: $@" >&2
        return 1
    }
    return 0
}
mattip's avatar
mattip committed
614
615
616

function install_pip {
    # Generic install pip
Matthew Brett's avatar
Matthew Brett committed
617
618
619
    echo "Deprecated - please see pip installs within the individual"
    echo "install functions for each Python type."
    echo "Multibuild itself no longer uses this function."
mattip's avatar
mattip committed
620
621
622
623
624
625
626
627
628
629
630
631
    # Gets needed version from version implied by $PYTHON_EXE
    # Installs pip into python given by $PYTHON_EXE
    # Assumes pip will be installed into same directory as $PYTHON_EXE
    check_python
    mkdir -p $DOWNLOADS_SDIR
    local py_mm=`get_py_mm`
    local get_pip_path=$DOWNLOADS_SDIR/get-pip.py
    curl $GET_PIP_URL > $get_pip_path
    # Travis VMS now install pip for system python by default - force install
    # even if installed already.
    $PYTHON_EXE $get_pip_path --ignore-installed $pip_args
    PIP_CMD=$(dirname $PYTHON_EXE)/pip$py_mm
mattip's avatar
mattip committed
632
633
634
635
    if [ "$USER" != "root" ]; then
        # inside a docker, there is no sudo but the user is already root
        PIP_CMD="sudo $PIP_CMD"
    fi
mattip's avatar
mattip committed
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
    # Append pip_args if present (avoiding trailing space cf using variable
    # above).
    if [ -n "$pip_args" ]; then
        PIP_CMD="$PIP_CMD $pip_args"
    fi
}

function check_python {
    if [ -z "$PYTHON_EXE" ]; then
        echo "PYTHON_EXE variable not defined"
        exit 1
    fi
}

function check_pip {
    if [ -z "$PIP_CMD" ]; then
        echo "PIP_CMD variable not defined"
        exit 1
    fi
}

function get_py_mm {
    check_python
    $PYTHON_EXE -c "import sys; print('{0}.{1}'.format(*sys.version_info[0:2]))"
}

662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
function cpython_path {
    # Return path to cpython given
    # * version (of form "2.7")
    # * u_width ("16" or "32" default "32")
    #
    # For back-compatibility "u" as u_width also means "32"
    local py_ver="${1:-2.7}"
    local abi_suff=m
    local u_width="${2:-${UNICODE_WIDTH}}"
    local u_suff=u
    # Python 3.8 and up no longer uses the PYMALLOC 'm' suffix
    # https://github.com/pypa/wheel/pull/303
    if [ $(lex_ver $py_ver) -ge $(lex_ver 3.8) ]; then
        abi_suff=""
    fi
    # Back-compatibility
    if [ "$u_width" == "u" ]; then u_width=32; fi
    # For Python >= 3.4, "u" suffix not meaningful
    if [ $(lex_ver $py_ver) -ge $(lex_ver 3.4) ] ||
        [ "$u_width" == "16" ]; then
        u_suff=""
mattip's avatar
typo  
mattip committed
683
    elif [ "$u_width" == "" ]; then
mattip's avatar
mattip committed
684
        u_width="32"
685
686
687
688
689
690
691
    elif [ "$u_width" != "32" ]; then
        echo "Incorrect u_width value $u_width"
        exit 1
    fi
    local no_dots=$(echo $py_ver | tr -d .)
    echo "/opt/python/cp${no_dots}-cp${no_dots}$abi_suff${u_suff}"
}