agentic-kit-common 0.0.8__py3-none-any.whl → 0.0.9__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of agentic-kit-common might be problematic. Click here for more details.

@@ -0,0 +1,53 @@
1
+ from typing import List, Union
2
+
3
+ import sqlparse
4
+ from sqlalchemy import text
5
+ from sqlalchemy.orm import Session
6
+
7
+
8
+ def is_readonly_sql(sql: str) -> bool:
9
+ """
10
+ 只允许:
11
+ SELECT / WITH / VALUES / EXPLAIN / DESCRIBE / SHOW
12
+ 拒绝:
13
+ INSERT/UPDATE/DELETE/CREATE/ALTER/DROP/TRUNCATE/LOAD/REPLACE/LOCK/UNLOCK/GRANT/REVOKE/EXECUTE/CALL
14
+ """
15
+ sql_clean = sqlparse.format(sql.strip(), strip_comments=True)
16
+ tokens = [t.normalized for t in sqlparse.parse(sql_clean)[0].flatten()
17
+ if t.ttype in (sqlparse.tokens.Keyword, sqlparse.tokens.DML, sqlparse.tokens.DDL)]
18
+
19
+ forbidden = {"INSERT", "UPDATE", "DELETE", "CREATE", "ALTER", "DROP", "TRUNCATE",
20
+ "LOAD", "REPLACE", "LOCK", "UNLOCK", "GRANT", "REVOKE", "EXEC", "CALL"}
21
+ allowed_root = {"SELECT", "WITH", "EXPLAIN", "DESCRIBE", "SHOW", "VALUES"}
22
+
23
+ root = tokens[0].upper() if tokens else ""
24
+ if root not in allowed_root:
25
+ return False
26
+ if any(k in forbidden for k in tokens):
27
+ return False
28
+ return True
29
+
30
+
31
+ def session_sql_execute(db_session: Session, sql_text: Union[str, List], query_only: bool = True):
32
+ if isinstance(sql_text, str):
33
+ # 处理单条SQL语句
34
+ if query_only:
35
+ if not is_readonly_sql(sql_text):
36
+ return []
37
+ result = db_session.execute(text(f"{sql_text}"))
38
+ columns = list(result.keys())
39
+ rows = [dict(zip(columns, r)) for r in result.fetchall()]
40
+ return rows
41
+ elif isinstance(sql_text, list):
42
+ results = []
43
+ for sub_sql_text in sql_text:
44
+ if query_only:
45
+ if not is_readonly_sql(sub_sql_text):
46
+ continue
47
+ result = db_session.execute(text(f"{sub_sql_text}"))
48
+ columns = list(result.keys())
49
+ rows = [dict(zip(columns, r)) for r in result.fetchall()]
50
+ results.append(rows)
51
+ return results
52
+ else:
53
+ return []
@@ -0,0 +1,245 @@
1
+ import logging
2
+ from contextlib import contextmanager
3
+ from threading import Lock
4
+ from typing import Dict, Optional, Any, List
5
+
6
+ from sqlalchemy import create_engine, text
7
+ from sqlalchemy.exc import OperationalError
8
+ from sqlalchemy.orm import sessionmaker, scoped_session
9
+
10
+ from .schema import DatabaseEngineModel, _DEFAULT_CONFIG
11
+
12
+ # 配置日志
13
+ logging.basicConfig(level=logging.INFO)
14
+ logger = logging.getLogger(__name__)
15
+
16
+
17
+ class DatabaseEngineManager:
18
+ """数据库引擎管理器"""
19
+
20
+ def __init__(self, init_engines: Optional[List[DatabaseEngineModel]] = None):
21
+ self._engines: Dict[str, Any] = {}
22
+ self._sessions: Dict[str, Any] = {}
23
+ self._engine_configs: Dict[str, Dict] = {}
24
+ self._default_engine_name = ""
25
+ self._lock = Lock()
26
+
27
+ # 初始化默认配置
28
+ self._default_config = _DEFAULT_CONFIG.model_dump()
29
+
30
+ # 初始化引擎
31
+ if init_engines:
32
+ self._init_engines(init_engines=init_engines)
33
+
34
+ def _init_engines(self, init_engines: List[DatabaseEngineModel]):
35
+ for engine in init_engines:
36
+ self.add_engine(engine)
37
+
38
+ def _create_engine(self, database_uri: str, database_name: str, config: Optional[Dict] = None) -> Any:
39
+ """创建数据库引擎"""
40
+ if config is None:
41
+ config = self._default_config.copy()
42
+
43
+ # 构建完整的数据库URL
44
+ if database_uri.endswith('/'):
45
+ full_url = f"{database_uri}{database_name}"
46
+ else:
47
+ full_url = f"{database_uri}/{database_name}"
48
+
49
+ try:
50
+ engine = create_engine(
51
+ url=full_url,
52
+ echo=config.get("echo", False),
53
+ pool_size=config.get("pool_size", 10),
54
+ max_overflow=config.get("max_overflow", 5),
55
+ pool_pre_ping=config.get("pool_pre_ping", True),
56
+ pool_recycle=config.get("pool_recycle", 1800),
57
+ )
58
+ logger.info(f"成功创建引擎: {database_name} -> {database_uri}")
59
+ return engine
60
+ except Exception as e:
61
+ logger.error(f"创建引擎失败: {database_name}, 错误: {e}")
62
+ raise
63
+
64
+ def add_engine(self, engine_info: DatabaseEngineModel) -> bool:
65
+ """添加数据库引擎"""
66
+ with self._lock:
67
+ engine_name = engine_info.engine_name
68
+ database_uri = engine_info.database_uri
69
+ database_name = engine_info.database_name
70
+ config = engine_info.config.model_dump().copy()
71
+
72
+ if engine_name in self._engines:
73
+ logger.warning(f"引擎 '{engine_name}' 已存在")
74
+ return False
75
+
76
+ try:
77
+ # 创建引擎
78
+ engine = self._create_engine(database_uri, database_name, config)
79
+
80
+ # 创建会话工厂
81
+ session_factory = scoped_session(
82
+ sessionmaker(
83
+ bind=engine,
84
+ expire_on_commit=False,
85
+ autocommit=False,
86
+ autoflush=False
87
+ )
88
+ )
89
+
90
+ # 存储配置和实例
91
+ self._engines[engine_name] = engine
92
+ self._sessions[engine_name] = session_factory
93
+ self._engine_configs[engine_name] = {
94
+ "database_uri": database_uri,
95
+ "database_name": database_name,
96
+ "config": config or self._default_config.copy()
97
+ }
98
+
99
+ logger.info(f"成功添加引擎: {engine_name}")
100
+ return True
101
+
102
+ except Exception as e:
103
+ logger.error(f"添加引擎失败: {engine_name}, 错误: {e}")
104
+ return False
105
+
106
+ def remove_engine(self, engine_name: str) -> bool:
107
+ """移除数据库引擎"""
108
+ with self._lock:
109
+ if engine_name not in self._engines:
110
+ logger.warning(f"引擎 '{engine_name}' 不存在")
111
+ return False
112
+
113
+ try:
114
+ # 关闭所有会话
115
+ if engine_name in self._sessions:
116
+ self._sessions[engine_name].close_all()
117
+ del self._sessions[engine_name]
118
+
119
+ # 处置引擎
120
+ if engine_name in self._engines:
121
+ self._engines[engine_name].dispose()
122
+ del self._engines[engine_name]
123
+
124
+ # 移除配置
125
+ if engine_name in self._engine_configs:
126
+ del self._engine_configs[engine_name]
127
+
128
+ # 如果移除的是默认引擎
129
+ if engine_name == self._default_engine_name and self._engines:
130
+ self._default_engine_name = ''
131
+
132
+ logger.info(f"成功移除引擎: {engine_name}")
133
+ return True
134
+
135
+ except Exception as e:
136
+ logger.error(f"移除引擎失败: {engine_name}, 错误: {e}")
137
+ return False
138
+
139
+ def get_engine(self, engine_name: Optional[str] = None) -> Any:
140
+ """获取数据库引擎"""
141
+ if engine_name is None:
142
+ engine_name = self._default_engine_name
143
+
144
+ if engine_name not in self._engines:
145
+ raise ValueError(f"数据库引擎 '{engine_name}' 不存在")
146
+
147
+ return self._engines[engine_name]
148
+
149
+ def get_session_factory(self, engine_name: Optional[str] = None) -> Any:
150
+ """获取会话工厂"""
151
+ if engine_name is None:
152
+ engine_name = self._default_engine_name
153
+
154
+ if engine_name not in self._sessions:
155
+ raise ValueError(f"数据库引擎 '{engine_name}' 不存在")
156
+
157
+ return self._sessions[engine_name]
158
+
159
+ @contextmanager
160
+ def get_db_session(self,
161
+ engine_name: Optional[str] = None,
162
+ auto_commit_by_exit: bool = False,
163
+ auto_close: bool = True):
164
+ """获取数据库会话(上下文管理器)"""
165
+ if engine_name is None:
166
+ engine_name = self._default_engine_name
167
+
168
+ if engine_name not in self._sessions:
169
+ raise ValueError(f"数据库引擎 '{engine_name}' 不存在")
170
+
171
+ session_factory = self._sessions[engine_name]
172
+ session = session_factory()
173
+
174
+ try:
175
+ yield session
176
+ if auto_commit_by_exit:
177
+ session.commit()
178
+ except OperationalError as e:
179
+ logger.warning(f"数据库连接异常,尝试重新连接: {e}")
180
+ session.rollback()
181
+ # 重新创建会话
182
+ session.close()
183
+ session = session_factory()
184
+ yield session
185
+ if auto_commit_by_exit:
186
+ session.commit()
187
+ except Exception as e:
188
+ session.rollback()
189
+ logger.error(f"数据库操作异常: {e}")
190
+ raise e
191
+ finally:
192
+ if auto_close:
193
+ session.close()
194
+
195
+ def set_default_engine(self, engine_name: str) -> bool:
196
+ """设置默认引擎"""
197
+ with self._lock:
198
+ if engine_name not in self._engines:
199
+ logger.warning(f"引擎 '{engine_name}' 不存在")
200
+ return False
201
+
202
+ self._default_engine_name = engine_name
203
+ logger.info(f"设置默认引擎为: {engine_name}")
204
+ return True
205
+
206
+ def list_engines(self) -> List[str]:
207
+ """列出所有引擎名称"""
208
+ return list(self._engines.keys())
209
+
210
+ def get_engine_info(self, engine_name: str) -> Optional[Dict]:
211
+ """获取引擎信息"""
212
+ if engine_name not in self._engine_configs:
213
+ return None
214
+
215
+ info = self._engine_configs[engine_name].copy()
216
+ info["is_default"] = (engine_name == self._default_engine_name)
217
+ return info
218
+
219
+ def health_check(self, engine_name: Optional[str] = None) -> Dict[str, bool]:
220
+ """健康检查"""
221
+ results = {}
222
+
223
+ if engine_name:
224
+ engines_to_check = [engine_name] if engine_name in self._engines else []
225
+ else:
226
+ engines_to_check = list(self._engines.keys())
227
+
228
+ for name in engines_to_check:
229
+ try:
230
+ with self.get_db_session(name, auto_close=True) as session:
231
+ session.execute(text("SELECT 1"))
232
+ results[name] = True
233
+ logger.debug(f"健康检查通过: {name}")
234
+ except Exception as e:
235
+ results[name] = False
236
+ logger.error(f"健康检查失败: {name}, 错误: {e}")
237
+
238
+ return results
239
+
240
+
241
+ # 初始化数据库引擎管理器
242
+ def initialize_database_engine_manager(init_engines: Optional[List[DatabaseEngineModel]] = None):
243
+ """初始化默认数据库"""
244
+ manager = DatabaseEngineManager(init_engines=init_engines)
245
+ return manager
@@ -0,0 +1,19 @@
1
+ from pydantic import BaseModel, Field
2
+
3
+
4
+ class DatabaseEngineConfigModel(BaseModel):
5
+ echo: bool = Field(False, description="数据库的 SQL 语句 + 参数 打印到标准输出")
6
+ pool_pre_ping: bool = Field(True, description="每次从池里拿连接前,先发一句做“心跳”")
7
+ pool_size: int = Field(10, description="连接池里 长期保持的“永久”连接 数量")
8
+ max_overflow: int = Field(5, description="当 pool_size 用光后,最多还能再新建多少条“临时”连接")
9
+ pool_recycle: int = Field(1800, description="一条连接被 复用多久之后强制回收(关闭并新建)")
10
+
11
+
12
+ _DEFAULT_CONFIG = DatabaseEngineConfigModel()
13
+
14
+
15
+ class DatabaseEngineModel(BaseModel):
16
+ engine_name: str = Field(..., description="数据库引擎名字")
17
+ database_uri: str = Field(..., description="数据库uir地址")
18
+ database_name: str = Field(..., description="数据库名称")
19
+ config: DatabaseEngineConfigModel = Field(_DEFAULT_CONFIG, description="配置信息")
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: agentic-kit-common
3
- Version: 0.0.8
3
+ Version: 0.0.9
4
4
  Summary: Common utilities and tools for agentic kit ecosystem
