Views
- class proton.views.BasicView
- abstract display_error(message: str) None
Display an error message. No action is expected from user.
- Parameters:
message (str) – Message to display
- abstract display_notice(message: str) None
Display a message. No action is expected from user.
- Parameters:
message (str) – Message to display
- abstract display_session_list(sessions: list['Session'], ask_to_select_one: bool = False) 'Session' | None
Display a list of Sessions, and optionally ask the user to select one of them.
- abstract ask_credentials(ask_login: bool = False, ask_password: bool = False, ask_2fa: bool = False) tuple[str | None, str | None, str | None]
Ask user for credentials.
- Parameters:
ask_login (bool, optional) – Ask for user name, defaults to False
ask_password (bool, optional) – Ask for the password, defaults to False
ask_2fa (bool, optional) – Ask for a 2FA code, defaults to False
- Returns:
A tuple (login, password, 2fa). Values are None if not asked from the user, or if user cancelled.
- Return type:
tuple[Optional[str], Optional[str], Optional[str]]
- class proton.views.basiccli.BasicCLIView
Implementation of
proton.views.BasicView
for a CLI. It’s really just print + input calls.- display_error(message: str) None
Display an error message. No action is expected from user.
- Parameters:
message (str) – Message to display
- display_notice(message: str) None
Display a message. No action is expected from user.
- Parameters:
message (str) – Message to display
- display_session_list(sessions: list['Session'], ask_to_select_one: bool = False) None
Display a list of Sessions, and optionally ask the user to select one of them.
- ask_credentials(ask_login: bool = False, ask_password: bool = False, ask_2fa: bool = False) tuple[str | None, str | None, str | None]
Ask user for credentials.
- Parameters:
ask_login (bool, optional) – Ask for user name, defaults to False
ask_password (bool, optional) – Ask for the password, defaults to False
ask_2fa (bool, optional) – Ask for a 2FA code, defaults to False
- Returns:
A tuple (login, password, 2fa). Values are None if not asked from the user, or if user cancelled.
- Return type:
tuple[Optional[str], Optional[str], Optional[str]]