Class ConfiguredComponent

traccheck.py:40–86

Encapsulate the logic for a single component line in [components].

@dataclass
class ConfiguredComponent:
    """
    Encapsulate the logic for a single component line in [components].
    """

    env: TracEnvironment
    pathstr: str
    boolstr: str

    @property
    def is_installed(self):
        """
        Recursively navigate the environment's installed components to figure out if
        this one matches one (or more) of them.
        """
        branch = self.env.registered_component_tree
        for node in self.pathstr.split("."):
            if node == "*":
                return bool(branch)
            if node not in branch:
                return False
            branch = branch[node]

        assert not branch, f"Final node in installation tree is not empty: {branch!r}"
        return True

    @property
    def is_valid_boolstr(self):
        """
        Only accept either `enabled` or `disabled`, this is to prevent issues with trailing
        comments. For example the line `someplugin.* = enabled  # we need this` would not
        enable the plugin because of the comment.
        """
        return self.boolstr in {"enabled", "disabled"}

    def __str__(self):
        return f"{self.pathstr} = {self.boolstr}"

    def get_lint_errors(self):
        errors = []

        if not self.is_valid_boolstr:
            errors.append("Invalid boolean value")
        if not self.is_installed:
            errors.append("Component is not installed")

        return errors


class CommandEnvironment(TracEnvironment):