File: __init__.py

package info (click to toggle)
python-itemadapter 0.12.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 304 kB
  • sloc: python: 3,381; makefile: 4
file content (390 lines) | stat: -rw-r--r-- 11,055 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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
from __future__ import annotations

import importlib
import sys
from contextlib import contextmanager
from dataclasses import dataclass, field
from enum import Enum
from typing import TYPE_CHECKING, Any, Callable, Optional, Union

from itemadapter import ItemAdapter
from itemadapter._imports import pydantic, pydantic_v1

if TYPE_CHECKING:
    from collections.abc import Generator


def make_mock_import(block_name: str) -> Callable:
    def mock_import(name: str, *args, **kwargs):
        """Prevent importing a specific module, let everything else pass."""
        if name.split(".")[0] == block_name:
            raise ImportError(name)
        return importlib.__import__(name, *args, **kwargs)

    return mock_import


@contextmanager
def clear_itemadapter_imports() -> Generator[None]:
    backup = {}
    for key in sys.modules.copy():
        if key.startswith("itemadapter"):
            backup[key] = sys.modules.pop(key)
    try:
        yield
    finally:
        sys.modules.update(backup)


class Color(Enum):
    RED = "red"
    GREEN = "green"
    BLUE = "blue"


class SetList(list):
    """List that compares as a set to other lists.

    Used for test expectations, for lists with a expected content but where
    order is not guaranteed.
    """

    def __eq__(self, other):
        return set(self) == set(other)

    def __hash__(self):
        return hash(frozenset(self))


@dataclass
class DataClassItem:
    name: str = field(default_factory=lambda: None, metadata={"serializer": str})
    value: int = field(default_factory=lambda: None, metadata={"serializer": int})


@dataclass
class DataClassItemNested:
    nested: DataClassItem
    adapter: ItemAdapter
    dict_: dict
    list_: list
    set_: set
    tuple_: tuple
    int_: int


@dataclass(init=False)
class DataClassWithoutInit:
    name: str = field(metadata={"serializer": str})
    value: int = field(metadata={"serializer": int})


@dataclass
class DataClassItemSubclassed(DataClassItem):
    subclassed: bool = True


@dataclass
class DataClassItemEmpty:
    pass


@dataclass
class DataClassItemJsonSchemaNested:
    is_nested: bool = True


@dataclass
class DataClassItemJsonSchema:
    __json_schema_extra__ = {
        "llmHint": "Hi model!",
    }
    name: str = field(metadata={"json_schema_extra": {"title": "Name"}})
    """Display name"""
    color: Color
    answer: Union[str, float, int, None]
    numbers: list[float]
    aliases: dict[str, str]
    nested: DataClassItemJsonSchemaNested
    nested_list: list[DataClassItemJsonSchemaNested]
    nested_dict: dict[str, DataClassItemJsonSchemaNested]
    nested_dict_list: list[dict[str, DataClassItemJsonSchemaNested]]
    value: Any = None
    produced: bool = field(default_factory=lambda: True)


try:
    import attr
except ImportError:
    AttrsItem = None
    AttrsItemNested = None
    AttrsItemWithoutInit = None
    AttrsItemSubclassed = None
    AttrsItemEmpty = None
    AttrsItemJsonSchema = None
    AttrsItemJsonSchemaNested = None
