fred-admin 1.0.0__py3-none-any.whl

fred_admin/common/PageSchema.py

@@ -0,0 +1,65 @@
+# coding: utf-8
+from marshmallow import Schema, fields
+
+"""
+ * @Author：PyCharm - yougangchen
+ * @Package：PageSchema
+ * @Project：fred-frame
+ * @name：PageSchema
+ * @Date：2025/7/2 11:33 - 星期三
+ * @Filename：PageSchema
+ 
+"""
+
+
+class PageSchema(Schema):
+	"""
+        @desc : 公共分页参数，支持泛型和嵌套
+    """
+	total = fields.Int(metadata={'description': '总数'})
+	pageNum = fields.Int(metadata={'description': '页码'})
+	pageSize = fields.Int(metadata={'description': '每页数量'})
+	
+	def __init__(self, item_schema=None, *args, **kwargs):
+		super().__init__(*args, **kwargs)
+		if item_schema is not None:
+			# 支持传入schema类或实例
+			if isinstance(item_schema, type) and issubclass(item_schema, Schema):
+				self.declared_fields['records'] = fields.List(fields.Nested(item_schema), metadata={'description': '列表'})
+			elif isinstance(item_schema, Schema):
+				self.declared_fields['records'] = fields.List(fields.Nested(item_schema.__class__), metadata={'description': '列表'})
+			else:
+				raise ValueError('item_schema must be a marshmallow.Schema subclass or instance')
+		else:
+			self.declared_fields['records'] = fields.List(fields.Dict(), metadata={'description': '列表'})
+
+
+def PageSchemaFactory(item_schema, custom_name=None):
+    # 获取 item_schema 的名称用于生成唯一的 schema 名称
+    if custom_name:
+        schema_name = custom_name
+    else:
+        if hasattr(item_schema, '__name__'):
+            base_name = item_schema.__name__
+        elif hasattr(item_schema, '__class__'):
+            base_name = item_schema.__class__.__name__
+        else:
+            base_name = "Item"
+        
+        schema_name = f"{base_name}Page"
+    
+    # 动态创建带有唯一名称的 schema 类
+    class Meta:
+        pass
+    
+    PageSchemaClass = type(
+        schema_name,  # 类名
+        (PageSchema,),  # 基类
+        {
+            'records': fields.List(fields.Nested(item_schema), metadata={'description': '列表'}),
+            'Meta': Meta,
+            '__module__': item_schema.__module__ if hasattr(item_schema, '__module__') else __name__
+        }
+    )
+    
+    return PageSchemaClass

fred_admin/common/Response.py

