common_utils.sh 20.1 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}

mattip's avatar
mattip committed
27
28
29
30
31
32
33
if [ $(uname) == "Darwin" ]; then
  IS_MACOS=1; IS_OSX=1;
else
  # In the manylinux_2_24 image, based on Debian9, python2 is not installed
  which python || export PATH=/opt/python/cp39-cp39/bin:$PATH
fi

34

Matthew Brett's avatar
Matthew Brett committed
35
36
37
38
# Work round bug in travis xcode image described at
# https://github.com/direnv/direnv/issues/210
shell_session_update() { :; }

xoviat's avatar
xoviat committed
39
40
41
42
# 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
43
44
unset -f pushd
unset -f popd
xoviat's avatar
xoviat committed
45

xoviat's avatar
xoviat committed
46
47
48
49
50
function start_spinner {
    if [ -n "$MB_SPINNER_PID" ]; then
        return
    fi

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

xoviat's avatar
xoviat committed
62
63
64
65
function stop_spinner {
    if [ ! -n "$MB_SPINNER_PID" ]; then
        return
    fi
66

xoviat's avatar
xoviat committed
67
68
    kill $MB_SPINNER_PID
    unset MB_SPINNER_PID
xoviat's avatar
xoviat committed
69
70

    >&2 echo "Building libraries finished."
xoviat's avatar
xoviat committed
71
}
xoviat's avatar
xoviat committed
72

73
function abspath {
74
    # Can work with any Python; need not be our installed Python.
75
76
77
    python -c "import os.path; print(os.path.abspath('$1'))"
}

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

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

89
90
91
92
93
94
95
96
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}'
}

97
98
99
100
101
102
103
104
105
106
107
108
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))
}

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

115
function gh_clone {
116
117
118
    git clone https://github.com/$1
}

Denver Ogaro's avatar
Denver Ogaro committed
119
120
121
122
# gh-clone was renamed to gh_clone, so we have this alias for
# backwards compatibility.
alias gh-clone=gh_clone

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

xoviat's avatar
xoviat committed
133
function suppress {
134
135
136
137
138
139
140
    # 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
141
    local errexit_set
142
    echo "Running $@"
Matthew Brett's avatar
Matthew Brett committed
143
    if [[ $- = *e* ]]; then errexit_set=true; fi
144
    set +e
Matthew Brett's avatar
Matthew Brett committed
145
    ( if [[ -n $errexit_set ]]; then set -e; fi; "$@"  > "$tmp" 2>&1 ) ; ret=$?
146
147
    [ "$ret" -eq 0 ] || cat "$tmp"
    rm -f "$tmp"
Matthew Brett's avatar
Matthew Brett committed
148
    if [[ -n $errexit_set ]]; then set -e; fi
149
    return "$ret"
xoviat's avatar
xoviat committed
150
151
}

robbuckley's avatar
robbuckley committed
152
153
154
155
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
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
}

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

193
194
195
196
197
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
198
199
200
        tar) tar -xf $in_fname ;;
        gz|tgz) tar -zxf $in_fname ;;
        bz2) tar -jxf $in_fname ;;
201
        zip) unzip -qq $in_fname ;;
202
        xz) unxz -c $in_fname | tar -xf ;;
203
204
205
206
        *) echo Did not recognize extension $extension; exit 1 ;;
    esac
}

207
function install_rsync {
Andrew Murray's avatar
Andrew Murray committed
208
    if [ -z "$IS_MACOS" ]; then
209
        [[ $(type -P rsync) ]] || yum_install rsync
210
211
212
    fi
}

213
214
215
216
217
218
function fetch_unpack {
    # Fetch input archive name from input URL
    # Parameters
    #    url - URL from which to fetch archive
    #    archive_fname (optional) archive name
    #
219
220
    # Echos unpacked directory and file names.
    #
221
222
223
224
225
226
227
228
229
    # 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}"
    # Make the archive directory in case it doesn't exist
    mkdir -p $arch_sdir
    local out_archive="${arch_sdir}/${archive_fname}"
230
    # If the archive is not already in the archives directory, get it.
231
    if [ ! -f "$out_archive" ]; then
232
233
234
        # Source it from multibuild archives if available.
        local our_archive="${MULTIBUILD_DIR}/archives/${archive_fname}"
        if [ -f "$our_archive" ]; then
235
            ln -s $our_archive $out_archive
236
237
238
239
        else
            # Otherwise download it.
            curl -L $url > $out_archive
        fi
240
    fi
241
242
    # Unpack archive, refreshing contents, echoing dir and file
    # names.
243
    rm_mkdir arch_tmp
244
    install_rsync
245
246
247
248
    (cd arch_tmp && \
        untar ../$out_archive && \
        ls -1d * &&
        rsync --delete -ah * ..)
249
250
}

251
252
253
254
255
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
256
257
258
259
260
    # 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"
