fastapi-rtk 1.0.3__py3-none-any.whl → 1.0.5__py3-none-any.whl

fastapi_rtk/_version.py

@@ -0,0 +1 @@
+__version__ = "1.0.5"

fastapi_rtk/api/model_rest_api.py

@@ -2735,11 +2735,8 @@ class ModelRestApi(BaseApi):
 
         async for chunk in data:
             for item in chunk:
-                async with AsyncTaskRunner():
-                    item_model = schema.model_validate(item, from_attributes=True)
-                item_dict = item_model.model_dump(mode="json")
-                row = CSVJSONConverter._json_to_csv(
-                    item_dict,
+                row = await CSVJSONConverter.ajson_to_csv_single(
+                    item,
                     list_columns=list_columns,
                     delimiter=delimiter,
                     export_mode=export_mode,

fastapi_rtk/utils/async_task_runner.py

@@ -2,6 +2,7 @@ import asyncio
 import contextvars
 import functools
 import inspect
+import traceback as tb
 import typing
 
 from .prettify_dict import prettify_dict
@@ -233,7 +234,9 @@ class AsyncTaskRunner:
                                     f'Task {index + 1}': {
                                         'message': str(exc),
                                         'caller': exc.caller,
-                                        'traceback': exc.original_exception.__traceback__,
+                                        'traceback': ''.join(
+                                            tb.format_exception(exc.original_exception)
+                                        ),
                                     }
                                     for index, exc in enumerate(exceptions)
                                 },

fastapi_rtk/utils/csv_json_converter.py

@@ -1,8 +1,15 @@
+import abc
 import csv
 import enum
+import inspect
 import json
 import typing
 
+from .run_utils import safe_call
+
+if typing.TYPE_CHECKING:
+    from ..bases import BasicModel
+
 __all__ = ["Line", "CSVJSONConverter"]
 
 
@@ -57,7 +64,7 @@ class CSVJSONConverter:
     @classmethod
     def json_to_csv(
         cls,
-        data: dict[str, typing.Any] | list[dict[str, typing.Any]],
+        data: "dict[str, typing.Any] | list[dict[str, typing.Any]] | BasicModel | list[BasicModel]",
         /,
         *,
         list_columns: list[str],
@@ -71,8 +78,10 @@ class CSVJSONConverter:
         """
         Converts JSON data to CSV format.
 
+        - Data can also be a subclass of `BasicModel` or a list of subclasses of `BasicModel`.
+
         Args:
-            data (dict[str, Any] | list[dict[str, Any]]): The JSON data to be converted.
+            data (dict[str, typing.Any] | list[dict[str, typing.Any]] | BasicModel | list[BasicModel]): The JSON data to be converted. Can also be a subclass of `BasicModel` or a list of subclasses of `BasicModel`.
             list_columns (list[str]): The list of columns to be included in the CSV.
             label_columns (dict[str, str]): The mapping of column names to labels.
             with_header (bool, optional): Whether to include the header in the CSV. Defaults to True.
@@ -93,11 +102,11 @@ class CSVJSONConverter:
             writer.writerow(header)
             csv_data = line.read()
 
-        if isinstance(data, dict):
+        if not isinstance(data, list):
             data = [data]
 
         for item in data:
-            row = cls._json_to_csv(
+            row = cls.json_to_csv_single(
                 item,
                 list_columns=list_columns,
                 delimiter=delimiter,
@@ -110,9 +119,9 @@ class CSVJSONConverter:
         return csv_data.strip()
 
     @classmethod
-    def _json_to_csv(
+    def json_to_csv_single(
         self,
-        data: dict[str, typing.Any],
+        data: "dict[str, typing.Any] | BasicModel",
         /,
         *,
         list_columns: list[str],
@@ -123,8 +132,10 @@ class CSVJSONConverter:
         """
         Converts single JSON object to CSV format.
 
+        - Data can also be a subclass of `BasicModel`.
+
         Args:
-            data (dict[str, Any]): The JSON data to be converted.
+            data (dict[str, typing.Any] | BasicModel): The JSON data to be converted. Can also be a subclass of `BasicModel`.
             list_columns (list[str]): The list of columns to be included in the CSV.
             delimiter (str, optional): The delimiter to use in the CSV. Defaults to ",".
             relation_separator (str, optional): The separator to use for nested keys. Defaults to ".".
@@ -134,40 +145,60 @@ class CSVJSONConverter:
             str: The CSV data as a string.
         """
         csv_data: list[str] = []
+        data_pipeline = DataPipeline()
+        data_pipeline.add_processor(ColumnProcessor(relation_separator))
+        data_pipeline.add_processor(ModelProcessor())
+        data_pipeline.add_processor(
+            ListProcessor(delimiter=delimiter, export_mode=export_mode)
+        )
+        data_pipeline.add_processor(EnumProcessor())
+        data_pipeline.add_processor(FallbackProcessor())
 
         for col in list_columns:
-            sub_col = []
-            if relation_separator in col:
-                col, *sub_col = col.split(relation_separator)
-            curr_val = data.get(col, "")
-            for sub in sub_col:
-                if isinstance(curr_val, dict):
-                    curr_val = curr_val.get(sub, "")
-                else:
-                    curr_val = ""
-
-            if isinstance(curr_val, dict):
-                curr_val = curr_val.get("name_", curr_val)
-            elif isinstance(curr_val, list):
-                curr_val = [
-                    curr_val.get(
-                        "id_" if export_mode == "detailed" else "name_",
-                        json.dumps(curr_val),
-                    )
-                    for curr_val in curr_val
-                ]
-                array_separator = "," if delimiter == ";" else ";"
-                curr_val = array_separator.join(curr_val)
-            elif isinstance(curr_val, enum.Enum):
-                curr_val = curr_val.value
-            if curr_val is not None:
-                if isinstance(curr_val, dict):
-                    curr_val = json.dumps(curr_val)
-                else:
-                    curr_val = str(curr_val)
-            else:
-                curr_val = ""
-            csv_data.append(curr_val)
+            value = data_pipeline.process(data, col)
+            csv_data.append(value)
+
+        return csv_data
+
+    @classmethod
+    async def ajson_to_csv_single(
+        cls,
+        data: "dict[str, typing.Any] | BasicModel",
+        /,
+        *,
+        list_columns: list[str],
+        delimiter=",",
+        relation_separator=".",
+        export_mode: ExportMode = "simplified",
+    ):
+        """
+        Asynchronously converts single JSON object to CSV format.
+
+        - Data can also be a `BasicModel`.
+
+        Args:
+            data (dict[str, typing.Any] | BasicModel): The JSON data to be converted. Can also be a `BasicModel`.
+            list_columns (list[str]): The list of columns to be included in the CSV.
+            delimiter (str, optional): The delimiter to use in the CSV. Defaults to ",".
+            relation_separator (str, optional): The separator to use for nested keys. Defaults to ".".
+            export_mode (ExportMode, optional): Export mode (simplified or detailed). Defaults to "simplified".
+
+        Returns:
+            str: The CSV data as a string.
+        """
+        csv_data: list[str] = []
+        data_pipeline = DataPipeline()
+        data_pipeline.add_processor(AsyncColumnProcessor(relation_separator))
+        data_pipeline.add_processor(ModelProcessor())
+        data_pipeline.add_processor(
+            ListProcessor(delimiter=delimiter, export_mode=export_mode)
+        )
+        data_pipeline.add_processor(EnumProcessor())
+        data_pipeline.add_processor(FallbackProcessor())
+
+        for col in list_columns:
+            value = await data_pipeline.aprocess(data, col)
+            csv_data.append(value)
 
         return csv_data
 
@@ -224,3 +255,175 @@ class CSVJSONConverter:
                 value = value.split(list_delimiter)
                 current[parts[-1]] = [item.strip() for item in value if item.strip()]
         return result
+
+
+class DataPipeline:
+    def __init__(self):
+        self.processors = list[DataProcessor]()
+
+    def add_processor(self, processor: "DataProcessor"):
+        """
+        Adds a data processor to the pipeline.
+
+        Args:
+            processor (DataProcessor): The data processor to add.
+        """
+        self.processors.append(processor)
+
+    def process(self, data: typing.Any, col: str):
+        """
+        Processes the data through the pipeline.
+
+        Args:
+            data (typing.Any): The data to process.
+            col (str): The column to process.
+
+        Returns:
+            typing.Any: The processed data.
+        """
+        for processor in self.processors:
+            data, col, should_continue = processor.process(data, col)
+            if not should_continue:
+                break
+        return data
+
+    async def aprocess(self, data: typing.Any, col: str):
+        """
+        Asynchronously processes the data through the pipeline.
+
+        Args:
+            data (typing.Any): The data to process.
+            col (str): The column to process.
+
+        Returns:
+            typing.Any: The processed data.
+        """
+        for processor in self.processors:
+            data, col, should_continue = await safe_call(processor.process(data, col))
+            if not should_continue:
+                break
+        return data
+
+
+class DataProcessor(abc.ABC):
+    @abc.abstractmethod
+    def process(self, data: typing.Any, col: str) -> tuple[typing.Any, str, bool]:
+        """
+        Processes the data for a specific column.
+
+        Args:
+            data (typing.Any): The data to process.
+            col (str): The column to process.
+
+        Returns:
+            tuple[typing.Any, str, bool]: The processed data, the column name, and a boolean indicating whether to continue processing.
+        """
+        raise NotImplementedError()
+
+
+class ColumnProcessor(DataProcessor):
+    def __init__(self, relation_separator: str = "."):
+        super().__init__()
+        self.relation_separator = relation_separator
+
+    def process(self, data, col):
+        sub_col = []
+        if self.relation_separator in col:
+            col, *sub_col = col.split(self.relation_separator)
+        data = data.get(col, "") if isinstance(data, dict) else getattr(data, col, "")
+        for sub in sub_col:
+            data = (
+                data.get(sub, "") if isinstance(data, dict) else getattr(data, sub, "")
+            )
+        return data, col, True
+
+
+class AsyncColumnProcessor(ColumnProcessor):
+    async def process(self, data, col):
+        data, col, continue_processing = super().process(data, col)
+        if inspect.iscoroutine(data):
+            data = await data
+        return data, col, continue_processing
+
+
+class ModelProcessor(DataProcessor):
+    def __init__(self, attr="name_"):
+        super().__init__()
+        self.attr = attr
+
+    def process(self, data, col):
+        from ..bases import BasicModel
+
+        continue_processing = True
+
+        if isinstance(data, BasicModel):
+            data = getattr(data, self.attr, "")
+            continue_processing = False
+        return data, col, continue_processing
+
+
+class DictProcessor(ModelProcessor):
+    def process(self, data, col):
+        continue_processing = True
+
+        if isinstance(data, dict):
+            data = data.get(self.attr, json.dumps(data))
+            continue_processing = False
+        return data, col, continue_processing
+
+
+class ListProcessor(DataProcessor):
+    def __init__(
+        self,
+        delimiter=",",
+        export_mode: CSVJSONConverter.ExportMode = "simplified",
+        attr_detailed="id_",
+        attr_simplified="name_",
+    ):
+        super().__init__()
+        self.separator = "," if delimiter == ";" else ";"
+        self.export_mode = export_mode
+        self.model_processor = ModelProcessor(
+            attr_detailed if export_mode == "detailed" else attr_simplified
+        )
+        self.dict_processor = DictProcessor(
+            attr_detailed if export_mode == "detailed" else attr_simplified
+        )
+
+    def process(self, data, col):
+        from ..bases import BasicModel
+
+        continue_processing = True
+
+        if isinstance(data, list):
+            processed_list = []
+            for item in data:
+                if isinstance(item, dict):
+                    item_processed, _, _ = self.dict_processor.process(item, col)
+                elif isinstance(item, BasicModel):
+                    item_processed, _, _ = self.model_processor.process(item, col)
+                else:
+                    item_processed = str(item)
+                processed_list.append(item_processed)
+            data = self.separator.join(processed_list)
+            continue_processing = False
+        return data, col, continue_processing
+
+
+class EnumProcessor(DataProcessor):
+    def process(self, data, col):
+        continue_processing = True
+
+        if isinstance(data, enum.Enum):
+            data = data.value
+            continue_processing = False
+        return data, col, continue_processing
+
+
+class FallbackProcessor(DataProcessor):
+    def process(self, data, col):
+        if data is None:
+            data = ""
+        else:
+            data = str(data)
+        return data, col, False

fastapi_rtk/version.py

@@ -1 +1,6 @@
 __version__ = "0.0.0"
+# Try to import the version from the generated _version.py file
+try:
+    from ._version import __version__  # noqa: F401
+except (ImportError, ModuleNotFoundError):
+    pass

{fastapi_rtk-1.0.3.dist-info → fastapi_rtk-1.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-rtk
-Version: 1.0.3
+Version: 1.0.5
 Summary: A package that provides a set of tools to build a FastAPI application with a Class-Based CRUD API.
 Project-URL: Homepage, https://codeberg.org/datatactics/fastapi-rtk
 Project-URL: Issues, https://codeberg.org/datatactics/fastapi-rtk/issues

{fastapi_rtk-1.0.3.dist-info → fastapi_rtk-1.0.5.dist-info}/RECORD

@@ -1,4 +1,5 @@
 fastapi_rtk/__init__.py,sha256=acLIihNMCZI3prFTq0cru1-k3kPjSZb2hhcqNrW7xJo,6203
+fastapi_rtk/_version.py,sha256=B9kKWJLln1i8LjtkcYecvNWGLTrez4gCUOHtnPlInFo,22
 fastapi_rtk/apis.py,sha256=6X_Lhl98m7lKrDRybg2Oe24pLFLJ29eCOQSwCAvpKhY,172
 fastapi_rtk/config.py,sha256=9PZF9E5i1gxmnsZEprZZKxVHSk0dFEklJSplX9NEqdo,14036
 fastapi_rtk/const.py,sha256=huvh4Zor77fgUkhU4-x6LgkOglSxeKXOlXdhnai_5CQ,4905
@@ -17,10 +18,10 @@ fastapi_rtk/routers.py,sha256=5gMGyH4Any9TwB3Fz23QDkmrX8MouzCxVgoAIcBqnTI,18988
 fastapi_rtk/schemas.py,sha256=zzzmf5qjSn6PtzrekD3Kll_WOn6XWR7h4AHQchW3GX8,17723
 fastapi_rtk/setting.py,sha256=vpjnio0mp_yZhDajZaBl6uOFmrBYl-sqB0L_lSkBpfk,19529
 fastapi_rtk/types.py,sha256=-LPnTIbHvqJW81__gab3EWrhjNmznHhptz0BtXkEAHQ,3612
-fastapi_rtk/version.py,sha256=ShXQBVjyiSOHxoQJS2BvNG395W4KZfqMxZWBAR0MZrE,22
+fastapi_rtk/version.py,sha256=D2cmQf2LNeHOiEfcNzVOOfcAmuLvPEmGEtZv5G54D0c,195
 fastapi_rtk/api/__init__.py,sha256=MwFR7HHppnhbjZGg3sOdQ6nqy9uxnHHXvicpswNFMNA,245
 fastapi_rtk/api/base_api.py,sha256=42I9v3b25lqxNAMDGEtajA5-btIDSyUWF0xMDgGkA8c,8078
-fastapi_rtk/api/model_rest_api.py,sha256=Hp6ws1CjLG-2e-yHxniIudUUmnKff9js2VVZ4Q5JMoo,105111
+fastapi_rtk/api/model_rest_api.py,sha256=PQwR_ya4rrzlZlHDl8lr3z7y1SH8mRbgiVRX2TrjsGk,104924
 fastapi_rtk/auth/__init__.py,sha256=iX7O41NivBYDfdomEaqm4lUx9KD17wI4g3EFLF6kUTw,336
 fastapi_rtk/auth/auth.py,sha256=MZmuueioiMbSHjd_F3frKEqCA3yjtanRWyKOy6CnOd0,20994
 fastapi_rtk/auth/hashers/__init__.py,sha256=uBThFj2VPPSMSioxYTktNiM4-mVgtDAjTpKA3ZzWxxs,110
@@ -105,9 +106,9 @@ fastapi_rtk/security/sqla/apis.py,sha256=J3BCqSnaX-w9raTA5LHa7muW24kA09nAm9kN6b3
 fastapi_rtk/security/sqla/models.py,sha256=dwIZHNU-6b1r0M2swlYyRtSgI1e1hnvav6d6jdmffM8,8096
 fastapi_rtk/security/sqla/security_manager.py,sha256=eBXhDTjqQYySCKQXnD6wEeHBGw8oytwVvmKpi9btNYI,17371
 fastapi_rtk/utils/__init__.py,sha256=0X4BwrVDl4S3mB7DLyHaZVednefMjRIjBIDT3yv_CHM,1875
-fastapi_rtk/utils/async_task_runner.py,sha256=PNo0vdKQAUOZ3HqGzU7E232qV8V218hKB7q8_uwx2dM,12653
+fastapi_rtk/utils/async_task_runner.py,sha256=JYXjVPxkWH1pxXImkjlebAOcn2noEUbX-vwpBWw3WGg,12778
 fastapi_rtk/utils/class_factory.py,sha256=jlVw8yCh-tYsMnR5Hm8fgxtL0kvXwnhe6DPJA1sUh7k,598
-fastapi_rtk/utils/csv_json_converter.py,sha256=S0j73joqFw4a2xqhqR53vOMCO2s6Q-eiGubTBysy0kU,7459
+fastapi_rtk/utils/csv_json_converter.py,sha256=7szrPiB7DrK5S-s2GaHVCmEP9_OXk9RFwbZmRtAKM5A,14036
 fastapi_rtk/utils/deep_merge.py,sha256=PHtKJgXfCngOBGVliX9aVlEFcwCxr-GlzU-w6vjgAIs,2426
 fastapi_rtk/utils/extender_mixin.py,sha256=eu22VAZJIf-r_uD-zVn_2IzvknfuUkmEHn9oo-0KU0k,1388
 fastapi_rtk/utils/flask_appbuilder_utils.py,sha256=nPLQIczDZgKElMtqBRSo_aPJZMOnPs7fRyjqKUtPDbo,2276
@@ -125,8 +126,8 @@ fastapi_rtk/utils/timezone.py,sha256=62S0pPWuDFFXxV1YTFCsc4uKiSP_Ba36Fv7S3gYjfhs
 fastapi_rtk/utils/update_signature.py,sha256=PIzZgNpGEwvDNgQ3G51Zi-QhVV3mbxvUvSwDwf_-yYs,2209
 fastapi_rtk/utils/use_default_when_none.py,sha256=H2HqhKy_8eYk3i1xijEjuaKak0oWkMIkrdz6T7DK9QU,469
 fastapi_rtk/utils/werkzeug.py,sha256=1Gv-oyqSmhVGrmNbB9fDqpqJzPpANOzWf4zMMrhW9UA,3245
-fastapi_rtk-1.0.3.dist-info/METADATA,sha256=83tmy_FUJBHWFpAIMx1Kd9-h4LJvMou7R-CnVefLSMs,1270
-fastapi_rtk-1.0.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-fastapi_rtk-1.0.3.dist-info/entry_points.txt,sha256=UuTkxSVIokSlVN28TMhoxzRRUaPxlVRSH3Gsx6yip60,53
-fastapi_rtk-1.0.3.dist-info/licenses/LICENSE,sha256=NDrWi4Qwcxal3u1r2lBWGA6TVh3OeW7yMan098mQz98,1073
-fastapi_rtk-1.0.3.dist-info/RECORD,,
+fastapi_rtk-1.0.5.dist-info/METADATA,sha256=4qQ4mOrd3rvE3SU3590DJYKggS00IhLaCPq8DGF8ZPI,1270
+fastapi_rtk-1.0.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+fastapi_rtk-1.0.5.dist-info/entry_points.txt,sha256=UuTkxSVIokSlVN28TMhoxzRRUaPxlVRSH3Gsx6yip60,53
+fastapi_rtk-1.0.5.dist-info/licenses/LICENSE,sha256=NDrWi4Qwcxal3u1r2lBWGA6TVh3OeW7yMan098mQz98,1073
+fastapi_rtk-1.0.5.dist-info/RECORD,,