@@ -0,0 +1,251 @@
+"""
+ * @Author：cyg
+ * @Package：response
+ * @Project：Default (Template) Project
+ * @name：response
+ * @Date：2024/9/26 16:36
+ * @Filename：response
+"""
+import http
+import json
+import time
+
+from flask import request, jsonify, current_app, g
+from marshmallow import Schema, fields
+
+from fred_admin.common.Utils import Utils
+from fred_admin.common.SystemLog import SystemLog
+
+
+def _format_validation_errors(errors, prefix=""):
+	"""将 Marshmallow / webargs 的 errors 结构转为可读字符串，供 message 展示。"""
+	if errors is None:
+		return ""
+	if isinstance(errors, dict):
+		parts = []
+		for key, value in errors.items():
+			path = f"{prefix}.{key}" if prefix else str(key)
+			if isinstance(value, list):
+				for item in value:
+					if isinstance(item, str):
+						parts.append(f"{path}: {item}")
+					elif isinstance(item, dict):
+						sub = _format_validation_errors(item, path)
+						if sub:
+							parts.append(sub)
+					else:
+						parts.append(f"{path}: {item}")
+			elif isinstance(value, dict):
+				sub = _format_validation_errors(value, path)
+				if sub:
+					parts.append(sub)
+			else:
+				parts.append(f"{path}: {value}")
+		return "; ".join(parts)
+	if isinstance(errors, list):
+		return "; ".join(str(x) for x in errors)
+	return str(errors)
+
+
+class Response(Schema):
+	code = fields.Int(load_default=200, metadata={'description': '状态码'})
+	data = fields.Raw(load_default=None, metadata={'description': '返回数据'})
+	message = fields.Str(load_default='', metadata={'description': '说明消息'})
+	execution_time = fields.Float(load_default=0.0, metadata={'description': '执行时间'})
+
+	def format_response(self, json_data, code):
+		"""
+		格式化输出
+		"""
+		return_data = Response().dump(json_data)
+		return_data['code'] = code
+		if code == http.HTTPStatus.OK:
+			encrypt = current_app.config.get('ENCRYPT_DATA', False)
+			the_data = json_data
+			# 检查 json_data 是否为字典类型
+			if isinstance(json_data, dict):
+				if 'message' in json_data:
+					return_data['message'] = json_data['message']
+					# 如果只有 message，则 data 设置为空字符串
+					if len(json_data) == 1:
+						the_data = ""
+					else:
+						if encrypt:
+							the_data = Utils.fernet_encrypt(json.dumps(the_data))
+				else:
+					if encrypt:
+						the_data = Utils.fernet_encrypt(json.dumps(json_data))
+			else:
+				# 如果 json_data 不是字典（如整数、字符串等），直接作为 data
+				if encrypt:
+					the_data = Utils.fernet_encrypt(json.dumps(json_data))
+			return_data['data'] = the_data
+			return return_data
+		return return_data
+
+	def custom_response(self, app):
+		"""
+		自定义输出返回格式
+		"""
+
+		@app.before_request  # 新增before_request钩子
+		def record_start_time():
+			g.start_time = time.time()
+			# 保存请求数据用于日志记录
+			g.request_body = None
+			try:
+				if request.is_json:
+					g.request_body = request.get_json()
+				elif request.form:
+					g.request_body = dict(request.form)
+				elif request.args:
+					g.request_body = dict(request.args)
+			except:
+				pass
+
+		@app.after_request
+		def after_request(response):
+			# 检查是否是swagger请求
+
+			swagger_ui_path = app.config.get('OPENAPI_URL_PREFIX', '') + app.config.get('OPENAPI_SWAGGER_UI_PATH', '')
+			if request.path.startswith(swagger_ui_path) or request.path.startswith('/openapi'):
+				return response
+			# 检查响应是否为JSON类型且非直接文件传输（处理 send_file/send_from_directory 的情况）
+			if response.mimetype == 'application/json' and not response.direct_passthrough:
+				# 尝试将响应转换为字典
+				json_response = response.get_json()
+				# 格式化响应
+				code = response.status_code
+				# 如果 json_response 为 None，设置为空字典
+				if json_response is None:
+					json_response = {}
+				# 非 200：优先用 errors 生成 message（flask-smorest 仅返回 errors、不填 message）
+				if code != http.HTTPStatus.OK:
+					# 兼容 flask_jwt_extended 等库使用 'msg' 而非 'message'
+					if 'message' not in json_response and 'msg' in json_response:
+						json_response['message'] = json_response.pop('msg')
+					msg = (json_response.get('message') or '').strip()
+					if not msg and json_response.get('errors') is not None:
+						detail = _format_validation_errors(json_response['errors'])
+						json_response['message'] = (
+							f'参数校验错误：{detail}' if detail else '参数校验错误'
+						)
+					elif 'message' not in json_response:
+						json_response['message'] = ''
+				serialized_response = self.format_response(json_response, code)
+				execution_time = time.time() - g.get('start_time', time.time())
+				if app.debug:
+					serialized_response['execution_time'] = round(execution_time, 5)
+				else:
+					#先判断execution_time是否存在在移除
+					if 'execution_time' in serialized_response:
+						del (serialized_response['execution_time'])
+				response = jsonify(serialized_response)
+				response.status_code = code
+				if app.debug:
+					response.headers.add('Access-Control-Allow-Origin', '*')
+
+				# 记录系统日志（所有接口）
+				try:
+					from flask import session
+					from fred_admin.common.Utils import Utils
+					# 加载模型模块
+					Utils.import_project_models('Admin')
+					# 直接导入模型
+					from model.model import Admin
+
+					user_id = 0
+					username = ''
+
+					# 根据不同的模块获取用户信息
+					if request.path.startswith('/admin'):
+						# admin 模块：从 session['admin_user_info'] 获取
+						admin_info = session.get('admin_user_info', None)
+						if admin_info:
+							if isinstance(admin_info, dict):
+								user_id = admin_info.get('id', 0)
+								username = admin_info.get('username', '')
+							else:
+								user_id = getattr(admin_info, 'id', 0)
+								username = getattr(admin_info, 'username', '')
+					else:
+						# 其他模块：从 session 中获取用户ID，然后查询用户名
+						# 尝试从不同模块的 session key 获取用户ID
+						user_info = None
+						if request.path.startswith('/server'):
+							user_info = session.get('server_user_info', None)
+						elif request.path.startswith('/terminal'):
+							user_info = session.get('terminal_user_info', None)
+						elif request.path.startswith('/algorithm'):
+							user_info = session.get('algorithm_user_info', None)
+						elif request.path.startswith('/demo'):
+							user_info = session.get('demo_user_info', None)
+						else:
+							# 尝试从其他可能的 session key 获取
+							for key in session.keys():
+								if key.endswith('_user_info'):
+									user_info = session.get(key, None)
+									break
+
+						# 转换为整数
+						if user_info is not None:
+							try:
+								user_id = int(user_info)
+							except (ValueError, TypeError):
+								user_id = 0
+
+						# 如果有用户ID，查询用户名
+						if user_id > 0:
+							try:
+								admin = Admin.query.filter_by(id=user_id).first()
+								if admin:
+									username = admin.username or ''
+							except:
+								username = ''
+
+					# 获取请求数据
+					request_body = g.get('request_body')
+					# 获取返回数据
+					response_body = serialized_response
+					# 调用日志记录方法
+					SystemLog.save_sys_log(
+						user_id=user_id,
+						api=request.path,
+						method=request.method,
+						code=code,
+						username=username,
+						request_body=request_body,
+						response_body=response_body
+					)
+				except Exception as e:
+					# 记录日志失败不影响主流程
+					pass
+			return response
+
+	def swagger_responses(self, spec, schemas):
+		"""
+		定义swagger默认显示的格式
+		"""
+		for path in spec['paths'].values():
+			for method in path.values():
+				if type(method) is not dict:
+					continue
+				responses = method.setdefault('responses', {})
+				for key, value in responses.items():
+					if key == '200':
+						continue
+					try:
+						code = int(key)
+					except ValueError:
+						# 处理无法转换的情况，例如赋值一个默认值或者记录日志
+						code = 200
+					responses[key] = {
+						'content': {
+							'application/json': {
+								'schema': schemas.get('Response'),
+								'example': Response().dump({'code': code})
+							}
+						}
+					}
+
+		return None