ezKit 1.10.4__py3-none-any.whl → 1.10.6__py3-none-any.whl

ezKit/database.py

@@ -6,8 +6,10 @@
 # PostgreSQL 14 Data Types
 #     https://www.postgresql.org/docs/14/datatype.html
 import csv
+import json
 from typing import Any
 
+import pandas as pd
 from loguru import logger
 from sqlalchemy import CursorResult, Index, create_engine, text
 from sqlalchemy.orm import DeclarativeBase
@@ -30,10 +32,14 @@ class Database():
         else:
             pass
 
+    # ----------------------------------------------------------------------------------------------
+
     def initializer(self):
         """ensure the parent proc's database connections are not touched in the new connection pool"""
         self.engine.dispose(close=False)
 
+    # ----------------------------------------------------------------------------------------------
+
     def connect_test(self) -> bool:
         info = "Database connect test"
         try:
@@ -46,6 +52,8 @@ class Database():
             logger.exception(e)
             return False
 
+    # ----------------------------------------------------------------------------------------------
+
     def metadata_init(self, base: DeclarativeBase, **kwargs) -> bool:
         # https://stackoverflow.com/questions/19175311/how-to-create-only-one-table-with-sqlalchemy
         info = "Database init table"
@@ -60,6 +68,8 @@ class Database():
             logger.exception(e)
             return False
 
+    # ----------------------------------------------------------------------------------------------
+
     def create_index(self, index_name, table_field) -> bool:
         # 创建索引
         #   https://stackoverflow.com/a/41254430
@@ -82,125 +92,272 @@ class Database():
             logger.error(e)
             return False
 
+    # ----------------------------------------------------------------------------------------------
+
     # 私有函数, 保存 execute 的结果到 CSV 文件
     def _result_save(self, file, data) -> bool:
         try:
             outcsv = csv.writer(file)
             outcsv.writerow(data.keys())
             outcsv.writerows(data)
+            logger.success("save to csv success")
             return True
         except Exception as e:
+            logger.error("save to csv failed")
             logger.exception(e)
             return False
 
-    def execute(
-        self,
-        sql: str | None = None,
-        sql_file: str | None = None,
-        sql_file_kwargs: dict | None = None,
-        csv_file: str | None = None,
-        csv_file_kwargs: dict | None = None
-    ) -> CursorResult[Any] | bool:
-        """"运行"""
+    # ----------------------------------------------------------------------------------------------
 
-        # ------------------------------------------------------------
+    # def execute(
+    #     self,
+    #     sql: str | None = None,
+    #     sql_file: str | None = None,
+    #     sql_file_kwargs: dict | None = None,
+    #     csv_file: str | None = None,
+    #     csv_file_kwargs: dict | None = None
+    # ) -> CursorResult[Any] | bool:
+    #     """"运行"""
 
-        # 提取 SQL
-        # 如果 sql 和 sql_file 同时存在, 优先执行 sql
+    #     # ------------------------------------------------------------
 
-        sql_object = None
+    #     # 提取 SQL
+    #     # 如果 sql 和 sql_file 同时存在, 优先执行 sql
 
-        info: str = f"""Extract SQL: {sql}"""
+    #     sql_object = None
 
-        try:
+    #     info: str = f"""Extract SQL: {sql}"""
 
-            logger.info(f"{info} ......")
+    #     try:
 
-            if utils.isTrue(sql, str):
+    #         logger.info(f"{info} ......")
 
-                sql_object = sql
+    #         if utils.isTrue(sql, str):
 
-            elif sql_file is not None and utils.isTrue(sql_file, str):
+    #             sql_object = sql
 
-                # 判断文件是否存在
-                if isinstance(sql_file, str) and utils.check_file_type(sql_file, "file") is False:
+    #         elif sql_file is not None and utils.isTrue(sql_file, str):
 
-                    logger.error(f"No such file: {sql_file}")
-                    return False
+    #             # 判断文件是否存在
+    #             if isinstance(sql_file, str) and utils.check_file_type(sql_file, "file") is False:
 
