j9dZddlmZddlZddlmZddlmZdZddd d d Z dd dd Z d gdgdgdgddgdZ ddddddddddZ Gdde Zd#d ZeZGd!d"ZdS)$u2The keyboard: from a key name to the four fields Juggler demands. ⛔ THIS FILE EXISTS BECAUSE `Page.dispatchKeyEvent` DOES NOT FORGIVE A WRONG FIELD SILENTLY - IT FORGIVES IT TOO MUCH. It wants `key`, `code`, `keyCode` and `location` together, and if `code` is empty and `keyCode` is zero the event still fires: the character shows up in the field, the action succeeds, the tests pass, and the page reads `event.code === ""` on a key that on every real Firefox has a physical name. It is a tell that lives in the fields nobody looks at because the action worked. The first draft of `_type` in `actions.py` sent exactly that: `code: ""`, `keyCode: 0`, for every character. **THREE DETAILS READ IN THE DRIVER'S CODE, not deduced** (`coreBundle.js`, `RawKeyboardImpl3`), and each one changes the bytes that go out: 1. The `keyCode` field carries **`keyCodeWithoutLocation`**, not `keyCode`. They differ exactly on the keys that exist twice: `ShiftLeft` has `keyCode` 160 and `keyCodeWithoutLocation` 16, and 16 is what a real Firefox puts in the event. 2. For Enter, `text` must be set to an **empty string**, not to `"\r"`: Gecko generates the character. Sending it explicitly inserts it twice. 3. `keyup` NEVER carries `text`. With `text` Juggler raises `keyup does not support text option` and typing dies halfway through. **And the layout is not here**: it lives in `keylayout.py`, GENERATED from the bundle by `scripts/gen_key_layout.py`. Here there is only how a name is resolved, which is the algorithm of `buildLayoutClosure` read in the driver and rewritten. ) annotationsN)Optional)LAYOUT)AltControlMetaShift)rrr r )rrr r rrr   ) ShiftLeft ControlLeftAltLeftMetaLeftEnter VolumeMute)codekeyCodeWithoutLocation VolumeDownVolumeUp)AudioVolumeMuteAudioVolumeDown AudioVolumeUpceZdZdZdS) UnknownKeyuThe name is not in the layout. ⛔ It is REJECTED instead of inventing an empty event: a `keyCode: 0` does not fail, it lies.N)__name__ __module__ __qualname____doc__OC:\Projects\Muse2API\.venv\Lib\site-packages\invisible_core/juggler/keyboard.pyr!r!Cs>>>>r'r!returndictc i}tjD]\}}|dpd}||dpd|dp|dpd||dpd|dpdd}t|d kr||d<d }|d rEt |}|d |d<|d |d<|d r |d |d<t || ||<t |gD]}|||<|drQt|dd kr||d||r+||dt |d |S)u}The name -> description dict, in the same shape as the driver. A key is reachable by `code` (`KeyA`), by `key` if it is a single character (`a`), by its shifted form (`A`), and by aliases (`Shift`). ⛔ A key with `location` does NOT get entered by `key`: `NumpadEnter` must not respond to the name `Enter`, or `press("Enter")` would end up on the numpad. keykeyCoderrtextlocation)r,r.rrr/r0rNshiftKey shiftKeyCode)shifted)ritemsgetlenr*ALIASES setdefault)outrdr,descrr3aliass r(_build_closurer=HsC<>>HHaeeEll buuY'',1&'ee,D&E&E'?)*y)9)9'?=>EE&MM'Rj)).Q   s88q==E&M 55   75kkGz]GEN mGFOuu^$$ 7%&~%6 "000D [[r**  ECJJ 55     uU|   ! ! NN5< / / /  H NN75>4+F+F+F G G G Jr'cpeZdZdZdddZdd Zdd Zd d Zd dZddd!dZ ddd"dZ d#dZ d$dZ d%dZ dS)&KeyboardaThe state of modifiers and pressed keys, plus the four verbs. STATE is the reason this is a class and not three functions: `press("Shift+a")` must send `A` and not `a`, and to know that it must remember that Shift is down between Shift's keydown and `a`'s. Nsessionstrc||_||_t|_t|_||_||_dSN)cr@set modifierspressedpersonaacts)self connectionr@rHrIs r(__init__zKeyboard.__init__}s< !eeEE   r'r,r)r*c|dkrdn|}t|}|td|zd|jvr|dr|d}t |}t |jdks!t |jdkrd|jvrd|d<|t|d i|S) N ControlOrMetarzunknown key: %r. Valid names are the layout's `code` values (KeyA, Digit1, Enter), a single character, or an alias (Shift, Control, Alt, Meta).r r3rr-r/r,)LAYOUT_CLOSUREr5r!rFr*r6updateFIREFOX_OVERRIDES)rJr,namer:s r(describezKeyboard.describes?22yy   t $ $ 957:;<< < dn $ $y)9)9 $) A GG t~   " "T^$$))gT^.K.KAfI "&&qx44555r'intcZd}|jD] }|t|dz}!|S)Nr)rF MODIFIER_MASKr5)rJmrRs r( modifier_maskzKeyboard.modifier_masks9 N , ,D ""4++ +AAr'Nonec ||}|d|jv}|j|d|dtvr |j|d|d}|dkrd}|jdd|d|d|d|d ||d |jd dS) Nrr,r/rr-Page.dispatchKeyEventkeydownrr0)typer,rr.r0repeatr/ r@timeout)rSrGadd MODIFIERSrFrDsendr@)rJr,r:r^r/s r(downz Keyboard.downs MM#  6dl* 6### U8y N  qx ( ( (y 4<<D  +'%!F)!"#;!<"#J-6"$$"\2  7 7 7 7 7r'c R||}|dtvr |j|d|j|d|jdd|d|d|d|ddd|jd dS) Nr,rr[keyuprr0F)r]r,rr.r0r^r_r`)rSrcrFdiscardrGrDrdr@)rJr,r:s r(upz Keyboard.ups MM#   U8y N " "1U8 , , , QvY'''  +%ah& !"#;!<"#J-5BB"\2  7 7 7 7 7r'dwell_msrkOptional[float]c|d}|d|dd}}|dkr|r d|dd}}||}|D]}|| |||dkrtj|dz ||t |D]}||dS#t |D]}||wxYw)u`press("a")`, `press("Enter")`, `press("Control+Shift+KeyA")`. The modifiers are held down for the whole final key and released in reverse order, the way a hand would. ⛔ `dwell_ms` IS HOW LONG THE KEY STAYS DOWN, and the unit is in the name on purpose: see the note on `type`. Zero was the only value this could produce before, which put `keyup` one protocol round trip after `keydown` - about 2.4 ms, where a finger takes 60-120. It applies to the FINAL key only. A modifier is held across the whole press by construction, so giving it a dwell of its own would be a second statement about the same duration. +Nr-@@)split _dwell_msretimesleeprireversed)rJr,rkpiecesfinalheldrWs r(presszKeyboard.presss!3Rj&"+t B;;4;tCRCy4E  ~~''H  A IIaLLLL  IIe   #~~ 8f,--- GGENNNd^^     Xd^^    s -AC)Drp)delay_msr/r{floatcP|D]}|tvrtd|z||}t|D]`\}}||\}}||||r|n|}|dkr-|t |dz krt j|dz adS)uROne key per character, with the rhythm of a hand. ⛔ This is NOT `insert_text`: a character the layout does not know (an ideogram, an emoji) has no key, so here it is REJECTED and deferred to `insert_text`. Typing something with no key would mean sending `code: ""`, which is exactly the defect this file exists to not have. ⛔ THE UNIT IS IN THE NAME, AND IT IS A FIX. The parameter used to be called `delay` and was handed straight to `time.sleep`, which takes SECONDS, while the public API documents it in MILLISECONDS. On the one path that actually forwarded it - the ElementHandle one - `type("abc", delay=100)` therefore slept for five minutes instead of 0.3 seconds. The six paths that dropped the value were accidentally protected from the bug the seventh had. ⛔ AND THE CALLER'S VALUE IS AN OVERRIDE, NOT THE DEFENCE. Without a persona this class used to emit keys as fast as the pipe allows, so the only thing standing between a caller and an inhuman rhythm was a parameter they had to know to pass - and every install that passed `delay=100` would have shared one flat rhythm, which is a key that links them. The persona is per-session and is what runs when nobody asks for anything. zu%r has no key on the US layout: use `insert_text`, which goes through `Page.insertText` and does not fake a keypress.rjrprrqN)rOr!_plan enumeraterzr6rtru) rJr/r{chplanirkgap_mswait_mss r(r]z Keyboard.types2 - -B'' ')+,---( zz$t__ - -EAr#Aw Hf JJrHJ - - -"*6hhG}}SYY]!2!2 7V+,,,  - -r'cV|jdS|dddS)zHow long ONE key stays down, for a press that is not part of typed text. Zero without a persona, which is what turning humanising off means.Nrpxr)rHr~)rJs r(rszKeyboard._dwell_ms(s+ < 3zz#q!!$$r'c|jdgt|zSddlm}|||j|jdS)uROne `(dwell_ms, gap_ms)` per character, from the session's persona. ⛔ Falls back to no rhythm rather than to a made-up one. A default constant here would be the shared invariant the persona exists to remove, and it would be invisible: every install would type alike and nothing would report it. N)rprpr) plan_typingtyping)nonce)rHr6 _behaviourrrInext)rJr/rs r(r~zKeyboard._plan0sX < <#d))+ +++++++{4TY^^H5M5MNNNNr'cP|jdd|i|jddS)znThe text goes in without key events. This is what is needed for a character that is not on the layout.zPage.insertTextr/r_r`N)rDrdr@)rJr/s r( insert_textzKeyboard.insert_text=s;  %~!\2  7 7 7 7 7r'rC)r@rA)r,rAr)r*)r)rT)r,rAr)rY)r,rArkrlr)rY)r/rAr{r|r)rY)r)r|)r/rA)r/rAr)rY)r"r#r$r%rLrSrXrerirzr]rsr~rr&r'r(r?r?us>*7777$ 7 7 7 7>B''''''R47&-&-&-&-&-&-P%%%% O O O O777777r'r?)r)r*)r% __future__rrtrr keylayoutrrcrV BUTTON_MASKr7rQ ValueErrorr!r=rOr?r&r'r(rs]<#"""""  0 a!Q?? a  ! 9+gF8tTl L L!-LL ,LL(CHH>>>>>>>> ''''T !!L7L7L7L7L7L7L7L7L7L7r'