python-code-format.yml

name: Check Python code formatting

on:
  push:
    # always check code formatting in all feature branches
    branches-ignore:
      - l10n
    paths:
      - 'src/**'
      - 'requirements.txt'
      - 'test-requirements.txt'
      - 'tests/**'
      - '.github/**/*.yml'
      - '.pylintrc'
      - 'pyproject.toml'
  pull_request:
    branches: [main]
    types: [opened, synchronize, reopened]

# prevent concurrent runs of this workflow for open pull requests
concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  test:
    runs-on: ubuntu-24.04

    name: Check Python code formatting
    steps:
      - uses: actions/checkout@v6

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.11"

      - name: Install pip
        run: |
          python -m pip install --upgrade pip

      - name: Install dependencies
        run: |
          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
          if [ -f test-requirements.txt ]; then pip install -r test-requirements.txt; fi
      - name: Analyzing the code with pylint
        run: |
          python -m pylint src
      - name: Lint with flake8
        run: |
          python -m flake8 src --count --show-source --statistics
      - name: Check code formatting with isort
        run: |
          python -m isort src/. --check --verbose
      - name: Check code formatting with black
        run: |
          python -m black src --check --verbose --line-length 120