-                if isinstance(sql_file, str) and utils.isTrue(sql_file, str):
+    #                 logger.error(f"No such file: {sql_file}")
+    #                 return False
 
-                    # 读取文件内容
-                    if sql_file_kwargs is not None and utils.isTrue(sql_file_kwargs, dict):
-                        with open(sql_file, "r", encoding="utf-8", **sql_file_kwargs) as _file:
-                            sql_object = _file.read()
-                    else:
-                        with open(sql_file, "r", encoding="utf-8") as _file:
-                            sql_object = _file.read()
+    #             if isinstance(sql_file, str) and utils.isTrue(sql_file, str):
 
-            else:
+    #                 # 读取文件内容
+    #                 if sql_file_kwargs is not None and utils.isTrue(sql_file_kwargs, dict):
+    #                     with open(sql_file, "r", encoding="utf-8", **sql_file_kwargs) as _file:
+    #                         sql_object = _file.read()
+    #                 else:
+    #                     with open(sql_file, "r", encoding="utf-8") as _file:
+    #                         sql_object = _file.read()
 
-                logger.error("SQL or SQL file error")
-                logger.error(f"{info} [failure]")
-                return False
+    #         else:
 
-            logger.success(f'{info} [success]')
+    #             logger.error("SQL or SQL file error")
+    #             logger.error(f"{info} [failure]")
+    #             return False
 
-        except Exception as e:
+    #         logger.success(f'{info} [success]')
 
-            logger.error(f"{info} [failure]")
-            logger.exception(e)
-            return False
+    #     except Exception as e:
+
+    #         logger.error(f"{info} [failure]")
+    #         logger.exception(e)
+    #         return False
+
+    #     # ------------------------------------------------------------
+
+    #     # 执行 SQL
+
+    #     info = f"""Execute SQL: {sql_object}"""
+
+    #     try:
+
+    #         logger.info(f"{info} ......")
+
+    #         with self.engine.connect() as connect:
+
+    #             # 执行SQL
+    #             if sql_object is None:
+    #                 return False
+
+    #             result = connect.execute(text(sql_object))
+
+    #             connect.commit()
+
+    #             if csv_file is None:
+    #                 # 如果 csv_file 没有定义, 则直接返回结果
+    #                 logger.success(f'{info} [success]')
+    #                 return result
+
+    #             # 如果 csv_file 有定义, 则保存结果到 csv_file
+    #             info_of_save = f"Save result to file: {csv_file}"
+    #             logger.info(f"{info_of_save} .......")
+
+    #             # 保存结果
+    #             if isinstance(csv_file_kwargs, dict) and utils.isTrue(csv_file_kwargs, dict):
+    #                 with open(csv_file, "w", encoding="utf-8", **csv_file_kwargs) as _file:
+    #                     result_of_save = self._result_save(_file, result)
+    #             else:
+    #                 with open(csv_file, "w", encoding="utf-8") as _file:
+    #                     result_of_save = self._result_save(_file, result)
+
+    #             # 检查保存结果
+    #             if result_of_save is True:
+    #                 logger.success(f'{info_of_save} [success]')
+    #                 logger.success(f'{info} [success]')
+    #                 return True
+
+    #             logger.error(f"{info_of_save} [failure]")
+    #             logger.error(f"{info} [failure]")
+    #             return False
+
+    #     except Exception as e:
+
+    #         logger.error(f'{info} [failure]')
+    #         logger.exception(e)
+    #         return False
 
-        # ------------------------------------------------------------
+    # ----------------------------------------------------------------------------------------------
 
-        # 执行 SQL
+    def connect_execute(
+        self,
+        sql: str | None = None,
+        read_sql_file: dict | None = None,
+        save_to_csv: dict | None = None
+    ) -> CursorResult[Any] | bool | None:
+
+        info: str = 'Database connect execute'
+
+        logger.info(f"{info} ......")
 
-        info = f"""Execute SQL: {sql_object}"""
+        sql_statement: str = ""
+
+        # ------------------------------------------------------------------------------------------
 
         try:
