SAutoScript 0.1.0__py3-none-any.whl

sautoscript/__init__.py

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+
+"""
+SAutoScript - 游戏自动脚本系统
+基于图像识别技术的动作游戏自动脚本系统，支持Windows平台的鼠标键盘仿真输入。
+"""
+
+__version__ = "0.1.0"
+__author__ = "SAutoScript Team"
+__license__ = "MIT"
+
+from sautoscript.core.base_game_script import BaseGameScript
+from sautoscript.core.input_controller import InputController
+from sautoscript.core.screen_capture import ScreenCapture
+from sautoscript.core.image_recognition import ImageRecognition
+from sautoscript.core.game_operations import GameOperations
+from sautoscript.core.window_locator import WindowLocator
+from sautoscript.core.error_logger import log_exception
+
+__all__ = [
+    "BaseGameScript",
+    "InputController",
+    "ScreenCapture",
+    "ImageRecognition",
+    "GameOperations",
+    "WindowLocator",
+    "log_exception"
+]

sautoscript/core/__init__.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+
+"""
+SAutoScript 核心模块
+"""
+
+from sautoscript.core.base_game_script import BaseGameScript
+from sautoscript.core.input_controller import InputController
+from sautoscript.core.screen_capture import ScreenCapture
+from sautoscript.core.image_recognition import ImageRecognition
+from sautoscript.core.game_operations import GameOperations
+from sautoscript.core.window_locator import WindowLocator
+from sautoscript.core.error_logger import log_exception
+
+__all__ = [
+    "BaseGameScript",
+    "InputController",
+    "ScreenCapture",
+    "ImageRecognition",
+    "GameOperations",
+    "WindowLocator",
+    "log_exception"
+]

sautoscript/core/base_game_script.py