261
262
263
264
265
266
267
268
    (cd $repo_dir \
        && git fetch origin \
        && git checkout $build_commit \
        && git clean -fxd \
        && git reset --hard \
        && git submodule update --init --recursive)
}

269
270
271
272
273
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
274
    #        Name of command for building wheel
275
    #     repo_dir  (optional, default $REPO_DIR)
276
277
278
279
280
281
    #
    # 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)
282
283
    local cmd=${1:-pip_wheel_cmd}
    local repo_dir=${2:-$REPO_DIR}
284
285
    [ -z "$repo_dir" ] && echo "repo_dir not defined" && exit 1
    local wheelhouse=$(abspath ${WHEEL_SDIR:-wheelhouse})
xoviat's avatar
xoviat committed
286
287
288
    start_spinner
    if [ -n "$(is_function "pre_build")" ]; then pre_build; fi
    stop_spinner
289
    if [ -n "$BUILD_DEPENDS" ]; then
Isuru Fernando's avatar
Isuru Fernando committed
290
        pip install $(pip_opts) $BUILD_DEPENDS
291
292
    fi
    (cd $repo_dir && $cmd $wheelhouse)
293
294
295
    repair_wheelhouse $wheelhouse
}

296
297
function pip_wheel_cmd {
    local abs_wheelhouse=$1
Isuru Fernando's avatar
Isuru Fernando committed
298
    pip wheel $(pip_opts) -w $abs_wheelhouse --no-deps .
299
300
301
302
303
304
305
306
307
308
}

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
309
310
    check_python
    $PYTHON_EXE setup.py bdist_wheel
