Adapt to nanobind 2.0.0, stubgen with nanobind, multiple improvements

.github/workflows/build.yml

@@ -4,11 +4,36 @@ on:
   push:
     tags:
         - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
-    release:
-      types:
-        - [published]
+  release:
+    types:
+      - published
 
 jobs:
+  build_sdist:
+    name: Build source distribution
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.8
+
+      - name: Build sdist
+        run: pipx run build --sdist
+
+      - name: Test sdist
+        run: |
+          python -m pip install dist/apngasm_python-*.tar.gz
+          pip install pytest numpy Pillow
+          pytest
+
+      - uses: actions/upload-artifact@v3
+        with:
+          path: dist/apngasm_python-*.tar.gz
+
   build_wheels:
     name: Build wheels for ${{ matrix.os }} ${{ matrix.cibw_archs }} ${{ matrix.cibw_build }}
     runs-on: ${{ matrix.os }}
@@ -18,71 +43,66 @@ jobs:
         include:
           - os: windows-2019
             cibw_archs: AMD64
-            cibw_build: "*"
+            cibw_build: "cp38* pp*"
             cibw_environment: APNGASM_COMPILE_TARGET=x86_64
           - os: windows-2019
             cibw_archs: x86
-            cibw_build: "*"
+            cibw_build: "cp38*"
             cibw_environment: APNGASM_COMPILE_TARGET=x86
           - os: windows-2019
             cibw_archs: ARM64
-            cibw_build: "*"
+            cibw_build: "cp39*"
             cibw_environment: APNGASM_COMPILE_TARGET=armv8
-          - os: macos-11
+          - os: macos-12
             cibw_archs: x86_64
-            cibw_build: "*"
-            cibw_environment: >
-              APNGASM_COMPILE_TARGET=x86_64
-              _PYTHON_HOST_PLATFORM=macosx-10.15-x86_64
-              MACOSX_DEPLOYMENT_TARGET=10.15
-          - os: macos-11
+            cibw_build: "cp38* pp*"
+            cibw_environment: APNGASM_COMPILE_TARGET=x86_64
+          - os: macos-14
             cibw_archs: arm64
-            cibw_build: "*"
-            cibw_environment: >
-              APNGASM_COMPILE_TARGET=armv8
-              _PYTHON_HOST_PLATFORM=macosx-11.0-arm64
-              MACOSX_DEPLOYMENT_TARGET=11.0
-          - os: macos-11
+            cibw_build: "cp38* pp*"
+            cibw_environment: APNGASM_COMPILE_TARGET=armv8
+          - os: macos-14
             cibw_archs: universal2
-            cibw_build: "*"
-            cibw_environment: >
-              APNGASM_COMPILE_TARGET=universal2
-              _PYTHON_HOST_PLATFORM=macosx-11.0-universal2
-              MACOSX_DEPLOYMENT_TARGET=11.0
+            cibw_build: "cp38* pp*"
+            cibw_environment: APNGASM_COMPILE_TARGET=universal2
           - os: ubuntu-20.04
             cibw_archs: x86_64
-            cibw_build: "*"
+            cibw_build: "cp38* pp*"
             cibw_environment: APNGASM_COMPILE_TARGET=x86_64
           - os: ubuntu-20.04
             cibw_archs: i686
-            cibw_build: "*"
+            cibw_build: "cp38* pp*"
             cibw_environment: APNGASM_COMPILE_TARGET=x86
           - os: ubuntu-20.04
             cibw_archs: aarch64
-            cibw_build: "*-musllinux_*"
+            cibw_build: "cp38*-musllinux_* pp*-musllinux_*"
             cibw_environment: APNGASM_COMPILE_TARGET=armv8
           - os: ubuntu-20.04
             cibw_archs: aarch64
-            cibw_build: "*-manylinux_*"
+            cibw_build: "cp38*-manylinux_* pp*-manylinux_*"
             cibw_environment: APNGASM_COMPILE_TARGET=armv8
           - os: ubuntu-20.04
             cibw_archs: ppc64le
-            cibw_build: "*-musllinux_*"
+            cibw_build: "cp38*-musllinux_*"
             cibw_environment: APNGASM_COMPILE_TARGET=ppc64le
           - os: ubuntu-20.04
             cibw_archs: ppc64le
-            cibw_build: "*-manylinux_*"
+            cibw_build: "cp38*-manylinux_*"
             cibw_environment: APNGASM_COMPILE_TARGET=ppc64le