5
5
  Home-page:
6
6
  Author: manson
@@ -3,7 +3,10 @@ agentic_kit_common/minio/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
3
3
  agentic_kit_common/minio/minio_manager.py,sha256=PzoUWn0YqXTHx1UClbkwLkIUmv5O4aSDc7eVf08qOzs,21494
4
4
  agentic_kit_common/orm/__init__.py,sha256=wqY81g3P7FftFvLK5SaxFJzNNxrQwtmcb4RCXOSAZa8,71
5
5
  agentic_kit_common/orm/base.py,sha256=QIura_i2nIY2XeA3-KkO2loLNbEAoJK2qx0hu_8nhYU,2277
6
+ agentic_kit_common/orm/execution.py,sha256=sCEcInFGFZ9ZiIs0eHKbQPtN4Z02v7vGdFMyVEWygcU,1951
6
7
  agentic_kit_common/orm/manager.py,sha256=lWgFk5fUu_9m6yN_fskWHSYGaW30ty--KZKj8AuvIh0,4852
8
+ agentic_kit_common/orm/multi_session.py,sha256=CAEnOLl0I-r77JAknKQ2sERF40OkHD7BOrYVYoHuQV4,8814
9
+ agentic_kit_common/orm/schema.py,sha256=ukdVP71NE_JO5_HOe_FApJjBAKUsDluoElVn5vNSGJQ,1023
7
10
  agentic_kit_common/orm/session.py,sha256=LX4ZUKJNXdcQ0KqRt5L0pJX-QG-tDyKXEDijcPUkGD0,2716
