File: test_marshal_types_struct.py

package info (click to toggle)
python-proto-plus 1.26.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 816 kB
  • sloc: python: 4,649; makefile: 27
file content (268 lines) | stat: -rw-r--r-- 7,345 bytes parent folder | download
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
# Copyright 2018 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import pytest

from google.protobuf import struct_pb2

import proto


def test_value_primitives_read():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.Value, number=1)

    assert Foo(value=3).value == 3.0
    assert Foo(value="3").value == "3"
    assert Foo(value=None).value is None
    assert Foo(value=False).value is False
    assert Foo(value=True).value is True


def test_value_absent():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.Value, number=1)

    assert Foo().value is None


def test_value_primitives_rmw():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.Value, number=1)

    foo = Foo()
    foo.value = 3
    assert isinstance(foo.value, float)
    assert abs(Foo.pb(foo).value.number_value - 3.0) < 1e-7
    foo.value = False
    assert not foo.value
    assert foo.value is False
    assert Foo.pb(foo).value.WhichOneof("kind") == "bool_value"
    foo.value = None
    assert not foo.value
    assert foo.value is None
    assert Foo.pb(foo).value.WhichOneof("kind") == "null_value"


def test_value_write_pb():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.Value, number=1)

    foo = Foo(value=struct_pb2.Value(string_value="stringy"))
    assert foo.value == "stringy"


def test_value_lists_read():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.Value, number=1)

    foo = Foo(value=["3", None, "foo", True])
    assert foo.value == ["3", None, "foo", True]


def test_value_lists_null():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.ListValue, number=1)

    foo = Foo()
    assert foo.value is None


def test_value_struct_null():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.Struct, number=1)

    foo = Foo()
    assert foo.value is None


def test_value_lists_rmw():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.Value, number=1)

    foo = Foo(value=["3", None, "foo", True])
    foo.value.append("bar")
    foo.value.pop(1)
    assert foo.value == ["3", "foo", True, "bar"]


def test_value_lists_nested():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.Value, number=1)

    foo = Foo(value=[[True, False], [True, False]])
    foo.value.append([False, True])
    assert foo.value == [[True, False], [True, False], [False, True]]


def test_value_lists_struct():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.Value, number=1)

    foo = Foo(value=[{"foo": "bar", "spam": "eggs"}])
    assert foo.value == [{"foo": "bar", "spam": "eggs"}]


def test_value_lists_detachment():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.Value, number=1)

    foo = Foo(value=["foo", "bar"])
    detached_list = foo.value
    detached_list.append("baz")
    assert foo.value == ["foo", "bar", "baz"]


def test_value_structs_read():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.Value, number=1)

    foo = Foo(value={"foo": True, "bar": False})
    assert foo.value == {"foo": True, "bar": False}


def test_value_structs_rmw():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.Value, number=1)

    foo = Foo(value={"foo": True, "bar": False})
    foo.value["baz"] = "a string"
    assert foo.value == {"foo": True, "bar": False, "baz": "a string"}


def test_value_structs_nested():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.Value, number=1)

    foo = Foo(value={"foo": True, "bar": {"spam": "eggs"}})
    assert foo.value == {"foo": True, "bar": {"spam": "eggs"}}
    sv = Foo.pb(foo).value.struct_value
    assert sv["foo"] is True
    assert sv["bar"].fields["spam"].string_value == "eggs"


def test_value_invalid_value():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.Value, number=1)

    with pytest.raises(ValueError):
        Foo(value=object())


def test_value_unset():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.Value, number=1)

    foo = Foo()
    assert "value" not in foo


def test_list_value_read():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.ListValue, number=1)

    foo = Foo(value=["foo", "bar", True, {"spam": "eggs"}])
    assert foo.value == ["foo", "bar", True, {"spam": "eggs"}]


def test_list_value_pb():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.ListValue, number=1)

    foo = Foo(
        value=struct_pb2.ListValue(
            values=[
                struct_pb2.Value(string_value="foo"),
                struct_pb2.Value(string_value="bar"),
                struct_pb2.Value(bool_value=True),
            ]
        )
    )
    assert foo.value == ["foo", "bar", True]


def test_list_value_reassignment():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.ListValue, number=1)

    foo = Foo(value=["foo", "bar"])
    detached = foo.value
    detached.append(True)
    foo.value = detached
    assert foo.value == ["foo", "bar", True]


def test_list_value_invalid():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.ListValue, number=1)

    with pytest.raises(TypeError):
        Foo(value=3)


def test_struct_read():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.Struct, number=1)

    foo = Foo(value={"foo": "bar", "bacon": True})
    assert foo.value == {"foo": "bar", "bacon": True}


def test_struct_pb():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.Struct, number=1)

    foo = Foo(
        value=struct_pb2.Struct(
            fields={
                "foo": struct_pb2.Value(string_value="bar"),
                "bacon": struct_pb2.Value(bool_value=True),
            }
        )
    )
    assert foo.value == {"foo": "bar", "bacon": True}


def test_struct_reassignment():
    class Foo(proto.Message):
        value = proto.Field(struct_pb2.Struct, number=1)

    foo = Foo(value={"foo": "bar"})
    detached = foo.value
    detached["bacon"] = True
    foo.value = detached
    assert foo.value == {"foo": "bar", "bacon": True}


def test_struct_nested():
    class Foo(proto.Message):
        struct_field: struct_pb2.Struct = proto.Field(
            proto.MESSAGE,
            number=1,
            message=struct_pb2.Struct,
        )

    class Bar(proto.Message):
        foo_field: Foo = proto.Field(
            proto.MESSAGE,
            number=1,
            message=Foo,
        )

    foo = Foo({"struct_field": {"foo": "bagel"}})
    assert foo.struct_field == {"foo": "bagel"}

    bar = Bar({"foo_field": {"struct_field": {"foo": "cheese"}}})
    assert bar.foo_field == Foo({"struct_field": {"foo": "cheese"}})
    assert bar.foo_field.struct_field == {"foo": "cheese"}