#!/usr/bin/env python3 -- coding: utf-8 -- """ RK3399多模态教育交互原型终端应用 主入口文件 """ import os…
- User
#!/usr/bin/env python3
-- coding: utf-8 --
""" RK3399多模态教育交互原型终端应用 主入口文件 """
import os import sys import platform import argparse import atexit import traceback
添加项目根目录到 Python 路径
project_root = os.path.dirname(os.path.dirname(os.path.abspath(file))) if project_root not in sys.path: sys.path.insert(0, project_root)
from PyQt5.QtWidgets import QApplication, QMessageBox from PyQt5.QtCore import Qt, QTimer, QMetaObject import time import logging import threading import signal import json from dotenv import load_dotenv from logging.handlers import RotatingFileHandler from datetime import datetime
导入日志工具
from terminal.utils.log_utils import configure_logging, get_logger
解析命令行参数
def parse_args(): parser = argparse.ArgumentParser(description='RK3399多模态教育交互原型终端应用') parser.add_argument('--mode', choices=['normal', 'safe', 'super-safe'], default='normal', help='运行模式: normal(正常模式), safe(安全模式), super-safe(超级安全模式)') parser.add_argument('--log-level', choices=['debug', 'info', 'warning', 'error'], default='info', help='日志级别') parser.add_argument('--no-camera', action='store_true', help='禁用摄像头') parser.add_argument('--no-wakeword', action='store_true', help='禁用唤醒词') return parser.parse_args()
检查虚拟环境
def check_virtual_env(): """检查是否在虚拟环境中运行""" in_venv = False venv_path = ""
if hasattr(sys, 'real_prefix') or (hasattr(sys, 'base_prefix') and sys.base_prefix != sys.prefix): in_venv = True venv_path = sys.prefix print(f"在虚拟环境中运行: {venv_path}") return True, venv_path else: print("警告: 未在虚拟环境中运行!建议使用start.bat启动程序。") return False, ""资源清理函数
def cleanup_resources(): """清理程序资源""" try: # 获取应用控制器实例 from terminal.application_controller import get_app_controller_instance app_controller = get_app_controller_instance()
# 停止所有组件 if app_controller: logger = get_logger(__name__) logger.info("正在清理资源...") app_controller.stop_all_components() logger.info("资源清理完成") except Exception as e: print(f"清理资源时出错: {e}")信号处理函数
def signal_handler(sig, frame): """处理信号以优雅地关闭程序""" try: signal_name = signal.Signals(sig).name print(f"接收到信号 {signal_name},正在优雅地关闭程序...") except: print(f"接收到信号 {sig},正在优雅地关闭程序...")
# 使用QApplication的quit方法,而不是sys.exit app = QApplication.instance() if app: app.quit() else: sys.exit(0)异常钩子
def exception_hook(exctype, value, tb): """全局异常处理钩子""" try: logger = get_logger(name) logger.error("未捕获的异常", exc_info=(exctype, value, tb))
# 获取应用控制器实例并清理资源 from terminal.application_controller import get_app_controller_instance app_controller = get_app_controller_instance() if app_controller: app_controller.stop_all_components() except: print("处理未捕获异常时出错") traceback.print_exception(exctype, value, tb) # 调用原始的异常处理器 sys.__excepthook__(exctype, value, tb)主函数
def main(): """主函数""" # 解析命令行参数 args = parse_args()
# 设置日志级别 log_level = getattr(logging, args.log_level.upper(), logging.INFO) # 创建唯一的QApplication实例 app = QApplication(sys.argv) # 检查是否在虚拟环境中运行 in_venv, venv_path = check_virtual_env() if not in_venv: # 显示警告对话框 msg = "程序未在虚拟环境中运行,可能导致依赖问题。\n请使用start.bat启动程序。\n是否继续?" result = QMessageBox.warning(None, "虚拟环境警告", msg, QMessageBox.Yes | QMessageBox.No, QMessageBox.No) if result == QMessageBox.No: print("程序已退出: 用户选择停止") return 0 # 加载环境变量 load_dotenv() # 创建日志目录 log_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), "logs") os.makedirs(log_dir, exist_ok=True) # 配置日志系统 root_logger = configure_logging(log_level=log_level) # 创建主模块的logger logger = get_logger(__name__) logger.info("日志系统已配置") # 注册退出时的清理函数 atexit.register(cleanup_resources) # 注册信号处理器 signal.signal(signal.SIGINT, signal_handler) # Ctrl+C signal.signal(signal.SIGTERM, signal_handler) # 终止信号 # 在Windows上注册额外的信号处理(如果可用) if hasattr(signal, 'SIGBREAK'): # Windows上的Ctrl+Break signal.signal(signal.SIGBREAK, signal_handler) # 注册全局异常钩子 sys.excepthook = exception_hook try: # 导入UI模块 logger.info("导入UI模块...") from terminal.ui.main_window import MainWindow # 导入应用控制器和初始化器 logger.info("导入应用控制器和初始化器...") from terminal.application_controller import ApplicationController, get_app_controller_instance from terminal.app_initializer import AppInitializer # 设置应用程序属性 app.setStyle('Fusion') # 使用Fusion风格 app.setAttribute(Qt.AA_UseHighDpiPixmaps) # 启用高DPI支持 # 创建主窗口 logger.info("创建主窗口...") main_window = MainWindow() # 导入UI信号 logger.info("导入UI信号...") from terminal.ui.signals import signals # 创建应用控制器 logger.info("创建应用控制器...") app_controller = get_app_controller_instance() # 创建初始化工作线程 logger.info("创建初始化工作线程...") initializer = AppInitializer(app_controller) # 连接初始化器的信号到UI信号 initializer.initialization_progress.connect(signals.initialization_progress) initializer.initialization_complete.connect(signals.initialization_complete) # 连接应用控制器的信号到UI信号 app_controller.initialized_success.connect(signals.initialization_success) app_controller.initialized_error.connect(signals.initialization_error) app_controller.module_status_update.connect(signals.module_status_update) # 连接UI信号到主窗口的槽 signals.initialization_progress.connect(main_window.show_status_message) signals.initialization_complete.connect(main_window.on_initialization_complete) signals.initialization_success.connect(main_window.on_initialization_success) signals.initialization_error.connect(main_window.on_initialization_error) signals.module_status_update.connect(main_window.on_module_status_update) signals.wake_word_detected.connect(main_window.activate_window) # 注册唤醒词回调 def on_wakeword_detected(word, confidence): logger.info(f"检测到唤醒词: {word}, 置信度: {confidence}") signals.wake_word_detected.emit(word, confidence) # 将回调函数注册到应用控制器 app_controller.set_wakeword_callback(on_wakeword_detected) # 显示主窗口 logger.info("显示主窗口...") main_window.show() # 启动初始化工作线程 logger.info("启动初始化工作线程...") initializer.start() # 进入事件循环 logger.info("进入事件循环...") return app.exec_() except Exception as e: logger.error(f"主函数执行出错: {e}") logger.error(traceback.format_exc()) return 1程序入口点
if name == "main": sys.exit(main()) 全程中文交流,分析问题
Assistant
好的,我们来对这份
main.py文件进行详细的代码审查和分析。总体评价:
这份
main.py文件作为应用的入口点,设计得相当不错。它考虑了许多生产级应用所需的关键点,例如:- 健壮性: 全局异常处理、信号处理、程序退出清理机制、虚拟环境检查。
- 模块化: 将日志、UI、应用逻辑等拆分到不同的模块,并通过应用控制器进行协调。
- 用户体验: 启动时的虚拟环境警告、初始化进度显示。
- 可配置性: 支持命令行参数配置运行模式和日志级别。
- 良好的日志: 集成了日志系统,方便调试和问题追踪。
具体代码审查及改进建议:
1. 文件头部
#!/usr/bin/env python3 # -*- coding: utf-8 -*- """ RK3399多模态教育交互原型终端应用 主入口文件 """- Shebang (
#!/usr/bin/env python3): 很好,确保在类Unix系统上直接执行时使用Python 3。 - 编码声明 (
# -*- coding: utf-8 -*-): 良好实践,即使在Python 3中默认就是UTF-8,明确声明也没有坏处。 - 文档字符串: 清晰明了,概括了文件的作用。
2. 导入(Imports)
import os import sys import platform # 未使用 import argparse import atexit import traceback from PyQt5.QtWidgets import QApplication, QMessageBox from PyQt5.QtCore import Qt, QTimer, QMetaObject # QTimer, QMetaObject 未使用 import time # 未使用 import logging import threading # 未使用 import signal import json # 未使用 from dotenv import load_dotenv from logging.handlers import RotatingFileHandler # 应该在log_utils中被使用,此处无需导入 from datetime import datetime # 应该在log_utils中被使用,此处无需导入 # 导入日志工具 from terminal.utils.log_utils import configure_logging, get_logger # ... (后续模块导入)-
优点: 结构清晰,将标准库、第三方库和项目内部库分开。
-
改进建议:
- 移除未使用的导入:
platform: 未在main.py中使用。time: 未在main.py中直接使用,即使在其他模块可能使用,这里也无需导入。threading: 未在main.py中直接使用。AppInitializer可能使用线程,但那是它内部的实现细节。json: 未在main.py中使用。QTimer,QMetaObject: 未在main.py中直接使用。RotatingFileHandler,datetime: 这些是日志配置内部可能使用的,应该在log_utils.py中导入和使用,而不是在main.py中。
- 理由: 清理未使用的导入可以使代码更简洁,减少潜在的命名冲突,并提升 IDE 的代码分析准确性。
- 推荐修改:
import os import sys import argparse import atexit import traceback import logging import signal from PyQt5.QtWidgets import QApplication, QMessageBox from PyQt5.QtCore import Qt from dotenv import load_dotenv # 导入日志工具 from terminal.utils.log_utils import configure_logging, get_logger # ... (后续模块导入保持不变,因为它们在main函数try块中按需导入) - 移除未使用的导入:
3.
parse_args()函数def parse_args(): parser = argparse.ArgumentParser(description='RK3399多模态教育交互原型终端应用') parser.add_argument('--mode', choices=['normal', 'safe', 'super-safe'], default='normal', help='运行模式: normal(正常模式), safe(安全模式), super-safe(超级安全模式)') parser.add_argument('--log-level', choices=['debug', 'info', 'warning', 'error'], default='info', help='日志级别') parser.add_argument('--no-camera', action='store_true', help='禁用摄像头') parser.add_argument('--no-wakeword', action='store_true', help='禁用唤醒词') return parser.parse_args()- 优点: 使用
argparse进行命令行参数解析,清晰且功能强大。choices参数限制了输入,增加了健壮性。 - 建议: 考虑为参数添加类型提示(Type Hinting),提高代码可读性和可维护性。例如:
import argparse def parse_args() -> argparse.Namespace: parser = argparse.ArgumentParser(description='RK3399多模态教育交互原型终端应用') # ... (argparse arguments) return parser.parse_args()
4.
check_virtual_env()函数def check_virtual_env(): """检查是否在虚拟环境中运行""" in_venv = False venv_path = "" if hasattr(sys, 'real_prefix') or (hasattr(sys, 'base_prefix') and sys.base_prefix != sys.prefix): in_venv = True venv_path = sys.prefix print(f"在虚拟环境中运行: {venv_path}") return True, venv_path else: print("警告: 未在虚拟环境中运行!建议使用start.bat启动程序。") return False, ""- 优点: 准确地检测了虚拟环境,并提供了友好的控制台输出。
- 建议:
- 函数内部的
print语句可以在最终发布版本中考虑替换为logger.info或logger.warning,以便将所有输出统一到日志系统。但在启动阶段,直接print也很常见。 - 类型提示:
def check_virtual_env() -> tuple[bool, str]: # ...
- 函数内部的
5.
cleanup_resources()函数def cleanup_resources(): """清理程序资源""" try: # 获取应用控制器实例 from terminal.application_controller import get_app_controller_instance app_controller = get_app_controller_instance() # 停止所有组件 if app_controller: logger = get_logger(__name__) logger.info("正在清理资源...") app_controller.stop_all_components() logger.info("资源清理完成") except Exception as e: print(f"清理资源时出错: {e}")- 优点: 使用
atexit.register确保程序退出时资源得到清理,这对于防止内存泄漏或文件句柄未关闭等问题至关重要。延迟导入get_app_controller_instance也是一个好习惯。 - 建议:
print(f"清理资源时出错: {e}")可以替换为logger.error(f"清理资源时出错: {e}", exc_info=True),这样能将错误信息和堆栈跟踪一并记录到日志中。
6.
signal_handler()函数def signal_handler(sig, frame): """处理信号以优雅地关闭程序""" try: signal_name = signal.Signals(sig).name print(f"接收到信号 {signal_name},正在优雅地关闭程序...") except: print(f"接收到信号 {sig},正在优雅地关闭程序...") # 使用QApplication的quit方法,而不是sys.exit app = QApplication.instance() if app: app.quit() else: sys.exit(0)- 优点: 优雅地处理了
SIGINT和SIGTERM(以及Windows上的SIGBREAK),通过QApplication.quit()来关闭Qt事件循环,这比直接sys.exit()更安全和优雅。 - 建议: 这里的
print语句也可以考虑统一到logger.info中,但对于关键的退出信息,直接打印确保用户能看到。
7.
exception_hook()函数def exception_hook(exctype, value, tb): """全局异常处理钩子""" try: logger = get_logger(__name__) logger.error("未捕获的异常", exc_info=(exctype, value, tb)) # 获取应用控制器实例并清理资源 from terminal.application_controller import get_app_controller_instance app_controller = get_app_controller_instance() if app_controller: app_controller.stop_all_components() except: # 捕获处理异常时的异常 print("处理未捕获异常时出错") traceback.print_exception(exctype, value, tb) # 这里还是打印原始异常 # 调用原始的异常处理器 sys.__excepthook__(exctype, value, tb)- 优点: 捕获未处理的全局异常,并记录日志,同时尝试清理资源。调用
sys.__excepthook__确保了默认的异常打印行为(如打印到控制台)得以保留,这很重要。 - 改进建议:
- 在
except块中捕获处理异常时的异常,然后print("处理未捕获异常时出错"),这很好。但更准确的做法应该是记录这个内部异常,而不是仅仅打印原始异常。 - 将
traceback.print_exception(exctype, value, tb)放到logger.error的exc_info=True中,可以避免在控制台重复输出(如果日志也输出到控制台的话)。但保留控制台输出有时是为了紧急调试。这是一个权衡。 - 如果
get_app_controller_instance()在异常发生时还没有初始化成功,app_controller可能会是None,if app_controller:已经处理了这种情况,很好。
- 在
8.
main()函数这是整个程序的核心。
def main(): """主函数""" # 解析命令行参数 args = parse_args() # 设置日志级别 log_level = getattr(logging, args.log_level.upper(), logging.INFO) # 创建唯一的QApplication实例 app = QApplication(sys.argv) # 检查是否在虚拟环境中运行 in_venv, venv_path = check_virtual_env() if not in_venv: # 显示警告对话框 msg = "程序未在虚拟环境中运行,可能导致依赖问题。\n请使用start.bat启动程序。\n是否继续?" result = QMessageBox.warning(None, "虚拟环境警告", msg, QMessageBox.Yes | QMessageBox.No, QMessageBox.No) if result == QMessageBox.No: print("程序已退出: 用户选择停止") return 0 # 加载环境变量 load_dotenv() # 创建日志目录 log_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), "logs") os.makedirs(log_dir, exist_ok=True) # 配置日志系统 root_logger = configure_logging(log_level=log_level) # root_logger 未被使用 # 创建主模块的logger logger = get_logger(__name__) logger.info("日志系统已配置") # 注册退出时的清理函数 atexit.register(cleanup_resources) # 注册信号处理器 signal.signal(signal.SIGINT, signal_handler) # Ctrl+C signal.signal(signal.SIGTERM, signal_handler) # 终止信号 # 在Windows上注册额外的信号处理(如果可用) if hasattr(signal, 'SIGBREAK'): # Windows上的Ctrl+Break signal.signal(signal.SIGBREAK, signal_handler) # 注册全局异常钩子 sys.excepthook = exception_hook try: # 导入UI模块 logger.info("导入UI模块...") from terminal.ui.main_window import MainWindow # 导入应用控制器和初始化器 logger.info("导入应用控制器和初始化器...") from terminal.application_controller import ApplicationController, get_app_controller_instance # ApplicationController 未被使用 from terminal.app_initializer import AppInitializer # 设置应用程序属性 app.setStyle('Fusion') # 使用Fusion风格 app.setAttribute(Qt.AA_UseHighDpiPixmaps) # 启用高DPI支持 # 创建主窗口 logger.info("创建主窗口...") main_window = MainWindow() # 导入UI信号 logger.info("导入UI信号...") from terminal.ui.signals import signals # 创建应用控制器 logger.info("创建应用控制器...") app_controller = get_app_controller_instance() # 创建初始化工作线程 logger.info("创建初始化工作线程...") initializer = AppInitializer(app_controller) # 连接初始化器的信号到UI信号 initializer.initialization_progress.connect(signals.initialization_progress) initializer.initialization_complete.connect(signals.initialization_complete) # 连接应用控制器的信号到UI信号 app_controller.initialized_success.connect(signals.initialization_success) app_controller.initialized_error.connect(signals.initialization_error) app_controller.module_status_update.connect(signals.module_status_update) # 连接UI信号到主窗口的槽 signals.initialization_progress.connect(main_window.show_status_message) signals.initialization_complete.connect(main_window.on_initialization_complete) signals.initialization_success.connect(main_window.on_initialization_success) signals.initialization_error.connect(main_window.on_initialization_error) signals.module_status_update.connect(main_window.on_module_status_update) signals.wake_word_detected.connect(main_window.activate_window) # 注册唤醒词回调 def on_wakeword_detected(word, confidence): logger.info(f"检测到唤醒词: {word}, 置信度: {confidence}") signals.wake_word_detected.emit(word, confidence) # 将回调函数注册到应用控制器 app_controller.set_wakeword_callback(on_wakeword_detected) # 显示主窗口 logger.info("显示主窗口...") main_window.show() # 启动初始化工作线程 logger.info("启动初始化工作线程...") initializer.start() # 进入事件循环 logger.info("进入事件循环...") return app.exec_() except Exception as e: logger.error(f"主函数执行出错: {e}") logger.error(traceback.format_exc()) return 1-
优点:
- QApplication实例化:
QApplication(sys.argv)放在了最前面,且确保只实例化一次,这是正确的Qt应用启动方式。 - 虚拟环境警告: 使用
QMessageBox提供了良好的用户交互,提示并允许用户选择是否继续。 - 日志和环境变量: 在应用核心逻辑之前加载和配置,确保后续操作能正确记录和使用配置。
- 资源清理和信号处理: 注册在程序启动早期,确保在不同退出场景下都能被触发。
- 延迟模块导入: 将
MainWindow,ApplicationController,AppInitializer等模块的导入放在try块内,可以更好地处理导入阶段可能出现的错误,并允许全局异常钩子捕获这些错误。 - 职责分离:
ApplicationController和AppInitializer的设计很好地将应用初始化和运行时管理分离开来。 - 信号与槽机制: Qt的信号与槽机制在此处得到了有效应用,连接了初始化进度、模块状态、唤醒词检测等与UI的交互。
- 异常捕获: 整个
main逻辑被try...except包裹,能捕获启动过程中的任何未处理异常,并记录日志,提高程序的健壮性。
- QApplication实例化:
-
改进建议:
root_logger未使用:root_logger = configure_logging(...)这一行,root_logger变量在后续没有被使用。如果configure_logging已经设置了根日志器的配置,那么这里无需存储它的返回值。ApplicationController未使用:from terminal.application_controller import ApplicationController, get_app_controller_instance中,ApplicationController本身没有在main()函数中直接实例化或使用,只有get_app_controller_instance被调用。可以只导入get_app_controller_instance。QApplication属性设置顺序:app.setAttribute(Qt.AA_UseHighDpiPixmaps)理论上应该在QApplication实例创建 之前 设置才能完全生效,但通常在创建后立即设置也有效。为了严格遵循最佳实践,可以在QApplication(sys.argv)之前设置。# 设置应用程序属性 (建议在 QApplication 实例化前设置一部分,例如高DPI) # PyQt5 文档建议 QApplication 实例化前设置 AA_UseHighDpiPixmaps QApplication.setAttribute(Qt.AA_UseHighDpiPixmaps) # 创建唯一的QApplication实例 app = QApplication(sys.argv) app.setStyle('Fusion') # 使用Fusion风格 # 其他需要在 QApplication 实例后设置的属性signals模块的中间层:initializer.initialization_progress.connect(signals.initialization_progress)这种模式(先连接到signals模块的信号,再由signals模块的信号连接到main_window的槽)增加了信号传递的间接性。虽然这对于构建一个中央信号总线(central signal bus)模式很有用,但如果signals模块只是一个简单的转发器,且没有额外的逻辑处理,可以考虑直接将initializer的信号连接到main_window的槽,例如:initializer.initialization_progress.connect(main_window.show_status_message)这会使信号流更直接。具体选择取决于项目规模和signals模块的预期职责。如果signals模块是为了集中管理所有应用级别的信号,那么这种中间层是合理的。- 命令行参数传递给控制器:
args(--no-camera,--no-wakeword,--mode)这些命令行参数虽然在main.py中解析了,但看起来并没有直接传递给ApplicationController或AppInitializer。如果这些参数需要影响组件的初始化行为,应该通过app_controller或initializer的构造函数/方法传递过去。 例如:
这需要修改# ... # 创建应用控制器 logger.info("创建应用控制器...") app_controller = get_app_controller_instance(args) # 假设控制器可以接收参数 # 创建初始化工作线程 logger.info("创建初始化工作线程...") # 假设 AppInitializer 需要这些参数来决定是否启用摄像头/唤醒词 initializer = AppInitializer(app_controller, no_camera=args.no_camera, no_wakeword=args.no_wakeword, mode=args.mode) # ...ApplicationController和AppInitializer的构造函数以接收这些参数。
9. 程序入口点
if __name__ == "__main__": sys.exit(main())- 优点: 标准的Python程序入口点,通过
sys.exit()返回main()的执行结果,符合命令行程序的约定。
总结
这份
main.py是一个非常好的起点,展现了对程序健壮性、可维护性和用户体验的深入思考。主要改进点集中在:- 清理未使用的导入: 提升代码整洁度。
- 日志输出统一: 尽量使用
logger而非print进行信息输出,便于管理。 - 命令行参数传递: 确保解析的参数能够被应用程序的核心逻辑(如
ApplicationController或AppInitializer)正确使用,以实现功能控制。 QApplication属性设置顺序: 遵循Qt文档建议的高DPI属性设置顺序。
这些改进并不会改变程序的核心功能,但能使其更加规范、易于维护和扩展。
Other models, same or similar prompt
Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.