refactor: location transformers and Storage.prepare_location do not accept FileData anymore`

Author: smotornyuk

docs/extending/location_transformers.md

@@ -10,10 +10,9 @@ unique identifiers.
 
 A location transformer is a callable (usually a function) that takes the
 original [Location][file_keeper.Location] string, optional
-[Upload][file_keeper.Upload] or [FileData][file_keeper.FileData] object, and
-any extra data as input, and returns a modified
-[Location][file_keeper.Location] string. They provide a flexible way to
-customize how locations are handled by file-keeper.
+[Upload][file_keeper.Upload], and any extra data as input, and returns a
+modified [Location][file_keeper.Location] string. They provide a flexible way
+to customize how locations are handled by file-keeper.
 
 Location transformers are set per-storage via
 [location_transformers][file_keeper.Settings.location_transformers] option. To
@@ -44,11 +43,12 @@ storage.upload(safe_location, ...)
 
 ### Define your transformer
 
-Create a function that accepts the [Location][file_keeper.Location], optional [Upload][file_keeper.Upload] or [FileData][file_keeper.FileData], and
-`extras` as input and returns the transformed [Location][file_keeper.Location].
+Create a function that accepts the [Location][file_keeper.Location], optional
+[Upload][file_keeper.Upload], and `extras` as input and returns the transformed
+[Location][file_keeper.Location].
 
 ```python
-def my_location_transformer(location, data, extras):
+def my_location_transformer(location, upload_or_none, extras):
     # Perform custom transformation here
     return "prefix_" + location
 ```

src/file_keeper/core/storage.py

@@ -605,13 +605,12 @@ def full_path(self, location: types.Location, /, **kwargs: Any) -> str:
         """
         return os.path.join(self.settings.path, location)
 
-    def prepare_location(
-        self, location: str, upload_or_data: data.BaseData | Upload | None = None, /, **kwargs: Any
-    ) -> types.Location:
+    def prepare_location(self, location: str, sample: Upload | None = None, /, **kwargs: Any) -> types.Location:
         """Transform and sanitize location using configured functions."""
         for name in self.settings.location_transformers:
             if transformer := location_transformers.get(name):
-                location = transformer(location, upload_or_data, kwargs)
+                location = transformer(location, sample, kwargs)
+
             else:
                 raise exceptions.LocationTransformerError(name)
 

src/file_keeper/core/types.py

@@ -6,12 +6,11 @@
 from typing import TYPE_CHECKING, Any, Literal, NewType, Protocol, TypeAlias
 
 if TYPE_CHECKING:
-    from .data import BaseData
     from .upload import Upload
 
 Location = NewType("Location", str)
 
-LocationTransformer: TypeAlias = Callable[[str, "Upload | BaseData | None", "dict[str, Any]"], str]
+LocationTransformer: TypeAlias = Callable[[str, "Upload | None", "dict[str, Any]"], str]
 
 SignedAction = Literal["upload", "download", "delete"]
 

src/file_keeper/default/__init__.py

@@ -46,6 +46,7 @@ def fix_extension_transformer(location: str, upload: Upload | BaseData | None, e
     When upload is not specified, transformer does nothing.
     """
     if not upload:
+        log.debug("Location %s remains unchanged because upload is not specified", location)
         return location
 
     name = os.path.splitext(location)[0]
@@ -61,17 +62,17 @@ def fix_extension_transformer(location: str, upload: Upload | BaseData | None, e
     return location
 
 
-def safe_relative_path_transformer(location: str, upload: Upload | BaseData | None, extras: dict[str, Any]) -> str:
+def safe_relative_path_transformer(location: str, upload: Upload | None, extras: dict[str, Any]) -> str:
     """Remove unsafe segments from path and strip leading slash."""
     return os.path.normpath(location).lstrip("./")
 
 
-def uuid_transformer(location: str, upload: Upload | BaseData | None, extras: dict[str, Any]) -> str:
+def uuid_transformer(location: str, upload: Upload | None, extras: dict[str, Any]) -> str:
     """Transform location into random UUID."""
     return str(uuid.uuid4())
 
 
-def static_uuid_transformer(location: str, upload: Upload | BaseData | None, extras: dict[str, Any]) -> str:
+def static_uuid_transformer(location: str, upload: Upload | None, extras: dict[str, Any]) -> str:
     """Transform location into static UUID.
 
     The same location always transformed into the same UUID. This transformer
@@ -81,23 +82,23 @@ def static_uuid_transformer(location: str, upload: Upload | BaseData | None, ext
     return str(uuid.uuid5(FILE_KEEPER_DNS, location))
 
 
-def uuid_prefix_transformer(location: str, upload: Upload | BaseData | None, extras: dict[str, Any]) -> str:
+def uuid_prefix_transformer(location: str, upload: Upload | None, extras: dict[str, Any]) -> str:
     """Prefix the location with random UUID."""
     return str(uuid.uuid4()) + location
 
 
-def uuid_with_extension_transformer(location: str, upload: Upload | BaseData | None, extras: dict[str, Any]) -> str:
+def uuid_with_extension_transformer(location: str, upload: Upload | None, extras: dict[str, Any]) -> str:
     """Replace location with random UUID, but keep the original extension."""
     ext = os.path.splitext(location)[1]
     return str(uuid.uuid4()) + ext
 
 
-def datetime_prefix_transformer(location: str, upload: Upload | BaseData | None, extras: dict[str, Any]) -> str:
+def datetime_prefix_transformer(location: str, upload: Upload | None, extras: dict[str, Any]) -> str:
     """Prefix location with current date-timestamp."""
     return datetime.now(timezone.utc).isoformat() + location
 
 
-def datetime_with_extension_transformer(location: str, upload: Upload | BaseData | None, extras: dict[str, Any]) -> str:
+def datetime_with_extension_transformer(location: str, upload: Upload | None, extras: dict[str, Any]) -> str:
     """Replace location with current date-timestamp, but keep the extension."""
     ext = os.path.splitext(location)[1]
     return datetime.now(timezone.utc).isoformat() + ext

src/file_keeper/default/adapters/azure_blob.py

@@ -141,7 +141,6 @@ class Manager(fk.Manager):
     def copy(self, location: fk.Location, data: fk.FileData, extras: dict[str, Any]) -> fk.FileData:
         """Copy a file to a new location."""
         src_filepath = self.storage.full_path(data.location)
-
         blob = self.storage.settings.container.get_blob_client(src_filepath)
         if not blob.exists():
             raise fk.exc.MissingFileError(self.storage, data.location)

src/file_keeper/default/adapters/fs.py

@@ -85,7 +85,7 @@ def upload(self, location: fk.types.Location, upload: fk.Upload, extras: dict[st
         # --8<-- [end:uploader_impl_path]
 
         # --8<-- [start:uploader_impl_check]
-        if os.path.exists(dest) and not self.storage.settings.override_existing:
+        if not self.storage.settings.override_existing and os.path.exists(dest):
             raise fk.exc.ExistingFileError(self.storage, location)
         # --8<-- [end:uploader_impl_check]