common_utils.sh 17.7 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
16
17
18
DOWNLOADS_SDIR=downloads
PYPY_URL=https://bitbucket.org/pypy/pypy/downloads
GET_PIP_URL=https://bootstrap.pypa.io/get-pip.py

19
if [ $(uname) == "Darwin" ]; then IS_OSX=1; fi
20

Matthew Brett's avatar
Matthew Brett committed
21
22
23
24
# Work round bug in travis xcode image described at
# https://github.com/direnv/direnv/issues/210
shell_session_update() { :; }

xoviat's avatar
xoviat committed
25
26
27
28
# 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
29
30
unset -f pushd
unset -f popd
xoviat's avatar
xoviat committed
31

xoviat's avatar
xoviat committed
32
33
34
35
36
function start_spinner {
    if [ -n "$MB_SPINNER_PID" ]; then
        return
    fi

xoviat's avatar
xoviat committed
37
    >&2 echo "Building libraries..."
38
39
    # Start a process that runs as a keep-alive
    # to avoid travis quitting if there is no output
xoviat's avatar
xoviat committed
40
    (while true; do
xoviat's avatar
xoviat committed
41
        sleep 60
xoviat's avatar
xoviat committed
42
        >&2 echo "Still building..."
xoviat's avatar
xoviat committed
43
44
    done) &
    MB_SPINNER_PID=$!
xoviat's avatar
xoviat committed
45
    disown
xoviat's avatar
xoviat committed
46
}
xoviat's avatar
xoviat committed
47

xoviat's avatar
xoviat committed
48
49
50
51
function stop_spinner {
    if [ ! -n "$MB_SPINNER_PID" ]; then
        return
    fi
52

xoviat's avatar
xoviat committed
53
54
    kill $MB_SPINNER_PID
    unset MB_SPINNER_PID
xoviat's avatar
xoviat committed
55
56

    >&2 echo "Building libraries finished."
xoviat's avatar
xoviat committed
57
}
xoviat's avatar
xoviat committed
58

59
60
61
62
function abspath {
    python -c "import os.path; print(os.path.abspath('$1'))"
}

63
64
65
66
67
function relpath {
    # Path of first input relative to second (or $PWD if not specified)
    python -c "import os.path; print(os.path.relpath('$1','${2:-$PWD}'))"
}

Matthew Brett's avatar
Matthew Brett committed
68
69
70
71
function realpath {
    python -c "import os; print(os.path.realpath('$1'))"
}

72
73
74
75
76
77
78
79
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}'
}

80
81
82
83
84
85
86
87
88
89
90
91
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))
}

92
function is_function {
93
94
    # Echo "true" if input argument string is a function
    # Allow errors during "set -e" blocks.
Matthew Brett's avatar
Matthew Brett committed
95
    (set +e; $(declare -Ff "$1" > /dev/null) && echo true)
96
97
}

98
function gh_clone {
99
100
101
    git clone https://github.com/$1
}

Denver Ogaro's avatar
Denver Ogaro committed
102
103
104
105
# gh-clone was renamed to gh_clone, so we have this alias for
# backwards compatibility.
alias gh-clone=gh_clone

106
107
108
function set_opts {
    # Set options from input options string (in $- format).
    local opts=$1
mattip's avatar
mattip committed
109
    local chars="exhmBH"
110
111
112
113
114
115
    for (( i=0; i<${#chars}; i++ )); do
        char=${chars:$i:1}
        [ -n "${opts//[^${char}]/}" ] && set -$char || set +$char
    done
}

xoviat's avatar
xoviat committed
116
function suppress {
117
118
119
120
121
122
123
    # 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
124
    local errexit_set
125
    echo "Running $@"
Matthew Brett's avatar
Matthew Brett committed
126
    if [[ $- = *e* ]]; then errexit_set=true; fi
127
    set +e
Matthew Brett's avatar
Matthew Brett committed
128
    ( if [[ -n $errexit_set ]]; then set -e; fi; "$@"  > "$tmp" 2>&1 ) ; ret=$?
129
130
    [ "$ret" -eq 0 ] || cat "$tmp"
    rm -f "$tmp"
Matthew Brett's avatar
Matthew Brett committed
131
    if [[ -n $errexit_set ]]; then set -e; fi
132
    return "$ret"
xoviat's avatar
xoviat committed
133
134
}

135
136
137
function rm_mkdir {
    # Remove directory if present, then make directory
    local path=$1
138
139
    if [ -z "$path" ]; then echo "Need not-empty path"; exit 1; fi
    if [ -d "$path" ]; then rm -rf $path; fi
140
141
142
    mkdir $path
}

143
144
145
146
147
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
148
149
150
        tar) tar -xf $in_fname ;;
        gz|tgz) tar -zxf $in_fname ;;
        bz2) tar -jxf $in_fname ;;
151
        zip) unzip -qq $in_fname ;;
152
        xz) unxz -c $in_fname | tar -xf ;;
153
154
155
156
        *) echo Did not recognize extension $extension; exit 1 ;;
    esac
}

