-
Notifications
You must be signed in to change notification settings - Fork 252
730 lines (581 loc) · 18.9 KB
/
ci.yml
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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
name: ci
on:
push:
branches:
- main
tags:
- '**'
pull_request: {}
env:
COLUMNS: 150
UV_PYTHON: 3.13
jobs:
coverage:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v4
- name: install rust nightly
uses: dtolnay/rust-toolchain@nightly
- id: cache-rust
name: cache rust
uses: Swatinem/rust-cache@v2
- run: cargo install rustfilt coverage-prepare
if: steps.cache-rust.outputs.cache-hit != 'true'
- run: rustup component add llvm-tools-preview
- name: install uv
uses: astral-sh/setup-uv@v4
with:
enable-cache: true
- name: install deps
run: uv sync --group testing
- run: rustc --version --verbose
- run: make build-dev
env:
RUST_BACKTRACE: 1
RUSTFLAGS: '-C instrument-coverage'
- run: uv pip freeze
- run: uv run coverage run -m pytest
- run: ls -lha
- run: uv run coverage xml
- run: coverage-prepare lcov python/pydantic_core/*.so
- uses: codecov/codecov-action@v5
# See https://github.com/PyO3/pyo3/discussions/2781
# tests intermittently segfault with pypy and cpython 3.7 when using `coverage run ...`, hence separate job
test-python:
name: test ${{ matrix.python-version }}
strategy:
fail-fast: false
matrix:
python-version:
- '3.8'
- '3.9'
- '3.10'
- '3.11'
- '3.12'
- '3.13'
- 'pypy3.9'
- 'pypy3.10'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: install rust stable
uses: dtolnay/rust-toolchain@stable
- name: cache rust
uses: Swatinem/rust-cache@v2
with:
key: test-v3
- name: install uv
uses: astral-sh/setup-uv@v4
with:
enable-cache: true
- name: install deps
run: uv sync --group testing
- run: uv pip install -e .
env:
RUST_BACKTRACE: 1
- run: uv pip freeze
- run: uv run pytest
env:
HYPOTHESIS_PROFILE: slow
env:
UV_PYTHON: ${{ matrix.python-version }}
test-os:
name: test on ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu, macos, windows]
runs-on: ${{ matrix.os }}-latest
steps:
- uses: actions/checkout@v4
- name: install rust stable
uses: dtolnay/rust-toolchain@stable
- name: cache rust
uses: Swatinem/rust-cache@v2
- name: install uv
uses: astral-sh/setup-uv@v4
with:
enable-cache: true
- name: install deps
run: uv sync --group testing
- run: uv pip install -e .
env:
RUST_BACKTRACE: 1
- run: uv pip freeze
- run: uv run pytest
- run: cargo test
test-msrv:
name: test MSRV
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: install uv
uses: astral-sh/setup-uv@v4
with:
enable-cache: true
- name: install deps
run: uv sync --group testing
- name: resolve MSRV
id: resolve-msrv
run: echo MSRV=`uv run python -c 'import tomllib; print(tomllib.load(open("Cargo.toml", "rb"))["package"]["rust-version"])'` >> $GITHUB_OUTPUT
- name: install rust MSRV
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ steps.resolve-msrv.outputs.MSRV }}
- name: cache rust
uses: Swatinem/rust-cache@v2
- run: uv pip install -e .
env:
RUST_BACKTRACE: 1
- run: uv pip freeze
- run: uv run pytest
- run: cargo test
# test with a debug build as it picks up errors which optimised release builds do not
test-debug:
name: test-debug ${{ matrix.python-version }}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version:
- '3.13'
- 'pypy3.10'
steps:
- uses: actions/checkout@v4
- name: install uv
uses: astral-sh/setup-uv@v4
with:
enable-cache: true
- name: install rust stable
uses: dtolnay/rust-toolchain@stable
- name: cache rust
uses: Swatinem/rust-cache@v2
- name: install deps
run: uv sync --group testing
- run: make build-dev
- run: uv pip freeze
- run: uv run pytest
env:
UV_PYTHON: ${{ matrix.python-version }}
test-pydantic-integration:
runs-on: ubuntu-latest
continue-on-error: true
steps:
- uses: actions/checkout@v4
with:
repository: pydantic/pydantic
path: pydantic
- uses: actions/checkout@v4
with:
path: pydantic-core
- name: install rust stable
uses: dtolnay/rust-toolchain@stable
- name: cache rust
uses: Swatinem/rust-cache@v2
- name: install uv
uses: astral-sh/setup-uv@v4
with:
enable-cache: true
- name: install deps
run: |
uv sync --extra timezone
uv pip install maturin pip
uv run bash -c 'cd ../pydantic-core && maturin develop'
working-directory: pydantic
- run: uv --version && uv pip list
working-directory: pydantic
# Run pytest with lax xfail because we often add tests to pydantic
# which xfail on a pending release of pydantic-core
- run: uv run pytest --override-ini=xfail_strict=False
working-directory: pydantic
env:
PYDANTIC_PRIVATE_ALLOW_UNHANDLED_SCHEMA_TYPES: 1
env:
UV_PROJECT_ENVIRONMENT: ${{ github.workspace }}/.venv
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: install rust stable
uses: dtolnay/rust-toolchain@stable
with:
components: rustfmt, clippy
- name: cache rust
uses: Swatinem/rust-cache@v2
# used to lint js code
- uses: actions/setup-node@v4
with:
node-version: '18'
- name: install uv
uses: astral-sh/setup-uv@v4
with:
enable-cache: true
- name: install deps
run: |
uv sync --group linting
make build-dev
uv pip freeze
- run: make lint
- run: make pyright
- run: npm install
- run: npm run lint
bench:
name: rust benchmarks
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: install rust nightly
uses: dtolnay/rust-toolchain@nightly
- name: cache rust
uses: Swatinem/rust-cache@v2
- uses: actions/setup-python@v5
with:
python-version: '3.13'
- run: pip install typing_extensions
- run: cargo bench
build-wasm-emscripten:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: install rust nightly
uses: dtolnay/rust-toolchain@nightly
with:
components: rust-src
targets: wasm32-unknown-emscripten
- name: cache rust
uses: Swatinem/rust-cache@v2
- uses: mymindstorm/setup-emsdk@v14
with:
# NOTE!: as per https://github.com/pydantic/pydantic-core/pull/149 this version needs to match the version
# in node_modules/pyodide/repodata.json, to get the version, run:
# `cat node_modules/pyodide/repodata.json | python -m json.tool | rg platform`
version: '3.1.58'
actions-cache-folder: emsdk-cache
- name: install uv
uses: astral-sh/setup-uv@v4
with:
enable-cache: true
- name: install deps
run: uv sync --group wasm
- name: build wheels
run: make build-wasm
- uses: actions/setup-node@v4
with:
node-version: '18'
- run: npm install
- run: npm run test
- run: |
ls -lh dist/
ls -l dist/
- uses: actions/upload-artifact@v4
with:
name: wasm_wheels
path: dist
env:
UV_PYTHON: 3.12
# https://github.com/marketplace/actions/alls-green#why used for branch protection checks
check:
if: always()
needs: [coverage, test-python, test-os, test-debug, lint, bench, build-wasm-emscripten]
runs-on: ubuntu-latest
steps:
- name: Decide whether the needed jobs succeeded or failed
uses: re-actors/alls-green@release/v1
with:
jobs: ${{ toJSON(needs) }}
allowed-failures: coverage
build-sdist:
name: build sdist
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.13'
- uses: PyO3/maturin-action@v1
with:
command: sdist
args: --out dist
rust-toolchain: stable
- uses: actions/upload-artifact@v4
with:
name: pypi_files_sdist
path: dist
build:
name: build on ${{ matrix.os }} (${{ matrix.target }} - ${{ matrix.interpreter || 'all' }}${{ matrix.os == 'linux' && format(' - {0}', matrix.manylinux == 'auto' && 'manylinux' || matrix.manylinux) || '' }})
# only run on push to main and on release
if: startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main' || contains(github.event.pull_request.labels.*.name, 'Full Build')
strategy:
fail-fast: false
matrix:
os: [linux, macos, windows]
target: [x86_64, aarch64]
manylinux: [auto]
include:
# manylinux for various platforms, plus x86_64 pypy
- os: linux
manylinux: auto
target: i686
- os: linux
manylinux: auto
target: aarch64
- os: linux
manylinux: auto
target: armv7
interpreter: 3.8 3.9 3.10 3.11 3.12 3.13
- os: linux
manylinux: auto
target: ppc64le
interpreter: 3.8 3.9 3.10 3.11 3.12 3.13
- os: linux
manylinux: auto
target: s390x
interpreter: 3.8 3.9 3.10 3.11 3.12 3.13
- os: linux
manylinux: auto
target: x86_64
interpreter: pypy3.9 pypy3.10
# musllinux
- os: linux
manylinux: musllinux_1_1
target: x86_64
- os: linux
manylinux: musllinux_1_1
target: aarch64
- os: linux
manylinux: musllinux_1_1
target: armv7
# macos;
# all versions x86_64
# arm pypy and older pythons which can't be run on the arm hardware for PGO
- os: macos
target: x86_64
- os: macos
target: aarch64
interpreter: 3.8 3.9 pypy3.9 pypy3.10
# windows;
# x86_64 pypy builds are not PGO optimized
# i686 not supported by pypy
# aarch64 only 3.11 and up, also not PGO optimized
- os: windows
target: x86_64
interpreter: pypy3.9 pypy3.10
- os: windows
target: i686
python-architecture: x86
interpreter: 3.8 3.9 3.10 3.11 3.12 3.13
- os: windows
target: aarch64
interpreter: 3.11 3.12 3.13
exclude:
# See above; disabled for now.
- os: windows
target: aarch64
runs-on: ${{ (matrix.os == 'linux' && 'ubuntu') || matrix.os }}-latest
steps:
- uses: actions/checkout@v4
- name: set up python
uses: actions/setup-python@v5
with:
python-version: '3.13'
architecture: ${{ matrix.python-architecture || 'x64' }}
- run: pip install -U twine 'ruff==0.5.0' typing_extensions
# generate self-schema now, so we don't have to do so inside docker in maturin build
- run: python generate_self_schema.py
- name: build wheels
uses: PyO3/maturin-action@v1
with:
target: ${{ matrix.target }}
manylinux: ${{ matrix.manylinux }}
args: --release --out dist --interpreter ${{ matrix.interpreter || '3.8 3.9 3.10 3.11 3.12 3.13 pypy3.9 pypy3.10' }}
# Limit windows builds to 1.77 to keep Windows 7 support.
# FIXME: Unpin when Python 3.8 support is dropped. (3.9 requires Windows 10)
rust-toolchain: ${{ (matrix.os == 'windows' && '1.77') || 'stable' }}
docker-options: -e CI
- run: ${{ (matrix.os == 'windows' && 'dir') || 'ls -lh' }} dist/
- run: twine check --strict dist/*
- uses: actions/upload-artifact@v4
with:
name: pypi_files_${{ matrix.os }}_${{ matrix.target }}_${{ matrix.interpreter || 'all' }}_${{ matrix.manylinux }}
path: dist
build-pgo:
name: build pgo-optimized on ${{ matrix.os }} / ${{ matrix.interpreter }}
# only run on push to main and on release
if: startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main' || contains(github.event.pull_request.labels.*.name, 'Full Build')
strategy:
fail-fast: false
matrix:
os: [linux, windows, macos]
interpreter: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
include:
# standard runners with override for macos arm
- os: linux
runs-on: ubuntu-latest
- os: windows
ls: dir
runs-on: windows-latest
- os: macos
runs-on: macos-latest-xlarge
exclude:
# macos arm only supported from 3.10 and up
- os: macos
interpreter: '3.8'
- os: macos
interpreter: '3.9'
runs-on: ${{ matrix.runs-on }}
steps:
- uses: actions/checkout@v4
- name: install uv
uses: astral-sh/setup-uv@v4
with:
enable-cache: true
- name: install rust stable
id: rust-toolchain
uses: dtolnay/rust-toolchain@master
with:
components: llvm-tools
# Limit windows builds to 1.77 to keep Windows 7 support.
# FIXME: Unpin when Python 3.8 support is dropped. (3.9 requires Windows 10)
toolchain: ${{ (matrix.os == 'windows' && '1.77') || 'stable' }}
- name: Build PGO wheel
id: pgo-wheel
uses: ./.github/actions/build-pgo-wheel
with:
interpreter: ${{ env.UV_PYTHON }}
rust-toolchain: ${{ steps.rust-toolchain.outputs.name }}
- run: ${{ matrix.ls || 'ls -lh' }} dist/
- uses: actions/upload-artifact@v4
with:
name: pypi_files_${{ matrix.os }}_${{ matrix.interpreter }}
path: dist
env:
UV_PYTHON: ${{ matrix.interpreter }}
inspect-pypi-assets:
needs: [build, build-sdist, build-pgo]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: get dist artifacts
uses: actions/download-artifact@v4
with:
pattern: pypi_files_*
merge-multiple: true
path: dist
- name: list dist files
run: |
ls -lh dist/
ls -l dist/
echo "`ls dist | wc -l` files"
- name: extract and list sdist file
run: |
mkdir sdist-files
tar -xvf dist/*.tar.gz -C sdist-files
tree -a sdist-files
- name: extract and list wheel file
run: |
ls dist/*cp310-manylinux*x86_64.whl | head -n 1
python -m zipfile --list `ls dist/*cp310-manylinux*x86_64.whl | head -n 1`
test-builds-arch:
name: test build on ${{ matrix.target }}-${{ matrix.distro }}
needs: [build]
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
target: [aarch64, armv7, s390x, ppc64le]
distro: ['ubuntu22.04']
include:
- target: aarch64
distro: alpine_latest
steps:
- uses: actions/checkout@v4
- name: get dist artifacts
uses: actions/download-artifact@v4
with:
pattern: pypi_files_linux_*
merge-multiple: true
path: dist
- uses: uraimo/run-on-arch-action@v2.8.1
name: install & test
with:
arch: ${{ matrix.target }}
distro: ${{ matrix.distro }}
githubToken: ${{ github.token }}
install: |
set -x
if command -v apt-get &> /dev/null; then
echo "installing python & pip with apt-get..."
apt-get update
apt-get install -y --no-install-recommends python3 python3-pip python3-venv git curl
else
echo "installing python & pip with apk..."
apk update
apk add python3 py3-pip git curl
fi
run: |
set -x
curl -LsSf https://astral.sh/uv/install.sh | sh
source $HOME/.local/bin/env
uv sync --frozen --group testing --no-install-project
uv pip install pydantic-core --no-index --no-deps --find-links dist --force-reinstall
uv run --no-sync pytest --ignore=tests/test_docstrings.py
uv run --no-sync python -c 'import pydantic_core._pydantic_core; print(pydantic_core._pydantic_core.__version__)'
test-builds-os:
name: test build on ${{ matrix.os }}
needs: [build, build-pgo]
strategy:
fail-fast: false
matrix:
os: [ubuntu, macos, windows]
runs-on: ${{ matrix.os }}-latest
steps:
- uses: actions/checkout@v4
- name: install uv
uses: astral-sh/setup-uv@v4
with:
enable-cache: true
- name: get dist artifacts
uses: actions/download-artifact@v4
with:
pattern: pypi_files_*
merge-multiple: true
path: dist
- run: uv sync --group testing
- run: uv pip install pydantic-core --no-index --no-deps --find-links dist --force-reinstall
- run: uv run pytest --ignore=tests/test_docstrings.py
release:
needs: [test-builds-arch, test-builds-os, build-sdist, check]
if: success() && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: set up python
uses: actions/setup-python@v5
with:
python-version: '3.13'
- run: pip install -U twine
- name: check package version
run: python .github/check_version.py
- name: get dist artifacts
uses: actions/download-artifact@v4
with:
pattern: pypi_files_*
merge-multiple: true
path: dist
- run: twine check --strict dist/*
- name: upload to pypi
run: twine upload dist/*
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.pypi_token }}
- name: get wasm dist artifacts
uses: actions/download-artifact@v4
with:
name: wasm_wheels
path: wasm
- name: upload to github release
uses: softprops/action-gh-release@v2
with:
files: |
wasm/*.whl
prerelease: ${{ contains(github.ref, 'alpha') || contains(github.ref, 'beta') }}