Merged PR 19680: Support macos builds for ARM64 and X86_64

This PR adds the support to allow building the macos wheels using cibuildwheel for x86_64 and arm64

Author: thiesmoeller

.github/workflows/main.yml

@@ -1,14 +1,14 @@
 # This is a basic workflow to help you get started with Actions
 name: build
 
-# Controls when the action will run. 
+# Controls when the action will run.
 on:
   # Triggers the workflow on push or pull request events but only for the master branch
   push:
     branches:
       - '**'
     tags:
-      - '*.*.*' 
+      - '*.*.*'
   pull_request:
     branches: [ master ]
 
@@ -34,7 +34,8 @@ jobs:
           ${PYLON_DOWNLOAD_URL_BASE_7_2}pylon_7.2.1.25747_x86_64_setup.tar.gz
           ${PYLON_DOWNLOAD_URL_BASE_7_2}pylon_7.2.1.25747_aarch64_setup.tar.gz
           ${PYLON_DOWNLOAD_URL_BASE}pylon_6.2.0.21487_armhf_setup.tar.gz
-          ${PYLON_DOWNLOAD_URL_BASE}pylon-6.1.2.19990.zip
+          ${PYLON_DOWNLOAD_URL_BASE}pylon-6.2.0.21487.dmg
+          ${PYLON_DOWNLOAD_ARM64_URL_BASE}pylon_7.3.1.0006_Darwin-arm64_SDK.selfsh
           EOF
       - uses: actions/cache@v3
         id: cache
@@ -49,6 +50,7 @@ jobs:
           PYLON_DOWNLOAD_URL_BASE_6_2: ${{ secrets.PYLON_DOWNLOAD_URL_BASE_6_2 }}
           PYLON_DOWNLOAD_URL_BASE_6_3: ${{ secrets.PYLON_DOWNLOAD_URL_BASE_6_3 }}
           PYLON_DOWNLOAD_URL_BASE_7_2: ${{ secrets.PYLON_DOWNLOAD_URL_BASE_7_2 }}
+          PYLON_DOWNLOAD_ARM64_URL_BASE: ${{ secrets.PYLON_DOWNLOAD_ARM64_URL_BASE }}
         run: |
           mkdir pylon-installer && cd pylon-installer
           while read line; do
@@ -64,7 +66,7 @@ jobs:
         with:
           name: pylon-installer
           path: pylon-installer
-          
+
       - name: Check for release build
         if: startsWith(github.ref, 'refs/tags/')
         run: |
@@ -104,12 +106,12 @@ jobs:
           ls pylon-installer
           docker run --rm --privileged multiarch/qemu-user-static:register --reset
           ./scripts/build/build-arch.sh --platform-tag $P --abi-tag $A --pylon-dir ./pylon-installer $ARGS
