domino_admin_toolkit.analyzers.base module

pydantic model domino_admin_toolkit.analyzers.base.AnalyzerBase

Bases: BaseModel, ABC

The base class for creating analyzers that perform specific analysis tasks.

Attributes:

name (ClassVar[str]): The name of the analyzer. results (List[CheckResult]): A list containing the results of the analysis.

Methods:

__init__(self, config: Optional[Dict[str, Any]] = None): Initializes the analyzer with optional configuration. mark_result(self, msg: str, status: Status) -> None: Records a result with a message and status. analyze(self, data: Dict[str, Any]) -> List[CheckResult]: Abstract method to be implemented by subclasses.

Fields:

• results (list[domino_admin_toolkit.status.status.CheckResult])

field results: list[CheckResult] = []

abstract analyze(data)

Analyzes the provided data and returns a list of CheckResult instances.

Return type:

list[CheckResult]

Args:

data (Dict[str, Any]): The data to be analyzed. The structure depends on the analyzer’s implementation.

Returns:

List[CheckResult]: A list containing the results of the analysis.

Raises:

NotImplementedError: If this method is not implemented by subclasses.

name: ClassVar[str] = 'DefaultAnalyzer'