python3-commons 0.8.35__py3-none-any.whl → 0.9.0__py3-none-any.whl

python3_commons/audit.py

@@ -5,23 +5,21 @@ import tarfile
 from bz2 import BZ2Compressor
 from collections import deque
 from datetime import UTC, datetime, timedelta
-from typing import Generator, Iterable
+from typing import AsyncGenerator
 from uuid import uuid4
 
 from lxml import etree
-from minio import S3Error
 from zeep.plugins import Plugin
 from zeep.wsdl.definitions import AbstractOperation
 
 from python3_commons import object_storage
 from python3_commons.conf import S3Settings, s3_settings
-from python3_commons.object_storage import ObjectStorage
 
 logger = logging.getLogger(__name__)
 
 
 class GeneratedStream(io.BytesIO):
-    def __init__(self, generator: Generator[bytes, None, None], *args, **kwargs):
+    def __init__(self, generator: AsyncGenerator[bytes], *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.generator = generator
 
@@ -29,7 +27,7 @@ class GeneratedStream(io.BytesIO):
         if size < 0:
             while True:
                 try:
-                    chunk = next(self.generator)
+                    chunk = anext(self.generator)
                 except StopIteration:
                     break
                 else:
@@ -39,7 +37,7 @@ class GeneratedStream(io.BytesIO):
 
             while total_written_size < size:
                 try:
-                    chunk = next(self.generator)
+                    chunk = anext(self.generator)
                 except StopIteration:
                     break
                 else:
@@ -67,17 +65,17 @@ class GeneratedStream(io.BytesIO):
         return True
 
 
-def generate_archive(
-    objects: Iterable[tuple[str, datetime, bytes]], chunk_size: int = 4096
-) -> Generator[bytes, None, None]:
+async def generate_archive(
+    objects: AsyncGenerator[tuple[str, datetime, bytes]], chunk_size: int = 4096
+) -> AsyncGenerator[bytes]:
     buffer = deque()
 
     with tarfile.open(fileobj=buffer, mode='w') as archive:
-        for name, last_modified, content in objects:
+        async for name, last_modified, content in objects:
             logger.info(f'Adding {name} to archive')
             info = tarfile.TarInfo(name)
             info.size = len(content)
-            info.mtime = last_modified.timestamp()
+            info.mtime = int(last_modified.timestamp())
             archive.addfile(info, io.BytesIO(content))
 
             buffer_length = buffer.tell()
@@ -109,10 +107,10 @@ def generate_archive(
     buffer.truncate(0)
 
 
-def generate_bzip2(chunks: Generator[bytes, None, None]) -> Generator[bytes, None, None]:
+async def generate_bzip2(chunks: AsyncGenerator[bytes]) -> AsyncGenerator[bytes]:
     compressor = BZ2Compressor()
 
-    for chunk in chunks:
+    async for chunk in chunks:
         if compressed_chunk := compressor.compress(chunk):
             yield compressed_chunk
 
@@ -120,14 +118,13 @@ def generate_bzip2(chunks: Generator[bytes, None, None]) -> Generator[bytes, Non
         yield compressed_chunk
 
 
-def write_audit_data_sync(settings: S3Settings, key: str, data: bytes):
+async def write_audit_data(settings: S3Settings, key: str, data: bytes):
     if settings.s3_secret_access_key:
         try:
-            client = ObjectStorage(settings).get_client()
             absolute_path = object_storage.get_absolute_path(f'audit/{key}')
 
-            client.put_object(settings.s3_bucket, absolute_path, io.BytesIO(data), len(data))
-        except S3Error as e:
+            await object_storage.put_object(settings.s3_bucket, absolute_path, io.BytesIO(data), len(data))
+        except Exception as e:
             logger.error(f'Failed storing object in storage: {e}')
         else:
             logger.debug(f'Stored object in storage: {key}')
@@ -135,10 +132,6 @@ def write_audit_data_sync(settings: S3Settings, key: str, data: bytes):
         logger.debug(f'S3 is not configured, not storing object in storage: {key}')
 
 
-async def write_audit_data(settings: S3Settings, key: str, data: bytes):
-    await asyncio.to_thread(write_audit_data_sync, settings, key, data)
-
-
 async def archive_audit_data(root_path: str = 'audit'):
     now = datetime.now(tz=UTC) - timedelta(days=1)
     year = now.year
@@ -155,9 +148,9 @@ async def archive_audit_data(root_path: str = 'audit'):
         archive_stream = GeneratedStream(bzip2_generator)
 
         archive_path = object_storage.get_absolute_path(f'audit/.archive/{year}_{month:02}_{day:02}.tar.bz2')
-        object_storage.put_object(bucket_name, archive_path, archive_stream, -1, part_size=5 * 1024 * 1024)
+        await object_storage.put_object(bucket_name, archive_path, archive_stream, -1, part_size=5 * 1024 * 1024)
 
-        if errors := object_storage.remove_objects(bucket_name, date_path):
+        if errors := await object_storage.remove_objects(bucket_name, date_path):
             for error in errors:
                 logger.error(f'Failed to delete object in {bucket_name=}: {error}')
 

python3_commons/conf.py

@@ -64,8 +64,8 @@ class DBSettings(BaseSettings):
 class S3Settings(BaseSettings):
     s3_endpoint_url: str | None = None
     s3_region_name: str | None = None
-    s3_access_key_id: SecretStr = ''
-    s3_secret_access_key: SecretStr = ''
+    s3_access_key_id: SecretStr = SecretStr('')
+    s3_secret_access_key: SecretStr = SecretStr('')
     s3_secure: bool = True
     s3_bucket: str | None = None
     s3_bucket_root: str | None = None

python3_commons/db/models/__init__.py

@@ -1,2 +1,8 @@
-from python3_commons.db.models.auth import ApiKey, User, UserGroup
-from python3_commons.db.models.rbac import RBACApiKeyRole, RBACPermission, RBACRole, RBACRolePermission, RBACUserRole
+from python3_commons.db.models.auth import ApiKey as ApiKey
+from python3_commons.db.models.auth import User as User
+from python3_commons.db.models.auth import UserGroup as UserGroup
+from python3_commons.db.models.rbac import RBACApiKeyRole as RBACApiKeyRole
+from python3_commons.db.models.rbac import RBACPermission as RBACPermission
+from python3_commons.db.models.rbac import RBACRole as RBACRole
+from python3_commons.db.models.rbac import RBACRolePermission as RBACRolePermission
+from python3_commons.db.models.rbac import RBACUserRole as RBACUserRole

python3_commons/helpers.py

@@ -1,6 +1,8 @@
 import logging
 import shlex
 import threading
+from abc import ABCMeta
+from collections import defaultdict
 from datetime import date, datetime, timedelta
 from decimal import ROUND_HALF_UP, Decimal
 from json import dumps
@@ -12,24 +14,24 @@ from python3_commons.serializers.json import CustomJSONEncoder
 logger = logging.getLogger(__name__)
 
 
-class SingletonMeta(type):
+class SingletonMeta(ABCMeta):
     """
     A metaclass that creates a Singleton base class when called.
     """
 
-    _instances = {}
-    _lock = threading.Lock()
+    __instances = {}
+    __locks = defaultdict(threading.Lock)
 
     def __call__(cls, *args, **kwargs):
         try:
-            return cls._instances[cls]
+            return cls.__instances[cls]
         except KeyError:
-            with cls._lock:
+            with cls.__locks[cls]:
                 try:
-                    return cls._instances[cls]
+                    return cls.__instances[cls]
                 except KeyError:
                     instance = super(SingletonMeta, cls).__call__(*args, **kwargs)
-                    cls._instances[cls] = instance
+                    cls.__instances[cls] = instance
 
                     return instance
 

python3_commons/object_storage.py

@@ -1,12 +1,16 @@
+from __future__ import annotations
+
 import io
 import logging
-from contextlib import contextmanager
+from contextlib import asynccontextmanager
 from datetime import datetime
-from typing import Generator, Iterable
+from typing import TYPE_CHECKING, AsyncGenerator, Iterable, Mapping, Sequence
+
+import aiobotocore.session
+from aiobotocore.response import StreamingBody
 
-from minio import Minio
-from minio.datatypes import Object
-from minio.deleteobjects import DeleteError, DeleteObject
+if TYPE_CHECKING:
+    from types_aiobotocore_s3.client import S3Client
 
 from python3_commons.conf import S3Settings, s3_settings
 from python3_commons.helpers import SingletonMeta
@@ -16,20 +20,23 @@ logger = logging.getLogger(__name__)
 
 class ObjectStorage(metaclass=SingletonMeta):
     def __init__(self, settings: S3Settings):
-        if not s3_settings.s3_endpoint_url:
-            raise ValueError('s3_settings.s3_endpoint_url must be set')
+        if not settings.s3_endpoint_url:
+            raise ValueError('s3_endpoint_url must be set')
 
-        self._client = Minio(
-            settings.s3_endpoint_url,
-            region=settings.s3_region_name,
-            access_key=settings.s3_access_key_id.get_secret_value(),
-            secret_key=settings.s3_secret_access_key.get_secret_value(),
-            secure=settings.s3_secure,
-            cert_check=settings.s3_cert_verify,
-        )
+        self._session = aiobotocore.session.get_session()
+        self._config = {
+            'endpoint_url': settings.s3_endpoint_url,
+            'region_name': settings.s3_region_name,
+            'aws_access_key_id': settings.s3_access_key_id.get_secret_value(),
+            'aws_secret_access_key': settings.s3_secret_access_key.get_secret_value(),
+            'use_ssl': settings.s3_secure,
+            'verify': settings.s3_cert_verify,
+        }
 
-    def get_client(self) -> Minio:
-        return self._client
+    @asynccontextmanager
+    async def get_client(self) -> AsyncGenerator[S3Client, None]:
+        async with self._session.create_client('s3', **self._config) as client:
+            yield client
 
 
 def get_absolute_path(path: str) -> str:
@@ -42,86 +49,135 @@ def get_absolute_path(path: str) -> str:
     return path
 
 
-def put_object(bucket_name: str, path: str, data: io.BytesIO, length: int, part_size: int = 0) -> str | None:
-    if s3_client := ObjectStorage(s3_settings).get_client():
-        result = s3_client.put_object(bucket_name, path, data, length, part_size=part_size)
+async def put_object(bucket_name: str, path: str, data: io.BytesIO, length: int, part_size: int = 0) -> str | None:
+    storage = ObjectStorage(s3_settings)
+
+    async with storage.get_client() as s3_client:
+        try:
+            data.seek(0)
+
+            await s3_client.put_object(Bucket=bucket_name, Key=path, Body=data, ContentLength=length)
+
+            logger.debug(f'Stored object into object storage: {bucket_name}:{path}')
+
+            return f's3://{bucket_name}/{path}'
 
-        logger.debug(f'Stored object into object storage: {bucket_name}:{path}')
+        except Exception as e:
+            logger.error(f'Failed to put object to object storage: {bucket_name}:{path}', exc_info=e)
 
-        return result.location
-    else:
-        logger.warning('No S3 client available, skipping object put')
+            return None
 
 
-@contextmanager
-def get_object_stream(bucket_name: str, path: str):
-    if s3_client := ObjectStorage(s3_settings).get_client():
+@asynccontextmanager
+async def get_object_stream(bucket_name: str, path: str) -> AsyncGenerator[StreamingBody]:
+    storage = ObjectStorage(s3_settings)
+
+    async with storage.get_client() as s3_client:
         logger.debug(f'Getting object from object storage: {bucket_name}:{path}')
 
         try:
-            response = s3_client.get_object(bucket_name, path)
+            response = await s3_client.get_object(Bucket=bucket_name, Key=path)
+
+            async with response['Body'] as stream:
+                yield stream
         except Exception as e:
             logger.debug(f'Failed getting object from object storage: {bucket_name}:{path}', exc_info=e)
 
             raise
 
-        yield response
 
-        response.close()
-        response.release_conn()
-    else:
-        logger.warning('No S3 client available, skipping object put')
-
-
-def get_object(bucket_name: str, path: str) -> bytes:
-    with get_object_stream(bucket_name, path) as stream:
-        body = stream.read()
+async def get_object(bucket_name: str, path: str) -> bytes:
+    async with get_object_stream(bucket_name, path) as stream:
+        body = await stream.read()
 
     logger.debug(f'Loaded object from object storage: {bucket_name}:{path}')
 
     return body
 
 
-def list_objects(bucket_name: str, prefix: str, recursive: bool = True) -> Generator[Object, None, None]:
-    s3_client = ObjectStorage(s3_settings).get_client()
+async def list_objects(bucket_name: str, prefix: str, recursive: bool = True) -> AsyncGenerator[Mapping, None]:
+    storage = ObjectStorage(s3_settings)
+
+    async with storage.get_client() as s3_client:
+        paginator = s3_client.get_paginator('list_objects_v2')
 
-    yield from s3_client.list_objects(bucket_name, prefix=prefix, recursive=recursive)
+        page_iterator = paginator.paginate(Bucket=bucket_name, Prefix=prefix, Delimiter='' if recursive else '/')
 
+        async for page in page_iterator:
+            if 'Contents' in page:
+                for obj in page['Contents']:
+                    yield dict(obj)
 
-def get_objects(
+
+async def get_object_streams(
     bucket_name: str, path: str, recursive: bool = True
-) -> Generator[tuple[str, datetime, bytes], None, None]:
-    for obj in list_objects(bucket_name, path, recursive):
-        object_name = obj.object_name
+) -> AsyncGenerator[tuple[str, datetime, StreamingBody], None]:
+    async for obj in list_objects(bucket_name, path, recursive):
+        object_name = obj['Key']
+        last_modified = obj['LastModified']
 
-        if obj.size:
-            data = get_object(bucket_name, object_name)
-        else:
-            data = b''
+        async with get_object_stream(bucket_name, path) as stream:
+            yield object_name, last_modified, stream
 
-        yield object_name, obj.last_modified, data
 
+async def get_objects(
+    bucket_name: str, path: str, recursive: bool = True
+) -> AsyncGenerator[tuple[str, datetime, bytes], None]:
+    async for object_name, last_modified, stream in get_object_streams(bucket_name, path, recursive):
+        data = await stream.read()
+
+        yield object_name, last_modified, data
 
-def remove_object(bucket_name: str, object_name: str):
-    s3_client = ObjectStorage(s3_settings).get_client()
-    s3_client.remove_object(bucket_name, object_name)
 
+async def remove_object(bucket_name: str, object_name: str):
+    storage = ObjectStorage(s3_settings)
 
-def remove_objects(
+    async with storage.get_client() as s3_client:
+        try:
+            await s3_client.delete_object(Bucket=bucket_name, Key=object_name)
+            logger.debug(f'Removed object from object storage: {bucket_name}:{object_name}')
+        except Exception as e:
+            logger.error(f'Failed to remove object from object storage: {bucket_name}:{object_name}', exc_info=e)
+
+            raise
+
+
+async def remove_objects(
     bucket_name: str, prefix: str = None, object_names: Iterable[str] = None
-) -> Iterable[DeleteError] | None:
-    s3_client = ObjectStorage(s3_settings).get_client()
-
-    if prefix:
-        delete_object_list = map(
-            lambda obj: DeleteObject(obj.object_name),
-            s3_client.list_objects(bucket_name, prefix=prefix, recursive=True),
-        )
-    elif object_names:
-        delete_object_list = map(DeleteObject, object_names)
-    else:
-        return None
-
-    errors = s3_client.remove_objects(bucket_name, delete_object_list)
-
-    return errors
+) -> Sequence[Mapping] | None:
+    storage = ObjectStorage(s3_settings)
+
+    async with storage.get_client() as s3_client:
+        objects_to_delete = []
+
+        if prefix:
+            async for obj in list_objects(bucket_name, prefix, recursive=True):
+                objects_to_delete.append({'Key': obj['Key']})
+        elif object_names:
+            objects_to_delete = [{'Key': name} for name in object_names]
+        else:
+            return None
+
+        if not objects_to_delete:
+            return None
+
+        try:
+            errors = []
+            # S3 delete_objects can handle up to 1000 objects at once
+            chunk_size = 1000
+
+            for i in range(0, len(objects_to_delete), chunk_size):
+                chunk = objects_to_delete[i : i + chunk_size]
+
+                response = await s3_client.delete_objects(Bucket=bucket_name, Delete={'Objects': chunk})
+
+                if 'Errors' in response:
+                    errors.extend(response['Errors'])
+
+            logger.debug(f'Removed {len(objects_to_delete)} objects from object storage: {bucket_name}')
+
+            return errors if errors else None
+        except Exception as e:
+            logger.error(f'Failed to remove objects from object storage: {bucket_name}', exc_info=e)
+
+            raise

{python3_commons-0.8.35.dist-info → python3_commons-0.9.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python3-commons
-Version: 0.8.35
+Version: 0.9.0
 Summary: Re-usable Python3 code
 Author-email: Oleg Korsak <kamikaze.is.waiting.you@gmail.com>
 License-Expression: GPL-3.0
@@ -12,12 +12,12 @@ Requires-Python: ==3.13.*
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 License-File: AUTHORS.rst
-Requires-Dist: aiohttp[speedups]~=3.12.13
+Requires-Dist: aiobotocore~=2.23.0
+Requires-Dist: aiohttp[speedups]~=3.12.14
 Requires-Dist: asyncpg~=0.30.0
 Requires-Dist: fastapi-users-db-sqlalchemy~=7.0.0
 Requires-Dist: fastapi-users[sqlalchemy]~=14.0.1
 Requires-Dist: lxml~=6.0.0
-Requires-Dist: minio~=7.2.15
 Requires-Dist: msgpack~=1.1.1
 Requires-Dist: msgspec~=0.19.0
 Requires-Dist: pydantic[email]~=2.11.7

{python3_commons-0.8.35.dist-info → python3_commons-0.9.0.dist-info}/RECORD

@@ -1,16 +1,16 @@
 python3_commons/__init__.py,sha256=0KgaYU46H_IMKn-BuasoRN3C4Hi45KlkHHoPbU9cwiA,189
 python3_commons/api_client.py,sha256=LT7_YmnYVHK2ucKxIhUJCZrmxgfy-lfOxx08-R0WvW0,4505
-python3_commons/audit.py,sha256=osx2ywZXf-V0zOkrhlNgSyzCBvojXQwSYBQ4-ze1xiM,6249
+python3_commons/audit.py,sha256=-jYGjkQ2r8rg3gj-C-5uTQ1lXhK3dRXkktonZxOs1PM,5994
 python3_commons/auth.py,sha256=vVaiJ5MHUMSbiLF6TIxe4dqVPhBlLttf940jjODL3a4,2934
 python3_commons/cache.py,sha256=lf27LTD4Z9Iqi5GaK8jH8UC0cL9sHH8wicZ88YDp6Mg,7725
-python3_commons/conf.py,sha256=JenspXyTqTlYeEb8X9Njfje1AiLCee23nm0k8zhYLfs,2283
+python3_commons/conf.py,sha256=K3GuXDp7iopHms_E-rNR4OzTBIoWSEZmMwRjxKYltTk,2305
 python3_commons/fs.py,sha256=wfLjybXndwLqNlOxTpm_HRJnuTcC4wbrHEOaEeCo9Wc,337
-python3_commons/helpers.py,sha256=ygnTv3KYoiibOFIi99-g8EXaETKHLt5i3jvykGrv6aE,3079
-python3_commons/object_storage.py,sha256=nQsXca0zzzeSY35qhnjE6pLfkLuxn7jDul0-hw0jizE,3985
+python3_commons/helpers.py,sha256=qSBQ1A02BEmIY8UPJkCoO28aZq0BPsMg6AGW9k-CThM,3166
+python3_commons/object_storage.py,sha256=eF0EOB29yFn3oVr8y0SegEVJLo1W5gJT3IYcINEtLOU,6301
 python3_commons/permissions.py,sha256=bhjTp-tq-oaTGFMHNnSBlcVX5XQCTL0nWcu6SdPEAB4,1555
 python3_commons/db/__init__.py,sha256=5nArsGm17e-pelpOwAeBKy2n_Py20XqklZsNgkcJ-DQ,2947
 python3_commons/db/helpers.py,sha256=PY0h08aLiGx-J54wmP3GHPCgGCcLd60rayAUnR3aWdI,1742
-python3_commons/db/models/__init__.py,sha256=Utr5AJf1FwcrxNtdesgjq92WMK4zpK4VL_8z1JEkJw0,185
+python3_commons/db/models/__init__.py,sha256=zjZCf0DNDkqmPZ49quJ6KZohtKH87viI_ijDG3E0PVE,554
 python3_commons/db/models/auth.py,sha256=dmyD3BX7LVBgKiepPN-bxlY6J3PhcmUfVdQwhNR45fU,1187
 python3_commons/db/models/common.py,sha256=IwrVfMQhAkPqrPmPRkG9CAB0KRa6YG_0Mogs1aafAoA,1537
 python3_commons/db/models/rbac.py,sha256=7NNTUbS8whuPUHpm4oba_UWDdNiJlHrm8HBO7oGtk64,3185
@@ -21,9 +21,9 @@ python3_commons/serializers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMp
 python3_commons/serializers/json.py,sha256=91UaXLGKGj0yPyrnuMeNrkG2GuPUgcgAsmIokUgEwpU,808
 python3_commons/serializers/msgpack.py,sha256=WrvaPE187shSK8zkH4UHHMimEZNMv9RaDSwsBE2HlCw,1269
 python3_commons/serializers/msgspec.py,sha256=0AliXlEl5sewi0UENjI8St5ZScXE5DNRERKzqWKy2Ps,2674
-python3_commons-0.8.35.dist-info/licenses/AUTHORS.rst,sha256=3R9JnfjfjH5RoPWOeqKFJgxVShSSfzQPIrEr1nxIo9Q,90
-python3_commons-0.8.35.dist-info/licenses/LICENSE,sha256=xxILuojHm4fKQOrMHPSslbyy6WuKAN2RiG74HbrYfzM,34575
-python3_commons-0.8.35.dist-info/METADATA,sha256=1bEvDnldw6teuH2wW6t9d4q05Dhupjw5g30yMJ8u3Ys,1128
-python3_commons-0.8.35.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-python3_commons-0.8.35.dist-info/top_level.txt,sha256=lJI6sCBf68eUHzupCnn2dzG10lH3jJKTWM_hrN1cQ7M,16
-python3_commons-0.8.35.dist-info/RECORD,,
+python3_commons-0.9.0.dist-info/licenses/AUTHORS.rst,sha256=3R9JnfjfjH5RoPWOeqKFJgxVShSSfzQPIrEr1nxIo9Q,90
+python3_commons-0.9.0.dist-info/licenses/LICENSE,sha256=xxILuojHm4fKQOrMHPSslbyy6WuKAN2RiG74HbrYfzM,34575
+python3_commons-0.9.0.dist-info/METADATA,sha256=ldVEpTyONYD-QMBV0ZSgYFg12IgYwa0sXJIjvtXaOI8,1133
+python3_commons-0.9.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+python3_commons-0.9.0.dist-info/top_level.txt,sha256=lJI6sCBf68eUHzupCnn2dzG10lH3jJKTWM_hrN1cQ7M,16
+python3_commons-0.9.0.dist-info/RECORD,,