bindings_python_ci.yml

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

name: Bindings Python CI

on:
  push:
    branches:
      - main
    paths:
      - '**'                                       # Include all files and directories in the repository by default.
      - '!.github/ISSUE_TEMPLATE/**'               # Exclude files and directories that don't impact tests or code like templates, metadata, and documentation.
      - '!dev/release/**'
      - '!website/**'
      - '!.asf.yml'
      - '!.gitattributes'
      - '!.gitignore'
      - '!CONTRIBUTING.md'
      - '!CHANGELOG.md'
      - '!LICENSE'
      - '!NOTICE'
      - '!README.md'
  pull_request:
  merge_group:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event_name }}
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  check-python:
    runs-on: ubuntu-slim
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false
      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
        with:
          version: "0.9.3"
          enable-cache: true
      - name: Install tools
        run: |
          uv tool install ruff@0.15.22
      - name: Check format
        working-directory: "bindings/python"
        run: |
          uvx ruff format . --diff
      - name: Check style
        working-directory: "bindings/python"
        run: |
          uvx ruff check .

  test:
    runs-on: ${{ matrix.os }}
    strategy:
      max-parallel: 15
      matrix:
        os:
          - ubuntu-latest
          - macos-latest
          - windows-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false
      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
        with:
          python-version: 3.12
      # Linux maturin builds may run inside manylinux Docker, so host Rust caches only help Windows/macOS.
      - name: Setup Rust toolchain
        if: runner.os != 'Linux'
        uses: $/.github/actions/setup-builder
      - name: Cache Rust artifacts
        if: runner.os != 'Linux'
        uses: Swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2.9.2
        with:
          key: bindings-python
          save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
      - uses: PyO3/maturin-action@e83996d129638aa358a18fbd1dfb82f0b0fb5d3b # v1.51.0
        with:
          working-directory: "bindings/python"
          command: build
          args: --out dist -i python3.12 # Explicitly set interpreter; manylinux containers have multiple Pythons and maturin may pick an older one
      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
        with:
          version: "0.9.3"
          enable-cache: true
      - name: Sync dependencies
        working-directory: "bindings/python"
        shell: bash
        run: |
          uv sync --group dev --no-install-project
      - name: Install built wheel
        working-directory: "bindings/python"
        shell: bash
        # --no-index keeps resolution inside dist/: --find-links alone only adds a
        # source, so a newer PyPI release would win and be tested instead.
        run: |
          uv pip install --no-build --reinstall --no-index --find-links dist/ pyiceberg-core
      - name: Run tests
        working-directory: "bindings/python"
        shell: bash
        env:
          HF_TOKEN: ${{ secrets.HF_TOKEN }}
          HF_DATASET: ${{ secrets.HF_DATASET }}
        run: |
          make test

  bindings-python-ci-required:
    if: ${{ always() }}
    needs: [check-python, test]
    runs-on: ubuntu-slim
    steps:
      - name: Verify Bindings Python CI jobs succeeded
        env:
          RESULTS: ${{ join(needs.*.result, ' ') }}
        run: |
          read -ra results <<< "$RESULTS"
          for result in "${results[@]}"; do
            test "$result" = "success"
          done