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
|
from __future__ import annotations
import unittest
from collections.abc import Iterator, KeysView
from types import MappingProxyType
from typing import Any
from unittest import mock
from itemadapter.adapter import AdapterInterface, ItemAdapter
class AdapterInterfaceTest(unittest.TestCase):
@mock.patch.multiple(AdapterInterface, __abstractmethods__=set())
def test_interface_class_methods(self):
with self.assertRaises(NotImplementedError):
AdapterInterface.is_item(object())
with self.assertRaises(NotImplementedError):
AdapterInterface.is_item_class(object)
class FakeItemClass:
_fields = {
"name": {"serializer": str},
"value": {"serializer": int},
}
def __init__(self, **kwargs) -> None:
self._values = {**kwargs}
class BaseFakeItemAdapter(AdapterInterface):
"""An adapter that only implements the required methods."""
@classmethod
def is_item_class(cls, item_class: type) -> bool:
return issubclass(item_class, FakeItemClass)
def __getitem__(self, field_name: str) -> Any:
if field_name in self.item._fields:
return self.item._values[field_name]
raise KeyError(field_name)
def __setitem__(self, field_name: str, value: Any) -> None:
if field_name in self.item._fields:
self.item._values[field_name] = value
else:
raise KeyError(field_name)
def __delitem__(self, field_name: str) -> None:
if field_name in self.item._fields and field_name in self.item._values:
del self.item._values[field_name]
else:
raise KeyError(field_name)
def __iter__(self) -> Iterator:
return iter(self.item._values)
def __len__(self) -> int:
return len(self.item._values)
class FieldNamesFakeItemAdapter(BaseFakeItemAdapter):
"""An adapter that also implements the field_names method."""
def field_names(self) -> KeysView:
return KeysView({key.upper(): value for key, value in self.item._fields.items()})
class MetadataFakeItemAdapter(BaseFakeItemAdapter):
"""An adapter that also implements metadata-related methods."""
@classmethod
def get_field_meta_from_class(cls, item_class: type, field_name: str) -> MappingProxyType:
return MappingProxyType(item_class._fields.get(field_name) or {})
class BaseFakeItemAdapterTest(unittest.TestCase):
item_class = FakeItemClass
adapter_class = BaseFakeItemAdapter
def setUp(self):
ItemAdapter.ADAPTER_CLASSES.appendleft(self.adapter_class)
def tearDown(self):
ItemAdapter.ADAPTER_CLASSES.popleft()
def test_repr(self):
item = self.item_class()
adapter = ItemAdapter(item)
self.assertEqual(repr(adapter), "<ItemAdapter for FakeItemClass()>")
adapter["name"] = "asdf"
adapter["value"] = 1234
self.assertEqual(repr(adapter), "<ItemAdapter for FakeItemClass(name='asdf', value=1234)>")
def test_get_set_value(self):
item = self.item_class()
adapter = ItemAdapter(item)
self.assertEqual(adapter.get("name"), None)
self.assertEqual(adapter.get("value"), None)
adapter["name"] = "asdf"
adapter["value"] = 1234
self.assertEqual(adapter.get("name"), "asdf")
self.assertEqual(adapter.get("value"), 1234)
self.assertEqual(adapter["name"], "asdf")
self.assertEqual(adapter["value"], 1234)
def test_get_set_value_init(self):
item = self.item_class(name="asdf", value=1234)
adapter = ItemAdapter(item)
self.assertEqual(adapter.get("name"), "asdf")
self.assertEqual(adapter.get("value"), 1234)
self.assertEqual(adapter["name"], "asdf")
self.assertEqual(adapter["value"], 1234)
def test_get_value_keyerror(self):
item = self.item_class()
adapter = ItemAdapter(item)
with self.assertRaises(KeyError):
adapter["_undefined_"]
def test_as_dict(self):
item = self.item_class(name="asdf", value=1234)
adapter = ItemAdapter(item)
self.assertEqual({"name": "asdf", "value": 1234}, dict(adapter))
def test_set_value_keyerror(self):
item = self.item_class()
adapter = ItemAdapter(item)
with self.assertRaises(KeyError):
adapter["_undefined_"] = "some value"
def test_delitem_len_iter(self):
item = self.item_class(name="asdf", value=1234)
adapter = ItemAdapter(item)
self.assertEqual(len(adapter), 2)
self.assertEqual(sorted(iter(adapter)), ["name", "value"])
del adapter["name"]
self.assertEqual(len(adapter), 1)
self.assertEqual(sorted(iter(adapter)), ["value"])
del adapter["value"]
self.assertEqual(len(adapter), 0)
self.assertEqual(sorted(iter(adapter)), [])
with self.assertRaises(KeyError):
del adapter["name"]
with self.assertRaises(KeyError):
del adapter["value"]
with self.assertRaises(KeyError):
del adapter["_undefined_"]
def test_get_value_keyerror_item_dict(self):
"""Instantiate without default values."""
adapter = ItemAdapter(self.item_class())
with self.assertRaises(KeyError):
adapter["name"]
def test_get_field_meta(self):
"""Metadata is always empty for the default implementation."""
adapter = ItemAdapter(self.item_class())
self.assertEqual(adapter.get_field_meta("_undefined_"), MappingProxyType({}))
self.assertEqual(adapter.get_field_meta("name"), MappingProxyType({}))
self.assertEqual(adapter.get_field_meta("value"), MappingProxyType({}))
def test_get_field_meta_from_class(self):
"""Metadata is always empty for the default implementation."""
self.assertEqual(
ItemAdapter.get_field_meta_from_class(self.item_class, "_undefined_"),
MappingProxyType({}),
)
self.assertEqual(
ItemAdapter.get_field_meta_from_class(self.item_class, "name"),
MappingProxyType({}),
)
self.assertEqual(
ItemAdapter.get_field_meta_from_class(self.item_class, "value"),
MappingProxyType({}),
)
def test_field_names(self):
item = self.item_class(name="asdf", value=1234)
adapter = ItemAdapter(item)
self.assertIsInstance(adapter.field_names(), KeysView)
self.assertEqual(sorted(adapter.field_names()), ["name", "value"])
class MetadataFakeItemAdapterTest(BaseFakeItemAdapterTest):
item_class = FakeItemClass
adapter_class = MetadataFakeItemAdapter
def test_get_field_meta(self):
adapter = ItemAdapter(self.item_class())
self.assertEqual(adapter.get_field_meta("_undefined_"), MappingProxyType({}))
self.assertEqual(adapter.get_field_meta("name"), MappingProxyType({"serializer": str}))
self.assertEqual(adapter.get_field_meta("value"), MappingProxyType({"serializer": int}))
def test_get_field_meta_from_class(self):
self.assertEqual(
ItemAdapter.get_field_meta_from_class(self.item_class, "_undefined_"),
MappingProxyType({}),
)
self.assertEqual(
ItemAdapter.get_field_meta_from_class(self.item_class, "name"),
MappingProxyType({"serializer": str}),
)
self.assertEqual(
ItemAdapter.get_field_meta_from_class(self.item_class, "value"),
MappingProxyType({"serializer": int}),
)
class FieldNamesFakeItemAdapterTest(BaseFakeItemAdapterTest):
item_class = FakeItemClass
adapter_class = FieldNamesFakeItemAdapter
def test_field_names(self):
item = self.item_class(name="asdf", value=1234)
adapter = ItemAdapter(item)
self.assertIsInstance(adapter.field_names(), KeysView)
self.assertEqual(sorted(adapter.field_names()), ["NAME", "VALUE"])
|
