Skip to content

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

chore: Implement `pop` method on `BaseSettings` class

Laerte Pereira080b9bd0b8f6
diff --git a/scrapy/settings/__init__.py b/scrapy/settings/__init__.py
index a3b849f7b..57fe1d17a 100644
--- a/scrapy/settings/__init__.py
+++ b/scrapy/settings/__init__.py
@@ -75,6 +75,8 @@ class BaseSettings(MutableMapping):
highest priority will be retrieved.
"""
+ __default = object()
+
def __init__(self, values=None, priority="project"):
self.frozen = False
self.attributes = {}
@@ -445,6 +447,18 @@ class BaseSettings(MutableMapping):
else:
p.text(pformat(self.copy_to_dict()))
+ def pop(self, name, default=__default):
+ try:
+ value = self.attributes[name]
+ except KeyError:
+ if default is self.__default:
+ raise
+
+ return SettingsAttribute(default, get_settings_priority("project"))
+ else:
+ del self.attributes[name]
+ return value
+
class Settings(BaseSettings):
"""
diff --git a/tests/test_settings/__init__.py b/tests/test_settings/__init__.py
index 4a577cd8c..0e2f4aa98 100644
--- a/tests/test_settings/__init__.py
+++ b/tests/test_settings/__init__.py
@@ -451,6 +451,19 @@ class SettingsTest(unittest.TestCase):
self.assertIsInstance(myhandler_instance, FileDownloadHandler)
self.assertTrue(hasattr(myhandler_instance, "download_request"))
+ def test_pop_item_with_default_value(self):
+ settings = Settings()
+
+ with self.assertRaises(KeyError):
+ settings.pop("DUMMY_CONFIG")
+
+ dummy_config = settings.pop("DUMMY_CONFIG", "dummy_value")
+
+ self.assertEqual(
+ repr(dummy_config), "<SettingsAttribute value='dummy_value' priority=20>"
+ )
+ self.assertEqual(dummy_config.value, "dummy_value")
+
if __name__ == "__main__":
unittest.main()