-          - os: ubuntu-20.04
-            cibw_archs: s390x
-            cibw_build: "*-musllinux_*"
-            cibw_environment: APNGASM_COMPILE_TARGET=s390x
-          - os: ubuntu-20.04
-            cibw_archs: s390x
-            cibw_build: "*-manylinux_*"
-            cibw_environment: APNGASM_COMPILE_TARGET=s390x
+          # - os: ubuntu-20.04
+          #   cibw_archs: s390x
+          #   cibw_build: "*-musllinux_*"
+          #   cibw_environment: APNGASM_COMPILE_TARGET=s390x
+          # - os: ubuntu-20.04
+          #   cibw_archs: s390x
+          #   cibw_build: "*-manylinux_*"
+          #   cibw_environment: APNGASM_COMPILE_TARGET=s390x
 
     steps:
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
       - uses: actions/checkout@v3
         with:
           submodules: true
@@ -94,37 +114,32 @@ jobs:
           platforms: all
 
       - name: Build wheels for ${{ matrix.os }} ${{ matrix.cibw_archs }} ${{ matrix.cibw_build }}
-        uses: pypa/cibuildwheel@v2.16.5
+        uses: pypa/cibuildwheel@v2.17.0
         env:
           CIBW_BUILD_FRONTEND: build
           CIBW_ARCHS: ${{ matrix.cibw_archs }}
-          CIBW_BEFORE_ALL: ${{ matrix.cibw_before_all }}
           # CIBW_ENVIRONMENT: PY_BUILD_CMAKE_VERBOSE=1 ${{ matrix.cibw_environment }}
           CIBW_ENVIRONMENT: ${{ matrix.cibw_environment }}
           CIBW_BUILD: ${{ matrix.cibw_build }}
