rule_base

Module for RuleBase

!!! classes RuleBase

RuleBase (IRule, ABC)

Implementation of the rule base

Source code in rules/rule_base.py

class RuleBase(IRule, ABC):
    """Implementation of the rule base"""

    def __init__(self, name: str, input_variable_names: List[str]):
        self._name = name
        self._description = ""
        self._input_variable_names = input_variable_names
        self._output_variable_name = "output"

    @property
    def name(self) -> str:
        """Name of the rule"""
        return self._name

    @name.setter
    def name(self, name: str):
        """Name of the rule"""
        self._name = name

    @property
    def description(self) -> str:
        """Description of the rule"""
        return self._description

    @description.setter
    def description(self, description: str):
        """Description of the rule"""
        self._description = description

    @property
    def input_variable_names(self) -> List[str]:
        """Name of the input variable"""
        return self._input_variable_names

    @input_variable_names.setter
    def input_variable_names(self, input_variable_names: List[str]) -> List[str]:
        """Name of the input variables"""
        self._input_variable_names = input_variable_names

    @property
    def output_variable_name(self) -> str:
        """Name of the output variable"""
        return self._output_variable_name

    @output_variable_name.setter
    def output_variable_name(self, output_variable_name: str):
        """Name of the output variable"""
        self._output_variable_name = output_variable_name

    def validate(self, logger: ILogger) -> bool:
        """Validates if the rule is valid

        Returns:
            bool: wether the rule is valid
        """
        return True

description: str property writable

Description of the rule

input_variable_names: List[str] property writable

Name of the input variable

name: str property writable

Name of the rule

output_variable_name: str property writable

Name of the output variable

validate(self, logger)

Validates if the rule is valid

Returns:

Type	Description
bool	wether the rule is valid

Source code in rules/rule_base.py

def validate(self, logger: ILogger) -> bool:
    """Validates if the rule is valid

    Returns:
        bool: wether the rule is valid
    """
    return True