Scrapy, a fast high-level web crawling & scraping framework for Python.
Remove deprecated DictItem class
Eugenio Lacuestafca49cca929d
diff --git a/docs/conf.py b/docs/conf.pyindex 406c4d94a..d5e139e66 100644--- a/docs/conf.py+++ b/docs/conf.py@@ -272,7 +272,6 @@ coverage_ignore_pyobjects = [r'^scrapy\.extensions\.[a-z]\w*?\.[a-z]', # helper functions# Never documented before, and deprecated now.- r'^scrapy\.item\.DictItem$',r'^scrapy\.linkextractors\.FilteringLinkExtractor$',# Implementation detail of LxmlLinkExtractordiff --git a/scrapy/item.py b/scrapy/item.pyindex 839bee3fa..2521ac829 100644--- a/scrapy/item.py+++ b/scrapy/item.py@@ -9,9 +9,7 @@ from collections.abc import MutableMappingfrom copy import deepcopyfrom pprint import pformatfrom typing import Dict-from warnings import warn-from scrapy.utils.deprecate import ScrapyDeprecationWarningfrom scrapy.utils.trackref import object_ref@@ -46,15 +44,30 @@ class ItemMeta(ABCMeta):return super().__new__(mcs, class_name, bases, new_attrs)-class DictItem(MutableMapping, object_ref):+class Item(MutableMapping, 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>`.++ If you need instances of a custom class to be considered items by Scrapy,+ you must inherit from either :class:`Item` or :class:`dict`.++ Items must declare :class:`Field` attributes, which are processed and stored+ in the ``fields`` attribute. This restricts the set of allowed field names+ and prevents typos, raising ``KeyError`` when referring to undefined fields.+ Additionally, fields can be used to define metadata and control the way+ data is processed internally. Please refer to the :ref:`documentation+ about fields <topics-items-fields>` for additional information.- fields: Dict[str, Field] = {}+ Unlike instances of :class:`dict`, instances of :class:`Item` may be+ :ref:`tracked <topics-leaks-trackrefs>` to debug memory leaks.+ """- def __new__(cls, *args, **kwargs):- if issubclass(cls, DictItem) and not issubclass(cls, Item):- warn('scrapy.item.DictItem is deprecated, please use scrapy.item.Item instead',- ScrapyDeprecationWarning, stacklevel=2)- return super().__new__(cls, *args, **kwargs)+ fields: Dict[str, Field]def __init__(self, *args, **kwargs):self._values = {}@@ -105,27 +118,3 @@ class DictItem(MutableMapping, object_ref):"""Return a :func:`~copy.deepcopy` of this item."""return deepcopy(self)---class Item(DictItem, 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>`.-- If you need instances of a custom class to be considered items by Scrapy,- you must inherit from either :class:`Item` or :class:`dict`.-- Items must declare :class:`Field` attributes, which are processed and stored- in the ``fields`` attribute. This restricts the set of allowed field names- and prevents typos, raising ``KeyError`` when referring to undefined fields.- Additionally, fields can be used to define metadata and control the way- data is processed internally. Please refer to the :ref:`documentation- about fields <topics-items-fields>` for additional information.-- Unlike instances of :class:`dict`, instances of :class:`Item` may be- :ref:`tracked <topics-leaks-trackrefs>` to debug memory leaks.- """diff --git a/tests/test_item.py b/tests/test_item.pyindex a12e425e0..25f2aea0a 100644--- a/tests/test_item.py+++ b/tests/test_item.py@@ -1,9 +1,7 @@import unittestfrom unittest import mock-from warnings import catch_warnings-from scrapy.exceptions import ScrapyDeprecationWarning-from scrapy.item import ABCMeta, DictItem, Field, Item, ItemMeta+from scrapy.item import ABCMeta, Field, Item, ItemMetaclass ItemTest(unittest.TestCase):@@ -254,18 +252,6 @@ class ItemTest(unittest.TestCase):item['tags'].append('tag2')assert item['tags'] != copied_item['tags']- def test_dictitem_deprecation_warning(self):- """Make sure the DictItem deprecation warning is not issued for- Item"""- with catch_warnings(record=True) as warnings:- Item()- self.assertEqual(len(warnings), 0)-- class SubclassedItem(Item):- pass- SubclassedItem()- self.assertEqual(len(warnings), 0)-class ItemMetaTest(unittest.TestCase):@@ -303,20 +289,5 @@ class ItemMetaClassCellRegression(unittest.TestCase):super().__init__(*args, **kwargs)-class DictItemTest(unittest.TestCase):-- def test_deprecation_warning(self):- with catch_warnings(record=True) as warnings:- DictItem()- self.assertEqual(len(warnings), 1)- self.assertEqual(warnings[0].category, ScrapyDeprecationWarning)- with catch_warnings(record=True) as warnings:- class SubclassedDictItem(DictItem):- pass- SubclassedDictItem()- self.assertEqual(len(warnings), 1)- self.assertEqual(warnings[0].category, ScrapyDeprecationWarning)--if __name__ == "__main__":unittest.main()