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
|
import json
from os.path import abspath
import pydantic
import pydantic_core
import pytest
from fsspec.implementations.http import get_client
from upath import UPath
from upath.implementations.local import FilePath
from upath.implementations.local import PosixUPath
from upath.implementations.local import WindowsUPath
from .utils import only_on_windows
from .utils import skip_on_windows
@pytest.mark.parametrize(
"path",
[
"/abc",
"file:///abc",
"memory://abc",
"s3://bucket/key",
"https://www.example.com",
],
)
@pytest.mark.parametrize("source", ["json", "python"])
def test_validate_from_str(path, source):
expected = UPath(path)
ta = pydantic.TypeAdapter(UPath)
if source == "json":
actual = ta.validate_json(json.dumps(path))
else: # source == "python"
actual = ta.validate_python(path)
assert abspath(actual.path) == abspath(expected.path)
assert actual.protocol == expected.protocol
@pytest.mark.parametrize(
"dct",
[
{
"path": "/my/path",
"protocol": "file",
"storage_options": {"foo": "bar", "baz": 3},
}
],
)
@pytest.mark.parametrize("source", ["json", "python"])
def test_validate_from_dict(dct, source):
ta = pydantic.TypeAdapter(UPath)
if source == "json":
output = ta.validate_json(json.dumps(dct))
else: # source == "python"
output = ta.validate_python(dct)
assert abspath(output.path) == abspath(dct["path"])
assert output.protocol == dct["protocol"]
assert output.storage_options == dct["storage_options"]
@pytest.mark.parametrize(
"path",
[
"/abc",
"file:///abc",
"memory://abc",
"s3://bucket/key",
"https://www.example.com",
],
)
def test_validate_from_instance(path):
input = UPath(path)
output = pydantic.TypeAdapter(UPath).validate_python(input)
assert output is input
@pytest.mark.parametrize(
("args", "kwargs"),
[
(
("/my/path",),
{
"protocol": "file",
"foo": "bar",
"baz": 3,
},
)
],
)
@pytest.mark.parametrize("mode", ["json", "python"])
def test_dump(args, kwargs, mode):
u = UPath(*args, **kwargs)
output = pydantic.TypeAdapter(UPath).dump_python(u, mode=mode)
assert output["path"] == u.path
assert output["protocol"] == u.protocol
assert output["storage_options"] == u.storage_options
def test_dump_non_serializable_python():
output = pydantic.TypeAdapter(UPath).dump_python(
UPath("https://www.example.com", get_client=get_client), mode="python"
)
assert output["storage_options"]["get_client"] is get_client
def test_dump_non_serializable_json():
with pytest.raises(pydantic_core.PydanticSerializationError, match="unknown type"):
pydantic.TypeAdapter(UPath).dump_python(
UPath("https://www.example.com", get_client=get_client), mode="json"
)
def test_proxyupath_serialization():
from upath.extensions import ProxyUPath
u = ProxyUPath("memory://my/path", some_option=True)
ta = pydantic.TypeAdapter(ProxyUPath)
dumped = ta.dump_python(u, mode="python")
loaded = ta.validate_python(dumped)
assert isinstance(loaded, ProxyUPath)
assert loaded.path == u.path
assert loaded.protocol == u.protocol
assert loaded.storage_options == u.storage_options
@pytest.mark.parametrize(
"path,cls",
[
pytest.param("/my/path", PosixUPath, marks=skip_on_windows(None)),
pytest.param("C:\\my\\path", WindowsUPath, marks=only_on_windows(None)),
("file:///my/path", FilePath),
],
)
def test_localpath_serialization(path, cls):
u = UPath(path)
assert type(u) is cls
ta = pydantic.TypeAdapter(cls)
dumped = ta.dump_python(u, mode="python")
loaded = ta.validate_python(dumped)
assert isinstance(loaded, cls)
assert loaded.path == u.path
assert loaded.protocol == u.protocol
assert loaded.storage_options == u.storage_options
def test_json_schema():
ta = pydantic.TypeAdapter(UPath)
ta.json_schema()
|