kennethreitz/pydantic
1
0
Fork 0
mirror of https://github.com/kennethreitz/pydantic.git synced 2026-06-05 23:00:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
c834f3419d78d03ce176e6223b0b4e96ac4d3891
pydantic/docs/examples
T
History
Eric Jolibois c834f3419d Support discriminated union (#2336) 
* feat: add discriminated union

* feat: add OpenAPI spec schema

* test: add basic example for generated schema

* test: add validation tests

* docs: add basic documentation

* fix: support ForwardRef

* test: add ForwardRef case

* fix: false positive lint error

https://github.com/PyCQA/pyflakes/pull/600

* improve error

* add schema/schema_json utils

* fix tests after merge

* refactor: add `discriminator` attribute to `FieldInfo`

* refactor: @cybojenix remarks

* fix schema with forward ref

* start nested

* feat: add allowed values in error message

* fix wrong check

Same example with

```
class FooDomainA(BaseModel):
    __root__: Union[FooDomainAA, FooDomainAB]
```

(without a discriminator)
should obviously be valid

* test: add nested examples

* remove uncovered code as we don't need it

* docs: add nested example

* fix: support properly Annotated Field syntax

* support naked annotated

* fix: handle TypeError

* make error loc more explicit

* fix behaviour with basemodel instance as value

* support schema for dataclasses

* tweak examples

* refactor: context manager just around code that fails

* refactor: add docstring + tweak on `get_sub_types`

* refactor: move `get_discriminator_values` in `utils.py`

* refactor: create `MissingDiscriminator` and `InvalidDiscriminator`

* refactor: move logic in `_validate_discriminated_union`

* refactor: remove `DiscriminatedUnionConfig`

* docs: schema/schema_json

* tests: add tests with other `Literal` types

* update 3.10

* add schema docstring

* weird bug on 3.8 with `Literal[None]`

* bump to view docs & coverage

* bump to prompt tests

* move tests in dedicated file

* chore: rewording

* refactor: replace property by direct slot

* refactor: faster check

* refactor: missing discriminator

* refactor: change error to ConfigError

* refactor: use display_as_type

* fix: mypy

* fix: duplicate

* feat: handle alias

* feat: handle nested unions

* tweak first example

Co-authored-by: Samuel Colvin <s@muelcolvin.com>
2021-12-18 16:31:35 +00:00
..
.editorconfig
Insert prints in docs. (#895)
2019-10-14 16:40:25 +01:00
annotated_types_named_tuple.py
feat: add support for NamedTuple and TypedDict types (#2216)
2021-02-13 10:05:57 +00:00
annotated_types_typed_dict.py
fix coverage and make typing-extensions a required dependency (#2368)
2021-02-17 19:17:30 +00:00
dataclasses_arbitrary_types_allowed.py
fix: pydantic dataclass can inherit from stdlib dataclass and arbitrary_types_allowed is supported (#2051)
2020-10-28 19:10:55 +00:00
dataclasses_default_schema.py
Support Field in dataclass + 'metadata' kwarg of dataclasses.field (#2384)
2021-02-25 20:04:16 +00:00
dataclasses_initvars.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
dataclasses_json_dumps.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
dataclasses_main.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
dataclasses_nested.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
dataclasses_post_init_post_parse.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
dataclasses_stdlib_inheritance.py
fix: pydantic dataclass can inherit from stdlib dataclass and arbitrary_types_allowed is supported (#2051)
2020-10-28 19:10:55 +00:00
dataclasses_stdlib_to_pydantic.py
feat: make pydantic dataclass decorator support built-in dataclass (#1817)
2020-10-26 11:09:28 +00:00
dataclasses_stdlib_with_basemodel.py
fix: forward all the params of the stdlib dataclass when converted into _pydantic_ dataclass (#2066)
2020-10-31 18:45:20 +00:00
devtools_main.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
exporting_models_copy.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
exporting_models_dict.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
exporting_models_exclude1.py
Add exclude as field parameter (#2231)
2021-05-01 16:45:37 +01:00
exporting_models_exclude2.py
Add exclude as field parameter (#2231)
2021-05-01 16:45:37 +01:00
exporting_models_exclude3.py
Add exclude as field parameter (#2231)
2021-05-01 16:45:37 +01:00
exporting_models_exclude4.py
Add exclude as field parameter (#2231)
2021-05-01 16:45:37 +01:00
exporting_models_exclude5.py
Add exclude as field parameter (#2231)
2021-05-01 16:45:37 +01:00
exporting_models_iterate.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
exporting_models_json_encoders_merge.py
Add merged json_encoders inheritance (#2064)
2021-02-13 15:56:34 +00:00
exporting_models_json_encoders.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
exporting_models_json_forward_ref.py
feat: make JSON serialization of referenced pydantic models possible (#2650)
2021-12-07 22:01:11 +00:00
exporting_models_json_subclass.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
exporting_models_json.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
exporting_models_orjson.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
exporting_models_pickle.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
exporting_models_ujson.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
generate_models_person_model.py
Add datamodel-code-generator link in pydantic document site (#1532)
2020-05-31 15:23:20 +01:00
hypothesis_property_based_test.py
Add a Hypothesis plugin (#2097)
2021-02-11 12:33:11 +00:00
index_error.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
index_main.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
model_config_alias_generator.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
model_config_alias_precedence.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
model_config_change_globally_custom.py
feat: avoid reconstructing models used as fields of another model on validation (#2193)
2021-02-12 13:04:52 +00:00
model_config_class_kwargs.py
Allow to configure models through class kwargs (#2356)
2021-02-22 17:10:04 +00:00
model_config_dataclass.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
model_config_main.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
model_config_smart_union_off.py
feat: add Config.smart_union option (#2092)
2021-12-07 21:58:52 +00:00
model_config_smart_union_on_edge_case.py
feat: add Config.smart_union option (#2092)
2021-12-07 21:58:52 +00:00
model_config_smart_union_on.py
feat: add Config.smart_union option (#2092)
2021-12-07 21:58:52 +00:00
models_abc.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_construct.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_custom_root_access.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_custom_root_field_parse_obj.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_custom_root_field.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_data_conversion.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_default_factory.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_dynamic_creation.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_dynamic_inheritance.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_dynamic_validators.py
Docs: Add validators to dynamic model (#1963)
2020-10-25 17:57:08 +00:00
models_errors1.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_errors2.py
Update validator function name in examples to show that value must b… (#3327)
2021-12-08 23:17:08 +00:00
models_errors3.py
Update validator function name in examples to show that value must b… (#3327)
2021-12-08 23:17:08 +00:00
models_field_order.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_from_typeddict.py
fix coverage and make typing-extensions a required dependency (#2368)
2021-02-17 19:17:30 +00:00
models_generics_inheritance_extend.py
Allow generics to extend concrete classes. fixes #2005 (#2006)
2020-10-25 19:22:25 +00:00
models_generics_inheritance.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_generics_naming.py
docs: Print name classes for __concrete_name__ example (#3470)
2021-12-07 10:45:39 +01:00
models_generics_nested.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_generics_typevars.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_generics.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_mutation.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_orm_mode_data_binding.py
Add GetterDict example (#2463)
2021-05-12 15:25:17 +01:00
models_orm_mode_recursive.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_orm_mode_reserved_name.py
fix blank lines in docs
2020-05-31 15:05:06 +01:00
models_orm_mode.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_parse.py
remove data.json, fix #1992 (#1994)
2020-10-11 19:34:37 +01:00
models_recursive.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_required_field_optional.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_required_fields.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_signature_custom_init.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
models_signature.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
mypy_main.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
parse_obj_as.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
postponed_annotations_broken.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
postponed_annotations_forward_ref.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
postponed_annotations_main.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
postponed_annotations_self_referencing_annotations.py
Try to evaluate forward refs after model created (#2588)
2021-12-05 14:20:48 +00:00
postponed_annotations_self_referencing_string.py
Try to evaluate forward refs after model created (#2588)
2021-12-05 14:20:48 +00:00
postponed_annotations_works.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
private_attributes_underscore_attrs_are_private.py
Add private attributes support (#1679)
2020-10-26 09:47:40 +00:00
private_attributes.py
Add private attributes support (#1679)
2020-10-26 09:47:40 +00:00
schema_ad_hoc.py
Support discriminated union (#2336)
2021-12-18 16:31:35 +00:00
schema_annotated.py
fix coverage and make typing-extensions a required dependency (#2368)
2021-02-17 19:17:30 +00:00
schema_custom.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
schema_extra_callable.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
schema_main.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
schema_top_level.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
schema_unenforced_constraints.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
schema_with_example.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
settings_add_custom_source.py
feat: Add the ability to add extra settings sources (#2107)
2021-02-11 16:55:40 +00:00
settings_case_sensitive.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
settings_disable_source.py
feat: Add the ability to add extra settings sources (#2107)
2021-02-11 16:55:40 +00:00
settings_env_priority.py
feat: Add the ability to add extra settings sources (#2107)
2021-02-11 16:55:40 +00:00
settings_main.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_arbitrary_allowed.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_bare_type.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_boolean.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_bytesize.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_callable.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_choices.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_color.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_constrained.py
Feature/add anystr lower to config (#2183)
2021-02-12 12:28:08 +00:00
types_custom_type.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_dt.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_generics.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_infinite_generator_validate_first.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_infinite_generator.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_iterables.py
Adding deque to valid field types (#1935)
2020-10-25 17:52:34 +00:00
types_json_type.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_literal1.py
linting as a separate CI step (#2030)
2020-10-25 15:03:33 +00:00
types_literal2.py
linting as a separate CI step (#2030)
2020-10-25 15:03:33 +00:00
types_literal3.py
linting as a separate CI step (#2030)
2020-10-25 15:03:33 +00:00
types_payment_card_number.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_secret_types.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_strict.py
Added StrictBytes type (#2136)
2020-12-01 01:18:35 +01:00
types_type.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_typevar.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_union_correct.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_union_discriminated_nested.py
Support discriminated union (#2336)
2021-12-18 16:31:35 +00:00
types_union_discriminated.py
Support discriminated union (#2336)
2021-12-18 16:31:35 +00:00
types_union_incorrect.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_url_properties.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_url_punycode.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
types_urls.py
Add rediss (Redis over SSL) protocol to RedisDsn (#1911)
2020-12-30 18:20:51 +00:00
validation_decorator_async.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
validation_decorator_config.py
Valdiate arguments config (#1663)
2020-09-06 23:17:52 +01:00
validation_decorator_field.py
Support Field(default_factory) in validate_arguments (#2176)
2021-02-23 12:07:11 +00:00
validation_decorator_main.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
validation_decorator_parameter_types.py
fix(decorator): detect when a duplicate argument is passed in (#2250)
2021-02-13 11:06:12 +00:00
validation_decorator_raw_function.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
validation_decorator_types.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
validation_decorator_validate.py
feat: add validate method on function to validate input without calling it (#2128)
2020-12-31 17:45:51 +00:00
validators_allow_reuse.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
validators_always.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
validators_dataclass.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
validators_pre_item.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
validators_root.py
Add linting for docs/examples (#1530)
2020-05-31 14:54:12 +01:00
validators_simple.py
Make assertion match message (#1533)
2020-05-31 14:57:37 +01:00
validators_subclass_each_item.py
Subclass validator each item docs (#1592)
2020-06-27 14:51:18 +01:00