311
312
313
    cp dist/*.whl $abs_wheelhouse
}

314
function wrap_wheel_builder {
Isuru Fernando's avatar
Isuru Fernando committed
315
    # Wrapper for build commands, overwritten by macOS for universal2 or arm64 wheel building
316
    $@
317
318
}

319
function build_pip_wheel {
320
    # Standard wheel building command with pip wheel
321
    wrap_wheel_builder build_wheel_cmd "pip_wheel_cmd" $@
322
323
324
325
}

function build_bdist_wheel {
    # Wheel building with bdist_wheel. See bdist_wheel_cmd
326
    wrap_wheel_builder build_wheel_cmd "bdist_wheel_cmd" $@
327
328
}

329
330
function build_wheel {
    # Set default building method to pip
331
    wrap_wheel_builder build_pip_wheel $@
332
333
}

334
function build_index_wheel_cmd {
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
    # 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
355
    start_spinner
356
    if [ -n "$(is_function "pre_build")" ]; then pre_build; fi
xoviat's avatar
xoviat committed
357
    stop_spinner
358
    if [ -n "$BUILD_DEPENDS" ]; then
Isuru Fernando's avatar
Isuru Fernando committed
359
        pip install $(pip_opts) $@ $BUILD_DEPENDS
360
    fi
Isuru Fernando's avatar
Isuru Fernando committed
361
    pip wheel $(pip_opts) $@ -w $wheelhouse --no-deps $project_spec
362
363
364
    repair_wheelhouse $wheelhouse
}

365
function build_index_wheel {
366
    wrap_wheel_builder build_index_wheel_cmd $@
367
368
}

369
370
function pip_opts {
    [ -n "$MANYLINUX_URL" ] && echo "--find-links $MANYLINUX_URL"
371
}
372

Isuru Fernando's avatar
Isuru Fernando committed
373
374
375
376
377
378
function get_os {
    # Report OS as given by uname
    # Use any Python that comes to hand.
    python -c 'import platform; print(platform.uname()[0])'
}

379
380
function get_platform {
    # Report platform as given by uname
381
382
    # Use any Python that comes to hand.
    python -c 'import platform; print(platform.uname()[4])'
383
384
}

385
386
387
if [ "$(get_platform)" == x86_64 ] || \
    [ "$(get_platform)" == i686 ]; then IS_X86=1; fi

388
389
390
function get_distutils_platform {
    # Report platform as given by distutils get_platform.
    # This is the platform tag that pip will use.
391
392
    check_python
    $PYTHON_EXE -c "import distutils.util; print(distutils.util.get_platform())"
393
394
}

395
396
function install_wheel {
    # Install test dependencies and built wheel
397
    #
398
    # Pass any input flags to pip install steps
399
    #
400
    # Depends on:
401
402
403
404
    #     WHEEL_SDIR  (optional, default "wheelhouse")
    #     TEST_DEPENDS  (optional, default "")
    #     MANYLINUX_URL (optional, default "") (via pip_opts function)
    local wheelhouse=$(abspath ${WHEEL_SDIR:-wheelhouse})
405
    check_pip
406
    if [ -n "$TEST_DEPENDS" ]; then
407
        while read TEST_DEPENDENCY; do
mattip's avatar
mattip committed
408
            $PIP_CMD install $(pip_opts) $@ $TEST_DEPENDENCY
409
        done <<< "$TEST_DEPENDS"
410
    fi
411
412
413
414

    check_python
    check_pip

mattip's avatar
mattip committed
415
    $PIP_CMD install packaging
mattip's avatar
mattip committed
416
    local supported_wheels=$($PYTHON_EXE $MULTIBUILD_DIR/supported_wheels.py $wheelhouse/*.whl)
417
418
419
420
    if [ -z "$supported_wheels" ]; then
        echo "ERROR: no supported wheels found"
        exit 1
    fi
421
    # Install compatible wheel
mattip's avatar
mattip committed
422
    $PIP_CMD install $(pip_opts) $@ $supported_wheels
423
}
424
425
426
427
428
429

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
430
    rmdir tmp_for_test  2>/dev/null || echo "Cannot remove tmp_for_test"
431
}
432
433
434
435

function fill_submodule {
    # Restores .git directory to submodule, if necessary
    # See:
Andrew Murray's avatar
Andrew Murray committed
436
    # https://stackoverflow.com/questions/41776331/is-there-a-way-to-reconstruct-a-git-directory-for-a-submodule
437
438
439
440
441
442
443
    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
444
445
    local repo_copy="$repo_dir-$RANDOM"
    git clone --recursive "$repo_dir" "$repo_copy"
446
    rm -rf "$repo_dir"
Matthew Brett's avatar
Matthew Brett committed
447
    mv "${repo_copy}" "$repo_dir"
448
449
    (cd "$repo_dir" && git remote set-url origin $origin_url)
}
Kyle Stewart's avatar
Kyle Stewart committed
450

mattip's avatar
mattip committed
451
# The latest versions of PyPy.
Kyle Stewart's avatar
Kyle Stewart committed
452
453
454
455
456
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
457
LATEST_PP_5p7=5.7.1
Andrew Murray's avatar
Andrew Murray committed
458
459
LATEST_PP_5p8=5.8.0
LATEST_PP_5p9=5.9.0
Andrew Murray's avatar
Andrew Murray committed
460
LATEST_PP_5=$LATEST_PP_5p9
Kyle Stewart's avatar
Kyle Stewart committed
461

Andrew Murray's avatar
Andrew Murray committed
462
463
464
LATEST_PP_6p0=6.0.0
LATEST_PP_6=$LATEST_PP_6p0

Andrew Murray's avatar
Andrew Murray committed
465
LATEST_PP_7p0=7.0.0
Andrew Murray's avatar
Andrew Murray committed
466
LATEST_PP_7p1=7.1.1
Andrew Murray's avatar
Andrew Murray committed
467
LATEST_PP_7p2=7.2.0
mattip's avatar
mattip committed
468
LATEST_PP_7p3=7.3.3
mattip's avatar
mattip committed
469
LATEST_PP_7=$LATEST_PP_7p3
Andrew Murray's avatar
Andrew Murray committed
470

Kyle Stewart's avatar
Kyle Stewart committed
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
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
490
491
492
493
494
495
496
497
498
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
499
    case "$PLAT" in
Andrew Murray's avatar
Andrew Murray committed
500
    "x86_64")  if [ -n "$IS_MACOS" ]; then
501
502
503
504
505
506
507
508
509
510
                   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
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530

    # 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
531
    $PYTHON_EXE -mpip install --upgrade pip setuptools wheel
mattip's avatar
mattip committed
532
533
534
535
536
537
    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
538
539
540
541
542
543
544
545
546
547
548
549
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
550
    #   $version : pypy version number, for example pypy-7.2 or pypy3.6-7.2
Kyle Stewart's avatar
Kyle Stewart committed
551
    local version=$1
mattip's avatar
mattip committed
552
553
554
555
556
    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
557
558
        local major=${BASH_REMATCH[1]}
        local minor=${BASH_REMATCH[2]}
Andrew Murray's avatar
Andrew Murray committed
559
560
561
        if (( $major > 6 )); then
            echo "pypy2.7-v"
        elif (( $major > 5 || ($major == 5 && $minor >= 3) )); then
Kyle Stewart's avatar
Kyle Stewart committed
562
563
564
565
566
            echo "pypy2-v"
        else
            echo "pypy-"
        fi
    else
mattip's avatar
mattip committed
567
        echo "error: expected version like pypy-7.2 or pypy3.6-7.2, got $1" 1>&2
Kyle Stewart's avatar
Kyle Stewart committed
568
569
570
        exit 1
    fi
}
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588

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
589
590
591

function install_pip {
    # Generic install pip
Matthew Brett's avatar
Matthew Brett committed
592
593
594
    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
595
596
597
598
599
600
601
602
603
604
605
606
    # 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
607
608
609
610
    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
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
    # 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]))"
}

637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
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
658
    elif [ "$u_width" == "" ]; then
mattip's avatar
mattip committed
659
        u_width="32"
660
661
662
663
664
665
666
    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}"
}