arno/trezor-firmware
1
0
Fork 0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-11-16 04:29:08 +00:00
Code Issues Releases Wiki Activity

fixup! fixup! docs(core): Layout lifecycle documentation

Browse Source
This commit is contained in:
obrusvit 2024-10-17 15:25:09 +02:00 committed by Martin Milata
parent 580a724ec8
commit 33a8d61734
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
core/src/trezor/ui/__init__.py
View File

@ -177,8 +177,8 @@ class Layout(Generic[T]):
"""True if the layout is in RUNNING state.""" """True if the layout is in RUNNING state."""
return CURRENT_LAYOUT is self return CURRENT_LAYOUT is self
def is_stopped(self) -> bool: def is_finished(self) -> bool:
"""True if the layout is in STOPPED state.""" """True if the layout is in FINISHED state."""
return CURRENT_LAYOUT is not self and not self.result_box.is_empty() return CURRENT_LAYOUT is not self and not self.result_box.is_empty()
def is_layout_attached(self) -> bool: def is_layout_attached(self) -> bool:
@ -187,7 +187,7 @@ class Layout(Generic[T]):
def start(self) -> None: def start(self) -> None:
"""Start the layout, stopping any other RUNNING layout. """Start the layout, stopping any other RUNNING layout.
If the layout is already RUNNING, do nothing. If the layout is STOPPED, fail. If the layout is already RUNNING, do nothing. If the layout is FINISHED, fail.
""" """
global CURRENT_LAYOUT global CURRENT_LAYOUT
@ -227,7 +227,7 @@ class Layout(Generic[T]):
current layout. current layout.
The resulting state is either READY (if there is no result to be picked up) or The resulting state is either READY (if there is no result to be picked up) or
STOPPED. FINISHED.
When called externally, this kills any tasks that wait for the result, assuming When called externally, this kills any tasks that wait for the result, assuming
that the external `stop()` is a kill. When called internally, `_kill_taker` is that the external `stop()` is a kill. When called internally, `_kill_taker` is
@ -263,7 +263,7 @@ class Layout(Generic[T]):
"""Wait for, and return, the result of this UI layout.""" """Wait for, and return, the result of this UI layout."""
if self.is_ready(): if self.is_ready():
self.start() self.start()
# else we are (a) still running or (b) already stopped # else we are (a) still running or (b) already finished
try: try:
if self.context is not None and self.result_box.is_empty(): if self.context is not None and self.result_box.is_empty():
self._start_task(self._handle_usb_iface()) self._start_task(self._handle_usb_iface())
@ -297,7 +297,6 @@ class Layout(Generic[T]):
elif __debug__: elif __debug__:
self.notify_debuglink(self) self.notify_debuglink(self)
if state is not None: if state is not None:
self.state = state self.state = state
@ -424,7 +423,10 @@ class Layout(Generic[T]):
ButtonAck, ButtonAck,
) )
if self. button_request_ack_pending and self.state is LayoutState.TRANSITIONING: if (
self.button_request_ack_pending
and self.state is LayoutState.TRANSITIONING
):
self.button_request_ack_pending = False self.button_request_ack_pending = False
self.state = LayoutState.ATTACHED self.state = LayoutState.ATTACHED
if __debug__: if __debug__: