Cj;YJSrSSKJr SSKrSSKJrJr SSKrSSK J r SSK J r J r SSKJr SSKJrJrJrJrJrJr SS KJrJr SS KJr SSS jjr"S S \5r"SS\5r\R@RCSS9"SS\\ 55r"g)z This module contains the `Pilot` class used by [App.run_test][textual.app.App.run_test] to programmatically operate an app. See the guide on how to [test Textual apps](/guide/testing). ) annotationsN)AnyGeneric) wait_for_idle)App ReturnType)HeadlessDriver)Click MouseDown MouseEvent MouseMoveMouseUpResize)OffsetSize)Widgetc XURRU-upgUUUSSUUUUUUS. nU$)zNGet the arguments to pass into mouse messages for the click and hover methods.r) widgetxydelta_xdelta_ybuttonshiftmetactrlscreen_xscreen_y)regionoffset) targetr rrrcontrolclick_xclick_ymessage_argumentss _/home/rurouni/.local/share/pipx/venvs/strix-agent/lib/python3.13/site-packages/textual/pilot.py_get_mouse_message_argumentsr'sL}}++f4G    c\rSrSrSrSrg) OutOfBounds2zFRaised when the pilot mouse target is outside of the (visible) screen.N__name__ __module__ __qualname____firstlineno____doc____static_attributes__r,r(r&r*r*2sPr(r*c\rSrSrSrSrg)WaitForScreenTimeout6zException raised if messages aren't being processed quickly enough. If this occurs, the most likely explanation is some kind of deadlock in the app code. r,Nr-r,r(r&r5r56sr(r5T)angularc\rSrSrSrSSjrSSjr\SSj5rSSjr SSjr SSS jjr SSS jjr SS S jjr SSS jjrSSS jjrS!S"SjjrS#S$SjjrS%S&SjjrS'S(SjjrS)SjrS)SjrS*SjrSrg)+Pilot=zPilot object to drive an app.cXlgN_app)selfapps r&__init__Pilot.__init__As r(c#,# SUR4v g7f)Nr@r=r?s r& __rich_repr__Pilot.__rich_repr__DsTYYscUR$)z$App: A reference to the application.r=rDs r&r@ Pilot.appGsyyr(c# U(a<URRU5IShvN UR5IShvN ggNN7f)z7Simulate key-presses. Args: *keys: Keys to press. N)r> _press_keys_wait_for_screen)r?keyss r&press Pilot.pressLs? ))''- - -'') ) )  - )s!&A AA A A  A c$# [X5n[URR[5(aX0RRlURR [X355 UR5IShvN gN7f)zResize the terminal to the given dimensions. Args: width: The new width of the terminal. height: The new height of the terminal. N) r isinstancer@_driverr _size post_messagerpause)r?widthheightsizes r&resize_terminalPilot.resize_terminalVs^E" dhh&& 7 7%)HH   " fT01jjlsBBB BNc # UR[[/UUUUUUS9IShvN $N![anUSeSnAff=f7f)aSimulate a [`MouseDown`][textual.events.MouseDown] event at a specified position. The final position for the event is computed based on the selector provided and the offset specified and it must be within the visible area of the screen. Args: widget: A widget or selector used as an origin for the event offset. If this is not specified, the offset is interpreted relative to the screen. You can use this parameter to try to target a specific widget. However, if the widget is currently hidden or obscured by another widget, the event may not land on the widget you specified. offset: The offset for the event. The offset is relative to the selector / widget provided or to the screen, if no selector is provided. shift: Simulate the event with the shift key held down. meta: Simulate the event with the meta key held down. control: Simulate the event with the control key held down. button: The mouse button to press. Raises: OutOfBounds: If the position for the event is outside of the (visible) screen. Returns: True if no selector was specified or if the event landed on the selected widget, False otherwise. rr rrrr"N)_post_mouse_eventsr r r*)r?rr rrr"rerrors r& mouse_downPilot.mouse_downds`D "00I&1  "T ! "+A"-+-A- ?:?Ac # UR[[/UUSUUUS9IShvN $N![anUSeSnAff=f7f)aSimulate a [`MouseUp`][textual.events.MouseUp] event at a specified position. The final position for the event is computed based on the selector provided and the offset specified and it must be within the visible area of the screen. Args: widget: A widget or selector used as an origin for the event offset. If this is not specified, the offset is interpreted relative to the screen. You can use this parameter to try to target a specific widget. However, if the widget is currently hidden or obscured by another widget, the event may not land on the widget you specified. offset: The offset for the event. The offset is relative to the widget / selector provided or to the screen, if no selector is provided. shift: Simulate the event with the shift key held down. meta: Simulate the event with the meta key held down. control: Simulate the event with the control key held down. Raises: OutOfBounds: If the position for the event is outside of the (visible) screen. Returns: True if no selector was specified or if the event landed on the selected widget, False otherwise. r[N)r\r rr*)r?rr rrr"r]s r&mouse_upPilot.mouse_ups`@ "00G$1  "T ! "r`c # UR[[[/UUUUUUUS9IShvN $N![anUSeSnAff=f7f)a7Simulate clicking with the mouse at a specified position. The final position to be clicked is computed based on the selector provided and the offset specified and it must be within the visible area of the screen. Implementation note: This method bypasses the normal event processing in `App.on_event`. Example: The code below runs an app and clicks its only button right in the middle: ```py async with SingleButtonApp().run_test() as pilot: await pilot.click(Button, offset=(8, 1)) ``` Args: widget: A widget or selector used as an origin for the click offset. If this is not specified, the offset is interpreted relative to the screen. You can use this parameter to try to click on a specific widget. However, if the widget is currently hidden or obscured by another widget, the click may not land on the widget you specified. offset: The offset to click. The offset is relative to the widget / selector provided or to the screen, if no selector is provided. shift: Click with the shift key held down. meta: Click with the meta key held down. control: Click with the control key held down. times: The number of times to click. 2 will double-click, 3 will triple-click, etc. button: The mouse button to click. Raises: OutOfBounds: If the position to be clicked is outside of the (visible) screen. Returns: `True` if no selector was specified or if the selected widget was under the mouse when the click was initiated. `False` is the selected widget was not under the pointer. )rr rrrr"timesN)r\r rr r*) r?rr rrr"rfrr]s r&click Pilot.clickseZ "00GU+1     "T ! "s0A(313A3 AAAAc D# URXX4USUS9IShvN $N7f)aSimulate double clicking with the mouse at a specified position. Alias for `pilot.click(..., times=2)`. The final position to be clicked is computed based on the selector provided and the offset specified and it must be within the visible area of the screen. Implementation note: This method bypasses the normal event processing in `App.on_event`. Example: The code below runs an app and double-clicks its only button right in the middle: ```py async with SingleButtonApp().run_test() as pilot: await pilot.double_click(Button, offset=(8, 1)) ``` Args: widget: A widget or selector used as an origin for the click offset. If this is not specified, the offset is interpreted relative to the screen. You can use this parameter to try to click on a specific widget. However, if the widget is currently hidden or obscured by another widget, the click may not land on the widget you specified. offset: The offset to click. The offset is relative to the widget / selector provided or to the screen, if no selector is provided. shift: Click with the shift key held down. meta: Click with the meta key held down. control: Click with the control key held down. button: The mouse button to click. Raises: OutOfBounds: If the position to be clicked is outside of the (visible) screen. Returns: `True` if no selector was specified or if the selected widget was under the mouse when the click was initiated. `False` is the selected widget was not under the pointer. rfrNrgr?rr rrr"rs r& double_clickPilot.double_click3ZZZ E&       c D# URXX4USUS9IShvN $N7f)aSimulate triple clicking with the mouse at a specified position. Alias for `pilot.click(..., times=3)`. The final position to be clicked is computed based on the selector provided and the offset specified and it must be within the visible area of the screen. Implementation note: This method bypasses the normal event processing in `App.on_event`. Example: The code below runs an app and triple-clicks its only button right in the middle: ```py async with SingleButtonApp().run_test() as pilot: await pilot.triple_click(Button, offset=(8, 1)) ``` Args: widget: A widget or selector used as an origin for the click offset. If this is not specified, the offset is interpreted relative to the screen. You can use this parameter to try to click on a specific widget. However, if the widget is currently hidden or obscured by another widget, the click may not land on the widget you specified. offset: The offset to click. The offset is relative to the widget / selector provided or to the screen, if no selector is provided. shift: Click with the shift key held down. meta: Click with the meta key held down. control: Click with the control key held down. button: The mouse button to click. Raises: OutOfBounds: If the position to be clicked is outside of the (visible) screen. Returns: `True` if no selector was specified or if the selected widget was under the mouse when the click was initiated. `False` is the selected widget was not under the pointer. rkNrlrms r& triple_clickPilot.triple_click,rprqc# UR5IShvN UR[/XSS9IShvN $N#N![anUSeSnAff=f7f)aSimulate hovering with the mouse cursor at a specified position. The final position to be hovered is computed based on the selector provided and the offset specified and it must be within the visible area of the screen. Args: widget: A widget or selector used as an origin for the hover offset. If this is not specified, the offset is interpreted relative to the screen. You can use this parameter to try to hover a specific widget. However, if the widget is currently hidden or obscured by another widget, the hover may not land on the widget you specified. offset: The offset to hover. The offset is relative to the widget / selector provided or to the screen, if no selector is provided. Raises: OutOfBounds: If the position to be hovered is outside of the (visible) screen. Returns: True if no selector was specified or if the hover landed on the selected widget, False otherwise. Nr)r)rTr\r r*)r?rr r]s r&hover Pilot.hover]sX8jjl "00)fUV0WW W W "T ! "s:A:A><>A> AA  AAc `# URn U Rn UcU n O)[U[5(aUn OU R U5n [ U UUUUUS9n [ U SU S5nX:R;a [S5eSn [SUS-5HknUHbnUR5IShvN U nU[La0UESU0EnU cU R"U6un nU"S0UD6nX9l U RU5 Md Mm UR5IShvN USL=(d XL$NyN7f) aSSimulate a series of mouse events to be fired at a given position. The final position for the events is computed based on the selector provided and the offset specified and it must be within the visible area of the screen. This function abstracts away the commonalities of the other mouse event-related functions that the pilot exposes. Args: widget: A widget or selector used as the origin for the event's offset. If this is not specified, the offset is interpreted relative to the screen. You can use this parameter to try to target a specific widget. However, if the widget is currently hidden or obscured by another widget, the events may not land on the widget you specified. offset: The offset for the events. The offset is relative to the widget / selector provided or to the screen, if no selector is provided. shift: Simulate the events with the shift key held down. meta: Simulate the events with the meta key held down. control: Simulate the events with the control key held down. times: The number of times to click. 2 will double-click, 3 will triple-click, etc. Raises: OutOfBounds: If the position for the events is outside of the (visible) screen. Returns: True if no selector was specified or if the *final* event landed on the selected widget, False otherwise. N)rrrr"rrz"M  ' '"M",,V4M8    )#.0A#0FG  &N  1eai(E#)jjl""+"e+777F$##4f#=LIq'1&1 &,"%%e,)$*).jjl~;!;;-#* s%B.D.0D*1A&D.D,D.,D.c^ ^ # URRnUR/URSS9QnSm [R "5m S U U 4SjjnUH nUR U5(dMT S- m M" T (a[R"T R55[R"URRR55/n[R"UU[RS9IShvN upxUHn U R5 M [U5[U5:Hn U (a [S 5eT S:agg![a gf=fN`7f) a}Wait for the current screen and its children to have processed all pending events. Args: timeout: A timeout in seconds to wait. Returns: `True` if all events were processed. `False` if an exception occurred, meaning that not all events could be processed. Raises: WaitForScreenTimeout: If the screen and its children didn't finish processing within the timeout. FT) with_selfrc>>TS-mTS:XaTR5 gg)z@Decrement internal counter, and set an event if it reaches zero.rbrN)set)countcount_zero_eventsr&decrement_counter1Pilot._wait_for_screen..decrement_counters& QJEz $$&r(rb)timeout return_whenNz@Timed out while waiting for widgets to process pending messages.returnNone)r@r{ Exception walk_childrenasyncioEvent call_later create_taskwait_exception_eventFIRST_COMPLETEDcancellenr5) r?rr{childrenrchildwait_forrpendingtask timed_outrrs @@r&rKPilot._wait_for_screensM XX__FHHDv33d3CD"==? ' 'E 122  ##$4$9$9$;<##DHH$=$=$B$B$DEH '||#33 JA    H W5I*V qy[  2s<E+EAE+5BE+E) AE+ E&#E+%E&&E+c# UR5IShvN Uc[S5IShvN O[R"U5IShvN URR R 5 gN^NJN-7f)zRInsert a pause. Args: delay: Seconds to pause, or None to wait for cpu idle. Nr)rKrrsleepr@r{_on_timer_update)r?delays r&rT Pilot.pauses]##%%% =" " "--& & & ((* & " &s1A;A5A;A7A; A9 *A;7A;9A;c# URRR5IShvN URRR 5 gN)7f)z+Wait for any current animation to complete.N)r>animatorrr@r{rrDs r&wait_for_animationPilot.wait_for_animation%s:ii  ..000 ((* 1s(AA*Ac@# UR5IShvN URRR5IShvN UR5IShvN [ 5IShvN UR R R5 gNNUN?N/7f)z:Wait for any current and scheduled animations to complete.N)rKr>rwait_until_completerr@r{rrDs r&wait_for_scheduled_animations#Pilot.wait_for_scheduled_animations*sr##%%%ii  44666##%%%o ((* &6%sEBB+BBBBB,B-*BBBBc# UR5IShvN [5IShvN URRU5 gN2N"7f)zhExit the app with the given result. Args: result: The app result returned by `run` or `run_async`. N)rKrr@exit)r?results r&r Pilot.exit2s< ##%%%o  f &sA A A A !A  A r=)r@App[ReturnType]rr)rzrich.repr.Result)rr)rLstrrr)rUintrVrrr)NrrFFFrb)r"Widget | type[Widget] | str | Noner tuple[int, int]rboolrrr"rrrrr)NrFFF) rrr rrrrrr"rrr)NrFFFrbrb)rrr rrrrrr"rrfrrrrr)Nr)r)Widget | type[Widget] | str | None | Noner rrr)NrrFFFrb)rzlist[type[MouseEvent]]rrr rrrrrrrr"rrfrrr)g>@)rfloatrrr<)rz float | Nonerrr)rrrr)r.r/r0r1r2rArEpropertyr@rMrXr^rcrgrnrtrwr\rKrTrrrr3r,r(r&r9r9=s'*  6:"(-"2-" -" -"  -"  -"-" -"b6:"( +"2+" +" +"  +"  +" +"^6:"(9"29" 9" 9"  9"  9"9"9" 9"z6:"(/ 2/  /  /  /  / /  / f6:"(/ 2/  /  /  /  / /  / f=A"( "9 "  "  "J=A"(X<&X<:X< X<  X<  X<X<X<X< Xrs#'':SS)! %          4Q)Q9|GJ ||r(