amsdal_storages 0.1.0__py3-none-any.whl

amsdal_storages/__about__.py

@@ -0,0 +1 @@
+__version__ = '0.1.0'

amsdal_storages/s3/storage.py

@@ -0,0 +1,201 @@
+from __future__ import annotations
+
+import io
+import os
+from contextlib import asynccontextmanager
+from typing import IO
+from typing import Any
+from typing import BinaryIO
+
+from amsdal_models.storage.backends.db import AsyncFileWrapper
+from amsdal_models.storage.base import Storage
+from amsdal_models.storage.errors import ConfigurationError
+from amsdal_models.storage.errors import StorageError
+from amsdal_models.storage.types import FileProtocol
+from amsdal_utils.config.manager import AmsdalConfigManager
+
+
+class S3Storage(Storage):
+    """S3-backed storage implementation.
+
+    Sync methods use boto3. Async methods use aioboto3.
+    """
+
+    keeps_local_copy = False
+
+    def __init__(
+        self,
+        object_prefix: str = '',
+        presign_ttl: int = 3600,
+    ) -> None:
+        self.bucket = os.environ.get('AWS_S3_BUCKET_NAME')
+        self.region_name = os.environ.get('AWS_S3_REGION_NAME') or os.environ.get('AWS_REGION')
+        self.endpoint_url = os.environ.get('AWS_S3_ENDPOINT_URL')
+        self.access_key_id = os.environ.get('AWS_S3_ACCESS_KEY_ID') or os.environ.get('AWS_ACCESS_KEY_ID')
+        self.secret_access_key = os.environ.get('AWS_S3_SECRET_ACCESS_KEY') or os.environ.get('AWS_SECRET_ACCESS_KEY')
+        self.security_token = os.environ.get('AWS_SESSION_TOKEN') or os.environ.get('AWS_SECURITY_TOKEN')
+        self.object_prefix = object_prefix.strip('/')
+        self.presign_ttl = presign_ttl
+
+        if not self.bucket:
+            msg = 'S3Storage requires a bucket name'
+            raise ConfigurationError(msg)
+
+        try:
+            if AmsdalConfigManager().get_config().async_mode:
+                import aioboto3  # noqa: F401
+            else:
+                import boto3  # noqa: F401
+        except ImportError:
+            msg = 'S3 dependencies are missing. Install it with `pip install amsdal_storages[s3]`.'
+            raise ConfigurationError(msg) from None
+
+    @property
+    def _s3(self) -> Any:
+        import boto3
+
+        return boto3.client(
+            's3',
+            region_name=self.region_name,
+            endpoint_url=self.endpoint_url,
+            aws_access_key_id=self.access_key_id,
+            aws_secret_access_key=self.secret_access_key,
+            aws_session_token=self.security_token,
+        )
+
+    @asynccontextmanager
+    async def _async_s3(self) -> Any:
+        import aioboto3
+
+        session = aioboto3.Session()
+        async with session.client(
+            's3',
+            region_name=self.region_name,
+            endpoint_url=self.endpoint_url,
+            aws_access_key_id=self.access_key_id,
+            aws_secret_access_key=self.secret_access_key,
+            aws_session_token=self.security_token,
+        ) as client:
+            yield client
+
+    def _key(self, file: FileProtocol) -> str:
+        base = file.filename.lstrip('/')
+        return f'{self.object_prefix}/{base}' if self.object_prefix else base
+
+    def _export_kwargs(self) -> dict[str, Any]:
+        return {
+            'object_prefix': self.object_prefix,
+        }
+
+    def save(self, file: FileProtocol, content: BinaryIO) -> str:
+        import botocore.exceptions
+
+        key = self._key(file)
+
+        try:
+            self._s3.upload_fileobj(content, self.bucket, key)
+        except botocore.exceptions.ClientError as e:
+            msg = f'Failed to upload to s3://{self.bucket}/{key}: {e}'
+            raise StorageError(msg) from e
+        return key
+
+    def open(self, file: FileProtocol, mode: str = 'rb') -> IO[Any]:  # noqa: ARG002
+        import botocore.exceptions
+
+        key = self._key(file)
+
+        try:
+            obj = self._s3.get_object(Bucket=self.bucket, Key=key)
+        except botocore.exceptions.ClientError as e:
+            msg = f'Failed to open s3://{self.bucket}/{key}: {e}'
+            raise StorageError(msg) from e
+        body = obj['Body']
+
+        return body  # StreamingBody implements a file-like interface
+
+    def delete(self, file: FileProtocol) -> None:
+        import botocore.exceptions
+
+        key = self._key(file)
+
+        try:
+            self._s3.delete_object(Bucket=self.bucket, Key=key)
+        except botocore.exceptions.ClientError as e:
+            msg = f'Failed to delete s3://{self.bucket}/{key}: {e}'
+            raise StorageError(msg) from e
+
+    def exists(self, file: FileProtocol) -> bool:
+        import botocore.exceptions
+
+        key = self._key(file)
+
+        try:
+            self._s3.head_object(Bucket=self.bucket, Key=key)
+            return True
+        except botocore.exceptions.ClientError as e:
+            code = e.response.get('Error', {}).get('Code')
+            if code in {'404', 'NotFound', 'NoSuchKey'}:
+                return False
+            raise
+
+    def url(self, file: FileProtocol) -> str:
+        key = self._key(file)
+
+        # fall back to presigned URL
+        return self._s3.generate_presigned_url(
+            'get_object',
+            Params={'Bucket': self.bucket, 'Key': key},
+            ExpiresIn=self.presign_ttl,
+        )
+
+    async def asave(self, file: FileProtocol, content: BinaryIO) -> str:
+        key = self._key(file)
+
+        async with self._async_s3() as client:
+            try:
+                await client.upload_fileobj(content, self.bucket, key)
+            except Exception as e:  # pragma: no cover - network dependent
+                msg = f'Failed to upload to s3://{self.bucket}/{key}: {e}'
+                raise StorageError(msg) from e
+        return key
+
+    async def aopen(self, file: FileProtocol, mode: str = 'rb') -> AsyncFileWrapper:  # noqa: ARG002
+        key = self._key(file)
+
+        async with self._async_s3() as client:
+            try:
+                obj = await client.get_object(Bucket=self.bucket, Key=key)
+                body = await obj['Body'].read()
+            except Exception as e:  # pragma: no cover
+                await client.__aexit__(None, None, None)
+                msg = f'Failed to open s3://{self.bucket}/{key}: {e}'
+                raise StorageError(msg) from e
+        return AsyncFileWrapper(io.BytesIO(body))
+
+    async def adelete(self, file: FileProtocol) -> None:
+        key = self._key(file)
+
+        async with self._async_s3() as client:
+            await client.delete_object(Bucket=self.bucket, Key=key)
+
+    async def aexists(self, file: FileProtocol) -> bool:
+        key = self._key(file)
+
+        async with self._async_s3() as client:
+            try:
+                await client.head_object(Bucket=self.bucket, Key=key)
+                return True
+            except Exception as e:  # pragma: no cover
+                # aiobotocore raises ClientError similarly; detect 404-ish
+                msg = getattr(e, 'response', {}).get('Error', {}).get('Code') if hasattr(e, 'response') else None
+                if msg in {'404', 'NotFound', 'NoSuchKey'}:
+                    return False
+                raise
+
+    async def aurl(self, file: FileProtocol) -> str:
+        key = self._key(file)
+
+        async with self._async_s3() as client:
+            return await client.generate_presigned_url(
+                'get_object', Params={'Bucket': self.bucket, 'Key': key}, ExpiresIn=self.presign_ttl
+            )

