mirror of
https://github.com/kennethreitz/pydantic.git
synced 2026-06-05 23:00:18 +00:00
Koudai Aono
e4b285a0cd
* support custom root types * update HISTORY.rst for costom root types * fix invalid arguments case * remove the keyword argument of "__root__" in __init__ add a keyword argument of "__root__" in parse_obj fix documents create a method for cheking valid field name * fix parse_obj * Update docs/index.rst Co-Authored-By: Samuel Colvin <samcolvin@gmail.com> * Apply suggestions from code review Co-Authored-By: Samuel Colvin <samcolvin@gmail.com> * add type cheking for custom root type * Update docs/index.rst Co-Authored-By: Samuel Colvin <samcolvin@gmail.com> * Update index.rst
135 lines
3.6 KiB
Python
135 lines
3.6 KiB
Python
import pickle
|
|
from typing import List, Union
|
|
|
|
import pytest
|
|
|
|
from pydantic import BaseModel, Protocol, Schema, ValidationError
|
|
|
|
|
|
class Model(BaseModel):
|
|
a: float
|
|
b: int = 10
|
|
|
|
|
|
def test_obj():
|
|
m = Model.parse_obj(dict(a=10.2))
|
|
assert str(m) == 'Model a=10.2 b=10'
|
|
|
|
|
|
def test_parse_obj_fails():
|
|
with pytest.raises(ValidationError) as exc_info:
|
|
Model.parse_obj([1, 2, 3])
|
|
assert exc_info.value.errors() == [
|
|
{'loc': ('__obj__',), 'msg': 'Model expected dict not list', 'type': 'type_error'}
|
|
]
|
|
|
|
|
|
def test_parse_obj_submodel():
|
|
m = Model.parse_obj(Model(a=10.2))
|
|
assert m.dict() == {'a': 10.2, 'b': 10}
|
|
|
|
|
|
def test_parse_obj_wrong_model():
|
|
class Foo(BaseModel):
|
|
c = 123
|
|
|
|
with pytest.raises(ValidationError) as exc_info:
|
|
Model.parse_obj(Foo())
|
|
assert exc_info.value.errors() == [{'loc': ('a',), 'msg': 'field required', 'type': 'value_error.missing'}]
|
|
|
|
|
|
def test_parse_obj_root():
|
|
class MyModel(BaseModel):
|
|
__root__: str
|
|
|
|
m = MyModel.parse_obj('a')
|
|
assert m.dict() == {'__root__': 'a'}
|
|
assert m.__root__ == 'a'
|
|
|
|
|
|
def test_parse_root_list():
|
|
class MyModel(BaseModel):
|
|
__root__: List[str]
|
|
|
|
m = MyModel.parse_obj(['a'])
|
|
assert m.dict() == {'__root__': ['a']}
|
|
assert m.__root__ == ['a']
|
|
|
|
|
|
def test_json():
|
|
assert Model.parse_raw('{"a": 12, "b": 8}') == Model(a=12, b=8)
|
|
|
|
|
|
def test_json_ct():
|
|
assert Model.parse_raw('{"a": 12, "b": 8}', content_type='application/json') == Model(a=12, b=8)
|
|
|
|
|
|
def test_pickle_ct():
|
|
data = pickle.dumps(dict(a=12, b=8))
|
|
assert Model.parse_raw(data, content_type='application/pickle', allow_pickle=True) == Model(a=12, b=8)
|
|
|
|
|
|
def test_pickle_proto():
|
|
data = pickle.dumps(dict(a=12, b=8))
|
|
assert Model.parse_raw(data, proto=Protocol.pickle, allow_pickle=True) == Model(a=12, b=8)
|
|
|
|
|
|
def test_pickle_not_allowed():
|
|
data = pickle.dumps(dict(a=12, b=8))
|
|
with pytest.raises(RuntimeError):
|
|
Model.parse_raw(data, proto=Protocol.pickle)
|
|
|
|
|
|
def test_bad_ct():
|
|
with pytest.raises(ValidationError) as exc_info:
|
|
Model.parse_raw('{"a": 12, "b": 8}', content_type='application/missing')
|
|
assert exc_info.value.errors() == [
|
|
{'loc': ('__obj__',), 'msg': 'Unknown content-type: application/missing', 'type': 'type_error'}
|
|
]
|
|
|
|
|
|
def test_bad_proto():
|
|
with pytest.raises(ValidationError) as exc_info:
|
|
Model.parse_raw('{"a": 12, "b": 8}', proto='foobar')
|
|
assert exc_info.value.errors() == [{'loc': ('__obj__',), 'msg': 'Unknown protocol: foobar', 'type': 'type_error'}]
|
|
|
|
|
|
def test_file_json(tmpdir):
|
|
p = tmpdir.join('test.json')
|
|
p.write('{"a": 12, "b": 8}')
|
|
assert Model.parse_file(str(p)) == Model(a=12, b=8)
|
|
|
|
|
|
def test_file_json_no_ext(tmpdir):
|
|
p = tmpdir.join('test')
|
|
p.write('{"a": 12, "b": 8}')
|
|
assert Model.parse_file(str(p)) == Model(a=12, b=8)
|
|
|
|
|
|
def test_file_pickle(tmpdir):
|
|
p = tmpdir.join('test.pkl')
|
|
p.write_binary(pickle.dumps(dict(a=12, b=8)))
|
|
assert Model.parse_file(str(p), allow_pickle=True) == Model(a=12, b=8)
|
|
|
|
|
|
def test_file_pickle_no_ext(tmpdir):
|
|
p = tmpdir.join('test')
|
|
p.write_binary(pickle.dumps(dict(a=12, b=8)))
|
|
assert Model.parse_file(str(p), content_type='application/pickle', allow_pickle=True) == Model(a=12, b=8)
|
|
|
|
|
|
def test_const_differentiates_union():
|
|
class SubModelA(BaseModel):
|
|
key: str = Schema('A', const=True)
|
|
foo: int
|
|
|
|
class SubModelB(BaseModel):
|
|
key: str = Schema('B', const=True)
|
|
foo: int
|
|
|
|
class Model(BaseModel):
|
|
a: Union[SubModelA, SubModelB]
|
|
|
|
m = Model.parse_obj({'a': {'key': 'B', 'foo': 3}})
|
|
assert isinstance(m.a, SubModelB)
|