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 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
|
from __future__ import annotations
import dataclasses
from abc import ABCMeta, abstractmethod
from collections import deque
from collections.abc import Iterable, Iterator, KeysView, MutableMapping
from types import MappingProxyType
from typing import Any
from itemadapter._imports import _scrapy_item_classes, attr
from itemadapter._json_schema import (
_json_schema_from_attrs,
_json_schema_from_dataclass,
_json_schema_from_item_class,
_json_schema_from_pydantic,
_JsonSchemaState,
_setdefault_attribute_docstrings_on_json_schema,
_setdefault_attribute_types_on_json_schema,
)
from itemadapter.utils import (
_get_pydantic_model_metadata,
_get_pydantic_v1_model_metadata,
_is_attrs_class,
_is_pydantic_model,
_is_pydantic_v1_model,
)
__all__ = [
"AdapterInterface",
"AttrsAdapter",
"DataclassAdapter",
"DictAdapter",
"ItemAdapter",
"PydanticAdapter",
"ScrapyItemAdapter",
]
class AdapterInterface(MutableMapping, metaclass=ABCMeta):
"""Abstract Base Class for adapters.
An adapter that handles a specific type of item should inherit from this
class and implement the abstract methods defined here, plus the
abtract methods inherited from the MutableMapping base class.
"""
def __init__(self, item: Any) -> None:
self.item = item
@classmethod
@abstractmethod
def is_item_class(cls, item_class: type) -> bool:
"""Return True if the adapter can handle the given item class, False otherwise."""
raise NotImplementedError
@classmethod
def is_item(cls, item: Any) -> bool:
"""Return True if the adapter can handle the given item, False otherwise."""
return cls.is_item_class(item.__class__)
@classmethod
def get_field_meta_from_class(cls, item_class: type, field_name: str) -> MappingProxyType:
return MappingProxyType({})
@classmethod
def get_field_names_from_class(cls, item_class: type) -> list[str] | None:
"""Return a list of fields defined for ``item_class``.
If a class doesn't support fields, None is returned."""
return None
@classmethod
def get_json_schema(
cls, item_class: type, *, _state: _JsonSchemaState | None = None
) -> dict[str, Any]:
return _json_schema_from_item_class(cls, item_class, _state)
def get_field_meta(self, field_name: str) -> MappingProxyType:
"""Return metadata for the given field name, if available."""
return self.get_field_meta_from_class(self.item.__class__, field_name)
def field_names(self) -> KeysView:
"""Return a dynamic view of the item's field names."""
return self.keys() # type: ignore[return-value]
class _MixinAttrsDataclassAdapter:
_fields_dict: dict
item: Any
def get_field_meta(self, field_name: str) -> MappingProxyType:
return self._fields_dict[field_name].metadata
def field_names(self) -> KeysView:
return KeysView(self._fields_dict)
def __getitem__(self, field_name: str) -> Any:
if field_name in self._fields_dict:
return getattr(self.item, field_name)
raise KeyError(field_name)
def __setitem__(self, field_name: str, value: Any) -> None:
if field_name in self._fields_dict:
setattr(self.item, field_name, value)
else:
raise KeyError(f"{self.item.__class__.__name__} does not support field: {field_name}")
def __delitem__(self, field_name: str) -> None:
if field_name in self._fields_dict:
try:
if hasattr(self.item, field_name):
delattr(self.item, field_name)
else:
raise AttributeError
except AttributeError as ex:
raise KeyError(field_name) from ex
else:
raise KeyError(f"{self.item.__class__.__name__} does not support field: {field_name}")
def __iter__(self) -> Iterator:
return iter(attr for attr in self._fields_dict if hasattr(self.item, attr))
def __len__(self) -> int:
return len(list(iter(self)))
class AttrsAdapter(_MixinAttrsDataclassAdapter, AdapterInterface):
def __init__(self, item: Any) -> None:
super().__init__(item)
if attr is None:
raise RuntimeError("attr module is not available")
# store a reference to the item's fields to avoid O(n) lookups and O(n^2) traversals
self._fields_dict = attr.fields_dict(self.item.__class__)
@classmethod
def is_item(cls, item: Any) -> bool:
return _is_attrs_class(item) and not isinstance(item, type)
@classmethod
def is_item_class(cls, item_class: type) -> bool:
return _is_attrs_class(item_class)
@classmethod
def get_field_meta_from_class(cls, item_class: type, field_name: str) -> MappingProxyType:
if attr is None:
raise RuntimeError("attr module is not available")
try:
return attr.fields_dict(item_class)[field_name].metadata
except KeyError as ex:
raise KeyError(f"{item_class.__name__} does not support field: {field_name}") from ex
@classmethod
def get_field_names_from_class(cls, item_class: type) -> list[str] | None:
if attr is None:
raise RuntimeError("attr module is not available")
return [a.name for a in attr.fields(item_class)]
@classmethod
def get_json_schema(
cls, item_class: type, *, _state: _JsonSchemaState | None = None
) -> dict[str, Any]:
_state = _state or _JsonSchemaState(adapter=cls, containers={item_class})
return _json_schema_from_attrs(item_class, _state)
class DataclassAdapter(_MixinAttrsDataclassAdapter, AdapterInterface):
def __init__(self, item: Any) -> None:
super().__init__(item)
# store a reference to the item's fields to avoid O(n) lookups and O(n^2) traversals
self._fields_dict = {field.name: field for field in dataclasses.fields(self.item)}
@classmethod
def is_item(cls, item: Any) -> bool:
return dataclasses.is_dataclass(item) and not isinstance(item, type)
@classmethod
def is_item_class(cls, item_class: type) -> bool:
return dataclasses.is_dataclass(item_class)
@classmethod
def get_field_meta_from_class(cls, item_class: type, field_name: str) -> MappingProxyType:
for field in dataclasses.fields(item_class):
if field.name == field_name:
return field.metadata
raise KeyError(f"{item_class.__name__} does not support field: {field_name}")
@classmethod
def get_field_names_from_class(cls, item_class: type) -> list[str] | None:
return [a.name for a in dataclasses.fields(item_class)]
@classmethod
def get_json_schema(
cls, item_class: type, *, _state: _JsonSchemaState | None = None
) -> dict[str, Any]:
_state = _state or _JsonSchemaState(adapter=cls, containers={item_class})
return _json_schema_from_dataclass(item_class, _state)
class PydanticAdapter(AdapterInterface):
item: Any
@classmethod
def is_item_class(cls, item_class: type) -> bool:
return _is_pydantic_model(item_class) or _is_pydantic_v1_model(item_class)
@classmethod
def get_field_meta_from_class(cls, item_class: type, field_name: str) -> MappingProxyType:
try:
try:
return _get_pydantic_model_metadata(item_class, field_name)
except AttributeError:
return _get_pydantic_v1_model_metadata(item_class, field_name)
except KeyError as ex:
raise KeyError(f"{item_class.__name__} does not support field: {field_name}") from ex
@classmethod
def get_field_names_from_class(cls, item_class: type) -> list[str] | None:
try:
return list(item_class.model_fields.keys()) # type: ignore[attr-defined]
except AttributeError:
return list(item_class.__fields__.keys()) # type: ignore[attr-defined]
@classmethod
def get_json_schema(
cls, item_class: type, *, _state: _JsonSchemaState | None = None
) -> dict[str, Any]:
return _json_schema_from_pydantic(cls, item_class, _state)
def field_names(self) -> KeysView:
try:
return KeysView(self.item.__class__.model_fields)
except AttributeError:
return KeysView(self.item.__fields__)
def __getitem__(self, field_name: str) -> Any:
try:
self.item.__class__.model_fields # noqa: B018
except AttributeError:
if field_name in self.item.__fields__:
return getattr(self.item, field_name)
else:
if field_name in self.item.__class__.model_fields:
return getattr(self.item, field_name)
raise KeyError(field_name)
def __setitem__(self, field_name: str, value: Any) -> None:
try:
self.item.__class__.model_fields # noqa: B018
except AttributeError:
if field_name in self.item.__fields__:
setattr(self.item, field_name, value)
return
else:
if field_name in self.item.__class__.model_fields:
setattr(self.item, field_name, value)
return
raise KeyError(f"{self.item.__class__.__name__} does not support field: {field_name}")
def __delitem__(self, field_name: str) -> None:
try:
self.item.__class__.model_fields # noqa: B018
except AttributeError as ex:
if field_name in self.item.__fields__:
try:
if hasattr(self.item, field_name):
delattr(self.item, field_name)
return
raise AttributeError from ex
except AttributeError as ex2:
raise KeyError(field_name) from ex2
else:
if field_name in self.item.__class__.model_fields:
try:
if hasattr(self.item, field_name):
delattr(self.item, field_name)
return
raise AttributeError
except AttributeError as ex:
raise KeyError(field_name) from ex
raise KeyError(f"{self.item.__class__.__name__} does not support field: {field_name}")
def __iter__(self) -> Iterator:
try:
return iter(
attr for attr in self.item.__class__.model_fields if hasattr(self.item, attr)
)
except AttributeError:
return iter(attr for attr in self.item.__fields__ if hasattr(self.item, attr))
def __len__(self) -> int:
return len(list(iter(self)))
class _MixinDictScrapyItemAdapter:
_fields_dict: dict
item: Any
def __getitem__(self, field_name: str) -> Any:
return self.item[field_name]
def __setitem__(self, field_name: str, value: Any) -> None:
self.item[field_name] = value
def __delitem__(self, field_name: str) -> None:
del self.item[field_name]
def __iter__(self) -> Iterator:
return iter(self.item)
def __len__(self) -> int:
return len(self.item)
class DictAdapter(_MixinDictScrapyItemAdapter, AdapterInterface):
@classmethod
def is_item(cls, item: Any) -> bool:
return isinstance(item, dict)
@classmethod
def is_item_class(cls, item_class: type) -> bool:
return issubclass(item_class, dict)
@classmethod
def get_json_schema(
cls, item_class: type, *, _state: _JsonSchemaState | None = None
) -> dict[str, Any]:
return {"type": "object"}
def field_names(self) -> KeysView:
return KeysView(self.item)
class ScrapyItemAdapter(_MixinDictScrapyItemAdapter, AdapterInterface):
@classmethod
def is_item(cls, item: Any) -> bool:
return isinstance(item, _scrapy_item_classes)
@classmethod
def is_item_class(cls, item_class: type) -> bool:
return issubclass(item_class, _scrapy_item_classes)
@classmethod
def get_field_meta_from_class(cls, item_class: type, field_name: str) -> MappingProxyType:
return MappingProxyType(item_class.fields[field_name]) # type: ignore[attr-defined]
@classmethod
def get_field_names_from_class(cls, item_class: type) -> list[str] | None:
return list(item_class.fields.keys()) # type: ignore[attr-defined]
@classmethod
def get_json_schema(
cls, item_class: type, *, _state: _JsonSchemaState | None = None
) -> dict[str, Any]:
_state = _state or _JsonSchemaState(adapter=cls, containers={item_class})
schema = super().get_json_schema(item_class, _state=_state)
_setdefault_attribute_types_on_json_schema(schema, item_class, _state)
_setdefault_attribute_docstrings_on_json_schema(schema, item_class)
return schema
def field_names(self) -> KeysView:
return KeysView(self.item.fields)
class ItemAdapter(MutableMapping):
"""Wrapper class to interact with data container objects. It provides a common interface
to extract and set data without having to take the object's type into account.
"""
ADAPTER_CLASSES: Iterable[type[AdapterInterface]] = deque(
[
ScrapyItemAdapter,
DictAdapter,
DataclassAdapter,
AttrsAdapter,
PydanticAdapter,
]
)
def __init__(self, item: Any) -> None:
for cls in self.ADAPTER_CLASSES:
if cls.is_item(item):
self.adapter = cls(item)
break
else:
raise TypeError(f"No adapter found for objects of type: {type(item)} ({item})")
@classmethod
def is_item(cls, item: Any) -> bool:
return any(adapter_class.is_item(item) for adapter_class in cls.ADAPTER_CLASSES)
@classmethod
def is_item_class(cls, item_class: type) -> bool:
return any(
adapter_class.is_item_class(item_class) for adapter_class in cls.ADAPTER_CLASSES
)
@classmethod
def _get_adapter_class(cls, item_class: type) -> type[AdapterInterface]:
for adapter_class in cls.ADAPTER_CLASSES:
if adapter_class.is_item_class(item_class):
return adapter_class
raise TypeError(f"{item_class} is not a valid item class")
@classmethod
def get_field_meta_from_class(cls, item_class: type, field_name: str) -> MappingProxyType:
adapter_class = cls._get_adapter_class(item_class)
return adapter_class.get_field_meta_from_class(item_class, field_name)
@classmethod
def get_field_names_from_class(cls, item_class: type) -> list[str] | None:
adapter_class = cls._get_adapter_class(item_class)
return adapter_class.get_field_names_from_class(item_class)
@classmethod
def get_json_schema(
cls, item_class: type, *, _state: _JsonSchemaState | None = None
) -> dict[str, Any]:
_state = _state or _JsonSchemaState(adapter=cls, containers={item_class})
adapter_class = cls._get_adapter_class(item_class)
return adapter_class.get_json_schema(item_class, _state=_state)
@property
def item(self) -> Any:
return self.adapter.item
def __repr__(self) -> str:
values = ", ".join([f"{key}={value!r}" for key, value in self.items()])
return f"<{self.__class__.__name__} for {self.item.__class__.__name__}({values})>"
def __getitem__(self, field_name: str) -> Any:
return self.adapter.__getitem__(field_name)
def __setitem__(self, field_name: str, value: Any) -> None:
self.adapter.__setitem__(field_name, value)
def __delitem__(self, field_name: str) -> None:
self.adapter.__delitem__(field_name)
def __iter__(self) -> Iterator:
return self.adapter.__iter__()
def __len__(self) -> int:
return self.adapter.__len__()
def get_field_meta(self, field_name: str) -> MappingProxyType:
"""Return metadata for the given field name."""
return self.adapter.get_field_meta(field_name)
def field_names(self) -> KeysView:
"""Return read-only key view with the names of all the defined fields for the item."""
return self.adapter.field_names()
def asdict(self) -> dict:
"""Return a dict object with the contents of the adapter. This works slightly different
than calling `dict(adapter)`: it's applied recursively to nested items (if there are any).
"""
return {key: self._asdict(value) for key, value in self.items()}
@classmethod
def _asdict(cls, obj: Any) -> Any:
if isinstance(obj, dict):
return {key: cls._asdict(value) for key, value in obj.items()}
if isinstance(obj, (list, set, tuple)):
return obj.__class__(cls._asdict(x) for x in obj)
if isinstance(obj, cls):
return obj.asdict()
if cls.is_item(obj):
return cls(obj).asdict()
return obj
|