mofox-plugin-dev-toolkit 0.3.3__py3-none-any.whl

mpdt/validators/base.py

@@ -0,0 +1,129 @@
+"""
+验证器基类
+"""
+
+from abc import ABC, abstractmethod
+from dataclasses import dataclass, field
+from enum import Enum
+from pathlib import Path
+
+
+class ValidationLevel(str, Enum):
+    """验证级别"""
+
+    ERROR = "error"
+    WARNING = "warning"
+    INFO = "info"
+
+
+@dataclass
+class ValidationIssue:
+    """验证问题"""
+
+    level: ValidationLevel
+    message: str
+    file_path: str | None = None
+    line_number: int | None = None
+    suggestion: str | None = None
+
+
+@dataclass
+class ValidationResult:
+    """验证结果"""
+
+    validator_name: str
+    issues: list[ValidationIssue] = field(default_factory=list)
+    success: bool = True
+
+    def add_error(self, message: str, file_path: str | None = None, line_number: int | None = None, suggestion: str | None = None) -> None:
+        """添加错误"""
+        self.issues.append(
+            ValidationIssue(
+                level=ValidationLevel.ERROR,
+                message=message,
+                file_path=file_path,
+                line_number=line_number,
+                suggestion=suggestion,
+            )
+        )
+        self.success = False
+
+    def add_warning(self, message: str, file_path: str | None = None, line_number: int | None = None, suggestion: str | None = None) -> None:
+        """添加警告"""
+        self.issues.append(
+            ValidationIssue(
+                level=ValidationLevel.WARNING,
+                message=message,
+                file_path=file_path,
+                line_number=line_number,
+                suggestion=suggestion,
+            )
+        )
+
+    def add_info(self, message: str, file_path: str | None = None, line_number: int | None = None) -> None:
+        """添加信息"""
+        self.issues.append(
+            ValidationIssue(
+                level=ValidationLevel.INFO,
+                message=message,
+                file_path=file_path,
+                line_number=line_number,
+            )
+        )
+
+    @property
+    def error_count(self) -> int:
+        """错误数量"""
+        return sum(1 for issue in self.issues if issue.level == ValidationLevel.ERROR)
+
+    @property
+    def warning_count(self) -> int:
+        """警告数量"""
+        return sum(1 for issue in self.issues if issue.level == ValidationLevel.WARNING)
+
+    @property
+    def info_count(self) -> int:
+        """信息数量"""
+        return sum(1 for issue in self.issues if issue.level == ValidationLevel.INFO)
+
+    def _update_counts(self) -> None:
+        """更新成功状态（根据错误数量）"""
+        if self.error_count > 0:
+            self.success = False
+        elif self.error_count == 0 and not self.success:
+            # 如果没有错误了，且之前是失败状态，更新为成功
+            self.success = True
+
+
+class BaseValidator(ABC):
+    """验证器基类"""
+
+    def __init__(self, plugin_path: Path):
+        """初始化验证器
+
+        Args:
+            plugin_path: 插件路径
+        """
+        self.plugin_path = plugin_path
+        self.result = ValidationResult(validator_name=self.__class__.__name__)
+
+    @abstractmethod
+    def validate(self) -> ValidationResult:
+        """执行验证
+
+        Returns:
+            ValidationResult: 验证结果
+        """
+        pass
+
+    def _get_plugin_name(self) -> str | None:
+        """获取插件名称（从目录名）
+
+        插件结构: my_plugin/plugin.py
+        """
+        # 检查 plugin.py 是否在根目录
+        if (self.plugin_path / "plugin.py").exists():
+            # 返回插件路径的目录名
+            return self.plugin_path.name
+
+        return None