@@ -0,0 +1,346 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+import os
+import sys
+import time
+import random
+import yaml
+from abc import ABC, abstractmethod
+from loguru import logger
+import gc
+import psutil  # 用于内存监控
+
+# 绝对导入
+try:
+    from sautoscript.core.image_recognition import ImageRecognition
+    from sautoscript.core.input_controller import InputController
+    from sautoscript.core.screen_capture import ScreenCapture
+    from sautoscript.core.game_operations import GameOperations, GameStuckError, GameTooManyClickError
+    from sautoscript.core.window_locator import WindowLocator
+    from sautoscript.core.error_logger import log_exception
+except ImportError:
+    # 处理独立运行时的导入
+    from core.image_recognition import ImageRecognition
+    from core.input_controller import InputController
+    from core.screen_capture import ScreenCapture
+    from core.game_operations import (
+        GameOperations,
+        GameStuckError,
+        GameTooManyClickError,
+    )
+    from core.window_locator import WindowLocator
+    from core.error_logger import log_exception
+
+
+class BaseGameScript(ABC):
+    """
+    游戏脚本基类
+
+    所有游戏脚本都应继承此类，实现通用的初始化、配置加载和主循环功能。
+    子类需要实现game_logic方法来定义具体的游戏逻辑。
+    """
+
+    def __init__(self, config_path=None):
+        """
+        初始化游戏脚本
+
+        Args:
+            config_path: 配置文件路径，默认为../config/settings.yaml
+        """
+        # 加载配置
+        self.config = self._load_config(config_path)
+
+        # 初始化组件
+        self._init_components()
+
+        # 运行状态
+        self.running = False
+
+        # 成功执行次数
+        self.success_num = 0
+
+        # 循环控制
+        # 循环控制
+        loop_config = self.config.get("loop_control", {})
+        self.max_loops = loop_config.get("max_iterations", 100)  # 默认最多执行100次循环
+        self.loop_delay = loop_config.get("iteration_delay", 1)  # 默认循环间隔1秒
+
+        # 内存优化配置
+        memory_config = self.config.get("memory_optimization", {})
+        self.gc_frequency = memory_config.get("gc_frequency", 50)  # 垃圾回收频率
+        self.memory_threshold_mb = memory_config.get(
+            "memory_threshold_mb", 400
+        )  # 内存阈值(MB)
+        self.enable_smart_gc = memory_config.get("enable_smart_gc", True)  # 启用智能GC
+        self.enable_memory_monitoring = memory_config.get(
+            "enable_memory_monitoring", True
+        )  # 启用内存监控
+        self.memory_check_frequency = memory_config.get(
+            "memory_check_frequency", 20
+        )  # 内存检查频率
+
+        logger.info(f"{self.__class__.__name__}初始化完成")
+
+    def _load_config(self, config_path=None):
+        """
+        加载配置文件
+
+        Args:
+            config_path: 配置文件路径
+
+        Returns:
+            dict: 配置字典
+        """
+        if config_path is None:
+            # 默认配置文件路径
+            config_path = os.path.join(
+                os.path.dirname(__file__), "..", "..", "config", "settings.yaml"
+            )
+
+        try:
+            with open(config_path, "r", encoding="utf-8") as f:
+                return yaml.safe_load(f)
+        except Exception as e:
+            logger.error(f"加载配置文件失败: {e}")
+            # 记录错误到以时间命名的日志文件
+            script_name = self.__class__.__name__
+            log_exception(
+                f"在{script_name}的_load_config方法中加载配置文件{config_path}时发生错误",
+                script_name,
+            )
+            return {}
+
+    def _init_components(self):
+        """
+        初始化组件
+        """
+        try:
+            # 初始化屏幕捕获组件
+            screen_capture_config = self.config.get("screen_capture", {})
+            self.screen_capture = ScreenCapture(screen_capture_config)
+
+            # 初始化输入控制组件
+            input_controller_config = self.config.get("input_control", {})
+            self.input_controller = InputController(input_controller_config)
+
+            # 初始化图像识别组件
+            self.image_recognition = ImageRecognition(
+                self.config.get("image_recognition", {})
+            )
+
+            # 初始化窗口定位组件
+            self.window_locator = WindowLocator()
+
+            # 初始化游戏操作组件
+            self.game_ops = GameOperations(
+                self.image_recognition,
+                self.input_controller,
+                self.screen_capture,
+                self.config,
+            )
+        except Exception as e:
+            logger.error(f"组件初始化失败: {e}")
+            # 记录错误到以时间命名的日志文件
+            script_name = self.__class__.__name__
+            log_exception(
+                f"在{script_name}的_init_components方法中初始化组件时发生错误",
+                script_name,
+            )
+            raise
+
+    def start(self, max_loops=None, loop_delay=None):
+        """
+        启动脚本
+        """
+        logger.info(f"启动{self.__class__.__name__}")
+
+        # 设置循环次数和延迟
+        if max_loops:
+            self.max_loops = max_loops  # 最多执行 x 次循环
+        if loop_delay:
+            self.loop_delay = loop_delay  # 循环间隔 x 秒
+
+        self.running = True
+
+        try:
+            # 调用启动前钩子
+            self.on_start()
+
+            # 主循环
+            self._main_loop()
+        except KeyboardInterrupt:
+            logger.info("接收到中断信号，正在停止...")
+            if self.success_num:
+                logger.info(f"======================================")
+                logger.info(f"中断前执行成功次数: {self.success_num}")
+                logger.info(f"======================================")
+
+        except Exception as e:
+            logger.error(f"运行时错误: {e}")
+            # 记录错误到以时间命名的日志文件
+            script_name = self.__class__.__name__
+            log_exception(f"在{script_name}的start方法中发生错误", script_name)
+            if self.success_num:
+                logger.info(f"======================================")
+                logger.info(f"异常终止前执行成功次数: {self.success_num}")
+                logger.info(f"======================================")
+
+        finally:
+            self.stop()
+
+    def stop(self):
+        """
+        停止脚本
+        """
+        logger.info(f"停止{self.__class__.__name__}")
+        self.running = False
+
+        # 调用停止后钩子
+        self.on_stop()
+
+    def _main_loop(self):
+        """
+        主循环 - 集成智能垃圾回收
+        """
+        loop_count = 0
+
+        while self.running and loop_count < self.max_loops:
+            try:
+                # 调用游戏逻辑
+                self.game_logic()
+                loop_count += 1
+                logger.info(f"======================================")
+                logger.info(f"循环执行次数: {loop_count}/{self.max_loops}")
+                if self.success_num:
+                    logger.info(f"当前执行成功次数: {self.success_num}/{loop_count}")
+                logger.info(f"======================================")
+
+                # 智能垃圾回收逻辑
+                if self.enable_smart_gc:
+                    # 定期垃圾回收
+                    if loop_count % self.gc_frequency == 0:
+                        logger.debug(f"执行定期垃圾回收 (第{loop_count}次循环)")
+                        gc.collect()
+
+                    # 内存监控
+                    if (
+                        self.enable_memory_monitoring
+                        and loop_count % self.memory_check_frequency == 0
+                    ):
+                        memory_mb = self._get_memory_usage()
+                        if memory_mb > self.memory_threshold_mb:
+                            logger.warning(
+                                f"内存使用过高: {memory_mb:.1f}MB > {self.memory_threshold_mb}MB，执行垃圾回收"
+                            )
+                            gc.collect()
+                            # 再次检查内存使用
+                            memory_after_gc = self._get_memory_usage()
+                            logger.info(f"垃圾回收后内存使用: {memory_after_gc:.1f}MB")
+
+                # 每次循环后添加延迟
+                time.sleep(self.loop_delay)
+            except Exception as e:
+                logger.error(f"主循环错误: {e}，脚本将退出")
+                # 记录错误到以时间命名的日志文件
+                script_name = self.__class__.__name__
+                log_exception(
+                    f"在{script_name}的主循环第{loop_count+1}次迭代中发生错误",
+                    script_name,
+                )
+                break
+
+        # 循环结束时的最终垃圾回收
+        if self.enable_smart_gc:
+            logger.debug("主循环结束，执行最终垃圾回收")
+            gc.collect()
+
+        logger.info(f"已完成{loop_count}次循环，脚本将退出")
+
+    def _get_memory_usage(self):
+        """
+        获取当前进程的内存使用量(MB)
+
+        Returns:
+            float: 内存使用量(MB)
+        """
+        try:
+            process = psutil.Process()
+            memory_info = process.memory_info()
+            memory_mb = memory_info.rss / 1024 / 1024  # 转换为MB
+            return memory_mb
+        except Exception as e:
+            logger.warning(f"获取内存使用量失败: {e}")
+            return 0.0
+
+    @abstractmethod
+    def game_logic(self):
+        """
+        游戏逻辑，子类必须实现此方法
+        """
+        pass
+
+    def on_start(self):
+        """
+        启动前钩子，子类可以重写此方法来执行启动前的操作
+        """
+        pass
+
+    def on_stop(self):
+        """
+        停止后钩子，子类可以重写此方法来执行停止后的操作
+        """
+        pass
+
+    def create_template_from_screenshot(self, region, filename):
+        """
+        从截图区域创建模板
+
+        Args:
+            region: 截图区域 (x, y, width, height)
+            filename: 模板文件名
+
+        Returns:
+            bool: 是否成功创建模板
+        """
+        # 捕获屏幕
+        screenshot = self.screen_capture.capture()
+
+        if screenshot is not None:
+            # 保存指定区域为模板
+            success = self.image_recognition.save_screenshot_region(
+                screenshot, region, filename
+            )
+
+            if success:
+                logger.info(f"模板已创建: {filename}")
+                return True
+
+        logger.error("创建模板失败")
+        return False
+    
+    def random_event(self):
+        """
+        随机事件，子类可以重写此方法来实现随机事件
+        """
+        
+        # 例
+        random_type = random.choice(["jump", "left_right", "squat_down"])
+        
+        if random_type == "jump":
+            # 跳跃
+            self.input_controller.key_press('space')
+            time.sleep(9)
+            self.input_controller.key_press('space')
+        elif random_type == "left_right":
+            # 左右移动 
+            self.input_controller.key_press('a')
+            time.sleep(9)
+            self.input_controller.key_press('d')
+        elif random_type == "squat_down":
+            # 蹲下
+            self.input_controller.key_down('ctrl')
+            time.sleep(9)
+            self.input_controller.key_up('ctrl')
+
+        pass