else:

    @attr.s
    class AttrsItem:
        name = attr.ib(default=None, metadata={"serializer": str})
        value = attr.ib(default=None, metadata={"serializer": int})

    @attr.s
    class AttrsItemNested:
        nested = attr.ib(type=AttrsItem)
        adapter = attr.ib(type=ItemAdapter)
        dict_ = attr.ib(type=dict)
        list_ = attr.ib(type=list)
        set_ = attr.ib(type=set)
        tuple_ = attr.ib(type=tuple)
        int_ = attr.ib(type=int)

    @attr.s(init=False)
    class AttrsItemWithoutInit:
        name = attr.ib(default=None, metadata={"serializer": str})
        value = attr.ib(default=None, metadata={"serializer": int})

    @attr.s(init=False)
    class AttrsItemSubclassed(AttrsItem):
        subclassed = attr.ib(default=True, type=bool)

    @attr.s
    class AttrsItemEmpty:
        pass

    @attr.s
    class AttrsItemJsonSchemaNested:
        is_nested: bool = attr.ib(default=True)

    @attr.s
    class AttrsItemJsonSchema:
        __json_schema_extra__ = {
            "llmHint": "Hi model!",
        }
        name: str = attr.ib(metadata={"json_schema_extra": {"title": "Name"}})
        """Display name"""
        color: Color = attr.ib()
        answer: Union[str, float, int, None] = attr.ib()
        numbers: list[float] = attr.ib()
        aliases: dict[str, str] = attr.ib()
        nested: AttrsItemJsonSchemaNested = attr.ib()
        nested_list: list[AttrsItemJsonSchemaNested] = attr.ib()
        nested_dict: dict[str, AttrsItemJsonSchemaNested] = attr.ib()
        nested_dict_list: list[dict[str, AttrsItemJsonSchemaNested]] = attr.ib()
        value: Any = attr.ib(default=None)
        produced: bool = attr.ib(factory=lambda: True)


if pydantic_v1 is None:
    PydanticV1Model = None
    PydanticV1SpecialCasesModel = None
    PydanticV1ModelNested = None
    PydanticV1ModelSubclassed = None
    PydanticV1ModelEmpty = None
    PydanticV1ModelJsonSchema = None
    PydanticV1ModelJsonSchemaNested = None
else:

    class PydanticV1Model(pydantic_v1.BaseModel):
        name: Optional[str] = pydantic_v1.Field(
            default_factory=lambda: None,
            serializer=str,
        )
        value: Optional[int] = pydantic_v1.Field(
            default_factory=lambda: None,
            serializer=int,
        )

    class PydanticV1SpecialCasesModel(pydantic_v1.BaseModel):
        special_cases: Optional[int] = pydantic_v1.Field(
            default_factory=lambda: None,
            alias="special_cases",
            allow_mutation=False,
        )

        class Config:
            validate_assignment = True

    class PydanticV1ModelNested(pydantic_v1.BaseModel):
        nested: PydanticV1Model
        adapter: ItemAdapter
        dict_: dict
        list_: list
        set_: set
        tuple_: tuple
        int_: int

        class Config:
            arbitrary_types_allowed = True

    class PydanticV1ModelSubclassed(PydanticV1Model):
        subclassed: bool = pydantic_v1.Field(
            default_factory=lambda: True,
        )

    class PydanticV1ModelEmpty(pydantic_v1.BaseModel):
        pass

    class PydanticV1ModelJsonSchemaNested(pydantic_v1.BaseModel):
        is_nested: bool = True

    class PydanticV1ModelJsonSchema(pydantic_v1.BaseModel):
        name: str = pydantic_v1.Field(description="Display name", title="Name")
        value: Any = None
        color: Color
        produced: bool
        answer: Union[str, float, int, None]
        numbers: list[float]
        aliases: dict[str, str]
        nested: PydanticV1ModelJsonSchemaNested
        nested_list: list[PydanticV1ModelJsonSchemaNested]
        nested_dict: dict[str, PydanticV1ModelJsonSchemaNested]
        nested_dict_list: list[dict[str, PydanticV1ModelJsonSchemaNested]]

        class Config:
            schema_extra = {
                "llmHint": "Hi model!",
            }


if pydantic is None:
    PydanticModel = None
    PydanticSpecialCasesModel = None
    PydanticModelNested = None
    PydanticModelSubclassed = None
    PydanticModelEmpty = None
    PydanticModelJsonSchema = None
    PydanticModelJsonSchemaNested = None
