Scrapy, a fast high-level web crawling & scraping framework for Python.
Update the outdated Item docstring. (#6427)
Andrey Rakhmatulline7f5ae0b34ef
diff --git a/docs/topics/items.rst b/docs/topics/items.rstindex 39a95815c..7cc476863 100644--- a/docs/topics/items.rst+++ b/docs/topics/items.rst@@ -42,39 +42,27 @@ Item objects:class:`Item` provides a :class:`dict`-like API plus additional features thatmake it the most feature-complete item type:-.. class:: scrapy.item.Item([arg])-.. class:: scrapy.Item([arg])+.. autoclass:: scrapy.Item+ :members: copy, deepcopy, fields+ :undoc-members:- :class:`Item` objects replicate the standard :class:`dict` API, including- its ``__init__`` method.+:class:`Item` objects replicate the standard :class:`dict` API, including+its ``__init__`` method.- :class:`Item` allows the defining of field names, so that:+:class:`Item` allows the defining of field names, so that:- - :class:`KeyError` is raised when using undefined field names (i.e.- prevents typos going unnoticed)+- :class:`KeyError` is raised when using undefined field names (i.e.+ prevents typos going unnoticed)- - :ref:`Item exporters <topics-exporters>` can export all fields by- default even if the first scraped object does not have values for all- of them+- :ref:`Item exporters <topics-exporters>` can export all fields by+ default even if the first scraped object does not have values for all+ of them- :class:`Item` also allows the defining of field metadata, which can be used to- :ref:`customize serialization <topics-exporters-field-serialization>`.+:class:`Item` also allows the defining of field metadata, which can be used to+:ref:`customize serialization <topics-exporters-field-serialization>`.- :mod:`trackref` tracks :class:`Item` objects to help find memory leaks- (see :ref:`topics-leaks-trackrefs`).-- :class:`Item` objects also provide the following additional API members:-- .. automethod:: copy-- .. automethod:: deepcopy-- .. attribute:: fields-- A dictionary containing *all declared fields* for this Item, not only- those populated. The keys are the field names and the values are the- :class:`Field` objects used in the :ref:`Item declaration- <topics-items-declaring>`.+:mod:`trackref` tracks :class:`Item` objects to help find memory leaks+(see :ref:`topics-leaks-trackrefs`).Example:@@ -205,10 +193,9 @@ documentation to see which metadata keys are used by each component.It's important to note that the :class:`Field` objects used to declare the itemdo not stay assigned as class attributes. Instead, they can be accessed through-the :attr:`Item.fields` attribute.+the :attr:`~scrapy.Item.fields` attribute.-.. class:: scrapy.item.Field([arg])-.. class:: scrapy.Field([arg])+.. autoclass:: scrapy.FieldThe :class:`Field` class is just an alias to the built-in :class:`dict` class anddoesn't provide any extra functionality or attributes. In other words,diff --git a/scrapy/item.py b/scrapy/item.pyindex f77002d18..1cc0ae584 100644--- a/scrapy/item.py+++ b/scrapy/item.py@@ -55,16 +55,13 @@ class ItemMeta(ABCMeta):class Item(MutableMapping[str, Any], object_ref, metaclass=ItemMeta):- """- Base class for scraped items.-- In Scrapy, an object is considered an ``item`` if it is an instance of either- :class:`Item` or :class:`dict`, or any subclass. For example, when the output of a- spider callback is evaluated, only instances of :class:`Item` or- :class:`dict` are passed to :ref:`item pipelines <topics-item-pipeline>`.+ """Base class for scraped items.- If you need instances of a custom class to be considered items by Scrapy,- you must inherit from either :class:`Item` or :class:`dict`.+ In Scrapy, an object is considered an ``item`` if it's supported by the+ `itemadapter`_ library. For example, when the output of a spider callback+ is evaluated, only such objects are passed to :ref:`item pipelines+ <topics-item-pipeline>`. :class:`Item` is one of the classes supported by+ `itemadapter`_ by default.Items must declare :class:`Field` attributes, which are processed and storedin the ``fields`` attribute. This restricts the set of allowed field names@@ -75,8 +72,14 @@ class Item(MutableMapping[str, Any], object_ref, metaclass=ItemMeta):Unlike instances of :class:`dict`, instances of :class:`Item` may be:ref:`tracked <topics-leaks-trackrefs>` to debug memory leaks.++ .. _itemadapter: https://github.com/scrapy/itemadapter"""+ #: A dictionary containing *all declared fields* for this Item, not only+ #: those populated. The keys are the field names and the values are the+ #: :class:`Field` objects used in the :ref:`Item declaration+ #: <topics-items-declaring>`.fields: dict[str, Field]def __init__(self, *args: Any, **kwargs: Any):