1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
name: CI
on:
push:
branches:
- main
- 2.*
pull_request:
workflow_dispatch:
env:
CACHE_VERSION: 3
KEY_PREFIX: venv
DEFAULT_PYTHON: "3.13"
PRE_COMMIT_CACHE: ~/.cache/pre-commit
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true
jobs:
base-checks:
name: Checks
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- &checkout
name: Check out code from GitHub
uses: actions/checkout@v5.0.0
- &setup-python-default
name: Set up Python ${{ env.DEFAULT_PYTHON }}
id: python
uses: actions/setup-python@v6.0.0
with:
python-version: ${{ env.DEFAULT_PYTHON }}
check-latest: true
- name: Generate partial Python venv restore key
id: generate-python-key
run: >-
echo "key=base-venv-${{ env.CACHE_VERSION }}-${{
hashFiles('pyproject.toml', 'requirements_dev.txt',
'requirements_full.txt', 'requirements_minimal.txt') }}" >> $GITHUB_OUTPUT
- &cache-python
name: Restore Python virtual environment
id: cache-venv
uses: actions/cache@v4.3.0
with:
path: venv
key: >-
${{ runner.os }}-${{ steps.python.outputs.python-version }}-${{
steps.generate-python-key.outputs.key }}
- name: Create Python virtual environment
if: steps.cache-venv.outputs.cache-hit != 'true'
run: |
python -m venv venv
. venv/bin/activate
python -m pip install -U pip
pip install -U -r requirements_full.txt
- name: Generate pre-commit restore key
id: generate-pre-commit-key
run: >-
echo "key=pre-commit-${{ env.CACHE_VERSION }}-${{
hashFiles('.pre-commit-config.yaml') }}" >> $GITHUB_OUTPUT
- name: Restore pre-commit environment
id: cache-precommit
uses: actions/cache@v4.3.0
with:
path: ${{ env.PRE_COMMIT_CACHE }}
key: >-
${{ runner.os }}-${{ steps.generate-pre-commit-key.outputs.key }}
- name: Install pre-commit dependencies
if: steps.cache-precommit.outputs.cache-hit != 'true'
run: |
. venv/bin/activate
pre-commit install --install-hooks
- name: Run pre-commit checks
run: |
. venv/bin/activate
pre-commit run --hook-stage manual pylint-ci --all-files
tests-linux:
name: tests / run / ${{ matrix.python-version }} / Linux
runs-on: ubuntu-latest
timeout-minutes: 20
strategy:
fail-fast: false
matrix:
python-version: &matrix-python-version ["3.10", "3.11", "3.12", "3.13", "3.14"]
outputs:
python-key: ${{ steps.generate-python-key.outputs.key }}
steps:
- *checkout
- name: Set up Python ${{ matrix.python-version }}
id: python
uses: actions/setup-python@v6.0.0
with:
python-version: ${{ matrix.python-version }}
allow-prereleases: true
check-latest: true
- name: Install Qt
if: ${{ matrix.python-version == '3.10' }}
run: |
sudo apt-get update
sudo apt-get install build-essential libgl1-mesa-dev
- name: Generate partial Python venv restore key
id: generate-python-key
run: >-
echo "key=${{ env.KEY_PREFIX }}-${{ env.CACHE_VERSION }}-${{
hashFiles('pyproject.toml', 'requirements_dev.txt',
'requirements_full.txt', 'requirements_minimal.txt') }}" >> $GITHUB_OUTPUT
- *cache-python
- name: Create Python virtual environment
if: steps.cache-venv.outputs.cache-hit != 'true'
run: |
python -m venv venv
. venv/bin/activate
python -m pip install -U pip wheel
pip install -U -r requirements_full.txt
pip install -e .
- name: Run pytest
run: |
. venv/bin/activate
pytest --cov
- name: Upload coverage artifact
uses: &actions-upload-artifact actions/upload-artifact@v4.6.2
with:
name: coverage-linux-${{ matrix.python-version }}
path: .coverage
include-hidden-files: true
tests-windows:
name: tests / run / ${{ matrix.python-version }} / Windows
runs-on: windows-latest
timeout-minutes: 20
needs: [tests-linux]
strategy:
fail-fast: false
matrix:
python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
steps:
- name: Set temp directory
run: echo "TEMP=$env:USERPROFILE\AppData\Local\Temp" >> $env:GITHUB_ENV
# Workaround to set correct temp directory on Windows
# https://github.com/actions/virtual-environments/issues/712
- *checkout
- &setup-python-matrix
name: Set up Python ${{ matrix.python-version }}
id: python
uses: actions/setup-python@v6.0.0
with:
python-version: ${{ matrix.python-version }}
allow-prereleases: true
check-latest: true
- name: Generate partial Python venv restore key
id: generate-python-key
run: >-
echo "key=${{ env.KEY_PREFIX }}-${{ env.CACHE_VERSION }}-${{
hashFiles('pyproject.toml', 'requirements_dev.txt',
'requirements_full.txt', 'requirements_minimal.txt') }}" >> $GITHUB_OUTPUT
- *cache-python
- name: Create Python virtual environment
if: steps.cache-venv.outputs.cache-hit != 'true'
run: |
python -m venv venv
. venv\\Scripts\\activate
python -m pip install -U pip
pip install -U -r requirements_full.txt
pip install -e .
- name: Run pytest
run: |
. venv\\Scripts\\activate
pytest --cov
- name: Upload coverage artifact
uses: *actions-upload-artifact
with:
name: coverage-windows-${{ matrix.python-version }}
path: .coverage
include-hidden-files: true
tests-pypy:
name: tests / run / ${{ matrix.python-version }} / Linux
runs-on: ubuntu-latest
timeout-minutes: 20
strategy:
fail-fast: false
matrix:
# We only test on the lowest and highest supported PyPy versions
python-version: ["pypy3.10"]
steps:
- *checkout
- *setup-python-matrix
- name: Generate partial Python venv restore key
id: generate-python-key
run: >-
echo "key=${{ env.KEY_PREFIX }}-${{ env.CACHE_VERSION }}-${{
hashFiles('pyproject.toml', 'requirements_minimal.txt')
}}" >> $GITHUB_OUTPUT
- *cache-python
- name: Create Python virtual environment
if: steps.cache-venv.outputs.cache-hit != 'true'
run: |
python -m venv venv
. venv/bin/activate
python -m pip install -U pip
pip install -U -r requirements_minimal.txt
pip install -e .
- name: Run pytest
run: |
. venv/bin/activate
pytest --cov
- name: Upload coverage artifact
uses: *actions-upload-artifact
with:
name: coverage-pypy-${{ matrix.python-version }}
path: .coverage
include-hidden-files: true
coverage:
name: tests / process / coverage
runs-on: ubuntu-latest
timeout-minutes: 10
needs: ["tests-linux", "tests-windows", "tests-pypy"]
steps:
- *checkout
- *setup-python-default
- name: Install dependencies
run: pip install -U -r requirements_minimal.txt
- name: Download all coverage artifacts
uses: actions/download-artifact@v5.0.0
- name: Combine Linux coverage results
run: |
coverage combine coverage-linux*/.coverage
coverage xml -o coverage-linux.xml
- uses: &actions-codecov codecov/codecov-action@v5
with:
token: ${{ secrets.CODECOV_TOKEN }}
fail_ci_if_error: true
verbose: true
flags: linux
files: coverage-linux.xml
- name: Combine Windows coverage results
run: |
coverage combine coverage-windows*/.coverage
coverage xml -o coverage-windows.xml
- uses: *actions-codecov
with:
token: ${{ secrets.CODECOV_TOKEN }}
fail_ci_if_error: true
verbose: true
flags: windows
files: coverage-windows.xml
- name: Combine PyPy coverage results
run: |
coverage combine coverage-pypy*/.coverage
coverage xml -o coverage-pypy.xml
- uses: *actions-codecov
with:
token: ${{ secrets.CODECOV_TOKEN }}
fail_ci_if_error: true
verbose: true
flags: pypy
files: coverage-pypy.xml
|
