fastapi-rtk 0.2.27__py3-none-any.whl → 1.0.13__py3-none-any.whl

fastapi_rtk/file_managers/s3_file_manager.py

@@ -1,5 +1,8 @@
+import typing
+
 from ..bases.file_manager import AbstractFileManager
 from ..const import logger
+from ..utils import smart_run
 
 __all__ = ["S3FileManager"]
 
@@ -11,20 +14,58 @@ class S3FileManager(AbstractFileManager):
 
     def __init__(
         self,
-        base_path=None,
-        allowed_extensions=None,
-        namegen=None,
-        permission=None,
-        bucket_name=None,
-        bucket_subfolder=None,
-        access_key=None,
-        secret_key=None,
+        base_path: str | None = None,
+        allowed_extensions: list[str] | None = None,
+        namegen: typing.Callable[[str], str] | None = None,
+        permission: int | None = None,
+        bucket_name: str | None = None,
+        bucket_subfolder: str | None = None,
+        access_key: str | None = None,
+        secret_key: str | None = None,
+        open_params: dict[str, typing.Any] | None = None,
+        boto3_client: typing.Any | None = None,
     ):
+        """
+        Initializes the S3FileManager.
+
+        Args:
+            base_path (str | None, optional): URL path to the S3 bucket. Defaults to None.
+            allowed_extensions (list[str] | None, optional): Allowed file extensions. Defaults to None.
+            namegen (typing.Callable[[str], str] | None, optional): Callable for generating file names. Defaults to None.
+            permission (int | None, optional): File permission settings. Defaults to None.
+            bucket_name (str | None, optional): Name of the S3 bucket. Defaults to None.
+            bucket_subfolder (str | None, optional): Subfolder within the S3 bucket. Defaults to None.
+            access_key (str | None, optional): AWS access key. Needed for default boto3 client in order to delete files. Defaults to None.
+            secret_key (str | None, optional): AWS secret key. Needed for default boto3 client in order to delete files. Defaults to None.
+            open_params (dict[str, typing.Any] | None, optional): Parameters for opening files. Defaults to None.
+            boto3_client (typing.Any | None, optional): Boto3 client instance. If None, a new client will be created. Defaults to None.
+        Raises:
+            ImportError: If required libraries are not installed.
+        """
         super().__init__(base_path, allowed_extensions, namegen, permission)
+
+        try:
+            import boto3
+            import smart_open
+
+            self.smart_open = smart_open
+            self.boto3 = boto3
+        except ImportError:
+            raise ImportError(
+                "smart_open is required for S3FileManager. "
+                "Please install it with 'pip install smart_open[s3]'."
+            )
+
         self.bucket_name = bucket_name
         self.bucket_subfolder = bucket_subfolder
         self.access_key = access_key
         self.secret_key = secret_key
+        self.open_params = open_params or {}
+        self.boto3_client = boto3_client or self.boto3.client(
+            "s3",
+            aws_access_key_id=self.access_key,
+            aws_secret_access_key=self.secret_key,
+        )
 
         if not self.bucket_name:
             logger.warning(
@@ -38,48 +79,41 @@ class S3FileManager(AbstractFileManager):
                 "Files may not be able to be deleted"
             )
 
-        try:
-            import boto3
-            import smart_open
-
-            self.smart_open = smart_open
-            self.boto3 = boto3
-        except ImportError:
-            raise ImportError(
-                "smart_open is required for S3FileManager. "
-                "Please install it with 'pip install smart_open[s3]'."
-            )
-
     def get_path(self, filename):
         return self.base_path + "/" + filename
 
     def get_file(self, filename):
-        with self.smart_open.open(self.get_path(filename), "rb") as f:
+        with self.smart_open.open(
+            self.get_path(filename), "rb", **self.open_params
+        ) as f:
             return f.read()
 
     async def stream_file(self, filename):
-        with self.smart_open.open(self.get_path(filename), "rb") as f:
-            while chunk := f.read(8192):
+        with self.smart_open.open(
+            self.get_path(filename), "rb", **self.open_params
+        ) as f:
+            while chunk := await smart_run(f.read, 8192):
                 yield chunk
 
     def save_file(self, file_data, filename):
-        with self.smart_open.open(self.get_path(filename), "wb") as f:
+        path = self.get_path(filename)
+        with self.smart_open.open(path, "wb", **self.open_params) as f:
             f.write(file_data.file.read())
