onboarding - Branch - pydantic/pydantic-core

docs: improve onboarding

#1775Merged

Comparing

onboarding

(

ca770ad

) with

main

(

57e4411

)

Untouched: 159

Benchmarks

Passed

test_dict_of_ints_core_json

tests/benchmarks/test_micro_benchmarks.py

+4%

1.4 ms1.3 ms

test_strict_int_fails

tests/benchmarks/test_micro_benchmarks.py

+2%

26.9 µs26.5 µs

test_validate_literal[python-many_small_strings]

tests/benchmarks/test_micro_benchmarks.py

+1%

15.4 µs15.2 µs

test_core_python

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkUUID

+1%

26.6 µs26.3 µs

test_list_of_strs_json_cached

tests/benchmarks/test_micro_benchmarks.py

+1%

316.3 µs312.4 µs

test_core_future_str

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkDateTime

+1%

19.2 µs19 µs

test_complete_core_error

tests/benchmarks/test_complete_benchmark.py

+1%

1.8 ms1.8 ms

test_list_of_dict_models_core

tests/benchmarks/test_micro_benchmarks.py

+1%

97.6 µs96.4 µs

test_arguments

tests/benchmarks/test_micro_benchmarks.py

+1%

25.1 µs24.8 µs

test_uuid_from_uuid_pyd

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkUUID

+1%

14.9 µs14.8 µs

test_core_str

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkDateTime

+1%

19 µs18.8 µs

test_small_class_core_model

tests/benchmarks/test_micro_benchmarks.py

+1%

27.4 µs27.1 µs

test_validate_literal[json-few_large_strings]

tests/benchmarks/test_micro_benchmarks.py

+1%

16.7 µs16.5 µs

test_core_string_strict

tests/benchmarks/test_micro_benchmarks.py

+1%

14 µs13.8 µs

test_decimal_from_string_pyd

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkDecimal

+1%

32.8 µs32.5 µs

test_tuple_many_positional

tests/benchmarks/test_micro_benchmarks.py

+1%

18.2 µs18 µs

test_enum_int_core

tests/benchmarks/test_micro_benchmarks.py

+1%

15 µs14.8 µs

test_isinstance_json

tests/benchmarks/test_micro_benchmarks.py

+1%

18.5 µs18.4 µs

test_generator_python

tests/benchmarks/test_micro_benchmarks.py

+1%

23.8 µs23.6 µs

test_variable_tuple

tests/benchmarks/test_micro_benchmarks.py

+1%

18.5 µs18.4 µs

test_date_format_function_no_info

tests/benchmarks/test_serialization_micro.py

+1%

51.6 µs51.1 µs

test_dataclass_serialization_python

tests/benchmarks/test_serialization_micro.py

+1%

22.4 µs22.2 µs

test_strict_union_core

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkUnion

+1%

16.7 µs16.5 µs

test_strict_int

tests/benchmarks/test_micro_benchmarks.py

+1%

14 µs13.8 µs

test_core_raw

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkUUID

+1%

14.1 µs14 µs

test_core_future

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkDateTime

+1%

26.3 µs26.1 µs

test_enum_str_core

tests/benchmarks/test_micro_benchmarks.py

+1%

15.3 µs15.2 µs

test_set_of_ints_core_json_duplicates

tests/benchmarks/test_micro_benchmarks.py

+1%

426 µs423.1 µs

test_complete_core_strict

tests/benchmarks/test_complete_benchmark.py

+1%

253.5 µs251.8 µs

test_model_core_json

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkDateTime

+1%

30.6 µs30.4 µs

test_validate_literal[json-few_mixed]

tests/benchmarks/test_micro_benchmarks.py

+1%

18.9 µs18.7 µs

test_core_string_lax

tests/benchmarks/test_micro_benchmarks.py

+1%

14 µs13.9 µs

test_isinstance_string_strict_true

tests/benchmarks/test_micro_benchmarks.py

+1%

14 µs13.9 µs

test_tagged_union_int_keys_json

tests/benchmarks/test_micro_benchmarks.py

+1%

24.7 µs24.6 µs

test_generator_rust

tests/benchmarks/test_micro_benchmarks.py

+1%

19 µs18.8 µs

test_decimal_from_string_limit

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkDecimal

+1%

18.9 µs18.8 µs

test_core_model_py

tests/benchmarks/test_serialization_micro.py

+1%

27.5 µs27.4 µs

test_model_instance

tests/benchmarks/test_micro_benchmarks.py

+1%

29.5 µs29.3 µs

test_complete_core_json

tests/benchmarks/test_complete_benchmark.py

+1%