157
158
function install_rsync {
    if [ -z "$IS_OSX" ]; then
159
        [[ $(type -P rsync) ]] || yum_install rsync
160
161
162
    fi
}

163
164
165
166
167
168
function fetch_unpack {
    # Fetch input archive name from input URL
    # Parameters
    #    url - URL from which to fetch archive
    #    archive_fname (optional) archive name
    #
169
170
    # Echos unpacked directory and file names.
    #
171
172
173
174
175
176
177
178
179
    # 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}"
180
    # If the archive is not already in the archives directory, get it.
181
    if [ ! -f "$out_archive" ]; then
182
183
184
        # Source it from multibuild archives if available.
        local our_archive="${MULTIBUILD_DIR}/archives/${archive_fname}"
        if [ -f "$our_archive" ]; then
185
            ln -s $our_archive $out_archive
186
187
188
189
        else
            # Otherwise download it.
            curl -L $url > $out_archive
        fi
190
    fi
191
192
    # Unpack archive, refreshing contents, echoing dir and file
    # names.
193
    rm_mkdir arch_tmp
194
    install_rsync
195
196
197
198
    (cd arch_tmp && \
        untar ../$out_archive && \
        ls -1d * &&
        rsync --delete -ah * ..)
199
200
}

201
202
203
204
205
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
206
207
208
209
210
    # 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"
211
212
213
214
215
216
217
218
    (cd $repo_dir \
        && git fetch origin \
        && git checkout $build_commit \
        && git clean -fxd \
        && git reset --hard \
        && git submodule update --init --recursive)
}

219
220
221
222
223
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
224
    #        Name of command for building wheel
225
    #     repo_dir  (optional, default $REPO_DIR)
226
227
228
229
230
231
    #
    # 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)
232
233
    local cmd=${1:-pip_wheel_cmd}
    local repo_dir=${2:-$REPO_DIR}
234
235
    [ -z "$repo_dir" ] && echo "repo_dir not defined" && exit 1
    local wheelhouse=$(abspath ${WHEEL_SDIR:-wheelhouse})
xoviat's avatar
xoviat committed
236
237
238
    start_spinner
    if [ -n "$(is_function "pre_build")" ]; then pre_build; fi
    stop_spinner
239
240
241
242
    if [ -n "$BUILD_DEPENDS" ]; then
        pip install $(pip_opts) $BUILD_DEPENDS
    fi
    (cd $repo_dir && $cmd $wheelhouse)
243
244
245
    repair_wheelhouse $wheelhouse
}