+        return path
 
     def save_content_to_file(self, content, filename):
-        with self.smart_open.open(self.get_path(filename), "wb") as f:
+        path = self.get_path(filename)
+        with self.smart_open.open(path, "wb", **self.open_params) as f:
             f.write(content)
+        return path
 
     def delete_file(self, filename):
         path = self.get_path(filename)
         try:
-            self.smart_open.open(path, "rb").close()  # Check if file exists
-            s3 = self.boto3.client(
-                "s3",
-                aws_access_key_id=self.access_key,
-                aws_secret_access_key=self.secret_key,
-            )
-            s3.delete_object(
+            self.smart_open.open(
+                path, "rb", **self.open_params
+            ).close()  # Check if file exists
+            self.boto3_client.delete_object(
                 Bucket=self.bucket_name,
                 Key=f"{self.bucket_subfolder}/{filename}"
                 if self.bucket_subfolder
@@ -91,7 +125,7 @@ class S3FileManager(AbstractFileManager):
     def file_exists(self, filename):
         path = self.get_path(filename)
         try:
-            with self.smart_open.open(path, "rb"):
+            with self.smart_open.open(path, "rb", **self.open_params):
                 return True
         except FileNotFoundError:
             return False
@@ -105,6 +139,8 @@ class S3FileManager(AbstractFileManager):
             else subfolder,
             access_key=self.access_key,
             secret_key=self.secret_key,
+            open_params=self.open_params,
+            boto3_client=self.boto3_client,
             *args,
             **kwargs,
         )

fastapi_rtk/globals.py

@@ -52,8 +52,6 @@ from .const import (
     BEARER_STRATEGY_CONFIG,
     COOKIE_CONFIG,
     COOKIE_STRATEGY_CONFIG,
-    DEFAULT_ADMIN_ROLE,
-    DEFAULT_PUBLIC_ROLE,
 )
 from .utils import lazy, lazy_import
 
@@ -85,14 +83,6 @@ class Globals:
     """
     The configuration settings for the FastAPI React Toolkit.
     """
-    admin_role: str
-    """
-    The role key for the admin role. Default is `"Admin"`.
-    """
-    public_role: str
-    """
-    The role key for the public role. Default is `"Public"`.
-    """
     is_migrate: bool
     """
     A boolean value to indicate if the application is in migration mode. `True` when you are running a command from `fastapi-rtk` CLI.
@@ -105,6 +95,10 @@ class Globals:
     """
     The background tasks object to add tasks to be executed after the response is sent. It will be `None` when not used in a request context.
     """
+    request: Request
+    """
+    The current request object. It will be `None` when not used in a request context.
+    """
     file_manager: "AbstractFileManager"
     """
     The file manager object to manage files in the application. Defaults to `FileManager` from `fastapi_rtk.file_managers.file_manager`.
@@ -119,6 +113,24 @@ class Globals:
         object.__setattr__(self, "_vars", {})
         object.__setattr__(self, "_defaults", {})
 
+    @property
+    def admin_role(self):
+        """
+        The role key for the admin role. Default is `"Admin"`.
+        """
+        from .setting import Setting
+
+        return Setting.AUTH_ROLE_ADMIN
+
+    @property
+    def public_role(self):
+        """
+        The role key for the public role. Default is `"Public"`.
+        """
+        from .setting import Setting
+
+        return Setting.AUTH_ROLE_PUBLIC
+
     def set_default(self, name: str, default: Any) -> None:
         """Set a default value for a variable."""
 
@@ -236,8 +248,6 @@ g.set_default(
     "auth", lazy_import("fastapi_rtk.auth", lambda mod: mod.AuthConfigurator())
 )
 g.set_default("config", Config())
-g.set_default("admin_role", DEFAULT_ADMIN_ROLE)
-g.set_default("public_role", DEFAULT_PUBLIC_ROLE)
 g.set_default("is_migrate", False)
 g.set_default("sensitive_data", {"User": ["password", "hashed_password"]})
 g.set_default(

fastapi_rtk/lang/__init__.py

@@ -0,0 +1,3 @@
+from .lazy_text import *
+
+__all__ = ["lazy_text", "translate", "_"]

fastapi_rtk/lang/babel/__init__.py

@@ -0,0 +1,4 @@
+from .cli import *
+from .config import *
+
+__all__ = ["FastAPIRTKBabelCLI", "FastAPIRTKBabelConfigs"]

fastapi_rtk/lang/babel/cli.py

@@ -0,0 +1,40 @@
+from subprocess import run
+
+import fastapi_babel
+
+__all__ = ["FastAPIRTKBabelCLI"]
+
+
+class FastAPIRTKBabelCLI(fastapi_babel.BabelCli):
+    """
+    Subclass of `fastapi_babel.BabelCli`.
+
+    - Modified `extract` method to handle custom keywords.
+    """
+
+    def extract(self, watch_dir, keywords: str | None = None):
+        """
+        Modified version of the default `extract` method to handle custom keywords too.
+
+        extract all messages that annotated using gettext/_
+        in the specified directory.
+
+        for first time will create messages.pot file into the root
+        directory.
+
+        Args:
+            watch_dir (str): directory to extract messages.
+            keywords (str | None): custom keywords to extract separated by space.
+        """
+        args = [
+            self.__module_name__,
+            "extract",
+            "-F",
+            self.babel.config.BABEL_CONFIG_FILE,
+            "-o",
+            self.babel.config.BABEL_MESSAGE_POT_FILE,
+        ]
+        if keywords:
+            args.extend(["-k", keywords])
+        args.append(watch_dir)
+        run(args)

fastapi_rtk/lang/babel/config.py

@@ -0,0 +1,17 @@
+import os
+
+import fastapi_babel
+
+__all__ = ["FastAPIRTKBabelConfigs"]
+
+
+class FastAPIRTKBabelConfigs(fastapi_babel.BabelConfigs):
+    """
+    Subclass of `fastapi_babel.BabelConfigs`.
+
+    - Modified `ROOT_DIR` to not use its parent directory.
+    """
+
+    def __post_init__(self):
+        self.ROOT_DIR = os.path.join(self.ROOT_DIR, "dummy")
+        return super().__post_init__()

fastapi_rtk/lang/babel.cfg

@@ -0,0 +1 @@
+[python: **/*.py]

fastapi_rtk/lang/lazy_text.py

@@ -0,0 +1,120 @@
+import fastapi_babel
+
+from ..utils import lazy, use_default_when_none
+
+__all__ = ["lazy_text", "translate", "_"]
+
+logger = None
+
+
+class lazy_text(lazy[str]):
+    """
+    Lazily translates a message using FastAPI Babel.
+    """
+
+    def __init__(self, message: str, *args, **kwargs):
+        """
+        Initializes a lazy_text instance that lazily translates the given message.
+
+        Args:
+            message (str): the message to be translated.
+            *args: positional arguments to format the message.
+            **kwargs: keyword arguments to format the message.
+        """
+        super().__init__(
+            lambda: translate(message).format(*args, **kwargs),
+            cache=False,
+            only_instance=True,
+        )
+
+    @classmethod
+    def _(cls, message: str, *args, **kwargs):
+        """
+        Class method to create a lazy_text instance that can be automatically found by `pybabel extract`.
+
+        Args:
+            message (str): the message to be translated.
+            *args: positional arguments to format the message.
+            **kwargs: keyword arguments to format the message.
+
+        Returns:
+            lazy_text: an instance of lazy_text that will lazily translate the message.
+        """
+        return cls(message, *args, **kwargs)
+
+    def __repr__(self):
+        """
+        When reading it as a string, it should return the formatted message.
+
+        Returns:
+            str: the formatted message.
+        """
+        return self.__call__()
+
+
+def translate(
+    message: str, *args, ensure_context=False, use_settings_translations=True, **kwargs
+):
+    """
+    Translates a message using FastAPI Babel.
+
+    Args:
+        message (str): the message to be translated.
+        *args: positional arguments to format the message.
+        ensure_context (bool): Whether to ensure the context is already set to know which language to use. If false, it will return the message as is if the translation is not found. Defaults to False.
+        use_translations (bool): Whether to use the translations defined in `Setting.TRANSLATIONS` as a fallback if the translation is not found. Defaults to True.
+        **kwargs: keyword arguments to format the message.
+
+    Returns:
+        str: the translated message.
+    """
+    try:
+        translated_message = fastapi_babel._(message)
+        if translated_message == message and use_settings_translations:
+            translated_message = use_default_when_none(
+                _use_settings_translations(message), message
+            )
+        return translated_message.format(*args, **kwargs)
+    except LookupError as e:
+        if not ensure_context:
+            from ..globals import g
+
+            if g.current_app and g.current_app.started:
+                global logger
+                if not logger:
+                    from ..const import logger as base_logger
+
+                    logger = base_logger.getChild("lang")
+
+                logger.warning(
+                    f"Translation not found for '{message}'. Returning the original message."
+                )
+            return message.format(*args, **kwargs)
+        raise e
+
+
+def _use_settings_translations(message: str):
+    """
+    Use translations defined in `Setting.TRANSLATIONS` as a fallback if the translation is not found.
+
+    Args:
+        message (str): The original message to translate.
+
+    Returns:
+        str | None: The translated message, or None if no translation is found.
+    """
+    from ..globals import g
+    from ..setting import Setting
+
+    if Setting.TRANSLATIONS and g.request:
+        try:
+            translated_message = Setting.TRANSLATIONS.get(
+                g.request.state.babel.locale, {}
+            ).get(message)
+            if translated_message:
+                return translated_message
+        except Exception:
+            pass
+
+
+_ = translate  # Alias for convenience

fastapi_rtk/lang/messages.pot

@@ -0,0 +1,238 @@
+# Translations template for PROJECT.
+# Copyright (C) 2025 ORGANIZATION
+# This file is distributed under the same license as the PROJECT project.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PROJECT VERSION\n"
+"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
+"POT-Creation-Date: 2025-10-30 10:07+0100\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.17.0\n"
+
+#: fastapi_rtk/schemas.py:419
+msgid "Columns must be a list"
+msgstr ""
+
+#: fastapi_rtk/schemas.py:429
+msgid "Invalid columns: Not a valid JSON string"
+msgstr ""
+
+#: fastapi_rtk/schemas.py:452
+msgid "Both 'order_column' and 'order_direction' must be filled or empty"
+msgstr ""
+
+#: fastapi_rtk/schemas.py:470
+msgid "Filters must be a list"
+msgstr ""
+
+#: fastapi_rtk/schemas.py:485
+msgid "Filter must be an object"
+msgstr ""
+
+#: fastapi_rtk/schemas.py:495
+msgid "Invalid filters: Not a valid JSON string"
+msgstr ""
+
+#: fastapi_rtk/schemas.py:520
+msgid "Opr Filters must be a list"
+msgstr ""
+
+#: fastapi_rtk/schemas.py:535
+msgid "Opr Filter must be an object"
+msgstr ""
+
+#: fastapi_rtk/schemas.py:545
+msgid "Invalid opr_filters: Not a valid JSON string"
+msgstr ""
+
+#: fastapi_rtk/api/model_rest_api.py:476
+#, python-brace-format
+msgid "List {ModelName}"
+msgstr ""
+
+#: fastapi_rtk/api/model_rest_api.py:485
+#, python-brace-format
+msgid "Show {ModelName}"
+msgstr ""
+
+#: fastapi_rtk/api/model_rest_api.py:494
+#, python-brace-format
+msgid "Add {ModelName}"
+msgstr ""
+
+#: fastapi_rtk/api/model_rest_api.py:503
+#, python-brace-format
+msgid "Edit {ModelName}"
+msgstr ""
+
+#: fastapi_rtk/api/model_rest_api.py:1395
+msgid "OK"
+msgstr ""
+
+#: fastapi_rtk/api/model_rest_api.py:2411
+#: fastapi_rtk/api/model_rest_api.py:2810
+#, python-brace-format
+msgid "Number of items in '{column}' does not match the number of items found."
+msgstr ""
+
+#: fastapi_rtk/api/model_rest_api.py:2432
+#, python-brace-format
+msgid "Could not find related item for column '{column}'"
+msgstr ""
+
+#: fastapi_rtk/api/model_rest_api.py:2464
+#, python-brace-format
+msgid "File type from '{filename}' is not allowed."
+msgstr ""
+
+#: fastapi_rtk/api/model_rest_api.py:2872
+#, python-brace-format
+msgid "Invalid column: {column}"
+msgstr ""
+
+#: fastapi_rtk/api/model_rest_api.py:2882
+#, python-brace-format
+msgid "Invalid filter: {column}"
+msgstr ""
+
+#: fastapi_rtk/backends/generic/db.py:66 fastapi_rtk/backends/sqla/db.py:163
+#, python-brace-format
+msgid "Invalid filter operator: {operator}"
+msgstr ""
+
+#: fastapi_rtk/backends/generic/db.py:90 fastapi_rtk/backends/sqla/db.py:194
+#, python-brace-format
+msgid "Invalid opr_filter operator: {operator}"
+msgstr ""
+
+#: fastapi_rtk/backends/generic/filters.py:81
+#: fastapi_rtk/backends/sqla/filters.py:243
+msgid "Text contains"
+msgstr ""
+
+#: fastapi_rtk/backends/generic/filters.py:89
+#: fastapi_rtk/backends/sqla/filters.py:259
+msgid "Equal to"
+msgstr ""
+
+#: fastapi_rtk/backends/generic/filters.py:117
+#: fastapi_rtk/backends/sqla/filters.py:277
+msgid "Starts with"
+msgstr ""
+
+#: fastapi_rtk/backends/generic/filters.py:126
+#: fastapi_rtk/backends/sqla/filters.py:286
+msgid "Not Starts with"
+msgstr ""
+
+#: fastapi_rtk/backends/generic/filters.py:135
+#: fastapi_rtk/backends/sqla/filters.py:295
+msgid "Ends with"
+msgstr ""
+
+#: fastapi_rtk/backends/generic/filters.py:144
+#: fastapi_rtk/backends/sqla/filters.py:304
+msgid "Not Ends with"
+msgstr ""
+
+#: fastapi_rtk/backends/generic/filters.py:153
+#: fastapi_rtk/backends/sqla/filters.py:313
+msgid "Contains"
+msgstr ""
+
+#: fastapi_rtk/backends/generic/filters.py:162
+msgid "Contains (insensitive)"
+msgstr ""
+
+#: fastapi_rtk/backends/generic/filters.py:171
+#: fastapi_rtk/backends/sqla/filters.py:322
+msgid "Not Contains"
+msgstr ""
+
+#: fastapi_rtk/backends/generic/filters.py:180
+#: fastapi_rtk/backends/sqla/filters.py:331
+msgid "Greater than"
+msgstr ""
+
+#: fastapi_rtk/backends/generic/filters.py:189
+#: fastapi_rtk/backends/sqla/filters.py:340
+msgid "Smaller than"
+msgstr ""
+
+#: fastapi_rtk/backends/generic/filters.py:198
+#: fastapi_rtk/backends/sqla/filters.py:349
+msgid "Greater equal"
+msgstr ""
+
+#: fastapi_rtk/backends/generic/filters.py:207
+#: fastapi_rtk/backends/sqla/filters.py:358
+msgid "Smaller equal"
+msgstr ""
+
+#: fastapi_rtk/backends/generic/filters.py:216
+#: fastapi_rtk/backends/sqla/filters.py:367
+msgid "One of"
+msgstr ""
+
+#: fastapi_rtk/backends/generic/filters.py:225
+#: fastapi_rtk/backends/sqla/filters.py:470
+msgid "Global Filter"
+msgstr ""
+
+#: fastapi_rtk/backends/sqla/filters.py:268
+msgid "Not equal to"
+msgstr ""
+
+#: fastapi_rtk/backends/sqla/filters.py:376
+msgid "Between"
+msgstr ""
+
+#: fastapi_rtk/backends/sqla/filters.py:389
+msgid "Between filter requires 2 values"
+msgstr ""
+
+#: fastapi_rtk/backends/sqla/filters.py:434
+msgid "In"
+msgstr ""
+
+#: fastapi_rtk/backends/sqla/filters.py:452
+msgid "Not In"
+msgstr ""
+
+#: fastapi_rtk/backends/sqla/extensions/geoalchemy2/filters.py:83
+msgid "Intersects"
+msgstr ""
+
+#: fastapi_rtk/backends/sqla/extensions/geoalchemy2/filters.py:93
+msgid "Not Intersects"
+msgstr ""
+
+#: fastapi_rtk/backends/sqla/extensions/geoalchemy2/filters.py:103
+msgid "Overlaps"
+msgstr ""
+
+#: fastapi_rtk/backends/sqla/extensions/geoalchemy2/filters.py:113
+msgid "Not Overlaps"
+msgstr ""
+
+#: fastapi_rtk/bases/db.py:463
+#, python-brace-format
+msgid "Invalid ID: {id}, expected {count} values"
+msgstr ""
+
+#: fastapi_rtk/bases/db.py:476
+msgid "Invalid ID"
+msgstr ""
+
+#: fastapi_rtk/security/sqla/apis.py:299
+msgid "User updated successfully."
+msgstr ""
+