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
|
.DEFAULT_GOAL := all
sources = pydantic tests docs/plugins release/
NUM_THREADS?=1
.PHONY: .uv ## Check that uv is installed
.uv:
@uv -V || echo 'Please install uv: https://docs.astral.sh/uv/getting-started/installation/'
.PHONY: .pre-commit ## Check that pre-commit is installed
.pre-commit: .uv
@uv run pre-commit -V || uv pip install pre-commit
.PHONY: install ## Install the package, dependencies, and pre-commit for local development
install: .uv
uv sync --frozen --group all --all-extras
uv pip install pre-commit
uv run pre-commit install --install-hooks
.PHONY: rebuild-lockfiles ## Rebuild lockfiles from scratch, updating all dependencies
rebuild-lockfiles: .uv
uv lock --upgrade
.PHONY: format ## Auto-format python source files
format: .uv
uv run ruff check --fix $(sources)
uv run ruff format $(sources)
.PHONY: lint ## Lint python source files
lint: .uv
uv run ruff check $(sources)
uv run ruff format --check $(sources)
.PHONY: codespell ## Use Codespell to do spellchecking
codespell: .pre-commit
uv run pre-commit run codespell --all-files
.PHONY: typecheck ## Perform type-checking
typecheck: .pre-commit
uv run pre-commit run typecheck --all-files
.PHONY: test-mypy ## Run the mypy integration tests
test-mypy: .uv
uv run coverage run -m pytest tests/mypy --test-mypy
.PHONY: test-mypy-update ## Update the mypy integration tests for the current mypy version
test-mypy-update: .uv
uv run coverage run -m pytest tests/mypy --test-mypy --update-mypy
.PHONY: test-typechecking-pyright ## Typechecking integration tests (Pyright)
test-typechecking-pyright: .uv
uv run bash -c 'cd tests/typechecking && pyright --version && pyright -p pyproject.toml'
.PHONY: test-typechecking-mypy ## Typechecking integration tests (Mypy). Not to be confused with `test-mypy`.
test-typechecking-mypy: .uv
uv run bash -c 'cd tests/typechecking && mypy --version && mypy --cache-dir=/dev/null --config-file pyproject.toml .'
.PHONY: test-typechecking-pyrefly ## Typechecking integration tests (Pyrefly).
test-typechecking-pyrefly: .uv
uv run bash -c 'cd tests/typechecking && pyrefly --version && pyrefly check'
.PHONY: test ## Run all tests, skipping the type-checker integration tests
test: .uv
uv run coverage run -m pytest --durations=10 --parallel-threads $(NUM_THREADS)
.PHONY: benchmark ## Run all benchmarks
benchmark: .uv
uv run coverage run -m pytest --durations=10 --benchmark-enable tests/benchmarks
.PHONY: testcov ## Run tests and generate a coverage report, skipping the type-checker integration tests
testcov: test
@echo "building coverage html"
@uv run coverage html
@echo "building coverage lcov"
@uv run coverage lcov
.PHONY: test-examples ## Run only the tests from the documentation
test-examples: .uv
@echo "running examples"
@find docs/examples -type f -name '*.py' | xargs -I'{}' sh -c 'uv run python {} >/dev/null 2>&1 || (echo "{} failed")'
.PHONY: test-pydantic-settings ## Run the pydantic-settings tests with this version of pydantic
test-pydantic-settings: .uv
git clone https://github.com/pydantic/pydantic-settings.git --single-branch
bash ./tests/test_pydantic_settings.sh
.PHONY: test-pydantic-extra-types ## Run the pydantic-extra-types tests with this version of pydantic
test-pydantic-extra-types: .uv
git clone https://github.com/pydantic/pydantic-extra-types.git --single-branch
bash ./tests/test_pydantic_extra_types.sh
.PHONY: test-no-docs # Run all tests except the docs tests
test-no-docs: .uv
uv run pytest tests --ignore=tests/test_docs.py
.PHONY: all ## Run the standard set of checks performed in CI
all: lint typecheck codespell testcov
.PHONY: clean ## Clear local caches and build artifacts
clean:
rm -rf `find . -name __pycache__`
rm -f `find . -type f -name '*.py[co]'`
rm -f `find . -type f -name '*~'`
rm -f `find . -type f -name '.*~'`
rm -rf .cache
rm -rf .pytest_cache
rm -rf .ruff_cache
rm -rf htmlcov
rm -rf *.egg-info
rm -f .coverage
rm -f .coverage.*
rm -rf build
rm -rf dist
rm -rf site
rm -rf docs/_build
rm -rf docs/.changelog.md docs/.version.md docs/.tmp_schema_mappings.html
rm -rf fastapi/test.db
rm -rf coverage.xml
.PHONY: docs ## Generate the docs
docs:
uv run mkdocs build --strict
.PHONY: docs-serve
docs-serve: ## Build and serve the documentation, for local preview
uv run mkdocs serve --strict
.PHONY: help ## Display this message
help:
@grep -E \
'^.PHONY: .*?## .*$$' $(MAKEFILE_LIST) | \
sort | \
awk 'BEGIN {FS = ".PHONY: |## "}; {printf "\033[36m%-19s\033[0m %s\n", $$2, $$3}'
.PHONY: update-v1 ## Update V1 namespace
update-v1:
uv run ./update_v1.sh
|