sautoscript/core/error_logger.py

@@ -0,0 +1,114 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+import os
+import sys
+import traceback
+import datetime
+from loguru import logger
+
+
+class ErrorLogger:
+    """
+    错误日志记录器
+    
+    用于在发生错误时将完整的错误信息保存到以时间命名的日志文件中
+    """
+    
+    def __init__(self, log_dir="logs/errors"):
+        """
+        初始化错误日志记录器
+        
+        Args:
+            log_dir: 错误日志目录
+        """
+        self.log_dir = log_dir
+        
+        # 确保错误日志目录存在
+        os.makedirs(self.log_dir, exist_ok=True)
+    
+    def log_error(self, error, context="", script_name=""):
+        """
+        记录错误到以时间命名的日志文件
+        
+        Args:
+            error: 错误对象或错误信息
+            context: 错误上下文信息
+            script_name: 脚本名称
+        """
+        # 生成时间戳作为文件名
+        timestamp = datetime.datetime.now().strftime("%Y%m%d_%H%M%S")
+        
+        # 添加脚本名称到文件名（如果有）
+        if script_name:
+            filename = f"{script_name}_{timestamp}.log"
+        else:
+            filename = f"error_{timestamp}.log"
+        
+        # 完整文件路径
+        filepath = os.path.join(self.log_dir, filename)
+        
+        # 构建错误信息
+        error_message = f"===== 错误日志 =====\n"
+        error_message += f"时间: {datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')}\n"
+        error_message += f"错误消息: {str(error)}\n"
+        
+        if script_name:
+            error_message += f"脚本名称: {script_name}\n"
+        
+        if context:
+            error_message += f"上下文信息:\n{context}\n"
+        
+        # 获取堆栈跟踪
+        error_message += "\n堆栈跟踪:\n"
+        error_message += traceback.format_exc()
+        error_message += "\n===================="
+        
+        # 写入错误日志文件
+        try:
+            with open(filepath, "w", encoding="utf-8") as f:
+                f.write(error_message)
+            
+            logger.info(f"错误日志已保存到: {filepath}")
+        except Exception as e:
+            logger.error(f"保存错误日志失败: {e}")
+
+
+# 全局错误日志记录器实例
+error_logger = ErrorLogger()
+
+
+def log_error(error, script_name="", context={}):
+    """
+    记录普通错误信息
+    
+    Args:
+        error: 错误信息
+        script_name: 脚本名称
+        context: 上下文信息（字典）
+    """
+    # 格式化上下文信息
+    context_str = ""
+    if context:
+        for key, value in context.items():
+            context_str += f"  {key}: {value}\n"
+    
+    error_logger.log_error(str(error), context_str, script_name)
+
+
+def log_exception(error, script_name="", context={}):
+    """
+    记录异常信息
+    
+    Args:
+        error: 异常对象或错误信息
+        script_name: 脚本名称
+        context: 上下文信息（字典）
+    """
+    # 格式化上下文信息
+    context_str = ""
+    if context:
+        for key, value in context.items():
+            context_str += f"  {key}: {value}\n"
+    
+    error_logger.log_error(str(error), context_str, script_name)