adgtk.utils.cli

CLI utilities are intende to improve overall UX

class adgtk.utils.cli.ChoiceValidator(choices: list)

Bases: Validator

Used for validating the user input is expected based on choices.

__init__(choices: list)

validate(document)

Validate the input. If invalid, this should raise a ValidationError.

Parameters:

document – Document instance.

class adgtk.utils.cli.FloatValidator

Bases: Validator

Used for validating an entry is an Float

validate(document)

Validate the input. If invalid, this should raise a ValidationError.

Parameters:

document – Document instance.

class adgtk.utils.cli.IntValidator

Bases: Validator

Used for validating an entry is an Integer

validate(document)

Validate the input. If invalid, this should raise a ValidationError.

Parameters:

document – Document instance.

class adgtk.utils.cli.MaxLengthValidator(max_length: int)

Bases: Validator

Used for validating an entry does not exceed a length

__init__(max_length: int)

validate(document)

Validate the input. If invalid, this should raise a ValidationError.

Parameters:

document – Document instance.

class adgtk.utils.cli.MaxValueValidator(max_value: int | float)

Bases: Validator

Max value checks

__init__(max_value: int | float)

validate(document)

Validate the input. If invalid, this should raise a ValidationError.

Parameters:

document – Document instance.

class adgtk.utils.cli.MinLengthValidator(min_length: int)

Bases: Validator

Used for validating an entry has a minimum length

__init__(min_length: int)

validate(document)

Validate the input. If invalid, this should raise a ValidationError.

Parameters:

document – Document instance.

class adgtk.utils.cli.MinValueValidator(min_value: int | float)

Bases: Validator

Min value checks

__init__(min_value: int | float)

validate(document)

Validate the input. If invalid, this should raise a ValidationError.

Parameters:

document – Document instance.

class adgtk.utils.cli.MultiValidator(validators: list)

Bases: Validator

__init__(validators: list)

validate(document)

Validate the input. If invalid, this should raise a ValidationError.

Parameters:

document – Document instance.

class adgtk.utils.cli.NoWhitespaceValidator

Bases: Validator

Used for validating an entry does not have a space

validate(document)

Validate the input. If invalid, this should raise a ValidationError.

Parameters:

document – Document instance.

adgtk.utils.cli.bottom_toolbar(helper: str | None = None, configuring: str | None = None, choices: list | None = None) → HTML

adgtk.utils.cli.clear_screen()

Clears the screen in the terminal.

adgtk.utils.cli.create_line(text: str = '', char: str = '=', modified: int = 0, title: str | None = None) → str

Creates a line

Parameters:

• text (str) – The text to underline/line. defaults to “”

• char (str, optional) – The character to create line with, defaults to “=”

• modified (int) – The additional/less characters in line, defaults to 0

• title (Union[str, None]) – The title to add to the line, defaults to None

Returns:

_A line using both the text length and modified value

Return type:

str

adgtk.utils.cli.get_more_ask(configuring: str | None = None) → bool

adgtk.utils.cli.get_user_input(user_prompt: str, requested: Literal['float', 'str', 'int', 'bool', 'ml-str'], configuring: str | None = None, helper: str | None = None, choices: list | None = None, allow_whitespace: bool = True, default_selection: float | str | int | bool | None = None, max_characters: int | None = None, min_characters: int | None = None, min_value: int | None = None, max_value: int | None = None, limit_ml_line_length: int | None = None) → str | int | float | bool

adgtk.utils.cli.prompt_continuation(width, line_number, wrap_count)