Skip to content

Scrapy, a fast high-level web crawling & scraping framework for Python.

Remove deprecated BaseItem class

Eugenio Lacuestabbfa185664ce
diff --git a/scrapy/exporters.py b/scrapy/exporters.py
index 36cca2d05..1c26e81db 100644
--- a/scrapy/exporters.py
+++ b/scrapy/exporters.py
@@ -13,7 +13,7 @@ from xml.sax.saxutils import XMLGenerator
from itemadapter import is_item, ItemAdapter
from scrapy.exceptions import ScrapyDeprecationWarning
-from scrapy.item import _BaseItem
+from scrapy.item import Item
from scrapy.utils.python import is_listlike, to_bytes, to_unicode
from scrapy.utils.serialize import ScrapyJSONEncoder
@@ -315,7 +315,7 @@ class PythonItemExporter(BaseItemExporter):
return serializer(value)
def _serialize_value(self, value):
- if isinstance(value, _BaseItem):
+ if isinstance(value, Item):
return self.export_item(value)
elif is_item(value):
return dict(self._serialize_item(value))
diff --git a/scrapy/item.py b/scrapy/item.py
index 2ccd7ad18..839bee3fa 100644
--- a/scrapy/item.py
+++ b/scrapy/item.py
@@ -15,39 +15,11 @@ from scrapy.utils.deprecate import ScrapyDeprecationWarning
from scrapy.utils.trackref import object_ref
-class _BaseItem(object_ref):
- """
- Temporary class used internally to avoid the deprecation
- warning raised by isinstance checks using BaseItem.
- """
- pass
-
-
-class _BaseItemMeta(ABCMeta):
- def __instancecheck__(cls, instance):
- if cls is BaseItem:
- warn('scrapy.item.BaseItem is deprecated, please use scrapy.item.Item instead',
- ScrapyDeprecationWarning, stacklevel=2)
- return super().__instancecheck__(instance)
-
-
-class BaseItem(_BaseItem, metaclass=_BaseItemMeta):
- """
- Deprecated, please use :class:`scrapy.item.Item` instead
- """
-
- def __new__(cls, *args, **kwargs):
- if issubclass(cls, BaseItem) and not issubclass(cls, (Item, DictItem)):
- warn('scrapy.item.BaseItem is deprecated, please use scrapy.item.Item instead',
- ScrapyDeprecationWarning, stacklevel=2)
- return super().__new__(cls, *args, **kwargs)
-
-
class Field(dict):
"""Container of field metadata"""
-class ItemMeta(_BaseItemMeta):
+class ItemMeta(ABCMeta):
"""Metaclass_ of :class:`Item` that handles field definitions.
.. _metaclass: https://realpython.com/python-metaclasses
@@ -74,7 +46,7 @@ class ItemMeta(_BaseItemMeta):
return super().__new__(mcs, class_name, bases, new_attrs)
-class DictItem(MutableMapping, BaseItem):
+class DictItem(MutableMapping, object_ref):
fields: Dict[str, Field] = {}
@@ -118,7 +90,7 @@ class DictItem(MutableMapping, BaseItem):
def __iter__(self):
return iter(self._values)
- __hash__ = BaseItem.__hash__
+ __hash__ = object_ref.__hash__
def keys(self):
return self._values.keys()
diff --git a/scrapy/utils/misc.py b/scrapy/utils/misc.py
index 11c4206c2..1221b39b2 100644
--- a/scrapy/utils/misc.py
+++ b/scrapy/utils/misc.py
@@ -14,11 +14,11 @@ from w3lib.html import replace_entities
from scrapy.utils.datatypes import LocalWeakReferencedCache
from scrapy.utils.python import flatten, to_unicode
-from scrapy.item import _BaseItem
+from scrapy.item import Item
from scrapy.utils.deprecate import ScrapyDeprecationWarning
-_ITERABLE_SINGLE_VALUES = dict, _BaseItem, str, bytes
+_ITERABLE_SINGLE_VALUES = dict, Item, str, bytes
def arg_to_iter(arg):
diff --git a/tests/test_item.py b/tests/test_item.py
index c94bb44af..7d82fbffe 100644
--- a/tests/test_item.py
+++ b/tests/test_item.py
@@ -3,7 +3,7 @@ from unittest import mock
from warnings import catch_warnings, filterwarnings
from scrapy.exceptions import ScrapyDeprecationWarning
-from scrapy.item import ABCMeta, _BaseItem, BaseItem, DictItem, Field, Item, ItemMeta
+from scrapy.item import ABCMeta, DictItem, Field, Item, ItemMeta
class ItemTest(unittest.TestCase):
@@ -318,79 +318,6 @@ class DictItemTest(unittest.TestCase):
self.assertEqual(warnings[0].category, ScrapyDeprecationWarning)
-class BaseItemTest(unittest.TestCase):
-
- def test_isinstance_check(self):
-
- class SubclassedBaseItem(BaseItem):
- pass
-
- class SubclassedItem(Item):
- pass
-
- with catch_warnings():
- filterwarnings("ignore", category=ScrapyDeprecationWarning)
- self.assertTrue(isinstance(BaseItem(), BaseItem))
- self.assertTrue(isinstance(SubclassedBaseItem(), BaseItem))
- self.assertTrue(isinstance(Item(), BaseItem))
- self.assertTrue(isinstance(SubclassedItem(), BaseItem))
-
- # make sure internal checks using private _BaseItem class succeed
- self.assertTrue(isinstance(BaseItem(), _BaseItem))
- self.assertTrue(isinstance(SubclassedBaseItem(), _BaseItem))
- self.assertTrue(isinstance(Item(), _BaseItem))
- self.assertTrue(isinstance(SubclassedItem(), _BaseItem))
-
- def test_deprecation_warning(self):
- """
- Make sure deprecation warnings are logged whenever BaseItem is used,
- either instantiated or in an isinstance check
- """
- with catch_warnings(record=True) as warnings:
- BaseItem()
- self.assertEqual(len(warnings), 1)
- self.assertEqual(warnings[0].category, ScrapyDeprecationWarning)
-
- with catch_warnings(record=True) as warnings:
-
- class SubclassedBaseItem(BaseItem):
- pass
-
- SubclassedBaseItem()
- self.assertEqual(len(warnings), 1)
- self.assertEqual(warnings[0].category, ScrapyDeprecationWarning)
-
- with catch_warnings(record=True) as warnings:
- self.assertFalse(isinstance("foo", BaseItem))
- self.assertEqual(len(warnings), 1)
- self.assertEqual(warnings[0].category, ScrapyDeprecationWarning)
-
- with catch_warnings(record=True) as warnings:
- self.assertTrue(isinstance(BaseItem(), BaseItem))
- self.assertEqual(len(warnings), 1)
- self.assertEqual(warnings[0].category, ScrapyDeprecationWarning)
-
-
-class ItemNoDeprecationWarningTest(unittest.TestCase):
- def test_no_deprecation_warning(self):
- """
- Make sure deprecation warnings are NOT logged whenever BaseItem subclasses are used.
- """
- class SubclassedItem(Item):
- pass
-
- with catch_warnings(record=True) as warnings:
- Item()
- SubclassedItem()
- _BaseItem()
- self.assertFalse(isinstance("foo", _BaseItem))
- self.assertFalse(isinstance("foo", Item))
- self.assertFalse(isinstance("foo", SubclassedItem))
- self.assertTrue(isinstance(_BaseItem(), _BaseItem))
- self.assertTrue(isinstance(Item(), Item))
- self.assertTrue(isinstance(SubclassedItem(), SubclassedItem))
- self.assertEqual(len(warnings), 0)
-
if __name__ == "__main__":
unittest.main()