Changeset 103028 in vbox for trunk/src/VBox/Installer/darwin

Timestamp:

Jan 24, 2024 3:53:59 PM (16 months ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

161263

Message:

Main/Python: Big revamp to modernize our vboxapi Python package to now use a so-called src-layout, which also can be used with pip directly. Also added compatibility w/ Python 3.12 where distutils are not shipped anymore. We also now do have automatic linting for our code, which hopefully should improve quality in this area. Moved some Python-related files into an own sub folder so that it's more clear to which these belong to. The "sdk/installer" directories also have an own "python" sub directory where the stuff resides now. The Windows installer also uses "sdk/installer" instead of "sdk/install", to match the other platforms. bugref:10579

Location:

trunk/src/VBox/Installer/darwin

Files:

• Makefile.kmk (modified) (1 diff)
• VirtualBox/postflight (modified) (1 diff)

trunk/src/VBox/Installer/darwin/Makefile.kmk

@@ -721 +721 @@
                         $(VBOX_PATH_VBOX_APP_TMP)/Contents/MacOS/sdk \
                         $(VBOX_PATH_VBOX_APP_TMP)/Contents/MacOS/sdk/installer \
-                        $(VBOX_PATH_VBOX_APP_TMP)/Contents/MacOS/sdk/installer/vboxapi \
+                        $(VBOX_PATH_VBOX_APP_TMP)/Contents/MacOS/sdk/installer/python/vboxapi \
                         $(VBOX_PATH_VBOX_APP_TMP)/Contents/MacOS/sdk/bindings/ \
                         $(VBOX_PATH_VBOX_APP_TMP)/Contents/MacOS/sdk/bindings/xpcom \

trunk/src/VBox/Installer/darwin/VirtualBox/postflight

@@ -34 +34 @@
 # Install the Python bindings
 #
+## @todo r=andy Merge this code with linux/routines.sh!
+#
 VBOX_INSTALL_PATH=/Applications/VirtualBox.app/Contents/MacOS
-PYTHON="python python2.3 python2.5 python2.6 python2.7"
-if [ -e "${VBOX_INSTALL_PATH}/sdk/installer/vboxapisetup.py" ]; then
-    for p in $PYTHON; do
+PYTHON_INSTALLER_PATH="$VBOX_INSTALL_PATH/sdk/installer/python"
+PYTHON_BINARIES="\
+    python2.7  \
+    python2    \
+    python3.3  \
+    python3.4  \
+    python3.5  \
+    python3.6  \
+    python3.7  \
+    python3.8  \
+    python3.9  \
+    python3.10 \
+    python3.11 \
+    python3.12 \
+    python3    \
+    python"
+
+if [ -e "$PYTHON_INSTALLER_PATH/vboxapisetup.py" ]; then
+    for PYTHON_BIN in $PYTHON_BINARIES; do
         # Install the python bindings if python is in the path
-        if [ "`\${p} -c 'print "test"' 2> /dev/null`" = "test" ]; then
-                echo  1>&2 "Python found: ${p}, installing bindings..."
-                # Pass install path via environment
-                export VBOX_INSTALL_PATH
-                /bin/sh -c "cd $VBOX_INSTALL_PATH/sdk/installer && ${p} vboxapisetup.py install"
-                /bin/sh -c "cd $VBOX_INSTALL_PATH/sdk/installer && ${p} vboxapisetup.py clean --all"
+        if [ "`\${PYTHON_BIN} -c 'print "test"' 2> /dev/null`" = "test" ]; then
+            echo  1>&2 "Python found: ${PYTHON_BIN}, installing bindings..."
+            # Pass install path via environment
+            export VBOX_INSTALL_PATH
+            # Check if python has working distutils
+            "$PYTHON_BIN" -c "from distutils.core import setup" > /dev/null 2>&1
+            if test "$?" -ne 0; then
+                echo 1>&2 "Python $PYTHON_VER does not have package 'distutils', checking for 'setuptools'..."
+                # Since Python 3.12 there are no distutils anymore. See PEP632.
+                "$PYTHON_BIN" -c "from setuptools import setup" > /dev/null 2>&1
+                if test "$?" -ne 0; then
+                    echo 1>&2 "Python $PYTHON_VER also does not have package 'setuptools'. Skipping installation."
+                    return 0
+                fi
+                # When we reach here, we have to use 'pip' in order to install our bindings (Python >= 3.12).
+                if test -x "`which pip 2>/dev/null`"; then
+                    PYTHON_PIP_BIN=$(which pip)
+                else
+                    echo 1>&2 "Python package manager 'pip' not found. Skipping installation."
+                fi
+            fi
+
+            if [ -n "$PYTHON_PIP_BIN" ]; then
+                # Note: We use '-v' to show verbose output of our setup.py script on error.
+                $SHELL -c "cd ${PYTHON_INSTALLER_PATH} && ${PYTHON_PIP_BIN} -v install ./vboxapi"
+            else
+                $SHELL -c "cd ${PYTHON_INSTALLER_PATH} && ${PYTHON_BIN} vboxapisetup.py install"
+                $SHELL -c "cd ${PYTHON_INSTALLER_PATH} && ${PYTHON_BIN} vboxapisetup.py clean --all"
+            fi
         fi
     done