maestral.cli.dialogs#

This module provides interactive commandline dialogs which are based on the survey Python library.

Module Contents#

maestral.cli.dialogs.P[source]#
maestral.cli.dialogs.T[source]#
maestral.cli.dialogs.exit_on_keyboard_interrupt(func)[source]#
Parameters:

func (Callable[P, T]) –

Return type:

Callable[P, T]

maestral.cli.dialogs.prompt(message, validate=None)[source]#
Parameters:

  • message (str) –

  • validate (Callable[[str], bool] | None) –

Return type:

str

maestral.cli.dialogs.confirm(message, default=True)[source]#
Parameters:

  • message (str) –

  • default (bool | None) –

Return type:

bool

maestral.cli.dialogs.select(message, options, hint='')[source]#
Parameters:

  • message (str) –

  • options (Sequence[str]) –

  • hint (str | None) –

Return type:

int

maestral.cli.dialogs.select_multiple(message, options, hint=None)[source]#
Parameters:

  • message (str) –

  • options (Sequence[str]) –

  • hint (str | None) –

Return type:

list[int]

maestral.cli.dialogs.select_path(message, default=None, validate=lambda x: ..., exists=False, files_allowed=True, dirs_allowed=True)[source]#
Parameters:

  • message (str) –

  • default (str | None) –

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

  • exists (bool) –

  • files_allowed (bool) –

  • dirs_allowed (bool) –

Return type:

str