# Copyright 2020, Microsoft Corporation
#
# SPDX-License-Identifier: LGPL-2.1-only
#
import logging
from typing import List
from ..exception import InvalidType, InvalidCheckValue
from .checkermodule import CheckerModule
from .util import config_bool_value
ATTR_OPT = "attr"
MISSINOK_OPT = "missing_ok"
class EmptyTypeAttr(CheckerModule):
"""Checker module for asserting a type attribute is empty."""
check_type = "empty_typeattr"
check_config = frozenset((ATTR_OPT, MISSINOK_OPT))
def __init__(self, policy, checkname, config) -> None:
super().__init__(policy, checkname, config)
self.log = logging.getLogger(__name__)
self._attr = None
self._missing_ok = False
# this will make the check pass automatically
# since the attribute is missing. Only set if
# missing_ok is True AND attr is missing.
self._pass_by_missing = False
self.missing_ok = config.get(MISSINOK_OPT)
self.attr = config.get(ATTR_OPT)
@property
def attr(self):
return self._attr
@attr.setter
def attr(self, value):
try:
if not value:
raise InvalidCheckValue("{}: \"{}\" setting is missing.".format(self.checkname,
ATTR_OPT))
self._attr = self.policy.lookup_typeattr(value)
self._pass_by_missing = False
except InvalidType as e:
if not self.missing_ok:
raise InvalidCheckValue("{}: attr setting error: {}".format(
self.checkname, e)) from e
self._attr = value
self._pass_by_missing = True
@property
def missing_ok(self):
return self._missing_ok
@missing_ok.setter
def missing_ok(self, value):
self._missing_ok = config_bool_value(value)
if self._missing_ok and isinstance(self.attr, str):
# attr is only a string if it doesn't exist.
self._pass_by_missing = True
else:
self._pass_by_missing = False
def run(self) -> List:
self.log.info("Checking type attribute {} is empty.".format(self.attr))
failures = []
if self._pass_by_missing:
self.log_info(" {} does not exist.".format(self.attr))
else:
self.output.write("Member types of {}:\n".format(self.attr))
types = sorted(self.attr.expand())
if types:
for type_ in types:
self.log_fail(type_.name)
failures.append(type_)
else:
self.log_ok(" <empty>")
self.log.debug("{} failure(s)".format(failures))
return failures
