persistence-kit 3.15.0__tar.gz → 3.16.0__tar.gz

{persistence_kit-3.15.0 → persistence_kit-3.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: persistence-kit
-Version: 3.15.0
+Version: 3.16.0
 Summary: Reusable persistence and repository toolkit
 License: MIT
 License-File: LICENSE
@@ -209,6 +209,15 @@ url = await storage.generate_presigned_url(key)
 `LocalObjectStorage` writes to a directory and signs its own download URLs.
 `S3ObjectStorage` uploads to S3 and returns AWS presigned URLs. Pick one with
 `get_export_storage(settings)`, which reads your settings and caches the adapter.
+Give `S3ObjectStorage` a `prefix` and every key it writes, presigns, deletes or
+lists stays under that folder of the bucket, while the keys you pass and get back
+stay relative to it.
+
+For files your users upload, `build_media_storage(settings, namespace=...,
+url_prefix=...)` checks type and size and keeps each namespace in its own
+folder: `<LOCAL_MEDIA_STORAGE_DIR>/<namespace>` with `MEDIA_STORAGE_PROVIDER=local`,
+and `<namespace>/` inside `AWS_S3_MEDIA_BUCKET` with `s3`. Keys are the same on
+both, so moving to S3 does not change what your app stores.
 
 FastAPI apps can mount `build_local_export_storage_router(...)` to serve local
 files, passing their settings provider, an optional current-user dependency, and

{persistence_kit-3.15.0 → persistence_kit-3.16.0}/README.md

@@ -158,6 +158,15 @@ url = await storage.generate_presigned_url(key)
 `LocalObjectStorage` writes to a directory and signs its own download URLs.
 `S3ObjectStorage` uploads to S3 and returns AWS presigned URLs. Pick one with
 `get_export_storage(settings)`, which reads your settings and caches the adapter.
+Give `S3ObjectStorage` a `prefix` and every key it writes, presigns, deletes or
+lists stays under that folder of the bucket, while the keys you pass and get back
+stay relative to it.
+
+For files your users upload, `build_media_storage(settings, namespace=...,
+url_prefix=...)` checks type and size and keeps each namespace in its own
+folder: `<LOCAL_MEDIA_STORAGE_DIR>/<namespace>` with `MEDIA_STORAGE_PROVIDER=local`,
+and `<namespace>/` inside `AWS_S3_MEDIA_BUCKET` with `s3`. Keys are the same on
+both, so moving to S3 does not change what your app stores.
 
 FastAPI apps can mount `build_local_export_storage_router(...)` to serve local
 files, passing their settings provider, an optional current-user dependency, and

{persistence_kit-3.15.0 → persistence_kit-3.16.0}/persistence_kit/storage/factory.py

@@ -87,10 +87,10 @@ def _local_media_object_storage_cached(base_dir: str) -> ObjectStorage:
 
 
 @lru_cache
-def _s3_media_object_storage_cached(bucket: str, region: str) -> ObjectStorage:
+def _s3_media_object_storage_cached(bucket: str, region: str, prefix: str) -> ObjectStorage:
     from persistence_kit.storage.s3 import S3ObjectStorage
 
-    return S3ObjectStorage(bucket=bucket, region=region)
+    return S3ObjectStorage(bucket=bucket, region=region, prefix=prefix)
 
 
 def _build_media_object_storage(
@@ -110,7 +110,7 @@ def _build_media_object_storage(
                 "Falta configuracion AWS_S3_MEDIA_BUCKET para el storage de media."
             )
         return _s3_media_object_storage_cached(
-            settings.aws_s3_media_bucket, settings.aws_region
+            settings.aws_s3_media_bucket, settings.aws_region, namespace
         )
     provider = getattr(
         settings.media_storage_provider, "value", settings.media_storage_provider

{persistence_kit-3.15.0 → persistence_kit-3.16.0}/persistence_kit/storage/s3.py

@@ -22,35 +22,42 @@ logger = logging.getLogger(__name__)
 
 
 class S3ObjectStorage:
-    def __init__(self, *, bucket: str, region: str) -> None:
+    def __init__(self, *, bucket: str, region: str, prefix: str = "") -> None:
         if boto3 is None:
             raise StorageConfigError("Falta dependencia boto3 para integrar con S3.")
         self._bucket = bucket
         self._region = region
+        normalized_prefix = prefix.strip("/")
+        self._prefix = f"{normalized_prefix}/" if normalized_prefix else ""
         self._client = boto3.client("s3", region_name=region)
 
+    def _object_key(self, key: str) -> str:
+        return f"{self._prefix}{key}"
+
     async def upload(
         self,
         key: str,
         data: bytes,
         content_type: str = "application/octet-stream",
     ) -> str:
+        object_key = self._object_key(key)
+
         def _upload() -> None:
             self._client.put_object(
                 Bucket=self._bucket,
-                Key=key,
+                Key=object_key,
                 Body=data,
                 ContentType=content_type,
             )
 
-        logger.info("S3 upload iniciado bucket=%s key=%s", self._bucket, key)
+        logger.info("S3 upload iniciado bucket=%s key=%s", self._bucket, object_key)
         try:
             await asyncio.to_thread(_upload)
         except ClientError as exc:
-            logger.exception("S3 upload fallido bucket=%s key=%s", self._bucket, key)
+            logger.exception("S3 upload fallido bucket=%s key=%s", self._bucket, object_key)
             raise StorageUploadError(f"No fue posible subir el archivo a S3: {exc}") from exc
 
-        logger.info("S3 upload exitoso bucket=%s key=%s", self._bucket, key)
+        logger.info("S3 upload exitoso bucket=%s key=%s", self._bucket, object_key)
         return key
 
     async def upload_file(
@@ -59,66 +66,75 @@ class S3ObjectStorage:
         file_path: Path,
         content_type: str = "application/octet-stream",
     ) -> str:
+        object_key = self._object_key(key)
+
         def _upload_file() -> None:
             with file_path.open("rb") as file_obj:
                 self._client.upload_fileobj(
                     Fileobj=file_obj,
                     Bucket=self._bucket,
-                    Key=key,
+                    Key=object_key,
                     ExtraArgs={"ContentType": content_type},
                 )
 
-        logger.info("S3 file upload iniciado bucket=%s key=%s path=%s", self._bucket, key, file_path)
+        logger.info(
+            "S3 file upload iniciado bucket=%s key=%s path=%s", self._bucket, object_key, file_path
+        )
         try:
             await asyncio.to_thread(_upload_file)
         except ClientError as exc:
-            logger.exception("S3 file upload fallido bucket=%s key=%s", self._bucket, key)
+            logger.exception("S3 file upload fallido bucket=%s key=%s", self._bucket, object_key)
             raise StorageUploadError(f"No fue posible subir el archivo a S3: {exc}") from exc
 
-        logger.info("S3 file upload exitoso bucket=%s key=%s", self._bucket, key)
+        logger.info("S3 file upload exitoso bucket=%s key=%s", self._bucket, object_key)
         return key
 
     async def generate_presigned_url(self, key: str, expires_in: int = 3600) -> str:
+        object_key = self._object_key(key)
+
         def _presign() -> str:
             return self._client.generate_presigned_url(
                 "get_object",
-                Params={"Bucket": self._bucket, "Key": key},
+                Params={"Bucket": self._bucket, "Key": object_key},
                 ExpiresIn=expires_in,
             )
 
         try:
             return await asyncio.to_thread(_presign)
         except ClientError as exc:
-            logger.exception("S3 presign fallido bucket=%s key=%s", self._bucket, key)
+            logger.exception("S3 presign fallido bucket=%s key=%s", self._bucket, object_key)
             raise StoragePresignError(f"No fue posible generar la URL prefirmada: {exc}") from exc
 
     async def delete(self, key: str) -> None:
+        object_key = self._object_key(key)
+
         def _delete() -> None:
-            self._client.delete_object(Bucket=self._bucket, Key=key)
+            self._client.delete_object(Bucket=self._bucket, Key=object_key)
 
         try:
             await asyncio.to_thread(_delete)
         except ClientError as exc:
-            logger.exception("S3 delete fallido bucket=%s key=%s", self._bucket, key)
+            logger.exception("S3 delete fallido bucket=%s key=%s", self._bucket, object_key)
             raise StorageError(f"No fue posible borrar el objeto en S3: {exc}") from exc
 
     async def list_keys(self, prefix: str = "") -> list[str]:
         normalized_prefix = prefix.lstrip("/")
         if normalized_prefix and not normalized_prefix.endswith("/"):
             normalized_prefix = normalized_prefix + "/"
+        search_prefix = self._object_key(normalized_prefix)
 
         def _list() -> list[str]:
             keys: list[str] = []
             paginator = self._client.get_paginator("list_objects_v2")
-            for page in paginator.paginate(Bucket=self._bucket, Prefix=normalized_prefix):
+            for page in paginator.paginate(Bucket=self._bucket, Prefix=search_prefix):
                 for obj in page.get("Contents", []) or []:
-                    keys.append(obj["Key"])
+                    keys.append(obj["Key"].removeprefix(self._prefix))
             return keys
 
         try:
             return await asyncio.to_thread(_list)
         except ClientError as exc:
-            logger.exception("S3 list fallido bucket=%s prefix=%s", self._bucket, normalized_prefix)
+            logger.exception("S3 list fallido bucket=%s prefix=%s", self._bucket, search_prefix)
             raise StorageError(f"No fue posible listar objetos en S3: {exc}") from exc
 
 

{persistence_kit-3.15.0 → persistence_kit-3.16.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "persistence-kit"
-version = "3.15.0"
+version = "3.16.0"
 description = "Reusable persistence and repository toolkit"
 authors = ["Andres Felipe Serrano Barrios <andresfserrano1@gmail.com>"]
 readme = "README.md"