.github/workflows/ci_bindings_python.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
  pull_request:
    branches:
      - main
    paths:
      - ".github/workflows/ci_bindings_python.yml"
      - "bindings/python/**"
      - "core/**"
  workflow_dispatch:

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

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - name: Setup Rust toolchain
        uses: ./.github/actions/setup
      - name: Install uv
        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
        with:
          working-directory: "bindings/python"
      - uses: taiki-e/install-action@just
      - name: Run Lints
        working-directory: "bindings/python"
        run: just lint

  stubs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - name: Setup Rust toolchain
        uses: ./.github/actions/setup
      - name: Install uv
        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
        with:
          working-directory: "bindings/python"
      - uses: taiki-e/install-action@just
      - name: Setup taplo
        uses: taiki-e/install-action@v2
        with:
          tool: taplo-cli
      - name: Setup hawkeye
        run: curl --proto '=https' --tlsv1.2 -LsSf https://github.com/korandoru/hawkeye/releases/download/v6.5.1/hawkeye-installer.sh | sh
      - name: Regenerate stubs
        working-directory: "bindings/python"
        run: just stub-gen
      - name: Check diff
        run: git diff --exit-code

  examples:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - name: Setup Rust toolchain
        uses: ./.github/actions/setup
        with:
          need-protoc: true
          github-token: ${{ secrets.GITHUB_TOKEN }}
      - name: Setup uv
        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
        with:
          working-directory: bindings/python
      - name: Build with maturin
        shell: bash
        working-directory: "bindings/python"
        run: |
          uv venv --python=python3.11
          uv sync --all-extras
          uv run -- maturin develop
      # Examples back the snippets shown in the website guide. Running them keeps
      # the docs honest: a broken example fails CI instead of shipping bad docs.
      - name: Run guide examples
        shell: bash
        working-directory: "bindings/python"
        run: uv run -- python examples/getting_started.py