+            # SQL文件优先
+            if isinstance(read_sql_file, dict) and utils.isTrue(read_sql_file, dict):
+                read_sql_file.pop("encoding")
+                read_sql_file_kwargs: dict = {
+                    "mode": "r",
+                    "encoding": "utf-8",
+                    **read_sql_file
+                }
+                with open(encoding="utf-8", **read_sql_file_kwargs) as _file:
+                    sql_statement = _file.read()
+            else:
+                if not (isinstance(sql, str) and utils.check_arguments([(sql, str, "sql")])):
+                    return None
+                sql_statement = sql
+        except Exception as e:
+            logger.exception(e)
+            return None
 
-            logger.info(f"{info} ......")
+        # ------------------------------------------------------------------------------------------
+
+        if not self.connect_test():
+            return None
+
+        # ------------------------------------------------------------------------------------------
+
+        # 创建一个连接
+        with self.engine.connect() as connection:
 
-            with self.engine.connect() as connect:
+            # 开始一个事务
+            with connection.begin():  # 事务会自动提交或回滚
 
-                # 执行SQL
-                if sql_object is None:
-                    return False
+                try:
 
-                result = connect.execute(text(sql_object))
+                    # 执行 SQL 查询
+                    result = connection.execute(text(sql_statement))
 
-                connect.commit()
+                    # 执行成功
+                    logger.success(f"{info} [success]")
+
+                    # 返回查询结果
+                    if isinstance(save_to_csv, dict) and utils.isTrue(save_to_csv, dict):
+                        save_to_csv_kwargs: dict = {
+                            "mode": "w",
+                            "encoding": "utf-8",
+                            **save_to_csv
+                        }
+                        with open(encoding="utf-8", **save_to_csv_kwargs) as _file:
+                            return self._result_save(_file, result)
 
-                if csv_file is None:
-                    # 如果 csv_file 没有定义, 则直接返回结果
-                    logger.success(f'{info} [success]')
                     return result
 
-                # 如果 csv_file 有定义, 则保存结果到 csv_file
-                info_of_save = f"Save result to file: {csv_file}"
-                logger.info(f"{info_of_save} .......")
+                except Exception as e:
+                    # 发生异常时回滚事务
+                    logger.info(f"{info} [failed]")
+                    logger.exception(e)
+                    return None
 
-                # 保存结果
-                if isinstance(csv_file_kwargs, dict) and utils.isTrue(csv_file_kwargs, dict):
-                    with open(csv_file, "w", encoding="utf-8", **csv_file_kwargs) as _file:
-                        result_of_save = self._result_save(_file, result)
-                else:
-                    with open(csv_file, "w", encoding="utf-8") as _file:
-                        result_of_save = self._result_save(_file, result)
+    # ----------------------------------------------------------------------------------------------
 
-                # 检查保存结果
-                if result_of_save is True:
-                    logger.success(f'{info_of_save} [success]')
-                    logger.success(f'{info} [success]')
-                    return True
+    def read_with_pandas(
+        self,
+        method: str = "read_sql",
+        result_type: str = "df",
+        **kwargs
+    ) -> pd.DataFrame | list | dict:
+        """读取数据"""
 
-                logger.error(f"{info_of_save} [failure]")
-                logger.error(f"{info} [failure]")
-                return False
+        # 使用SQL查询数据: 使用 pd.read_sql 的参数
+        # read_data_with_pandas(by="sql", result_type="df", sql="SELECT * FROM table ORDER BY date DESC LIMIT 1")
 
-        except Exception as e:
+        # 读取表中的数据: 使用 pd.read_sql_table 的参数
+        # read_data_with_pandas(by="table", result_type="df", table_name="ashare")
 