else:

    class PydanticModel(pydantic.BaseModel):
        name: Optional[str] = pydantic.Field(
            default_factory=lambda: None,
            json_schema_extra={"serializer": str},
        )
        value: Optional[int] = pydantic.Field(
            default_factory=lambda: None,
            json_schema_extra={"serializer": int},
        )

    class PydanticSpecialCasesModel(pydantic.BaseModel):
        special_cases: Optional[int] = pydantic.Field(
            default_factory=lambda: None,
            alias="special_cases",
            frozen=True,
        )

        model_config = {
            "validate_assignment": True,
        }

    class PydanticModelNested(pydantic.BaseModel):
        nested: PydanticModel
        adapter: ItemAdapter
        dict_: dict
        list_: list
        set_: set
        tuple_: tuple
        int_: int

        model_config = {
            "arbitrary_types_allowed": True,
        }

    class PydanticModelSubclassed(PydanticModel):
        subclassed: bool = pydantic.Field(
            default_factory=lambda: True,
        )

    class PydanticModelEmpty(pydantic.BaseModel):
        pass

    class PydanticModelJsonSchemaNested(pydantic.BaseModel):
        is_nested: bool = True

    class PydanticModelJsonSchema(pydantic.BaseModel):
        name: str = pydantic.Field(description="Display name", title="Name")
        value: Any = None
        color: Color
        produced: bool = pydantic.Field(default_factory=lambda: True)
        answer: Union[str, float, int, None]
        numbers: list[float]
        aliases: dict[str, str]
        nested: PydanticModelJsonSchemaNested
        nested_list: list[PydanticModelJsonSchemaNested]
        nested_dict: dict[str, PydanticModelJsonSchemaNested]
        nested_dict_list: list[dict[str, PydanticModelJsonSchemaNested]]

        model_config = {
            "json_schema_extra": {
                "llmHint": "Hi model!",
            },
        }


try:
    from scrapy.item import Field
    from scrapy.item import Item as ScrapyItem
except ImportError:
    ScrapyItem = None
    ScrapySubclassedItem = None
    ScrapySubclassedItemNested = None
    ScrapySubclassedItemSubclassed = None
    ScrapySubclassedItemEmpty = None
    ScrapySubclassedItemJsonSchema = None
    ScrapySubclassedItemJsonSchemaNested = None
else:

    class ScrapySubclassedItem(ScrapyItem):
        name = Field(serializer=str)
        value = Field(serializer=int)

    class ScrapySubclassedItemNested(ScrapyItem):
        nested = Field()
        adapter = Field()
        dict_ = Field()
        list_ = Field()
        set_ = Field()
        tuple_ = Field()
        int_ = Field()

    class ScrapySubclassedItemSubclassed(ScrapySubclassedItem):
        subclassed = Field()

    class ScrapySubclassedItemEmpty(ScrapyItem):
        pass

    class ScrapySubclassedItemJsonSchemaNested(ScrapyItem):
        is_nested: bool = Field(
            json_schema_extra={
                "default": True,
            },
        )

    class ScrapySubclassedItemJsonSchema(ScrapyItem):
        __json_schema_extra__ = {
            "llmHint": "Hi model!",
        }

        name: str = Field(
            json_schema_extra={
                "title": "Name",
            },
        )
        """Display name"""

        value = Field(
            json_schema_extra={
                "default": None,
            },
        )
        color: Color = Field()
        produced = Field()
        answer: Union[str, float, int, None] = Field()
        numbers: list[float] = Field()
        aliases: dict[str, str] = Field()
        nested: ScrapySubclassedItemJsonSchemaNested = Field()
        nested_list: list[ScrapySubclassedItemJsonSchemaNested] = Field()
        nested_dict: dict[str, ScrapySubclassedItemJsonSchemaNested] = Field()
        nested_dict_list: list[dict[str, ScrapySubclassedItemJsonSchemaNested]] = Field()