ezKit 1.10.3__tar.gz → 1.10.5__tar.gz

{ezkit-1.10.3/ezKit.egg-info → ezkit-1.10.5}/PKG-INFO

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

{ezkit-1.10.3 → ezkit-1.10.5}/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,6 +92,8 @@ class Database():
             logger.error(e)
             return False
 
+    # ----------------------------------------------------------------------------------------------
+
     # 私有函数, 保存 execute 的结果到 CSV 文件
     def _result_save(self, file, data) -> bool:
         try:
@@ -93,6 +105,8 @@ class Database():
             logger.exception(e)
             return False
 
+    # ----------------------------------------------------------------------------------------------
+
     def execute(
         self,
         sql: str | None = None,
@@ -204,3 +218,46 @@ class Database():
             logger.error(f'{info} [failure]')
             logger.exception(e)
             return False
+
+    # ----------------------------------------------------------------------------------------------
+
+    def read_data_with_pandas(self, result_type: str = "df", **kwargs) -> pd.DataFrame | dict | list | None:
+        """读取表中所有数据"""
+
+        # 使用 pd.read_sql_table 的参数
+        # read_data_with_pandas(result_type="df", table_name="ashare")
+
+        info = f"读取 {kwargs.get('table_name', None)} 表中所有数据"
+
+        try:
+
+            logger.info(f"{info} ......")
+
+            # 从 kwargs 中删除 con 键
+            kwargs.pop('con', None)
+
+            # 读取数据
+            data: pd.DataFrame = pd.read_sql_table(con=self.engine, **kwargs)
+
+            if data.empty:
+                logger.error(f"{info} [失败]")
+                return None
+
+            logger.success(f"{info} [成功]")
+
+            if utils.isTrue(result_type, str) and result_type == "json":
+                return json.loads(data.to_json(orient='records'))
+
+            if utils.isTrue(result_type, str) and result_type == "dict":
+                return data.to_dict()
+
+            if utils.isTrue(result_type, str) and result_type == "list":
+                # https://stackoverflow.com/a/26716774
+                return data.to_dict('list')
+
+            return data
+
+        except Exception as e:
+            logger.error(f"{info} [失败]")
+            logger.exception(e)
+            return None

{ezkit-1.10.3 → ezkit-1.10.5}/ezKit/utils.py

@@ -13,7 +13,7 @@ from multiprocessing import Pool
 from multiprocessing.pool import ThreadPool
 from pathlib import Path
 from shutil import rmtree
-from typing import Any, Callable, List, Union
+from typing import Any, Callable, List, Optional, Union
 from urllib.parse import ParseResult, urlparse
 from uuid import uuid4
 
@@ -1001,46 +1001,45 @@ def datetime_object(
 # --------------------------------------------------------------------------------------------------
 
 
-# run_cmd = bash('echo ok', universal_newlines=True, stdout=PIPE)
-#
-# if run_cmd != None:
-#     returncode = run_cmd.returncode
-#     outputs = run_cmd.stdout.splitlines()
-#     print(returncode, type(returncode))
-#     print(outputs, type(outputs))
-#
-# # echo 'echo ok' > /tmp/ok.sh
-# run_script = bash('/tmp/ok.sh', file=True, universal_newlines=True, stdout=PIPE)
-#
-# if run_script != None:
-#     returncode = run_script.returncode
-#     outputs = run_script.stdout.splitlines()
-#     print(returncode, type(returncode))
-#     print(outputs, type(outputs))
-
-
 def shell(
     command: str,
     isfile: bool = False,
-    sh_shell: str = '/bin/bash',
-    sh_option: str | None = None,
+    sh_shell: str = "/bin/bash",
+    sh_option: Optional[str] = None,
     **kwargs
-) -> subprocess.CompletedProcess | None:
-    """run shell command or script"""
+) -> Optional[subprocess.CompletedProcess]:
+    """执行 Shell 命令 或 脚本"""
+
+    # :param command: 需要执行的命令
+    # :param isfile: 是否将命令视为文件路径
+    # :param sh_shell: 使用的 Shell 程序路径
+    # :param sh_option: Shell 执行选项，例如 '-c'
+    # :param kwargs: 其他传递给 subprocess.run 的参数
+    # :return: 返回 subprocess.CompletedProcess 对象，失败时返回 None
+
     try:
-        match True:
-            case True if not check_file_type(sh_shell, 'file'):
-                return None
-            case True if isTrue(sh_shell, str) and isTrue(command, str):
-                if isfile is True:
-                    if sh_option is None:
-                        return subprocess.run([sh_shell, command], **kwargs, check=False)
-                    return subprocess.run([sh_shell, sh_option, command], **kwargs, check=False)
-                if sh_option is None:
-                    sh_option = '-c'
-                return subprocess.run([sh_shell, sh_option, command], **kwargs, check=False)
-            case _:
-                return None
+
+        # 校验 Shell 程序路径
+        if not check_file_type(sh_shell, "file"):
+            logger.error(f"Invalid shell path: {sh_shell}")
+            return None
+
+        # 校验 command 和 sh_shell 的类型
+        if not (isTrue(sh_shell, str) and isTrue(command, str)):
+            logger.error("Invalid shell or command input.")
+            return None
+
+        # 构造命令
+        if isfile:
+            args = [sh_shell, command] if sh_option is None else [sh_shell, sh_option, command]
+        else:
+            sh_option = sh_option or "-c"
+            args = [sh_shell, sh_option, command]
+
+        logger.info(f"Executing command: {args}")
+
+        return subprocess.run(args, **kwargs, check=False)
+
     except Exception as e:
         logger.exception(e)
         return None

{ezkit-1.10.3 → ezkit-1.10.5/ezKit.egg-info}/PKG-INFO

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

{ezkit-1.10.3 → ezkit-1.10.5}/setup.py

@@ -3,7 +3,7 @@ from setuptools import find_packages, setup
 
 setup(
     name='ezKit',
-    version='1.10.3',
+    version='1.10.5',
     author='septvean',
     author_email='septvean@gmail.com',
     description='Easy Kit',