amsdal_storages-0.1.0.dist-info/METADATA

@@ -0,0 +1,60 @@
+Metadata-Version: 2.4
+Name: amsdal_storages
+Version: 0.1.0
+Summary: amsdal_storages plugin for AMSDAL Framework
+Requires-Python: >=3.11
+Requires-Dist: amsdal-models>=0.5.16
+Requires-Dist: amsdal[cli]==0.5.10
+Provides-Extra: s3
+Requires-Dist: aioboto3>=11.0.0; extra == 's3'
+Requires-Dist: boto3; extra == 's3'
+Description-Content-Type: text/markdown
+
+# amsdal_storages
+
+This plugin provides implementations of the Storage backends for AMSDAL.
+
+## Plugin Structure
+
+- `pyproject.toml` - Plugin configuration file
+- `config.yml` - Configuration for connections
+
+## Installing this Plugin
+
+To use this plugin in an AMSDAL application:
+
+1. Copy the plugin directory to your AMSDAL application
+2. Import the models and transactions as needed
+3. Register the plugin in your application configuration
+
+## Development
+
+This plugin uses sync mode.
+
+### Adding Models
+
+```bash
+amsdal generate model ModelName --format py
+```
+
+### Adding Properties
+
+```bash
+amsdal generate property --model ModelName property_name
+```
+
+### Adding Transactions
+
+```bash
+amsdal generate transaction TransactionName
+```
+
+### Adding Hooks
+
+```bash
+amsdal generate hook --model ModelName on_create
+```
+
+## Testing
+
+Test your plugin by integrating it with an AMSDAL application and running the application's test suite.

amsdal_storages-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+amsdal_storages/Third-Party Materials - AMSDAL Dependencies - License Notices.md,sha256=uHJlGG0D4tbpUi8cq-497NNO9ltQ67a5448k-T14HTw,68241
+amsdal_storages/__about__.py,sha256=IMjkMO3twhQzluVTo8Z6rE7Eg-9U79_LGKMcsWLKBkY,22
+amsdal_storages/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+amsdal_storages/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+amsdal_storages/s3/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+amsdal_storages/s3/storage.py,sha256=8rccyJOLdl6uhVb-VkRZ4eeZpWhm6jjo8SNY9exnHx4,7196
+amsdal_storages-0.1.0.dist-info/METADATA,sha256=J66_rv0_gS_GI2S4sFOSL9C1nFgNQz9ARNudPAF8xv8,1286
+amsdal_storages-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+amsdal_storages-0.1.0.dist-info/RECORD,,

amsdal_storages-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any