kamihi.questions.bool

Generic boolean reusable question.

License

MIT

Classes:

Name	Description
Bool	Generic boolean reusable question.

Bool

Bool(
    text: str,
    error_text: str = None,
    true_values: set[str] = None,
    false_values: set[str] = None,
)

Bases: Question

Generic boolean reusable question.

Initialize an instance of the Bool question.

Parameters:

Name	Type	Description	Default
text	str	The text of the question.	required
error_text	str	The error text to display for invalid responses. Defaults to a value from settings.	None
true_values	set[str]	A set of strings that represent true values. Defaults to a value from settings.	None
false_values	set[str]	A set of strings that represent false values. Defaults to a value from settings.	None

Source code in src/kamihi/questions/bool.py

def __init__(
    self, text: str, error_text: str = None, true_values: set[str] = None, false_values: set[str] = None
) -> None:
    """
    Initialize an instance of the Bool question.

    Args:
        text (str): The text of the question.
        error_text (str, optional): The error text to display for invalid responses. Defaults to a value from settings.
        true_values (set[str], optional): A set of strings that represent true values. Defaults to a value from settings.
        false_values (set[str], optional): A set of strings that represent false values. Defaults to a value from settings.

    """
    super().__init__()
    self.question_text = text

    if error_text is not None:
        self.error_text = error_text

    if true_values is not None:
        self.true_values.update(true_values)

    if false_values is not None:
        self.false_values.update(false_values)