Source code for config.config_types.bool

import typing

from .base_type import BaseType


class Bool(BaseType):
    #: :class:`typing.Optional` [:class:`bool`]: Current value
    value: typing.Optional[bool]

    def __init__(self) -> None:
        """
        Base Bool type for config

        :Basic usage:

        >>> Bool()
        <config_types.Bool object with value None>
        """
        self.value = None

    def check_value(self, value: bool) -> bool:
        """
        Check if value is a correct bool

        :Basic usage:

        >>> my_bool = Bool()
        >>> my_bool.check_value(0)
        True
        >>> my_bool.check_value(-2)
        True
        >>> my_bool.check_value(345)
        True
        >>> my_bool.check_value(0)
        True
        >>> my_bool.check_value(-2)
        True
        >>> my_bool.check_value(345)
        True
        >>> my_bool.check_value(10)
        True
        >>> my_bool.check_value(-2)
        True
        >>> my_bool.check_value(20)
        True
        >>> my_bool.check_value(2)
        True
        >>> my_bool.check_value(4)
        True
        >>> my_bool.check_value(5)
        True

        :param bool value: value to check
        :return: True if value is correct
        :rtype: bool
        """
        try:
            bool(value)
        except ValueError:
            return False
        return True

    def set(self, value: bool) -> None:
        """
        Set value of parameter

        :Basic usage:

        >>> my_bool = Bool()
        >>> my_bool.set(34)

        :param bool value: Value to set
        """
        if not self.check_value(value):
            raise ValueError("Attempt to set incompatible value.")
        self.value = bool(value)

    def get(self) -> typing.Optional[bool]:
        """
        Get value of parameter

        :Basic usage:

        >>> my_bool = Bool()
        >>> my_bool.set(34)
        >>> my_bool.get()
        True

        :return: Value of parameter
        :rtype: typing.Optional[bool]
        """
        return self.value

    def to_save(self) -> bool:
        """
        Build a serializable object

        :Basic usage:

        >>> my_bool = Bool()
        >>> my_bool.to_save()
        >>> my_bool.set(34)
        >>> my_bool.to_save()
        True

        :return: Current value
        :rtype: bool
        """
        return self.value

    def load(self, value: bool) -> None:
        """
        Load serialized value

        >>> my_bool = Bool()
        >>> my_bool.load(True)
        >>> my_bool.get()
        True

        :param bool value: Value to load
        """
        if not self.check_value(value):
            raise ValueError("Attempt to load incompatible value.")
        self.value = value

    def __repr__(self):
        return f'<config_types.Bool object with value {self.value}>'