-          
+
       - uses: actions/upload-artifact@v3
         with:
           name: build-results-${{ matrix.p }}-${{ matrix.a }}
           path: dist/*
-          
+
       - name: Upload Release Asset
         if: needs.prepare.outputs.is_release_build == 'true'
         uses: softprops/action-gh-release@v1
@@ -123,89 +125,57 @@ jobs:
         run: |
           sudo pip3 install twine
           python3 -m twine upload --non-interactive --skip-existing dist/*
-          
-          
+
+
   build-macos:
     needs: prepare
-    runs-on: macos-10.15
+    runs-on: macos-11
     strategy:
       fail-fast: false
-      matrix:
-        a: [cp36, cp37, cp38, cp39, cp3_10, cp3_11]
-    env:
-      P: macosx-10.15-intel
-      A: ${{ matrix.a }}
     steps:
       - uses: actions/checkout@v3
-        
+
+      - name: Install Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.6 - 3.11"
+
       - uses: actions/download-artifact@v3
         with:
           name: pylon-installer
           path: pylon-installer
 
-
-      - name: Build and test
+      - name: Setup pylon
         run: |
-          eval "$(pyenv init -)"
-          export PATH=$HOME/.pyenv/bin:$PATH
-          case $A in
-            cp36)
-              PYENV_VERSION="3.6"
-              curl -sSfL -o python.pkg "https://www.python.org/ftp/python/3.6.8/python-3.6.8-macosx10.9.pkg"
-              ;;
-            cp37)
-              PYENV_VERSION="3.7"
-              curl -sSfL -o python.pkg "https://www.python.org/ftp/python/3.7.9/python-3.7.9-macosx10.9.pkg"
-              ;;
-            cp38)
-              PYENV_VERSION="3.8"
-              curl -sSfL -o python.pkg "https://www.python.org/ftp/python/3.8.7/python-3.8.7-macosx10.9.pkg"
-              ;;
-            cp39)
-              PYENV_VERSION="3.9"
-              curl -sSfL -o python.pkg "https://www.python.org/ftp/python/3.9.1/python-3.9.1-macosx10.9.pkg"
-              ;;
-            cp3_10)
-              PYENV_VERSION="3.10"
-              curl -sSfL -o python.pkg "https://www.python.org/ftp/python/3.10.2/python-3.10.2-macos11.pkg"
-              ;;
-            cp3_11)
-              PYENV_VERSION="3.11"
-              curl -sSfL -o python.pkg "https://www.python.org/ftp/python/3.11.0/python-3.11.0-macos11.pkg"
-              ;;
-            *)
-              echo "Invalid python version $A"
-              exit -1
-              ;;
-          esac
-          sudo installer -pkg python.pkg -target /
+          # install x86_64
           cd pylon-installer
-          unzip pylon-*.zip
           hdiutil attach pylon-*.dmg
           sudo installer -pkg /Volumes/pylon\ *\ Camera\ Software\ Suite/pylon-*.pkg  -target /
           hdiutil detach /Volumes/pylon\ *\ Camera\ Software\ Suite
-          brew install swig
-          cd ${GITHUB_WORKSPACE}
-          pip3 install numpy
-          pip3 install wheel
-          # pylon 6.1 is linked against 10.14
-          export MACOSX_DEPLOYMENT_TARGET=10.14
-          python3 setup.py test
-          python3 setup.py bdist_wheel
-          
+          # install arm64
+          chmod a+x pylon_7.3.1.0006_Darwin-arm64_SDK.selfsh
+          ./pylon_7.3.1.0006_Darwin-arm64_SDK.selfsh --accept
+          mkdir /tmp/pylon_framework
+          cp -pr pylon/Frameworks/* /tmp/pylon_framework
+
+      - name: Build wheels
+        uses: pypa/[email protected]
+        env:
+          PYLON_FRAMEWORK_ARM64: /tmp/pylon_framework
+          PYLON_FRAMEWORK_X86_64: /Library/Frameworks
+
       - uses: actions/upload-artifact@v3
         with:
-          name: build-results-macosx-${{ matrix.a }}
-          path: dist/*
-     
+          path: ./wheelhouse/*.whl
+
       - name: Upload Release Asset
         if: needs.prepare.outputs.is_release_build == 'true'
         uses: softprops/action-gh-release@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          files: dist/*
-      
+          files: ./wheelhouse/*.whl
+
       - name: Publish package to (Test)PyPI
         if: needs.prepare.outputs.is_release_build == 'true'
         run: |
@@ -226,4 +196,4 @@ jobs:
       with:
         name: pylon-installer
 
-     
+

.gitignore

@@ -35,4 +35,6 @@ scripts/reference_types.txt
 NodeMap.pfs
 
 #ignore generated html
-pypylon.*.html
+pypylon.*.html
+osx_includes
+wheelhouse

README.md

@@ -16,7 +16,7 @@ You are welcome to post any questions or issues on [GitHub](https://github.com/b
  * Install [pylon](https://www.baslerweb.com/pylon)
    This is strongly recommended but not mandatory. See [known issues](#known-issues) for further details.
  * Install pypylon: ```pip3 install pypylon```
-   For more installation options and the supported systems please read the [Installation](#installation) paragraph.
+   For more installation options and the supported systems please read the [Installation](#Installation) paragraph.
  * Look at [samples/grab.py](https://github.com/basler/pypylon/blob/master/samples/grab.py) or use the following snippet:
 
 ```python
@@ -68,20 +68,22 @@ The following versions are available on pypi:
  | Linux x86_64*    | x   | x   | x   | x   |  x   |  x   |
  | Linux armv7l*    | x   | x   | x   | x   |  x   |  x   |
  | Linux aarch64*   | x   | x   | x   | x   |  x   |  x   |
- | Mac OS**         | x   | x   | x   | x   |  x   |  x   |
+ | macOS x86_64**   | x   | x   | x   | x   |  x   |  x   |
+ | macOS arm64**    |     |     | x   | x   |  x   |  x   |
 
 
 > Additional Notes on binary packages:
 > * (*) The linux binaries are manylinux_2_28 conformant.
     This is roughly equivalent to a minimum glibc version >= 2.28.
     :warning: You need at least pip 20.3 to install them.
-> * (**) MacOS binaries are built for macOS >= 10.14 (Mojave)
+> * (**) macOS binaries are built for macOS >= 11.0 (Big-Sur)
 
 ## Installation from Source
-Building the pypylon bindings is supported and tested on Windows and Linux.
+Building the pypylon bindings is supported and tested on Windows, Linux and macOS
 
 You need a few more things to compile pypylon:
- * A compiler for your system (Visual Studio on Windows, gcc on linux)
+ * An installation of pylon SDK for your platform
+ * A compiler for your system (Visual Studio on Windows, gcc on linux, xCode commandline tools on macOS)
  * Python development files (e.g. `sudo apt install python-dev` on linux)
  * [swig](http://www.swig.org) >= 4.0
    * For all 64bit platforms you can install the tool via `pip install swig`
@@ -92,6 +94,12 @@ git clone https://github.com/basler/pypylon.git
 cd pypylon
 pip install .
 ```
+
+If pylon SDK is not installed in a default location you have to specify the location from the environment
+ * on Linux: `export PYLON_ROOT=<installation directory of pylon SDK>`
+ * on macOS: `export PYLON_FRAMEWORK_LOCATION=<framework base folder that contains pylon.framework>`
+
+
 # Development
 
 Pull requests to pypylon are very welcome. To help you getting started with pypylon improvements, here are some hints:
@@ -106,9 +114,9 @@ After changing pypylon, execute `python setup.py build` and test...
 ## Running Unit Tests
 > NOTE: The unit tests try to import `pypylon....`, so they run against the *installed* version of pypylon.
 ```console
-python -m unittest tests/....
-python tests/....
+pytest tests/....
 ```
+
 # Known Issues
  * For USB 3.0 cameras to work on Linux, you need to install appropriate udev rules.
    The easiest way to get them is to install the official [pylon](http://www.baslerweb.com/pylon) package.

VersionInfo.py

@@ -1,9 +1,11 @@
-Version [next]
-    - Date 2023-MM-DD
+Version 2.2.0rc1
+    - Date 2023-06-14
+    - Integrate macos build for arm64
     - Fix memory leak if ImageDecompressor is called on invalid data
     - Call Pylon::PylonTerminate on module unload to free pylon ressources
     - Fix Warnings from swig and c++ compile steps
     - Add support for swig installed via pypi
+    - move tests to pytest format
 
 Version 2.0.0
     - Date 2023-05-24

changelog.txt

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["setuptools>=42", "swig>=4.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.cibuildwheel]
+build-verbosity = "0"
+archs = "x86_64 arm64"
+build = "*-macosx_*"
+skip  = "pp*"
+test-requires = "pytest numpy"
+
+[tool.cibuildwheel.macos]
+before-all = 'echo "Building: $CIBW_BUILD"'
+repair-wheel-command = ""
+test-command = [
+             '''
+             pytest {project}/tests/genicam_tests {project}/tests/pylon_tests/emulated
+             '''
+             ]
+
+
+[[tool.cibuildwheel.overrides]]
+select = "*-macosx_arm64"
+before-build = [
+             '''
+             echo "arm framework"
+             if [ -z "${PYLON_FRAMEWORK_ARM64}" ]; then
+                 echo "Set PYLON_FRAMEWORK_ARM64 to the directory where pylon.framework for arm64 is installed"
+             exit -1
+             fi
+             '''
+            ]
+environment = { PYLON_FRAMEWORK_LOCATION="${PYLON_FRAMEWORK_ARM64}",MACOSX_DEPLOYMENT_TARGET="11.0" }
+
+[[tool.cibuildwheel.overrides]]
+select = "*-macosx_x86_64"
+before-build = [
+             '''
+             echo "intel framework"
+             if [ -z "${PYLON_FRAMEWORK_X86_64}" ]; then
+                 echo "Set PYLON_FRAMEWORK_X86_64 to the directory where pylon.framework for x86_64 is installed"
+                 echo "default of /Library/Frameworks will be used"
+             fi
+             '''
+            ]
+environment = { SYSTEM_VERSION_COMPAT="0",PYLON_FRAMEWORK_LOCATION="${PYLON_FRAMEWORK_X86_64}",MACOSX_DEPLOYMENT_TARGET="11.0" }
+