+          CIBW_TEST_REQUIRES: pytest
+          CIBW_BEFORE_TEST: pip install --only-binary ":all:" Pillow numpy; true
+          CIBW_BEFORE_TEST_WINDOWS: pip install --only-binary ":all:" Pillow numpy || VER>NUL
+          CIBW_TEST_COMMAND: pytest {package}/tests
+          CIBW_TEST_SKIP: pp*
+
+      - name: abi3audit
+        run: |
+          pip install abi3audit
+          abi3audit $(ls ./wheelhouse/*.whl) --debug --verbose
 
       - uses: actions/upload-artifact@v3
         with:
           path: ./wheelhouse/*.whl
-
-  build_sdist:
-    name: Build source distribution
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          submodules: recursive
-
-      - name: Build sdist
-        run: pipx run build --sdist
-
-      - uses: actions/upload-artifact@v3
-        with:
-          path: dist/*.tar.gz
 
   # upload_pypi_test:
   #   needs: [build_wheels, build_sdist]
   #   runs-on: ubuntu-latest
+  #   if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
   #   steps:
   #     - uses: actions/download-artifact@v3
   #       with:
@@ -142,6 +157,7 @@ jobs:
   upload_pypi:
     needs: [build_wheels, build_sdist]
     runs-on: ubuntu-latest
+    if: github.event_name == 'release' && github.event.action == 'published'
     steps:
       - uses: actions/download-artifact@v3
         with:

.github/workflows/check_and_fix.yml

@@ -0,0 +1,49 @@
+name: Check, update stub and formatting
+
+on:
+  push:
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    cancel-in-progress: true
+
+jobs:
+  check_and_fix:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+      with:
+        fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
+        submodules: recursive
+    - name: Extract branch name
+      shell: bash
+      run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT
+      id: extract_branch
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.9'
+    - name: Install test
+      run: pip install .[full,test,lint]
+    - name: Ruff check
+      run: ruff check
+    - name: Ruff format
+      run: ruff format
+    - name: mypy
+      run: mypy
+    - name: isort
+      run: isort .
+    - name: nanobind stubgen
+      run: |
+        pip install nanobind
+        python -m nanobind.stubgen \
+            -m apngasm_python._apngasm_python \
+            -o src-python/apngasm_python/_apngasm_python.pyi \
+            -M src-python/apngasm_python/py.typed
+    - name: Pytest
+      run: pytest
+    - name: Commit & Push changes
+      uses: actions-js/push@master
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        message: Update stub and formatting
+        branch: ${{ steps.extract_branch.outputs.branch }}

.gitignore

@@ -3,4 +3,7 @@ dist/
 .py-build-cmake_cache/
 .vscode/
 conan_output/
-example/output/
+samples/output/
+venv/
+docs/_build/
+CMakeUserPresets.json

CMakeLists.txt

@@ -22,32 +22,35 @@ execute_process(
 )
 message(STATUS "Finished get_deps.py")
 
-if (WIN32)
+if (MSVC)
     set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
     set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /MT")
     set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /MTd")
+    set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO} /Zi /Ob0 /Od /RTC1")
 elseif (LINUX)
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fPIC")
 elseif (APPLE)
-    if(${APNGASM_COMPILE_TARGET} STREQUAL "x86_64")
+    if(${APNGASM_COMPILE_TARGET} STREQUAL "armv8")
         set(CMAKE_OSX_DEPLOYMENT_TARGET "11.0")
     else()
-        set(CMAKE_OSX_DEPLOYMENT_TARGET "10.15")
+        set(CMAKE_OSX_DEPLOYMENT_TARGET "10.9")
+        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++0x -stdlib=libc++ -fno-aligned-allocation")
     endif()
 endif()
 
 set(ZLIB_USE_STATIC_LIBS ON)
 set(PNG_USE_STATIC_LIBS ON)
 set(Boost_USE_STATIC_LIBS ON)
-if (WIN32)
+if (MSVC)
     set(Boost_USE_MULTITHREADED ON)
     set(Boost_USE_STATIC_RUNTIME ON)
 endif()
 
 # Add conan packages
-if ("${APNGASM_COMPILE_TARGET}" STREQUAL "universal2")
-    # x86_64 Contians static libraries that are universal2
+if ("${APNGASM_COMPILE_TARGET}" STREQUAL "universal2_x86_64")
     set(CONAN_TOOLCHAIN ${CMAKE_SOURCE_DIR}/conan_output/x86_64/conan_toolchain.cmake)
+elseif ("${APNGASM_COMPILE_TARGET}" STREQUAL "universal2_armv8")
+    set(CONAN_TOOLCHAIN ${CMAKE_SOURCE_DIR}/conan_output/armv8/conan_toolchain.cmake)
 else()
     set(CONAN_TOOLCHAIN ${CMAKE_SOURCE_DIR}/conan_output/${APNGASM_COMPILE_TARGET}/conan_toolchain.cmake)
 endif()
@@ -58,7 +61,7 @@ else()
     message(FATAL_ERROR "The conan_toolchain file could not be found: ${CONAN_TOOLCHAIN}")
 endif()
 
-project(apngasm-python VERSION 1.2.3)
+project(apngasm-python VERSION 1.3.0)
 set(PY_VERSION_SUFFIX "")
 set(PY_FULL_VERSION ${PROJECT_VERSION}${PY_VERSION_SUFFIX})
 
@@ -76,7 +79,7 @@ find_nanobind_python_first()
 
 # Compile the Python module
 nanobind_add_module(_apngasm_python "src/apngasm_python.cpp" NB_STATIC STABLE_ABI)
-if (WIN32)
+if (MSVC)
     nanobind_compile_options(_apngasm_python "/MT /MP /bigobj")
 endif()
 target_compile_definitions(_apngasm_python PRIVATE _apngasm_python_EXPORTS)
@@ -101,7 +104,7 @@ set_target_properties(_apngasm_python PROPERTIES
     CXX_VISIBILITY_PRESET "hidden"
     VISIBILITY_INLINES_HIDDEN true
     POSITION_INDEPENDENT_CODE true)
-if (WIN32)
+if (MSVC)
     set_target_properties(_apngasm_python PROPERTIES LINK_FALGS_RELEASE "/WHOLEARCHIVE:MNN")
 elseif (LINUX)
     target_link_options(_apngasm_python PRIVATE "LINKER:--exclude-libs,ALL")
@@ -114,14 +117,13 @@ install(TARGETS _apngasm_python
         COMPONENT python_modules)
 
 # Generate stubs for the Python module
-option(WITH_PY_STUBS
-    "Generate Python stub files (.pyi) for the Python module." On)
-if (WITH_PY_STUBS AND NOT CMAKE_CROSSCOMPILING)
-    include(cmake/NanobindStubgen.cmake)
-    nanobind_stubgen(_apngasm_python)
-    add_custom_command(TARGET _apngasm_python POST_BUILD
-        COMMAND ${PYTHON_EXECUTABLE} patch_stub.py $<TARGET_FILE_DIR:_apngasm_python>/_apngasm_python.pyi
-        WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/scripts
-        USES_TERMINAL)
-    nanobind_stubgen_install(_apngasm_python ${PY_BUILD_CMAKE_MODULE_NAME})
-endif()
+nanobind_add_stub(
+    apngasm_python_stub
+    INSTALL_TIME
+    MODULE apngasm_python._apngasm_python
+    OUTPUT "${PY_BUILD_CMAKE_MODULE_NAME}/_apngasm_python.pyi"
+    MARKER_FILE "${PY_BUILD_CMAKE_MODULE_NAME}/py.typed"
+    COMPONENT python_modules
+    EXCLUDE_FROM_ALL
+    VERBOSE
+)