8
11
  agentic_kit_common/vector/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
9
12
  agentic_kit_common/vector/embedding/__init__.py,sha256=mp--cfCDzTn5hNxzcIAU4m0g4F0d0rrZErFVWsGDvx4,40
@@ -21,8 +24,9 @@ test/config.py,sha256=VMcvfWnuWZKr_p0rC57i90jTq-XVsRuVzfEIe1C7Drg,3804
21
24
  test/settings.py,sha256=vU1dqUvGzshi6MG7JbGfW4jKfUsfAObgUfky-LMjUNs,344
22
25
  test/test_embedding.py,sha256=78M6t9tt6-oCfdQZfOartCIkUFZMvogcu5UKJh1lJb8,609
23
26
  test/test_minio.py,sha256=TOkX8A2pPkjrwAIH88xBZmFpDc1ZgTk1QS6mtubOZ-Y,2308
27
+ test/test_orm.py,sha256=8fGCU7BWaD5sDbg0fgYN0Saf_hi7t-q8svHCHLQDceo,1620
24
28
  test/test_vector.py,sha256=4sJ7bXt5iRhc6j1Ig0bZ1j0huPU-clnsnT7O0-uFbkw,1311
25
- agentic_kit_common-0.0.8.dist-info/METADATA,sha256=mLi0procHOdh1DiCFCstlsD1RM-wAMWEKFpHTRMbLxo,7496
26
- agentic_kit_common-0.0.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
27
- agentic_kit_common-0.0.8.dist-info/top_level.txt,sha256=nEKDlp84vqKSVWssGcxyuIsTqWLhMo45xqMs2GK4Dgg,24
28
- agentic_kit_common-0.0.8.dist-info/RECORD,,
29
+ agentic_kit_common-0.0.9.dist-info/METADATA,sha256=2QyqNG2MQrLYyQ6TDuPXkyBnPdf5La0g4-rloQ4jAZY,7496
30
+ agentic_kit_common-0.0.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
31
+ agentic_kit_common-0.0.9.dist-info/top_level.txt,sha256=nEKDlp84vqKSVWssGcxyuIsTqWLhMo45xqMs2GK4Dgg,24
32
+ agentic_kit_common-0.0.9.dist-info/RECORD,,
test/test_orm.py ADDED
@@ -0,0 +1,47 @@
1
+ import sys
2
+ import unittest
3
+ from pathlib import Path
4
+
5
+ from agentic_kit_common.orm.execution import session_sql_execute
6
+ from agentic_kit_common.orm.multi_session import initialize_database_engine_manager
7
+ from agentic_kit_common.orm.schema import DatabaseEngineModel
8
+
9
+ project_root = Path(__file__).parent.parent
10
+ sys.path.insert(0, str(project_root))
11
+
12
+
13
+ class MyTestCase(unittest.TestCase):
14
+ def test_multi_session(self):
15
+ engine = DatabaseEngineModel(
16
+ engine_name='default',
17
+ database_name='czailab_llm',
18
+ database_uri='mysql+mysqlconnector://ailab_dev:Qwert!%40%234@45.120.102.236'
19
+ )
20
+ # manager = initialize_database_engine_manager(init_engines=[engine])
21
+
22
+ manager = initialize_database_engine_manager()
23
+ manager.add_engine(engine_info=engine)
24
+
25
+ print(manager.get_engine('default'))
26
+ print(manager.get_engine_info('default'))
27
+ print(manager.list_engines())
28
+
29
+ # session = manager.get_db_session(engine_name='default')
30
+ with manager.get_db_session(engine_name='default') as session:
31
+ print(session)
32
+ print(type(session))
33
+
34
+ result = session_sql_execute(db_session=session, sql_text='select * from tenant; select * from rerank_model')
35
+ print(result)
36
+ print(type(result))
37
+ for item in result:
38
+ print(item)
39
+ print(item.keys())
40
+ print(item.values())
41
+ print(item.items())
42
+ for _item in item.items():
43
+ print(_item)
44
+
45
+
46
+ if __name__ == '__main__':
47
+ unittest.main()