422.8 µs420.4 µs

test_int_range_json

tests/benchmarks/test_micro_benchmarks.py

+1%

16 µs15.9 µs

test_core_dict_filter

tests/benchmarks/test_serialization_micro.py::TestBenchmarkSimpleModel

+1%

77.7 µs77.3 µs

test_smart_union_core

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkUnion

+1%

16 µs15.9 µs

test_complete_core_serializer_to_python

tests/benchmarks/test_complete_benchmark.py

+1%

240.2 µs238.9 µs

test_model_instance_abc

tests/benchmarks/test_micro_benchmarks.py

+1%

30 µs29.9 µs

test_with_default

tests/benchmarks/test_micro_benchmarks.py

+1%

22.9 µs22.8 µs

test_int_error

tests/benchmarks/test_micro_benchmarks.py

+1%

40.5 µs40.3 µs

test_enum_str_python

tests/benchmarks/test_micro_benchmarks.py

24.1 µs24 µs

test_enum_int_python

tests/benchmarks/test_micro_benchmarks.py

24.4 µs24.3 µs

test_chain_function

tests/benchmarks/test_micro_benchmarks.py

24.9 µs24.8 µs

test_small_class_core_dict

tests/benchmarks/test_micro_benchmarks.py

19.1 µs19 µs

test_core_model_py_extra

tests/benchmarks/test_serialization_micro.py

30.4 µs30.3 µs

test_datetime_seconds

tests/benchmarks/test_serialization_micro.py

25.3 µs25.2 µs

test_core_dict

tests/benchmarks/test_serialization_micro.py::TestBenchmarkSimpleModel

71.9 µs71.6 µs

test_datetime_milliseconds

tests/benchmarks/test_serialization_micro.py

25.4 µs25.3 µs

test_list_of_ints_core_json

tests/benchmarks/test_micro_benchmarks.py

755.4 µs752.1 µs

test_core_python_fs

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkSimpleModel

70.4 µs70.1 µs

test_list_of_strs_json_uncached

tests/benchmarks/test_micro_benchmarks.py

404.4 µs402.7 µs

test_date_format

tests/benchmarks/test_serialization_micro.py

52.9 µs52.6 µs

test_build_schema

tests/benchmarks/test_complete_benchmark.py

344.8 µs343.4 µs

test_core_raw

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkDateTime

14.5 µs14.5 µs

test_core_python

tests/benchmarks/test_micro_benchmarks.py::TestModelLarge

129.6 µs129 µs

test_list_of_ints_core_py

tests/benchmarks/test_micro_benchmarks.py

516.9 µs515 µs

test_complete_core_serializer_to_json

tests/benchmarks/test_complete_benchmark.py

283.1 µs282 µs

test_validate_literal[json-few_ints]

tests/benchmarks/test_micro_benchmarks.py

15.9 µs15.9 µs

test_frozenset_of_ints_duplicates_core

tests/benchmarks/test_micro_benchmarks.py

157.5 µs157 µs

test_validate_literal[json-many_large_strings]

tests/benchmarks/test_micro_benchmarks.py

16.6 µs16.5 µs

test_smart_union_coerce_core

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkUnion

17.6 µs17.5 µs

test_complete_core_root

tests/benchmarks/test_complete_benchmark.py

281.3 µs280.4 µs

test_datetime

tests/benchmarks/test_serialization_micro.py

27.4 µs27.3 µs

test_dont_raise_error

tests/benchmarks/test_micro_benchmarks.py

20.4 µs20.3 µs

test_tagged_union_int_keys_python

tests/benchmarks/test_micro_benchmarks.py

21.1 µs21 µs

test_raise_error_custom

tests/benchmarks/test_micro_benchmarks.py

38.2 µs38.1 µs

test_core_root_model

tests/benchmarks/test_micro_benchmarks.py

36.8 µs36.7 µs

test_model_exclude_unset_true

tests/benchmarks/test_serialization_micro.py

36.1 µs36 µs

test_bool_core

tests/benchmarks/test_micro_benchmarks.py

23.4 µs23.4 µs

test_chain_list

tests/benchmarks/test_micro_benchmarks.py

25.3 µs25.3 µs

test_filter

tests/benchmarks/test_serialization_micro.py

41.2 µs41.2 µs

test_complete_core_root_json

tests/benchmarks/test_complete_benchmark.py

429.6 µs428.6 µs

test_core_string_lax_wrong

tests/benchmarks/test_micro_benchmarks.py

27 µs26.9 µs

test_core_json

tests/benchmarks/test_serialization_micro.py::TestBenchmarkSimpleModel

