IntegerInput

class backpy.cli.elements.IntegerInput(message, default_value=None, min_value=None, max_value=None, allow_none=False, validate=<function _validate_integer>, suggest_matches=False, suggestible_values=None, confirm_suggestion=True, highlight_suggestion=True, invalid_error_message=None)

Bases: TextInput

Methods Summary

prompt()

Methods Documentation

Parameters:

  • message (str)

  • default_value (int | None)

  • min_value (int | None)

  • max_value (int | None)

  • allow_none (bool)

  • validate (Callable[[str], bool])

  • suggest_matches (bool)

  • suggestible_values (list[int] | None)

  • confirm_suggestion (bool)

  • highlight_suggestion (bool)

  • invalid_error_message (str | None)

prompt()
Return type:

int | None