chore: override_existing option for base storage

ckanext/files/base.py

@@ -427,6 +427,10 @@ def __str__(self):
         return self.settings.get("name", "unknown")
 
     def __init__(self, **settings: Any):
+        settings.setdefault("override_existing", False)
+        settings.setdefault("supported_types", [])
+        settings.setdefault("max_size", 0)
+
         self.settings = settings
 
         self.uploader = self.make_uploader()
@@ -443,13 +447,13 @@ def max_size(self) -> int:
 
         """
 
-        return self.settings.get("max_size", 0)
+        return self.settings["max_size"]
 
     @property
     def supported_types(self) -> list[str]:
         """List of supported MIMEtypes or their parts."""
 
-        return self.settings.get("supported_types", [])
+        return self.settings["supported_types"]
 
     @classmethod
     def declare_config_options(cls, declaration: Declaration, key: Key):
@@ -466,6 +470,10 @@ def declare_config_options(cls, declaration: Declaration, key: Key):
             + "\nExample: text/csv pdf application video jpeg",
         )
 
+        declaration.declare_bool(key.override_existing).set_description(
+            "If file already exists, replace it with new content.",
+        )
+
         declaration.declare(key.name, key[-1]).set_description(
             "Descriptive name of the storage used for debugging. When empty,"
             + " name from the config option is used,"

ckanext/files/storage/fs.py

@@ -43,7 +43,6 @@ def __init__(self, **settings: Any):
         path = self.ensure_option(settings, "path")
         settings.setdefault("create_path", False)
         settings.setdefault("recursive", False)
-        settings.setdefault("override_existing", False)
 
         if not os.path.exists(path):
             if tk.asbool(settings["create_path"]):
@@ -72,10 +71,6 @@ def declare_config_options(cls, declaration: Declaration, key: Key):
             + " of the main storage path.",
         )
 
-        declaration.declare_bool(key.override_existing).set_description(
-            "If file already exists, replace it with new content.",
-        )
-
 
 class FsUploader(Uploader):
     required_options = ["path"]

ckanext/files/storage/redis.py

@@ -219,7 +219,10 @@ def copy(
         if not self.storage.redis.exists(src):
             raise exceptions.MissingFileError(self.storage, src)
 
-        if self.storage.redis.exists(dest):
+        if (
+            self.storage.redis.exists(dest)
+            and not self.storage.settings["override_existing"]
+        ):
             raise exceptions.ExistingFileError(self.storage, dest)
 
         try:
@@ -249,7 +252,10 @@ def move(
         if not self.storage.redis.exists(src):
             raise exceptions.MissingFileError(self.storage, src)
 
-        if self.storage.redis.exists(dest):
+        if (
+            self.storage.redis.exists(dest)
+            and not self.storage.settings["override_existing"]
+        ):
             raise exceptions.ExistingFileError(self.storage, dest)
 
         self.storage.redis.rename(src, dest)

ckanext/files/tests/test_base.py

@@ -151,8 +151,13 @@ def test_settings(self, faker: Faker):
         """Storage keeps all incoming arguments as settings."""
 
         settings = faker.pydict()
+
         storage = base.Storage(**settings)
-        assert storage.settings == settings
+        expected = dict(
+            {"supported_types": [], "max_size": 0, "override_existing": False},
+            **settings,
+        )
+        assert storage.settings == expected
 
     def test_max_size(self, faker: Faker):
         """Storage has a dedicated property for `max_size` setting."""

ckanext/files/tests/test_config.py

@@ -31,6 +31,7 @@ def test_empty(self):
             "default": {
                 "type": "files:redis",
                 "prefix": "ckanext:files:test.ckan.net:file_content:",
+                "override_existing": False,
                 "name": "default",
                 "supported_types": [],
                 "max_size": 0,
@@ -55,6 +56,7 @@ def test_customized(self, monkeypatch: MonkeyPatch, ckan_config: dict[str, Any])
             "default": {
                 "type": "files:redis",
                 "prefix": "ckanext:files:test.ckan.net:file_content:",
+                "override_existing": False,
                 "name": "default",
                 "supported_types": [],
                 "max_size": 0,
@@ -82,6 +84,7 @@ def test_non_setting(self):
             "default": {
                 "type": "files:redis",
                 "prefix": "ckanext:files:test.ckan.net:file_content:",
+                "override_existing": False,
                 "name": "default",
                 "supported_types": [],
                 "max_size": 0,

docs/configuration/fs.md

@@ -12,8 +12,6 @@ ckanext.files.storage.NAME.create_path = false
 ## Use this flag if files can be stored inside subfolders
 ## of the main storage path.
 ckanext.files.storage.NAME.recursive = false
-## If file already exists, replace it with new content.
-ckanext.files.storage.NAME.override_existing = false
 ```
 
 
@@ -29,8 +27,6 @@ ckanext.files.storage.NAME.create_path = false
 ## Use this flag if files can be stored inside subfolders
 ## of the main storage path.
 ckanext.files.storage.NAME.recursive = false
-## If file already exists, replace it with new content.
-ckanext.files.storage.NAME.override_existing = false
 ## URL of the storage folder. `public_root + location` must produce a public URL
 ckanext.files.storage.NAME.public_root =
 ```

docs/configuration/storage/index.md

@@ -76,6 +76,8 @@ ckanext.files.storage.NAME.max_size = 0
 ## Space-separated list of MIME types or just type or subtype part.
 ## Example: text/csv pdf application video jpeg
 ckanext.files.storage.NAME.supported_types =
+## If file already exists, replace it with new content.
+ckanext.files.storage.NAME.override_existing = false
 ## Descriptive name of the storage used for debugging. When empty, name from
 ## the config option is used, i.e: `ckanext.files.storage.DEFAULT_NAME...`
 ckanext.files.storage.NAME.name = NAME