246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
function pip_wheel_cmd {
    local abs_wheelhouse=$1
    pip wheel $(pip_opts) -w $abs_wheelhouse --no-deps .
}

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
    python setup.py bdist_wheel
    cp dist/*.whl $abs_wheelhouse
}

263
function build_pip_wheel {
264
265
266
267
268
269
270
271
272
    # Standard wheel building command with pip wheel
    build_wheel_cmd "pip_wheel_cmd" $@
}

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

273
274
275
276
277
function build_wheel {
    # Set default building method to pip
    build_pip_wheel $@
}

278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
function build_index_wheel {
    # 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
299
    start_spinner
300
    if [ -n "$(is_function "pre_build")" ]; then pre_build; fi
xoviat's avatar
xoviat committed
301
    stop_spinner
302
303
304
    if [ -n "$BUILD_DEPENDS" ]; then
        pip install $(pip_opts) $@ $BUILD_DEPENDS
    fi
Matthew Brett's avatar
Matthew Brett committed
305
    pip wheel $(pip_opts) $@ -w $wheelhouse --no-deps $project_spec
306
307
308
    repair_wheelhouse $wheelhouse
}

309
310
function pip_opts {
    [ -n "$MANYLINUX_URL" ] && echo "--find-links $MANYLINUX_URL"
311
}
312

313
314
315
316
317
function get_platform {
    # Report platform as given by uname
    python -c 'import platform; print(platform.uname()[4])'
}

318
319
320
if [ "$(get_platform)" == x86_64 ] || \
    [ "$(get_platform)" == i686 ]; then IS_X86=1; fi

321
322
323
324
325
326
function get_distutils_platform {
    # Report platform as given by distutils get_platform.
    # This is the platform tag that pip will use.
    python -c "import distutils.util; print(distutils.util.get_platform())"
}

327
328
function install_wheel {
    # Install test dependencies and built wheel
329
    #
330
    # Pass any input flags to pip install steps
331
    #
332
    # Depends on:
333
334
335
336
    #     WHEEL_SDIR  (optional, default "wheelhouse")
    #     TEST_DEPENDS  (optional, default "")
    #     MANYLINUX_URL (optional, default "") (via pip_opts function)
    local wheelhouse=$(abspath ${WHEEL_SDIR:-wheelhouse})
337
    if [ -n "$TEST_DEPENDS" ]; then
338
        while read TEST_DEPENDENCY; do
339
            python -mpip install $(pip_opts) $@ $TEST_DEPENDENCY
340
        done <<< "$TEST_DEPENDS"
341
    fi
342
    python -mpip install packaging
343
344
345
    local supported_wheels=$(python $MULTIBUILD_DIR/supported_wheels.py $wheelhouse/*.whl)
    if [ -z "$supported_wheels" ]; then
        echo "ERROR: no supported wheels found"
mattip's avatar
mattip committed
346
        ls $wheelhouse/*.whl
347
348
        exit 1
    fi
349
    # Install compatible wheel
350
    python -mpip install $(pip_opts) $@ $supported_wheels
351
}
352
353
354
355
356
357

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
358
    rmdir tmp_for_test  2>/dev/null || echo "Cannot remove tmp_for_test"
359
}
360
361
362
363

function fill_submodule {
    # Restores .git directory to submodule, if necessary
    # See:
Andrew Murray's avatar
Andrew Murray committed
364
    # https://stackoverflow.com/questions/41776331/is-there-a-way-to-reconstruct-a-git-directory-for-a-submodule
365
366
367
368
369
370
371
    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
372
373
    local repo_copy="$repo_dir-$RANDOM"
    git clone --recursive "$repo_dir" "$repo_copy"
374
    rm -rf "$repo_dir"
Matthew Brett's avatar
Matthew Brett committed
375
    mv "${repo_copy}" "$repo_dir"
376
377
    (cd "$repo_dir" && git remote set-url origin $origin_url)
}
Kyle Stewart's avatar
Kyle Stewart committed
378

mattip's avatar
mattip committed
379
# As of 2020-01-15, the latest verions of PyPy.
Kyle Stewart's avatar
Kyle Stewart committed
380
381
382
383
384
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
385
LATEST_PP_5p7=5.7.1
Andrew Murray's avatar
Andrew Murray committed
386
387
LATEST_PP_5p8=5.8.0
LATEST_PP_5p9=5.9.0
Andrew Murray's avatar
Andrew Murray committed
388
LATEST_PP_5=$LATEST_PP_5p9
Kyle Stewart's avatar
Kyle Stewart committed
389

Andrew Murray's avatar
Andrew Murray committed
390
391
392
LATEST_PP_6p0=6.0.0
LATEST_PP_6=$LATEST_PP_6p0

Andrew Murray's avatar
Andrew Murray committed
393
LATEST_PP_7p0=7.0.0
Andrew Murray's avatar
Andrew Murray committed
394
LATEST_PP_7p1=7.1.1
Andrew Murray's avatar
Andrew Murray committed
395
LATEST_PP_7p2=7.2.0
mattip's avatar
mattip committed
396
397
LATEST_PP_7p3=7.3.0
LATEST_PP_7=$LATEST_PP_7p3
Andrew Murray's avatar
Andrew Murray committed
398

Kyle Stewart's avatar
Kyle Stewart committed
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
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
    suffix=linux64
    case "$PLAT" in
    "x86_64")  suffix="linux64";;
    "i686")    suffix="linux32";;
    "darwin")  suffix="osx64";;
    "ppc64le") suffix="ppc64le";;
    "s30x")    suffix="s390x";;
    "aarch64")  suffix="aarch64";;
435
436
    *) if [ -n "$IS_OSX" ]; then
            suffix="osx64";
mattip's avatar
mattip committed
437
       else
438
            echo unknown platform "$PLAT"; exit 1
mattip's avatar
mattip committed
439
       fi;;
mattip's avatar
mattip committed
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
    esac

    # 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
461
    $PYTHON_EXE -mpip install --upgrade pip setuptools wheel
mattip's avatar
mattip committed
462
463
464
465
466
467
    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
468
469
470
471
472
473
474
475
476
477
478
479
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
480
    #   $version : pypy version number, for example pypy-7.2 or pypy3.6-7.2
Kyle Stewart's avatar
Kyle Stewart committed
481
    local version=$1
mattip's avatar
mattip committed
482
483
484
485
486
    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
487
488
        local major=${BASH_REMATCH[1]}
        local minor=${BASH_REMATCH[2]}
Andrew Murray's avatar
Andrew Murray committed
489
490
491
        if (( $major > 6 )); then
            echo "pypy2.7-v"
        elif (( $major > 5 || ($major == 5 && $minor >= 3) )); then
Kyle Stewart's avatar
Kyle Stewart committed
492
493
494
495
496
            echo "pypy2-v"
        else
            echo "pypy-"
        fi
    else
mattip's avatar
mattip committed
497
        echo "error: expected version like pypy-7.2 or pypy3.6-7.2, got $1" 1>&2
Kyle Stewart's avatar
Kyle Stewart committed
498
499
500
        exit 1
    fi
}
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518

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
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533

function install_pip {
    # Generic install pip
    # 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
534
535
536
537
    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
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
    # 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]))"
}

564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
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
585
    elif [ "$u_width" == "" ]; then
mattip's avatar
mattip committed
586
        u_width="32"
587
588
589
590
591
592
593
    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}"
}