81.5 µs81.3 µs

test_isinstance_string_lax_true

tests/benchmarks/test_micro_benchmarks.py

14 µs14 µs

test_core_model_json_extra

tests/benchmarks/test_serialization_micro.py

29.6 µs29.6 µs

test_date_from_date

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkDateX

14.3 µs14.3 µs

test_validate_literal[json-few_small_strings]

tests/benchmarks/test_micro_benchmarks.py

16.4 µs16.4 µs

test_uuid_from_uuid_core

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkUUID

14 µs14 µs

test_int_range

tests/benchmarks/test_micro_benchmarks.py

14.9 µs14.8 µs

test_validate_literal[python-many_large_strings]

tests/benchmarks/test_micro_benchmarks.py

15.3 µs15.3 µs

test_validate_literal[json-many_ints]

tests/benchmarks/test_micro_benchmarks.py

15.9 µs15.9 µs

test_tuple_many_variable

tests/benchmarks/test_micro_benchmarks.py

18.1 µs18.1 µs

test_many_models_core_dict

tests/benchmarks/test_micro_benchmarks.py

931.5 µs929.9 µs

test_dict_of_ints_core

tests/benchmarks/test_micro_benchmarks.py

1 ms1 ms

test_list_of_strs_py_cached

tests/benchmarks/test_micro_benchmarks.py

125.5 µs125.3 µs

test_dont_raise_error_no_info

tests/benchmarks/test_micro_benchmarks.py

18.1 µs18.1 µs

test_complete_core_lax

tests/benchmarks/test_complete_benchmark.py

275.5 µs275.1 µs

test_positional_tuple

tests/benchmarks/test_micro_benchmarks.py

18.7 µs18.7 µs

test_decimal_from_string_core

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkDecimal

23.8 µs23.8 µs

test_model_core_json

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkUUID

41.8 µs41.8 µs

test_list_of_any_core_py

tests/benchmarks/test_micro_benchmarks.py

99.1 µs99 µs

test_frozenset_of_ints_core

tests/benchmarks/test_micro_benchmarks.py

244.9 µs244.5 µs

test_uuid

tests/benchmarks/test_serialization_micro.py

23.3 µs23.3 µs

test_core_string_strict_wrong

tests/benchmarks/test_micro_benchmarks.py

26.6 µs26.6 µs

test_json_direct_list_int

tests/benchmarks/test_serialization_micro.py

140.9 µs140.8 µs

test_core_str

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkUUID

32.7 µs32.7 µs

test_list_of_nullable_core

tests/benchmarks/test_micro_benchmarks.py

107.2 µs107 µs

test_chain_two_functions

tests/benchmarks/test_micro_benchmarks.py

29.2 µs29.2 µs

test_chain_nested_functions

tests/benchmarks/test_micro_benchmarks.py

29.2 µs29.2 µs

test_model_list_core_json

tests/benchmarks/test_serialization_micro.py

160.3 µs160.2 µs

test_json_any_list_int

tests/benchmarks/test_serialization_micro.py

218.6 µs218.5 µs

test_definition_in_tree

tests/benchmarks/test_micro_benchmarks.py

743.4 µs743.1 µs

test_definition_out_of_tree

tests/benchmarks/test_micro_benchmarks.py

1 ms1 ms

test_date_from_datetime_str

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkDateX

19.4 µs19.4 µs

test_validate_literal[python-few_small_strings]

tests/benchmarks/test_micro_benchmarks.py

15.2 µs15.2 µs

test_bytes_core

tests/benchmarks/test_micro_benchmarks.py

13.9 µs13.9 µs

test_core_future

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkDateX

18.4 µs18.4 µs

test_date_from_datetime

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkDateX

22.4 µs22.4 µs

test_validate_literal[python-few_ints]

tests/benchmarks/test_micro_benchmarks.py

14.8 µs14.8 µs

test_core_future_str

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkDateX

16.4 µs16.4 µs

test_isinstance_string_strict_false

tests/benchmarks/test_micro_benchmarks.py

15.3 µs15.3 µs

test_isinstance_string_lax_false

tests/benchmarks/test_micro_benchmarks.py

15.7 µs15.7 µs

test_validate_literal[python-few_large_strings]

tests/benchmarks/test_micro_benchmarks.py

15.2 µs15.2 µs

test_date_format_function

tests/benchmarks/test_serialization_micro.py

52.8 µs52.8 µs

test_set_of_ints_core_duplicates

tests/benchmarks/test_micro_benchmarks.py

310.9 µs310.9 µs

test_ser_list_of_lists

tests/benchmarks/test_serialization_micro.py

