bauiv1lib.account package

UI functionality related to accounts.

Submodules

bauiv1lib.account.page module

Doc-ui pages about an account, from the master server.

The classicaccount domain (see bacommon.docui.routes.classicaccount). Other domains’ pages open these through local-actions of their own, via bauiv1lib.docui.TypedDocUIController.browse_from() on a ClassicAccountUIController.

class bauiv1lib.account.page.ClassicAccountUIController

Bases: TypedDocUIController[Account, Placeholder]

DocUI setup for account pages.

fulfill_route(route: bacommon.docui.routes.classicaccount.AnyClassicAccountRoute) → DocUIResponse

Handle fulfillment for a route.

The type-safe equivalent of fulfill_request(); the same rules apply (called in a background thread; should always return a response).

fulfill_unrouted_request(request: bacommon.docui.v2.Request, error: str) → DocUIResponse

Handle a request that maps to none of our routes.

The default shows error. Controllers fronting a server should generally forward the request as-is here instead; a server is free to grow pages (or arg values) that older clients have no routes for, and those should keep working.

classmethod get_local_action_type() → type[ClassicAccountLocalAction]

Return the family class for the local-actions we handle.

Domains with no local-actions can leave this as is and pass typing.Never as their local-action type arg.

classmethod get_route_type() → type[ClassicAccountRoute]

Return the family class for the routes we handle.

run_local_action(action: bacommon.docui.routes.classicaccount.AnyClassicAccountLocalAction, context: DocUILocalAction) → None

Do something locally on behalf of the doc-ui.

The type-safe equivalent of local_action(); the same cautions apply. The original action is passed as context for access to the originating widget and window.

bauiv1lib.account.settings module

Provides UI for account functionality.

class bauiv1lib.account.settings.AccountSettingsWindow(transition: str | None = 'in_right', origin_widget: Widget | None = None, close_once_signed_in: bool = False, auxiliary_style: bool = True)

Bases: MainWindow

Window for account related functionality.

get_main_window_state() → MainWindowState

Return a WindowState to recreate this specific window.

Used to gracefully return to a window from another window or ui system.

main_window_should_preserve_selection() → bool

Whether this window should auto-save/restore selection.

If enabled, selection will be stored in the window’s shared state. See get_main_window_shared_state_id() for more info about main-window shared-state.

The default value of None results in a warning to explicitly override this (as the implicit default will change from False to True after api 9 support ends).

bauiv1lib.account.settings.show_what_is_legacy_unlinking_page() → None

Show the webpage describing legacy unlinking.

bauiv1lib.account.signin module

UI functionality related to accounts.

bauiv1lib.account.signin.show_sign_in_prompt(origin_widget: Widget | None = None) → None

Bring up a prompt telling the user they must sign in.

bauiv1lib.account.v2proxy module

V2 account ui bits.

class bauiv1lib.account.v2proxy.V2ProxySignInWindow(origin_widget: Widget)

Bases: Window

A window allowing signing in to a v2 account.

bauiv1lib.account.viewer module

Provides a popup for displaying info about any account.

class bauiv1lib.account.viewer.AccountViewerWindow(account_id: str, *, profile_id: str | None = None, position: tuple[float, float] = (0.0, 0.0), scale: float | None = None, offset: tuple[float, float] = (0.0, 0.0))

Bases: PopupWindow

Popup window that displays info for an account.

on_popup_cancel() → None

Called when the popup is canceled.

Cancels can occur due to clicking outside the window, hitting escape, etc.

popup_menu_closing(window: PopupMenu) → None

Called when the popup menu is closing.

popup_menu_selected_choice(window: PopupMenu, choice: str) → None

Called when a menu entry is selected.