cygclass/python3.cygclass

   1 ################################################################################
   2 #
   3 # python3.cygclass - functions for installing Python3 modules
   4 #
   5 # Part of cygport - Cygwin packaging application
   6 # Copyright (C) 2006-2020 Cygport authors
   7 # Provided by the Cygwin project <https://cygwin.com/>
   8 #
   9 # cygport is free software: you can redistribute it and/or modify
  10 # it under the terms of the GNU General Public License as published by
  11 # the Free Software Foundation, either version 3 of the License, or
  12 # (at your option) any later version.
  13 #
  14 # cygport is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 # GNU General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU General Public License
  20 # along with cygport.  If not, see <https://www.gnu.org/licenses/>.
  21 #
  22 ################################################################################
  23
  24 #****h* Cygclasses/python3.cygclass
  25 #  SYNOPSIS
  26 #  inherit python3
  27 #  DESCRIPTION
  28 #  Python is a general-purpose, interpreted programming language used in a
  29 #  wide variety of software.  It comes with a large standard library, and is
  30 #  easily extendible with modules written in Python and/or C/C++.  Programs
  31 #  can also embed a Python interpreter for use with their own extensions.
  32 #
  33 #  The new 3.x versions of Python are incompatible with the widely used 2.x
  34 #  versions, so they are designed to be installed in parallel as separate
  35 #  interpreters.
  36 #
  37 #  This cygclass provides definitions and some install helpers which can be used
  38 #  by any Python3-based package.  Python3 modules and programs are built in a
  39 #  number of ways, so this cygclass does not provide any build functions.  The
  40 #  two most common build systems for Python3 packages are Distutils and autotools.
  41 #  NOTE
  42 #  python3.cygclass is for the 3.x versions of Python; for the 2.x versions,
  43 #  see python2.cygclass.
  44 #  INHERITED BY
  45 #  python-wheel.cygclass
  46 #  REQUIRES
  47 #  python3
  48 #****
  49
  50 # cross-compiling is not (yet?) supported
  51 __cross_compiling_error
  52
  53 check_prog_req python3
  54
  55 #****d* python3.cygclass/PYTHON3
  56 #  DESCRIPTION
  57 #  Absolute path to the Python3 interpreter.
  58 #****
  59 PYTHON3=$(readlink -f /usr/bin/python3 | sed -e 's/\.exe$//')
  60
  61 #****d* python3.cygclass/PYTHON3_CONFIG
  62 #  DESCRIPTION
  63 #  Absolute path to the Python3 config script.
  64 #****
  65 PYTHON3_CONFIG=$(readlink -f /usr/bin/python3-config)
  66
  67 #****d* python3.cygclass/PYTHON3_VERSION
  68 #  DESCRIPTION
  69 #  The major.minor version of the current Python3 interpreter.
  70 #****
  71 PYTHON3_VERSION=$(${PYTHON3} -c 'from distutils.sysconfig import * ; print(get_python_version());')
  72
  73 #****d* python3.cygclass/PYTHON3_PKGVERSION
  74 #  DESCRIPTION
  75 #  The $major$minor version (without a dot) for use in package names.
  76 #****
  77 PYTHON3_PKGVERSION=${PYTHON3_VERSION/.}
  78
  79 #****d* python3.cygclass/PYTHON3_ABIFLAGS
  80 #  DESCRIPTION
  81 #  The ABI flags of the current Python3 interpreter, as used in the names of
  82 #  the interpreter, config script and subdir, shared library, and includedir.
  83 #****
  84 PYTHON3_ABIFLAGS=$(${PYTHON3_CONFIG} --abiflags 2>/dev/null)
  85
  86 #****d* python3.cygclass/PYTHON3_INCLUDEDIR
  87 #  DESCRIPTION
  88 #  Path containing the Python3 C library headers.
  89 #****
  90 PYTHON3_INCLUDEDIR=$(${PYTHON3} -c 'from distutils.sysconfig import * ; print(get_python_inc());')
  91
  92 #****d* python3.cygclass/PYTHON3_LIB
  93 #  DESCRIPTION
  94 #  Path containing the Python3 standard library.
  95 #  NOTE
  96 #  Never install third-party extensions into PYTHON3_LIB; use PYTHON3_SITELIB instead.
  97 #****
  98 PYTHON3_LIB=$(${PYTHON3} -c 'from distutils.sysconfig import * ; print(get_python_lib(0,1));')
  99
 100 #****d* python3.cygclass/PYTHON3_SITELIB
 101 #  DESCRIPTION
 102 #  Installation path for all Python3 extension modules.
 103 #****
 104 PYTHON3_SITELIB=$(${PYTHON3} -c 'from distutils.sysconfig import * ; print(get_python_lib(0,0));')
 105
 106 #****d* python3.cygclass/LIBPYTHON3
 107 #  DESCRIPTION
 108 #  Link flags for the Python3 C library.  This definition must be properly quoted.
 109 #****
 110 LIBPYTHON3=$(${PYTHON3_CONFIG} --libs)
 111
 112 #****I* python3.cygclass/python3into
 113 #  SYNOPSIS
 114 #  python3into SUBDIRECTORY
 115 #  DESCRIPTION
 116 #  Subdirectory of PYTHON3_SITELIB into which dopython3 should install.  This is
 117 #  usually unnecessary.
 118 #****
 119 python3into() {
 120         if (( $# != 1 ))
 121         then
 122             error "python3into accepts exactly one argument";
 123         fi
 124
 125         case ${1} in
 126         /*) error "python3into argument should be only a subdirectory" ;;
 127         esac
 128
 129         _python3into_dir=${1};
 130 }
 131
 132 #****I* python3.cygclass/dopython3
 133 #  SYNOPSIS
 134 #  [python3into SUBDIRECTORY]
 135 #  dopython3 MODULE1 [MODULE2] ...
 136 #  DESCRIPTION
 137 #  Installs the given Python3 module(s) (.py or .dll) into PYTHON3_SITELIB under $D,
 138 #  or a subdirectory thereof if python3into was previously called.
 139 #****
 140 dopython3() {
 141         local pydir
 142         local i
 143
 144         if defined _python3into_dir
 145         then
 146                 pydir=${PYTHON3_SITELIB}/${_python3into_dir}
 147         else
 148                 pydir=${PYTHON3_SITELIB}
 149         fi
 150
 151         dodir ${pydir}
 152
 153         for i
 154         do
 155                 if [ -e ${i} ]
 156                 then
 157                         case ${i} in
 158                                 *.dll)
 159                                         __doinstall 0755 ${i} ${pydir} || error "dopython3 ${i} failed"
 160                                         ;;
 161                                 *)
 162                                         __doinstall 0644 ${i} ${pydir} || error "dopython3 ${i} failed"
 163                                         ;;
 164                         esac
 165                 else
 166                         error "dopython3: ${i}: file not found"
 167                 fi
 168         done
 169 }
 170
 171 #****I* python3.cygclass/python3_optimize
 172 #  SYNOPSIS
 173 #  python3_optimize DIRECTORY [DIRECTORY] ...
 174 #  DESCRIPTION
 175 #  Bytecode-compile all Python3 modules found in the given directories under $D.
 176 #****
 177 python3_optimize() {
 178         local pyd
 179
 180         for pyd
 181         do
 182                 if [ ! -d ${D}${pyd} ]
 183                 then
 184                         error "directory ${pyd} does not exist"
 185                 fi
 186
 187                 inform "Compiling ${pyd}..."
 188                 ${PYTHON3} ${PYTHON3_LIB}/compileall.py -f -q -d ${pyd} ${D}${pyd}
 189                 ${PYTHON3} -O ${PYTHON3_LIB}/compileall.py -f -q -d ${pyd} ${D}${pyd}
 190                 ${PYTHON3} -OO ${PYTHON3_LIB}/compileall.py -f -q -d ${pyd} ${D}${pyd}
 191         done
 192 }
 193
 194 #****I* python3.cygclass/python3_fix_shebang
 195 #  SYNOPSIS
 196 #  python3_fix_shebang SCRIPT [SCRIPT ...]
 197 #  DESCRIPTION
 198 #  Fixes the designated interpreter of SCRIPT to PYTHON3.  This would be necessary
 199 #  if the original uses an incorrect path (e.g. /usr/local/bin) or an
 200 #  incorrectly versioned binary.  SCRIPT need not be prefixed by $D.
 201 #****
 202 python3_fix_shebang() {
 203         for f
 204         do
 205                 __fix_shebang ${PYTHON3} ${D}/${f#${D}}
 206         done
 207 }
 208
 209 readonly -f python3into dopython3 python3_optimize python3_fix_shebang