-            logger.error(f'{info} [failure]')
+        data: pd.DataFrame = pd.DataFrame()
+
+        if not utils.check_arguments([(method, str, "method")]):
+            return data
+
+        if not utils.check_arguments([(result_type, str, "result_type")]):
+            return data
+
+        info: str = "read data"
+
+        try:
+
+            logger.info(f"{info} ......")
+
+            # 从 kwargs 中删除 con 键
+            kwargs.pop('con', None)
+
+            match method:
+                case "read_sql":
+                    data = pd.read_sql(con=self.engine, **kwargs)
+                case "read_sql_query":
+                    data = pd.read_sql_query(con=self.engine, **kwargs)
+                case "read_sql_table":
+                    data = pd.read_sql_table(con=self.engine, **kwargs)
+                case _:
+                    logger.error(f"{info} [incorrect method: {method}]")
+                    return data
+
+            if data.empty:
+                logger.error(f"{info} [failed]")
+                return data
+
+            logger.success(f"{info} [success]")
+
+            match result_type:
+                case "json":
+                    return json.loads(data.to_json(orient='records'))
+                case "dict":
+                    return data.to_dict()
+                case "list":
+                    # https://stackoverflow.com/a/26716774
+                    return data.to_dict('list')
+                case _:
+                    return data
+
+        except Exception as e:
+            logger.error(f"{info} [failed]")
             logger.exception(e)
-            return False
+            return data

{ezKit-1.10.4.dist-info → ezKit-1.10.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ezKit
-Version: 1.10.4
+Version: 1.10.6
 Summary: Easy Kit
 Author: septvean
 Author-email: septvean@gmail.com

{ezKit-1.10.4.dist-info → ezKit-1.10.6.dist-info}/RECORD

@@ -2,7 +2,7 @@ ezKit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ezKit/bottle.py,sha256=usKK1wVaZw4_D-4VwMYmOIc8jtz4TrpM30nck59HMFw,180178
 ezKit/bottle_extensions.py,sha256=3reEQVZuHklXTl6r7F8kiBFFPb0RaAGc3mYJJnrMDjQ,1129
 ezKit/cipher.py,sha256=0T_StbjiNI4zgrjVgcfU-ffKgu1waBA9UDudAnqFcNM,2896
-ezKit/database.py,sha256=Rc4RgjHOOtf5dMLvMkK1beRfbIai5E1x4HTsDwKsA-Q,6822
+ezKit/database.py,sha256=Hc1XWWnBwrnnaV8vOH9DAvZXz1DaEVEXSwKfWakX89I,12584
 ezKit/http.py,sha256=i3Kn5AMAMicDMcDjxKKZU7zqEKTU88Ec9_LwCuBJy-0,1801
 ezKit/mongo.py,sha256=dOm_1wXEPp_e8Ml5Qq78M7FDNrQUAZaThzVIiiLJJwk,2393
 ezKit/qywx.py,sha256=X_H4fzP-iEqeDEbumr7D1bXi6dxczaxfO8iyutzy02s,7171
@@ -11,8 +11,8 @@ ezKit/sendemail.py,sha256=tRXCsJm_RfTJ9xEWe_lTQ5kOs2JxHGPXvq0oWA7prq0,7263
 ezKit/token.py,sha256=HKREyZj_T2S8-aFoFIrBXTaCKExQq4zE66OHXhGHqQg,1750
 ezKit/utils.py,sha256=ILLaptYUSalERbCOhmoq4w0ZNZgj9yurpHEZwjRMZ8w,42387
 ezKit/xftp.py,sha256=XyIdr_2rxRVLqPofG6fIYWhAMVsFwTyp46dg5P9FLW4,7774
-ezKit-1.10.4.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-ezKit-1.10.4.dist-info/METADATA,sha256=uH8X29vT0V5J3nwzW7pwMvgor45UyDqw_1iGCwU_9A4,191
-ezKit-1.10.4.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-ezKit-1.10.4.dist-info/top_level.txt,sha256=aYLB_1WODsqNTsTFWcKP-BN0KCTKcV-HZJ4zlHkCFw8,6
-ezKit-1.10.4.dist-info/RECORD,,
+ezKit-1.10.6.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+ezKit-1.10.6.dist-info/METADATA,sha256=M7MZnhU7VDU0Zx7TG8Lrn_t_IS0E46zcyzVUS3EDRuc,191
+ezKit-1.10.6.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+ezKit-1.10.6.dist-info/top_level.txt,sha256=aYLB_1WODsqNTsTFWcKP-BN0KCTKcV-HZJ4zlHkCFw8,6
+ezKit-1.10.6.dist-info/RECORD,,