1.3 ms1.3 ms

test_dict_of_any_core

tests/benchmarks/test_micro_benchmarks.py

707.6 µs707.9 µs

test_validate_literal[json-many_small_strings]

tests/benchmarks/test_micro_benchmarks.py

16.5 µs16.5 µs

test_python_json_list_int

tests/benchmarks/test_serialization_micro.py

148.5 µs148.6 µs

test_nested_schema_using_defs

tests/benchmarks/test_nested_benchmark.py

15.4 ms15.5 ms

test_set_of_ints_core_json

tests/benchmarks/test_micro_benchmarks.py

859.5 µs859.9 µs

test_raise_error_value_error

tests/benchmarks/test_micro_benchmarks.py

36.8 µs36.8 µs

test_nested_schema_inlined

tests/benchmarks/test_nested_benchmark.py

16.7 ms16.7 ms

test_set_of_ints_core_length

tests/benchmarks/test_micro_benchmarks.py

708.4 µs708.9 µs

test_uuid_from_string_core

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkUUID

32.7 µs32.7 µs

test_dataclass_serialization_json

tests/benchmarks/test_serialization_micro.py

25.2 µs25.2 µs

test_set_of_ints_core

tests/benchmarks/test_micro_benchmarks.py

693.9 µs694.8 µs

test_to_string_format

tests/benchmarks/test_serialization_micro.py

23.6 µs23.6 µs

test_python_json_list_str

tests/benchmarks/test_serialization_micro.py

154.6 µs154.8 µs

test_to_string_direct

tests/benchmarks/test_serialization_micro.py

18.9 µs18.9 µs

test_validate_literal[python-few_mixed]

tests/benchmarks/test_micro_benchmarks.py

16.9 µs16.9 µs

test_validate_literal[python-few_str_enum]

tests/benchmarks/test_micro_benchmarks.py

15.5 µs15.5 µs

test_strict_union_error_core

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkUnion

32.2 µs32.2 µs

test_uuid_from_string_pyd

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkUUID

48.3 µs48.4 µs

test_core_model_json

tests/benchmarks/test_serialization_micro.py

25.8 µs25.8 µs

test_model_exclude_unset_false

tests/benchmarks/test_serialization_micro.py

30.3 µs30.3 µs

test_python_json_list_none

tests/benchmarks/test_serialization_micro.py

123 µs123.4 µs

test_field_function_validator

tests/benchmarks/test_micro_benchmarks.py

413.2 µs414.3 µs

test_json_any_list_str

tests/benchmarks/test_serialization_micro.py

254.6 µs255.2 µs

test_json_direct_list_str

tests/benchmarks/test_serialization_micro.py

171.8 µs172.3 µs

test_validate_literal[json-few_str_enum]

tests/benchmarks/test_micro_benchmarks.py

20.5 µs20.5 µs

test_date_from_str

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkDateX

16.3 µs16.3 µs

test_core_json_fs

tests/benchmarks/test_micro_benchmarks.py::TestModelLarge

175 µs175.7 µs

test_many_models_core_model

tests/benchmarks/test_micro_benchmarks.py

-1%

2.3 ms2.3 ms

test_definition_model_core

tests/benchmarks/test_micro_benchmarks.py

-1%

1.1 ms1.1 ms

test_validate_literal[python-many_ints]

tests/benchmarks/test_micro_benchmarks.py

-1%

14.8 µs14.9 µs

test_core_python

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkDateTime

-1%

27.1 µs27.4 µs

test_to_json_list_of_lists

tests/benchmarks/test_serialization_micro.py

-1%

1.9 ms1.9 ms

test_core_string_strict_wrong_str_e

tests/benchmarks/test_micro_benchmarks.py

-2%

40.2 µs40.9 µs

test_core_json_fs

tests/benchmarks/test_micro_benchmarks.py::TestBenchmarkSimpleModel

-2%

104.8 µs106.4 µs

test_dataclass_to_json

tests/benchmarks/test_serialization_micro.py

-2%

40 µs40.8 µs

test_complete_core_isinstance

tests/benchmarks/test_complete_benchmark.py

-3%

1.7 ms1.7 ms

Commits

Click on a commit to change the comparison range

Base

main

57e4411

+0.63%

docs: improve onboarding Onboarding was not up to date now that `uv` is really supported everywhere. - `make install` now only relies on `uv` - `make help` is a new target to describe all targets with their meaning - README setup section is way clearer

23cdc37

3 months ago

by PrettyWood

-0.36%

docs: improve readme

ca770ad

2 months ago

by PrettyWood

Home Terms Privacy Docs