| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297 |
- # Copyright (c) Microsoft Corporation.
- #
- # Licensed under the Apache License, Version 2.0 (the "License");
- # you may not use this file except in compliance with the License.
- # You may obtain a copy of the License at
- #
- # http://www.apache.org/licenses/LICENSE-2.0
- #
- # Unless required by applicable law or agreed to in writing, software
- # distributed under the License is distributed on an "AS IS" BASIS,
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- # See the License for the specific language governing permissions and
- # limitations under the License.
- import datetime
- import pathlib
- import typing
- from typing import Literal
- from playwright._impl._api_structures import (
- BrowserBindResult,
- ClientCertificate,
- Cookie,
- DebuggerLocation,
- DebuggerPausedDetails,
- DropPayload,
- FilePayload,
- FloatRect,
- Geolocation,
- HttpCredentials,
- NameValue,
- PdfMargins,
- Position,
- ProxySettings,
- RemoteAddr,
- RequestSizes,
- ResourceTiming,
- ScreencastFrame,
- SecurityDetails,
- SetCookieParam,
- SourceLocation,
- StorageState,
- TracingGroupLocation,
- ViewportSize,
- WebErrorLocation,
- )
- from playwright._impl._assertions import (
- APIResponseAssertions as APIResponseAssertionsImpl,
- )
- from playwright._impl._assertions import LocatorAssertions as LocatorAssertionsImpl
- from playwright._impl._assertions import PageAssertions as PageAssertionsImpl
- from playwright._impl._async_base import (
- AsyncBase,
- AsyncContextManager,
- AsyncEventContextManager,
- mapping,
- )
- from playwright._impl._browser import Browser as BrowserImpl
- from playwright._impl._browser_context import BrowserContext as BrowserContextImpl
- from playwright._impl._browser_type import BrowserType as BrowserTypeImpl
- from playwright._impl._cdp_session import CDPSession as CDPSessionImpl
- from playwright._impl._clock import Clock as ClockImpl
- from playwright._impl._console_message import ConsoleMessage as ConsoleMessageImpl
- from playwright._impl._debugger import Debugger as DebuggerImpl
- from playwright._impl._dialog import Dialog as DialogImpl
- from playwright._impl._disposable import Disposable as DisposableImpl
- from playwright._impl._download import Download as DownloadImpl
- from playwright._impl._element_handle import ElementHandle as ElementHandleImpl
- from playwright._impl._errors import Error
- from playwright._impl._fetch import APIRequest as APIRequestImpl
- from playwright._impl._fetch import APIRequestContext as APIRequestContextImpl
- from playwright._impl._fetch import APIResponse as APIResponseImpl
- from playwright._impl._file_chooser import FileChooser as FileChooserImpl
- from playwright._impl._form_data import FormData
- from playwright._impl._frame import Frame as FrameImpl
- from playwright._impl._helper import to_milliseconds
- from playwright._impl._input import Keyboard as KeyboardImpl
- from playwright._impl._input import Mouse as MouseImpl
- from playwright._impl._input import Touchscreen as TouchscreenImpl
- from playwright._impl._js_handle import JSHandle as JSHandleImpl
- from playwright._impl._locator import FrameLocator as FrameLocatorImpl
- from playwright._impl._locator import Locator as LocatorImpl
- from playwright._impl._network import Request as RequestImpl
- from playwright._impl._network import Response as ResponseImpl
- from playwright._impl._network import Route as RouteImpl
- from playwright._impl._network import WebSocket as WebSocketImpl
- from playwright._impl._network import WebSocketRoute as WebSocketRouteImpl
- from playwright._impl._page import Page as PageImpl
- from playwright._impl._page import Worker as WorkerImpl
- from playwright._impl._playwright import Playwright as PlaywrightImpl
- from playwright._impl._screencast import Screencast as ScreencastImpl
- from playwright._impl._selectors import Selectors as SelectorsImpl
- from playwright._impl._tracing import Tracing as TracingImpl
- from playwright._impl._video import Video as VideoImpl
- from playwright._impl._web_error import WebError as WebErrorImpl
- class Request(AsyncBase):
- @property
- def url(self) -> str:
- """Request.url
- URL of the request.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.url)
- @property
- def resource_type(self) -> str:
- """Request.resource_type
- Contains the request's resource type as it was perceived by the rendering engine. ResourceType will be one of the
- following: `document`, `stylesheet`, `image`, `media`, `font`, `script`, `texttrack`, `xhr`, `fetch`,
- `eventsource`, `websocket`, `manifest`, `other`.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.resource_type)
- @property
- def service_worker(self) -> typing.Optional["Worker"]:
- """Request.service_worker
- The Service `Worker` that is performing the request.
- **Details**
- This method is Chromium only. It's safe to call when using other browsers, but it will always be `null`.
- Requests originated in a Service Worker do not have a `request.frame()` available.
- Returns
- -------
- Union[Worker, None]
- """
- return mapping.from_impl_nullable(self._impl_obj.service_worker)
- @property
- def method(self) -> str:
- """Request.method
- Request's method (GET, POST, etc.)
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.method)
- @property
- def post_data(self) -> typing.Optional[str]:
- """Request.post_data
- Request's post body, if any.
- Returns
- -------
- Union[str, None]
- """
- return mapping.from_maybe_impl(self._impl_obj.post_data)
- @property
- def post_data_json(self) -> typing.Optional[typing.Any]:
- """Request.post_data_json
- Returns parsed request's body for `form-urlencoded` and JSON as a fallback if any.
- When the response is `application/x-www-form-urlencoded` then a key/value object of the values will be returned.
- Otherwise it will be parsed as JSON.
- Returns
- -------
- Union[Any, None]
- """
- return mapping.from_maybe_impl(self._impl_obj.post_data_json)
- @property
- def post_data_buffer(self) -> typing.Optional[bytes]:
- """Request.post_data_buffer
- Request's post body in a binary form, if any.
- Returns
- -------
- Union[bytes, None]
- """
- return mapping.from_maybe_impl(self._impl_obj.post_data_buffer)
- @property
- def existing_response(self) -> typing.Optional["Response"]:
- """Request.existing_response
- Returns the `Response` object if the response has already been received, `null` otherwise.
- Unlike `request.response()`, this method does not wait for the response to arrive. It returns immediately
- with the response object if the response has been received, or `null` if the response has not been received yet.
- Returns
- -------
- Union[Response, None]
- """
- return mapping.from_impl_nullable(self._impl_obj.existing_response)
- @property
- def frame(self) -> "Frame":
- """Request.frame
- Returns the `Frame` that initiated this request.
- **Usage**
- ```py
- frame_url = request.frame.url
- ```
- **Details**
- Note that in some cases the frame is not available, and this method will throw.
- - When request originates in the Service Worker. You can use `request.serviceWorker()` to check that.
- - When navigation request is issued before the corresponding frame is created. You can use
- `request.is_navigation_request()` to check that.
- Here is an example that handles all the cases:
- Returns
- -------
- Frame
- """
- return mapping.from_impl(self._impl_obj.frame)
- @property
- def redirected_from(self) -> typing.Optional["Request"]:
- """Request.redirected_from
- Request that was redirected by the server to this one, if any.
- When the server responds with a redirect, Playwright creates a new `Request` object. The two requests are connected
- by `redirectedFrom()` and `redirectedTo()` methods. When multiple server redirects has happened, it is possible to
- construct the whole redirect chain by repeatedly calling `redirectedFrom()`.
- **Usage**
- For example, if the website `http://example.com` redirects to `https://example.com`:
- ```py
- response = await page.goto(\"http://example.com\")
- print(response.request.redirected_from.url) # \"http://example.com\"
- ```
- If the website `https://google.com` has no redirects:
- ```py
- response = await page.goto(\"https://google.com\")
- print(response.request.redirected_from) # None
- ```
- Returns
- -------
- Union[Request, None]
- """
- return mapping.from_impl_nullable(self._impl_obj.redirected_from)
- @property
- def redirected_to(self) -> typing.Optional["Request"]:
- """Request.redirected_to
- New request issued by the browser if the server responded with redirect.
- **Usage**
- This method is the opposite of `request.redirected_from()`:
- ```py
- assert request.redirected_from.redirected_to == request
- ```
- Returns
- -------
- Union[Request, None]
- """
- return mapping.from_impl_nullable(self._impl_obj.redirected_to)
- @property
- def failure(self) -> typing.Optional[str]:
- """Request.failure
- The method returns `null` unless this request has failed, as reported by `requestfailed` event.
- **Usage**
- Example of logging of all the failed requests:
- ```py
- page.on(\"requestfailed\", lambda request: print(request.url + \" \" + request.failure))
- ```
- Returns
- -------
- Union[str, None]
- """
- return mapping.from_maybe_impl(self._impl_obj.failure)
- @property
- def timing(self) -> ResourceTiming:
- """Request.timing
- Returns resource timing information for given request. Most of the timing values become available upon the
- response, `responseEnd` becomes available when request finishes. Find more information at
- [Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
- **Usage**
- ```py
- async with page.expect_event(\"requestfinished\") as request_info:
- await page.goto(\"http://example.com\")
- request = await request_info.value
- print(request.timing)
- ```
- Returns
- -------
- {startTime: float, domainLookupStart: float, domainLookupEnd: float, connectStart: float, secureConnectionStart: float, connectEnd: float, requestStart: float, responseStart: float, responseEnd: float}
- """
- return mapping.from_impl(self._impl_obj.timing)
- @property
- def headers(self) -> typing.Dict[str, str]:
- """Request.headers
- An object with the request HTTP headers. The header names are lower-cased. Note that this method does not return
- security-related headers, including cookie-related ones. You can use `request.all_headers()` for complete
- list of headers that include `cookie` information.
- Returns
- -------
- Dict[str, str]
- """
- return mapping.from_maybe_impl(self._impl_obj.headers)
- async def sizes(self) -> RequestSizes:
- """Request.sizes
- Returns resource size information for given request.
- Returns
- -------
- {requestBodySize: int, requestHeadersSize: int, responseBodySize: int, responseHeadersSize: int}
- """
- return mapping.from_impl(await self._impl_obj.sizes())
- async def response(self) -> typing.Optional["Response"]:
- """Request.response
- Returns the matching `Response` object, or `null` if the response was not received due to error.
- Returns
- -------
- Union[Response, None]
- """
- return mapping.from_impl_nullable(await self._impl_obj.response())
- def is_navigation_request(self) -> bool:
- """Request.is_navigation_request
- Whether this request is driving frame's navigation.
- Some navigation requests are issued before the corresponding frame is created, and therefore do not have
- `request.frame()` available.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(self._impl_obj.is_navigation_request())
- async def all_headers(self) -> typing.Dict[str, str]:
- """Request.all_headers
- An object with all the request HTTP headers associated with this request. The header names are lower-cased.
- Returns
- -------
- Dict[str, str]
- """
- return mapping.from_maybe_impl(await self._impl_obj.all_headers())
- async def headers_array(self) -> typing.List[NameValue]:
- """Request.headers_array
- An array with all the request HTTP headers associated with this request. Unlike `request.all_headers()`,
- header names are NOT lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple
- times.
- Returns
- -------
- List[{name: str, value: str}]
- """
- return mapping.from_impl_list(await self._impl_obj.headers_array())
- async def header_value(self, name: str) -> typing.Optional[str]:
- """Request.header_value
- Returns the value of the header matching the name. The name is case-insensitive.
- Parameters
- ----------
- name : str
- Name of the header.
- Returns
- -------
- Union[str, None]
- """
- return mapping.from_maybe_impl(await self._impl_obj.header_value(name=name))
- mapping.register(RequestImpl, Request)
- class Response(AsyncBase):
- @property
- def url(self) -> str:
- """Response.url
- Contains the URL of the response.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.url)
- @property
- def ok(self) -> bool:
- """Response.ok
- Contains a boolean stating whether the response was successful (status in the range 200-299) or not.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(self._impl_obj.ok)
- @property
- def status(self) -> int:
- """Response.status
- Contains the status code of the response (e.g., 200 for a success).
- Returns
- -------
- int
- """
- return mapping.from_maybe_impl(self._impl_obj.status)
- @property
- def status_text(self) -> str:
- """Response.status_text
- Contains the status text of the response (e.g. usually an \"OK\" for a success).
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.status_text)
- @property
- def headers(self) -> typing.Dict[str, str]:
- """Response.headers
- An object with the response HTTP headers. The header names are lower-cased. Note that this method does not return
- security-related headers, including cookie-related ones. You can use `response.all_headers()` for complete
- list of headers that include `cookie` information.
- Returns
- -------
- Dict[str, str]
- """
- return mapping.from_maybe_impl(self._impl_obj.headers)
- @property
- def from_service_worker(self) -> bool:
- """Response.from_service_worker
- Indicates whether this Response was fulfilled by a Service Worker's Fetch Handler (i.e. via
- [FetchEvent.respondWith](https://developer.mozilla.org/en-US/docs/Web/API/FetchEvent/respondWith)).
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(self._impl_obj.from_service_worker)
- @property
- def request(self) -> "Request":
- """Response.request
- Returns the matching `Request` object.
- Returns
- -------
- Request
- """
- return mapping.from_impl(self._impl_obj.request)
- @property
- def frame(self) -> "Frame":
- """Response.frame
- Returns the `Frame` that initiated this response.
- Returns
- -------
- Frame
- """
- return mapping.from_impl(self._impl_obj.frame)
- async def all_headers(self) -> typing.Dict[str, str]:
- """Response.all_headers
- An object with all the response HTTP headers associated with this response.
- Returns
- -------
- Dict[str, str]
- """
- return mapping.from_maybe_impl(await self._impl_obj.all_headers())
- async def headers_array(self) -> typing.List[NameValue]:
- """Response.headers_array
- An array with all the request HTTP headers associated with this response. Unlike `response.all_headers()`,
- header names are NOT lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple
- times.
- Returns
- -------
- List[{name: str, value: str}]
- """
- return mapping.from_impl_list(await self._impl_obj.headers_array())
- async def header_value(self, name: str) -> typing.Optional[str]:
- """Response.header_value
- Returns the value of the header matching the name. The name is case-insensitive. If multiple headers have the same
- name (except `set-cookie`), they are returned as a list separated by `, `. For `set-cookie`, the `\\n` separator is
- used. If no headers are found, `null` is returned.
- Parameters
- ----------
- name : str
- Name of the header.
- Returns
- -------
- Union[str, None]
- """
- return mapping.from_maybe_impl(await self._impl_obj.header_value(name=name))
- async def header_values(self, name: str) -> typing.List[str]:
- """Response.header_values
- Returns all values of the headers matching the name, for example `set-cookie`. The name is case-insensitive.
- Parameters
- ----------
- name : str
- Name of the header.
- Returns
- -------
- List[str]
- """
- return mapping.from_maybe_impl(await self._impl_obj.header_values(name=name))
- async def server_addr(self) -> typing.Optional[RemoteAddr]:
- """Response.server_addr
- Returns the IP address and port of the server.
- Returns
- -------
- Union[{ipAddress: str, port: int}, None]
- """
- return mapping.from_impl_nullable(await self._impl_obj.server_addr())
- async def security_details(self) -> typing.Optional[SecurityDetails]:
- """Response.security_details
- Returns SSL and other security information.
- Returns
- -------
- Union[{issuer: Union[str, None], protocol: Union[str, None], subjectName: Union[str, None], validFrom: Union[float, None], validTo: Union[float, None]}, None]
- """
- return mapping.from_impl_nullable(await self._impl_obj.security_details())
- async def http_version(self) -> str:
- """Response.http_version
- Returns the http version used by the response.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(await self._impl_obj.http_version())
- async def finished(self) -> None:
- """Response.finished
- Waits for this response to finish, returns always `null`.
- """
- return mapping.from_maybe_impl(await self._impl_obj.finished())
- async def body(self) -> bytes:
- """Response.body
- Returns the buffer with response body.
- Returns
- -------
- bytes
- """
- return mapping.from_maybe_impl(await self._impl_obj.body())
- async def text(self) -> str:
- """Response.text
- Returns the text representation of response body.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(await self._impl_obj.text())
- async def json(self) -> typing.Any:
- """Response.json
- Returns the JSON representation of response body.
- This method will throw if the response body is not parsable via `JSON.parse`.
- Returns
- -------
- Any
- """
- return mapping.from_maybe_impl(await self._impl_obj.json())
- mapping.register(ResponseImpl, Response)
- class Route(AsyncBase):
- @property
- def request(self) -> "Request":
- """Route.request
- A request to be routed.
- Returns
- -------
- Request
- """
- return mapping.from_impl(self._impl_obj.request)
- async def abort(self, error_code: typing.Optional[str] = None) -> None:
- """Route.abort
- Aborts the route's request.
- Parameters
- ----------
- error_code : Union[str, None]
- Optional error code. Defaults to `failed`, could be one of the following:
- - `'aborted'` - An operation was aborted (due to user action)
- - `'accessdenied'` - Permission to access a resource, other than the network, was denied
- - `'addressunreachable'` - The IP address is unreachable. This usually means that there is no route to the
- specified host or network.
- - `'blockedbyclient'` - The client chose to block the request.
- - `'blockedbyresponse'` - The request failed because the response was delivered along with requirements which are
- not met ('X-Frame-Options' and 'Content-Security-Policy' ancestor checks, for instance).
- - `'connectionaborted'` - A connection timed out as a result of not receiving an ACK for data sent.
- - `'connectionclosed'` - A connection was closed (corresponding to a TCP FIN).
- - `'connectionfailed'` - A connection attempt failed.
- - `'connectionrefused'` - A connection attempt was refused.
- - `'connectionreset'` - A connection was reset (corresponding to a TCP RST).
- - `'internetdisconnected'` - The Internet connection has been lost.
- - `'namenotresolved'` - The host name could not be resolved.
- - `'timedout'` - An operation timed out.
- - `'failed'` - A generic failure occurred.
- """
- return mapping.from_maybe_impl(await self._impl_obj.abort(errorCode=error_code))
- async def fulfill(
- self,
- *,
- status: typing.Optional[int] = None,
- headers: typing.Optional[typing.Dict[str, str]] = None,
- body: typing.Optional[typing.Union[str, bytes]] = None,
- json: typing.Optional[typing.Any] = None,
- path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- content_type: typing.Optional[str] = None,
- response: typing.Optional["APIResponse"] = None,
- ) -> None:
- """Route.fulfill
- Fulfills route's request with given response.
- **Usage**
- An example of fulfilling all requests with 404 responses:
- ```py
- await page.route(\"**/*\", lambda route: route.fulfill(
- status=404,
- content_type=\"text/plain\",
- body=\"not found!\"))
- ```
- An example of serving static file:
- ```py
- await page.route(\"**/xhr_endpoint\", lambda route: route.fulfill(path=\"mock_data.json\"))
- ```
- Parameters
- ----------
- status : Union[int, None]
- Response status code, defaults to `200`.
- headers : Union[Dict[str, str], None]
- Response headers. Header values will be converted to a string.
- body : Union[bytes, str, None]
- Response body.
- json : Union[Any, None]
- JSON response. This method will set the content type to `application/json` if not set.
- path : Union[pathlib.Path, str, None]
- File path to respond with. The content type will be inferred from file extension. If `path` is a relative path,
- then it is resolved relative to the current working directory.
- content_type : Union[str, None]
- If set, equals to setting `Content-Type` response header.
- response : Union[APIResponse, None]
- `APIResponse` to fulfill route's request with. Individual fields of the response (such as headers) can be
- overridden using fulfill options.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.fulfill(
- status=status,
- headers=mapping.to_impl(headers),
- body=body,
- json=mapping.to_impl(json),
- path=path,
- contentType=content_type,
- response=response._impl_obj if response else None,
- )
- )
- async def fetch(
- self,
- *,
- url: typing.Optional[str] = None,
- method: typing.Optional[str] = None,
- headers: typing.Optional[typing.Dict[str, str]] = None,
- post_data: typing.Optional[typing.Union[typing.Any, str, bytes]] = None,
- max_redirects: typing.Optional[int] = None,
- max_retries: typing.Optional[int] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> "APIResponse":
- """Route.fetch
- Performs the request and fetches result without fulfilling it, so that the response could be modified and then
- fulfilled.
- **Usage**
- ```py
- async def handle(route):
- response = await route.fetch()
- json = await response.json()
- json[\"message\"][\"big_red_dog\"] = []
- await route.fulfill(response=response, json=json)
- await page.route(\"https://dog.ceo/api/breeds/list/all\", handle)
- ```
- **Details**
- Note that `headers` option will apply to the fetched request as well as any redirects initiated by it. If you want
- to only apply `headers` to the original request, but not to redirects, look into `route.continue_()`
- instead.
- Parameters
- ----------
- url : Union[str, None]
- If set changes the request URL. New URL must have same protocol as original one.
- method : Union[str, None]
- If set changes the request method (e.g. GET or POST).
- headers : Union[Dict[str, str], None]
- If set changes the request HTTP headers. Header values will be converted to a string.
- post_data : Union[Any, bytes, str, None]
- Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string
- and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type`
- header will be set to `application/octet-stream` if not explicitly set.
- max_redirects : Union[int, None]
- Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is
- exceeded. Defaults to `20`. Pass `0` to not follow redirects.
- max_retries : Union[int, None]
- Maximum number of times network errors should be retried. Currently only `ECONNRESET` error is retried. Does not
- retry based on HTTP response codes. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries.
- timeout : Union[float, None]
- Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.
- Returns
- -------
- APIResponse
- """
- return mapping.from_impl(
- await self._impl_obj.fetch(
- url=url,
- method=method,
- headers=mapping.to_impl(headers),
- postData=mapping.to_impl(post_data),
- maxRedirects=max_redirects,
- maxRetries=max_retries,
- timeout=to_milliseconds(timeout),
- )
- )
- async def fallback(
- self,
- *,
- url: typing.Optional[str] = None,
- method: typing.Optional[str] = None,
- headers: typing.Optional[typing.Dict[str, str]] = None,
- post_data: typing.Optional[typing.Union[typing.Any, str, bytes]] = None,
- ) -> None:
- """Route.fallback
- Continues route's request with optional overrides. The method is similar to `route.continue_()` with the
- difference that other matching handlers will be invoked before sending the request.
- **Usage**
- When several routes match the given pattern, they run in the order opposite to their registration. That way the
- last registered route can always override all the previous ones. In the example below, request will be handled by
- the bottom-most handler first, then it'll fall back to the previous one and in the end will be aborted by the first
- registered route.
- ```py
- await page.route(\"**/*\", lambda route: route.abort()) # Runs last.
- await page.route(\"**/*\", lambda route: route.fallback()) # Runs second.
- await page.route(\"**/*\", lambda route: route.fallback()) # Runs first.
- ```
- Registering multiple routes is useful when you want separate handlers to handle different kinds of requests, for
- example API calls vs page resources or GET requests vs POST requests as in the example below.
- ```py
- # Handle GET requests.
- async def handle_get(route):
- if route.request.method != \"GET\":
- await route.fallback()
- return
- # Handling GET only.
- # ...
- # Handle POST requests.
- async def handle_post(route):
- if route.request.method != \"POST\":
- await route.fallback()
- return
- # Handling POST only.
- # ...
- await page.route(\"**/*\", handle_get)
- await page.route(\"**/*\", handle_post)
- ```
- One can also modify request while falling back to the subsequent handler, that way intermediate route handler can
- modify url, method, headers and postData of the request.
- ```py
- async def handle(route, request):
- # override headers
- headers = {
- **request.headers,
- \"foo\": \"foo-value\", # set \"foo\" header
- \"bar\": None # remove \"bar\" header
- }
- await route.fallback(headers=headers)
- await page.route(\"**/*\", handle)
- ```
- Use `route.continue_()` to immediately send the request to the network, other matching handlers won't be
- invoked in that case.
- Parameters
- ----------
- url : Union[str, None]
- If set changes the request URL. New URL must have same protocol as original one. Changing the URL won't affect the
- route matching, all the routes are matched using the original request URL.
- method : Union[str, None]
- If set changes the request method (e.g. GET or POST).
- headers : Union[Dict[str, str], None]
- If set changes the request HTTP headers. Header values will be converted to a string.
- post_data : Union[Any, bytes, str, None]
- If set changes the post data of request.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.fallback(
- url=url,
- method=method,
- headers=mapping.to_impl(headers),
- postData=mapping.to_impl(post_data),
- )
- )
- async def continue_(
- self,
- *,
- url: typing.Optional[str] = None,
- method: typing.Optional[str] = None,
- headers: typing.Optional[typing.Dict[str, str]] = None,
- post_data: typing.Optional[typing.Union[typing.Any, str, bytes]] = None,
- ) -> None:
- """Route.continue_
- Sends route's request to the network with optional overrides.
- **Usage**
- ```py
- async def handle(route, request):
- # override headers
- headers = {
- **request.headers,
- \"foo\": \"foo-value\", # set \"foo\" header
- \"bar\": None # remove \"bar\" header
- }
- await route.continue_(headers=headers)
- await page.route(\"**/*\", handle)
- ```
- **Details**
- The `headers` option applies to both the routed request and any redirects it initiates. However, `url`, `method`,
- and `postData` only apply to the original request and are not carried over to redirected requests.
- `route.continue_()` will immediately send the request to the network, other matching handlers won't be
- invoked. Use `route.fallback()` If you want next matching handler in the chain to be invoked.
- **NOTE** Some request headers are **forbidden** and cannot be overridden (for example, `Cookie`, `Host`,
- `Content-Length` and others, see
- [this MDN page](https://developer.mozilla.org/en-US/docs/Glossary/Forbidden_request_header) for full list). If an
- override is provided for a forbidden header, it will be ignored and the original request header will be used.
- To set custom cookies, use `browser_context.add_cookies()`.
- Parameters
- ----------
- url : Union[str, None]
- If set changes the request URL. New URL must have same protocol as original one.
- method : Union[str, None]
- If set changes the request method (e.g. GET or POST).
- headers : Union[Dict[str, str], None]
- If set changes the request HTTP headers. Header values will be converted to a string.
- post_data : Union[Any, bytes, str, None]
- If set changes the post data of request.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.continue_(
- url=url,
- method=method,
- headers=mapping.to_impl(headers),
- postData=mapping.to_impl(post_data),
- )
- )
- mapping.register(RouteImpl, Route)
- class WebSocket(AsyncBase):
- @typing.overload
- def on(
- self,
- event: Literal["close"],
- f: typing.Callable[["WebSocket"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Fired when the websocket closes."""
- @typing.overload
- def on(
- self,
- event: Literal["framereceived"],
- f: typing.Callable[
- ["typing.Union[bytes, str]"], "typing.Union[typing.Awaitable[None], None]"
- ],
- ) -> None:
- """
- Fired when the websocket receives a frame."""
- @typing.overload
- def on(
- self,
- event: Literal["framesent"],
- f: typing.Callable[
- ["typing.Union[bytes, str]"], "typing.Union[typing.Awaitable[None], None]"
- ],
- ) -> None:
- """
- Fired when the websocket sends a frame."""
- @typing.overload
- def on(
- self,
- event: Literal["socketerror"],
- f: typing.Callable[["str"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Fired when the websocket has an error."""
- def on(
- self,
- event: str,
- f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]],
- ) -> None:
- return super().on(event=event, f=f)
- @typing.overload
- def once(
- self,
- event: Literal["close"],
- f: typing.Callable[["WebSocket"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Fired when the websocket closes."""
- @typing.overload
- def once(
- self,
- event: Literal["framereceived"],
- f: typing.Callable[
- ["typing.Union[bytes, str]"], "typing.Union[typing.Awaitable[None], None]"
- ],
- ) -> None:
- """
- Fired when the websocket receives a frame."""
- @typing.overload
- def once(
- self,
- event: Literal["framesent"],
- f: typing.Callable[
- ["typing.Union[bytes, str]"], "typing.Union[typing.Awaitable[None], None]"
- ],
- ) -> None:
- """
- Fired when the websocket sends a frame."""
- @typing.overload
- def once(
- self,
- event: Literal["socketerror"],
- f: typing.Callable[["str"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Fired when the websocket has an error."""
- def once(
- self,
- event: str,
- f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]],
- ) -> None:
- return super().once(event=event, f=f)
- @property
- def url(self) -> str:
- """WebSocket.url
- Contains the URL of the WebSocket.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.url)
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["close"],
- predicate: typing.Optional[typing.Callable[["WebSocket"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["WebSocket"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["framereceived"],
- predicate: typing.Optional[
- typing.Callable[["typing.Union[bytes, str]"], bool]
- ] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["typing.Union[bytes, str]"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["framesent"],
- predicate: typing.Optional[
- typing.Callable[["typing.Union[bytes, str]"], bool]
- ] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["typing.Union[bytes, str]"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["socketerror"],
- predicate: typing.Optional[typing.Callable[["str"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["str"]: ...
- @typing.overload
- def expect_event(
- self,
- event: str,
- predicate: typing.Optional[typing.Callable[..., bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager[typing.Any]: ...
- def expect_event(
- self,
- event: str,
- predicate: typing.Optional[typing.Callable] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> AsyncEventContextManager:
- """WebSocket.expect_event
- Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy
- value. Will throw an error if the webSocket is closed before the event is fired. Returns the event data value.
- Parameters
- ----------
- event : str
- Event name, same one would pass into `webSocket.on(event)`.
- predicate : Union[Callable, None]
- Receives the event data and resolves to truthy value when the waiting should resolve.
- timeout : Union[float, None]
- Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The
- default value can be changed by using the `browser_context.set_default_timeout()`.
- Returns
- -------
- EventContextManager
- """
- return AsyncEventContextManager(
- self._impl_obj.expect_event(
- event=event,
- predicate=self._wrap_handler(predicate),
- timeout=to_milliseconds(timeout),
- ).future
- )
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["close"],
- predicate: typing.Optional[typing.Callable[["WebSocket"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "WebSocket": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["framereceived"],
- predicate: typing.Optional[
- typing.Callable[["typing.Union[bytes, str]"], bool]
- ] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "typing.Union[bytes, str]": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["framesent"],
- predicate: typing.Optional[
- typing.Callable[["typing.Union[bytes, str]"], bool]
- ] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "typing.Union[bytes, str]": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["socketerror"],
- predicate: typing.Optional[typing.Callable[["str"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "str": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: str,
- predicate: typing.Optional[typing.Callable[..., bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> typing.Any: ...
- async def wait_for_event(
- self,
- event: str,
- predicate: typing.Optional[typing.Callable] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> typing.Any:
- """WebSocket.wait_for_event
- **NOTE** In most cases, you should use `web_socket.expect_event()`.
- Waits for given `event` to fire. If predicate is provided, it passes event's value into the `predicate` function
- and waits for `predicate(event)` to return a truthy value. Will throw an error if the socket is closed before the
- `event` is fired.
- Parameters
- ----------
- event : str
- Event name, same one typically passed into `*.on(event)`.
- predicate : Union[Callable, None]
- Receives the event data and resolves to truthy value when the waiting should resolve.
- timeout : Union[float, None]
- Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The
- default value can be changed by using the `browser_context.set_default_timeout()`.
- Returns
- -------
- Any
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.wait_for_event(
- event=event,
- predicate=self._wrap_handler(predicate),
- timeout=to_milliseconds(timeout),
- )
- )
- def is_closed(self) -> bool:
- """WebSocket.is_closed
- Indicates that the web socket has been closed.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(self._impl_obj.is_closed())
- mapping.register(WebSocketImpl, WebSocket)
- class WebSocketRoute(AsyncBase):
- @property
- def url(self) -> str:
- """WebSocketRoute.url
- URL of the WebSocket created in the page.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.url)
- @property
- def protocols(self) -> typing.List[str]:
- """WebSocketRoute.protocols
- The list of WebSocket subprotocols requested by the page, as passed via the second argument to the
- [`WebSocket` constructor](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/WebSocket). Corresponds to the
- `Sec-WebSocket-Protocol` request header.
- Returns an empty array if no protocols were specified.
- **Usage**
- ```py
- async def handler(ws: WebSocketRoute):
- if \"chat.v2\" in ws.protocols:
- ws.on_message(lambda message: ws.send(f\"v2:{message}\"))
- else:
- await ws.close(code=1002, reason=\"Unsupported protocol\")
- await page.route_web_socket(\"wss://example.com/ws\", handler)
- ```
- Returns
- -------
- List[str]
- """
- return mapping.from_maybe_impl(self._impl_obj.protocols)
- async def close(
- self, *, code: typing.Optional[int] = None, reason: typing.Optional[str] = None
- ) -> None:
- """WebSocketRoute.close
- Closes one side of the WebSocket connection.
- Parameters
- ----------
- code : Union[int, None]
- Optional [close code](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#code).
- reason : Union[str, None]
- Optional [close reason](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#reason).
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.close(code=code, reason=reason)
- )
- def connect_to_server(self) -> "WebSocketRoute":
- """WebSocketRoute.connect_to_server
- By default, routed WebSocket does not connect to the server, so you can mock entire WebSocket communication. This
- method connects to the actual WebSocket server, and returns the server-side `WebSocketRoute` instance, giving the
- ability to send and receive messages from the server.
- Once connected to the server:
- - Messages received from the server will be **automatically forwarded** to the WebSocket in the page, unless
- `web_socket_route.on_message()` is called on the server-side `WebSocketRoute`.
- - Messages sent by the [`WebSocket.send()`](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/send) call
- in the page will be **automatically forwarded** to the server, unless `web_socket_route.on_message()` is
- called on the original `WebSocketRoute`.
- See examples at the top for more details.
- Returns
- -------
- WebSocketRoute
- """
- return mapping.from_impl(self._impl_obj.connect_to_server())
- def send(self, message: typing.Union[str, bytes]) -> None:
- """WebSocketRoute.send
- Sends a message to the WebSocket. When called on the original WebSocket, sends the message to the page. When called
- on the result of `web_socket_route.connect_to_server()`, sends the message to the server. See examples at the
- top for more details.
- Parameters
- ----------
- message : Union[bytes, str]
- Message to send.
- """
- return mapping.from_maybe_impl(self._impl_obj.send(message=message))
- def on_message(
- self, handler: typing.Callable[[typing.Union[str, bytes]], typing.Any]
- ) -> None:
- """WebSocketRoute.on_message
- This method allows to handle messages that are sent by the WebSocket, either from the page or from the server.
- When called on the original WebSocket route, this method handles messages sent from the page. You can handle this
- messages by responding to them with `web_socket_route.send()`, forwarding them to the server-side connection
- returned by `web_socket_route.connect_to_server()` or do something else.
- Once this method is called, messages are not automatically forwarded to the server or to the page - you should do
- that manually by calling `web_socket_route.send()`. See examples at the top for more details.
- Calling this method again will override the handler with a new one.
- Parameters
- ----------
- handler : Callable[[Union[bytes, str]], Any]
- Function that will handle messages.
- """
- return mapping.from_maybe_impl(
- self._impl_obj.on_message(handler=self._wrap_handler(handler))
- )
- def on_close(
- self,
- handler: typing.Callable[
- [typing.Optional[int], typing.Optional[str]], typing.Any
- ],
- ) -> None:
- """WebSocketRoute.on_close
- Allows to handle [`WebSocket.close`](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close).
- By default, closing one side of the connection, either in the page or on the server, will close the other side.
- However, when `web_socket_route.on_close()` handler is set up, the default forwarding of closure is disabled,
- and handler should take care of it.
- Parameters
- ----------
- handler : Callable[[Union[int, None], Union[str, None]], Any]
- Function that will handle WebSocket closure. Received an optional
- [close code](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#code) and an optional
- [close reason](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#reason).
- """
- return mapping.from_maybe_impl(
- self._impl_obj.on_close(handler=self._wrap_handler(handler))
- )
- mapping.register(WebSocketRouteImpl, WebSocketRoute)
- class Keyboard(AsyncBase):
- async def down(self, key: str) -> None:
- """Keyboard.down
- Dispatches a `keydown` event.
- `key` can specify the intended
- [keyboardEvent.key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) value or a single character
- to generate the text for. A superset of the `key` values can be found
- [here](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values). Examples of the keys are:
- `F1` - `F12`, `Digit0`- `Digit9`, `KeyA`- `KeyZ`, `Backquote`, `Minus`, `Equal`, `Backslash`, `Backspace`, `Tab`,
- `Delete`, `Escape`, `ArrowDown`, `End`, `Enter`, `Home`, `Insert`, `PageDown`, `PageUp`, `ArrowRight`, `ArrowUp`,
- etc.
- Following modification shortcuts are also supported: `Shift`, `Control`, `Alt`, `Meta`, `ShiftLeft`,
- `ControlOrMeta`. `ControlOrMeta` resolves to `Control` on Windows and Linux and to `Meta` on macOS.
- Holding down `Shift` will type the text that corresponds to the `key` in the upper case.
- If `key` is a single character, it is case-sensitive, so the values `a` and `A` will generate different respective
- texts.
- If `key` is a modifier key, `Shift`, `Meta`, `Control`, or `Alt`, subsequent key presses will be sent with that
- modifier active. To release the modifier key, use `keyboard.up()`.
- After the key is pressed once, subsequent calls to `keyboard.down()` will have
- [repeat](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/repeat) set to true. To release the key,
- use `keyboard.up()`.
- **NOTE** Modifier keys DO influence `keyboard.down`. Holding down `Shift` will type the text in upper case.
- Parameters
- ----------
- key : str
- Name of the key to press or a character to generate, such as `ArrowLeft` or `a`.
- """
- return mapping.from_maybe_impl(await self._impl_obj.down(key=key))
- async def up(self, key: str) -> None:
- """Keyboard.up
- Dispatches a `keyup` event.
- Parameters
- ----------
- key : str
- Name of the key to press or a character to generate, such as `ArrowLeft` or `a`.
- """
- return mapping.from_maybe_impl(await self._impl_obj.up(key=key))
- async def insert_text(self, text: str) -> None:
- """Keyboard.insert_text
- Dispatches only `input` event, does not emit the `keydown`, `keyup` or `keypress` events.
- **Usage**
- ```py
- await page.keyboard.insert_text(\"嗨\")
- ```
- **NOTE** Modifier keys DO NOT effect `keyboard.insertText`. Holding down `Shift` will not type the text in upper
- case.
- Parameters
- ----------
- text : str
- Sets input to the specified text value.
- """
- return mapping.from_maybe_impl(await self._impl_obj.insert_text(text=text))
- async def type(self, text: str, *, delay: typing.Optional[float] = None) -> None:
- """Keyboard.type
- **NOTE** In most cases, you should use `locator.fill()` instead. You only need to press keys one by one if
- there is special keyboard handling on the page - in this case use `locator.press_sequentially()`.
- Sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text.
- To press a special key, like `Control` or `ArrowDown`, use `keyboard.press()`.
- **Usage**
- ```py
- await page.keyboard.type(\"Hello\") # types instantly
- await page.keyboard.type(\"World\", delay=100) # types slower, like a user
- ```
- **NOTE** Modifier keys DO NOT effect `keyboard.type`. Holding down `Shift` will not type the text in upper case.
- **NOTE** For characters that are not on a US keyboard, only an `input` event will be sent.
- Parameters
- ----------
- text : str
- A text to type into a focused element.
- delay : Union[float, None]
- Time to wait between key presses in milliseconds. Defaults to 0.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.type(text=text, delay=delay)
- )
- async def press(self, key: str, *, delay: typing.Optional[float] = None) -> None:
- """Keyboard.press
- **NOTE** In most cases, you should use `locator.press()` instead.
- `key` can specify the intended
- [keyboardEvent.key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) value or a single character
- to generate the text for. A superset of the `key` values can be found
- [here](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values). Examples of the keys are:
- `F1` - `F12`, `Digit0`- `Digit9`, `KeyA`- `KeyZ`, `Backquote`, `Minus`, `Equal`, `Backslash`, `Backspace`, `Tab`,
- `Delete`, `Escape`, `ArrowDown`, `End`, `Enter`, `Home`, `Insert`, `PageDown`, `PageUp`, `ArrowRight`, `ArrowUp`,
- etc.
- Following modification shortcuts are also supported: `Shift`, `Control`, `Alt`, `Meta`, `ShiftLeft`,
- `ControlOrMeta`. `ControlOrMeta` resolves to `Control` on Windows and Linux and to `Meta` on macOS.
- Holding down `Shift` will type the text that corresponds to the `key` in the upper case.
- If `key` is a single character, it is case-sensitive, so the values `a` and `A` will generate different respective
- texts.
- Shortcuts such as `key: \"Control+o\"`, `key: \"Control++` or `key: \"Control+Shift+T\"` are supported as well. When
- specified with the modifier, modifier is pressed and being held while the subsequent key is being pressed.
- **Usage**
- ```py
- page = await browser.new_page()
- await page.goto(\"https://keycode.info\")
- await page.keyboard.press(\"a\")
- await page.screenshot(path=\"a.png\")
- await page.keyboard.press(\"ArrowLeft\")
- await page.screenshot(path=\"arrow_left.png\")
- await page.keyboard.press(\"Shift+O\")
- await page.screenshot(path=\"o.png\")
- await browser.close()
- ```
- Shortcut for `keyboard.down()` and `keyboard.up()`.
- Parameters
- ----------
- key : str
- Name of the key to press or a character to generate, such as `ArrowLeft` or `a`.
- delay : Union[float, None]
- Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0.
- """
- return mapping.from_maybe_impl(await self._impl_obj.press(key=key, delay=delay))
- mapping.register(KeyboardImpl, Keyboard)
- class Mouse(AsyncBase):
- async def move(
- self, x: float, y: float, *, steps: typing.Optional[int] = None
- ) -> None:
- """Mouse.move
- Dispatches a `mousemove` event.
- Parameters
- ----------
- x : float
- X coordinate relative to the main frame's viewport in CSS pixels.
- y : float
- Y coordinate relative to the main frame's viewport in CSS pixels.
- steps : Union[int, None]
- Defaults to 1. Sends `n` interpolated `mousemove` events to represent travel between Playwright's current cursor
- position and the provided destination. When set to 1, emits a single `mousemove` event at the destination location.
- """
- return mapping.from_maybe_impl(await self._impl_obj.move(x=x, y=y, steps=steps))
- async def down(
- self,
- *,
- button: typing.Optional[Literal["left", "middle", "right"]] = None,
- click_count: typing.Optional[int] = None,
- ) -> None:
- """Mouse.down
- Dispatches a `mousedown` event.
- Parameters
- ----------
- button : Union["left", "middle", "right", None]
- Defaults to `left`.
- click_count : Union[int, None]
- defaults to 1. See [UIEvent.detail].
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.down(button=button, clickCount=click_count)
- )
- async def up(
- self,
- *,
- button: typing.Optional[Literal["left", "middle", "right"]] = None,
- click_count: typing.Optional[int] = None,
- ) -> None:
- """Mouse.up
- Dispatches a `mouseup` event.
- Parameters
- ----------
- button : Union["left", "middle", "right", None]
- Defaults to `left`.
- click_count : Union[int, None]
- defaults to 1. See [UIEvent.detail].
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.up(button=button, clickCount=click_count)
- )
- async def click(
- self,
- x: float,
- y: float,
- *,
- delay: typing.Optional[float] = None,
- button: typing.Optional[Literal["left", "middle", "right"]] = None,
- click_count: typing.Optional[int] = None,
- ) -> None:
- """Mouse.click
- Shortcut for `mouse.move()`, `mouse.down()`, `mouse.up()`.
- Parameters
- ----------
- x : float
- X coordinate relative to the main frame's viewport in CSS pixels.
- y : float
- Y coordinate relative to the main frame's viewport in CSS pixels.
- delay : Union[float, None]
- Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
- button : Union["left", "middle", "right", None]
- Defaults to `left`.
- click_count : Union[int, None]
- defaults to 1. See [UIEvent.detail].
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.click(
- x=x, y=y, delay=delay, button=button, clickCount=click_count
- )
- )
- async def dblclick(
- self,
- x: float,
- y: float,
- *,
- delay: typing.Optional[float] = None,
- button: typing.Optional[Literal["left", "middle", "right"]] = None,
- ) -> None:
- """Mouse.dblclick
- Shortcut for `mouse.move()`, `mouse.down()`, `mouse.up()`, `mouse.down()` and
- `mouse.up()`.
- Parameters
- ----------
- x : float
- X coordinate relative to the main frame's viewport in CSS pixels.
- y : float
- Y coordinate relative to the main frame's viewport in CSS pixels.
- delay : Union[float, None]
- Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
- button : Union["left", "middle", "right", None]
- Defaults to `left`.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.dblclick(x=x, y=y, delay=delay, button=button)
- )
- async def wheel(self, delta_x: float, delta_y: float) -> None:
- """Mouse.wheel
- Dispatches a `wheel` event. This method is usually used to manually scroll the page. See
- [scrolling](https://playwright.dev/python/docs/input#scrolling) for alternative ways to scroll.
- **NOTE** Wheel events may cause scrolling if they are not handled, and this method does not wait for the scrolling
- to finish before returning.
- Parameters
- ----------
- delta_x : float
- Pixels to scroll horizontally.
- delta_y : float
- Pixels to scroll vertically.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.wheel(deltaX=delta_x, deltaY=delta_y)
- )
- mapping.register(MouseImpl, Mouse)
- class Touchscreen(AsyncBase):
- async def tap(self, x: float, y: float) -> None:
- """Touchscreen.tap
- Dispatches a `touchstart` and `touchend` event with a single touch at the position (`x`,`y`).
- **NOTE** `page.tap()` the method will throw if `hasTouch` option of the browser context is false.
- Parameters
- ----------
- x : float
- X coordinate relative to the main frame's viewport in CSS pixels.
- y : float
- Y coordinate relative to the main frame's viewport in CSS pixels.
- """
- return mapping.from_maybe_impl(await self._impl_obj.tap(x=x, y=y))
- mapping.register(TouchscreenImpl, Touchscreen)
- class JSHandle(AsyncBase):
- async def evaluate(
- self, expression: str, arg: typing.Optional[typing.Any] = None
- ) -> typing.Any:
- """JSHandle.evaluate
- Returns the return value of `expression`.
- This method passes this handle as the first argument to `expression`.
- If `expression` returns a [Promise], then `handle.evaluate` would wait for the promise to resolve and return its
- value.
- **Usage**
- ```py
- tweet_handle = await page.query_selector(\".tweet .retweets\")
- assert await tweet_handle.evaluate(\"node => node.innerText\") == \"10 retweets\"
- ```
- Parameters
- ----------
- expression : str
- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
- function is automatically invoked.
- arg : Union[Any, None]
- Optional argument to pass to `expression`.
- Returns
- -------
- Any
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.evaluate(
- expression=expression, arg=mapping.to_impl(arg)
- )
- )
- async def evaluate_handle(
- self, expression: str, arg: typing.Optional[typing.Any] = None
- ) -> "JSHandle":
- """JSHandle.evaluate_handle
- Returns the return value of `expression` as a `JSHandle`.
- This method passes this handle as the first argument to `expression`.
- The only difference between `jsHandle.evaluate` and `jsHandle.evaluateHandle` is that `jsHandle.evaluateHandle`
- returns `JSHandle`.
- If the function passed to the `jsHandle.evaluateHandle` returns a [Promise], then `jsHandle.evaluateHandle` would
- wait for the promise to resolve and return its value.
- See `page.evaluate_handle()` for more details.
- Parameters
- ----------
- expression : str
- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
- function is automatically invoked.
- arg : Union[Any, None]
- Optional argument to pass to `expression`.
- Returns
- -------
- JSHandle
- """
- return mapping.from_impl(
- await self._impl_obj.evaluate_handle(
- expression=expression, arg=mapping.to_impl(arg)
- )
- )
- async def get_property(self, property_name: str) -> "JSHandle":
- """JSHandle.get_property
- Fetches a single property from the referenced object.
- Parameters
- ----------
- property_name : str
- property to get
- Returns
- -------
- JSHandle
- """
- return mapping.from_impl(
- await self._impl_obj.get_property(propertyName=property_name)
- )
- async def get_properties(self) -> typing.Dict[str, "JSHandle"]:
- """JSHandle.get_properties
- The method returns a map with **own property names** as keys and JSHandle instances for the property values.
- **Usage**
- ```py
- handle = await page.evaluate_handle(\"({ window, document })\")
- properties = await handle.get_properties()
- window_handle = properties.get(\"window\")
- document_handle = properties.get(\"document\")
- await handle.dispose()
- ```
- Returns
- -------
- Dict[str, JSHandle]
- """
- return mapping.from_impl_dict(await self._impl_obj.get_properties())
- def as_element(self) -> typing.Optional["ElementHandle"]:
- """JSHandle.as_element
- Returns either `null` or the object handle itself, if the object handle is an instance of `ElementHandle`.
- Returns
- -------
- Union[ElementHandle, None]
- """
- return mapping.from_impl_nullable(self._impl_obj.as_element())
- async def dispose(self) -> None:
- """JSHandle.dispose
- The `jsHandle.dispose` method stops referencing the element handle.
- """
- return mapping.from_maybe_impl(await self._impl_obj.dispose())
- async def json_value(self) -> typing.Any:
- """JSHandle.json_value
- Returns a JSON representation of the object. If the object has a `toJSON` function, it **will not be called**.
- **NOTE** The method will return an empty JSON object if the referenced object is not stringifiable. It will throw
- an error if the object has circular references.
- Returns
- -------
- Any
- """
- return mapping.from_maybe_impl(await self._impl_obj.json_value())
- mapping.register(JSHandleImpl, JSHandle)
- class ElementHandle(JSHandle):
- def as_element(self) -> typing.Optional["ElementHandle"]:
- """ElementHandle.as_element
- Returns either `null` or the object handle itself, if the object handle is an instance of `ElementHandle`.
- Returns
- -------
- Union[ElementHandle, None]
- """
- return mapping.from_impl_nullable(self._impl_obj.as_element())
- async def owner_frame(self) -> typing.Optional["Frame"]:
- """ElementHandle.owner_frame
- Returns the frame containing the given element.
- Returns
- -------
- Union[Frame, None]
- """
- return mapping.from_impl_nullable(await self._impl_obj.owner_frame())
- async def content_frame(self) -> typing.Optional["Frame"]:
- """ElementHandle.content_frame
- Returns the content frame for element handles referencing iframe nodes, or `null` otherwise
- Returns
- -------
- Union[Frame, None]
- """
- return mapping.from_impl_nullable(await self._impl_obj.content_frame())
- async def get_attribute(self, name: str) -> typing.Optional[str]:
- """ElementHandle.get_attribute
- Returns element attribute value.
- Parameters
- ----------
- name : str
- Attribute name to get the value for.
- Returns
- -------
- Union[str, None]
- """
- return mapping.from_maybe_impl(await self._impl_obj.get_attribute(name=name))
- async def text_content(self) -> typing.Optional[str]:
- """ElementHandle.text_content
- Returns the `node.textContent`.
- Returns
- -------
- Union[str, None]
- """
- return mapping.from_maybe_impl(await self._impl_obj.text_content())
- async def inner_text(self) -> str:
- """ElementHandle.inner_text
- Returns the `element.innerText`.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(await self._impl_obj.inner_text())
- async def inner_html(self) -> str:
- """ElementHandle.inner_html
- Returns the `element.innerHTML`.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(await self._impl_obj.inner_html())
- async def is_checked(self) -> bool:
- """ElementHandle.is_checked
- Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(await self._impl_obj.is_checked())
- async def is_disabled(self) -> bool:
- """ElementHandle.is_disabled
- Returns whether the element is disabled, the opposite of [enabled](https://playwright.dev/python/docs/actionability#enabled).
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(await self._impl_obj.is_disabled())
- async def is_editable(self) -> bool:
- """ElementHandle.is_editable
- Returns whether the element is [editable](https://playwright.dev/python/docs/actionability#editable).
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(await self._impl_obj.is_editable())
- async def is_enabled(self) -> bool:
- """ElementHandle.is_enabled
- Returns whether the element is [enabled](https://playwright.dev/python/docs/actionability#enabled).
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(await self._impl_obj.is_enabled())
- async def is_hidden(self) -> bool:
- """ElementHandle.is_hidden
- Returns whether the element is hidden, the opposite of [visible](https://playwright.dev/python/docs/actionability#visible).
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(await self._impl_obj.is_hidden())
- async def is_visible(self) -> bool:
- """ElementHandle.is_visible
- Returns whether the element is [visible](https://playwright.dev/python/docs/actionability#visible).
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(await self._impl_obj.is_visible())
- async def dispatch_event(
- self, type: str, event_init: typing.Optional[typing.Dict] = None
- ) -> None:
- """ElementHandle.dispatch_event
- The snippet below dispatches the `click` event on the element. Regardless of the visibility state of the element,
- `click` is dispatched. This is equivalent to calling
- [element.click()](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/click).
- **Usage**
- ```py
- await element_handle.dispatch_event(\"click\")
- ```
- Under the hood, it creates an instance of an event based on the given `type`, initializes it with `eventInit`
- properties and dispatches it on the element. Events are `composed`, `cancelable` and bubble by default.
- Since `eventInit` is event-specific, please refer to the events documentation for the lists of initial properties:
- - [DeviceMotionEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent/DeviceMotionEvent)
- - [DeviceOrientationEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceOrientationEvent/DeviceOrientationEvent)
- - [DragEvent](https://developer.mozilla.org/en-US/docs/Web/API/DragEvent/DragEvent)
- - [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event/Event)
- - [FocusEvent](https://developer.mozilla.org/en-US/docs/Web/API/FocusEvent/FocusEvent)
- - [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/KeyboardEvent)
- - [MouseEvent](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/MouseEvent)
- - [PointerEvent](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/PointerEvent)
- - [TouchEvent](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent/TouchEvent)
- - [WheelEvent](https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/WheelEvent)
- You can also specify `JSHandle` as the property value if you want live objects to be passed into the event:
- ```py
- # note you can only create data_transfer in chromium and firefox
- data_transfer = await page.evaluate_handle(\"new DataTransfer()\")
- await element_handle.dispatch_event(\"#source\", \"dragstart\", {\"dataTransfer\": data_transfer})
- ```
- Parameters
- ----------
- type : str
- DOM event type: `"click"`, `"dragstart"`, etc.
- event_init : Union[Dict, None]
- Optional event-specific initialization properties.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.dispatch_event(
- type=type, eventInit=mapping.to_impl(event_init)
- )
- )
- async def scroll_into_view_if_needed(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """ElementHandle.scroll_into_view_if_needed
- This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, then tries to scroll element into view, unless
- it is completely visible as defined by
- [IntersectionObserver](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API)'s `ratio`.
- Throws when `elementHandle` does not point to an element
- [connected](https://developer.mozilla.org/en-US/docs/Web/API/Node/isConnected) to a Document or a ShadowRoot.
- See [scrolling](https://playwright.dev/python/docs/input#scrolling) for alternative ways to scroll.
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.scroll_into_view_if_needed(
- timeout=to_milliseconds(timeout)
- )
- )
- async def hover(
- self,
- *,
- modifiers: typing.Optional[
- typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]
- ] = None,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- force: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """ElementHandle.hover
- This method hovers over the element by performing the following steps:
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the element, unless `force` option is set.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to hover over the center of the element, or the specified `position`.
- If the element is detached from the DOM at any moment during the action, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- Parameters
- ----------
- modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
- Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
- current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
- "Control" on Windows and Linux and to "Meta" on macOS.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.hover(
- modifiers=mapping.to_impl(modifiers),
- position=position,
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- force=force,
- trial=trial,
- )
- )
- async def click(
- self,
- *,
- modifiers: typing.Optional[
- typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]
- ] = None,
- position: typing.Optional[Position] = None,
- delay: typing.Optional[float] = None,
- button: typing.Optional[Literal["left", "middle", "right"]] = None,
- click_count: typing.Optional[int] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- steps: typing.Optional[int] = None,
- ) -> None:
- """ElementHandle.click
- This method clicks the element by performing the following steps:
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the element, unless `force` option is set.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to click in the center of the element, or the specified `position`.
- 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
- If the element is detached from the DOM at any moment during the action, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- Parameters
- ----------
- modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
- Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
- current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
- "Control" on Windows and Linux and to "Meta" on macOS.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- delay : Union[float, None]
- Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
- button : Union["left", "middle", "right", None]
- Defaults to `left`.
- click_count : Union[int, None]
- defaults to 1. See [UIEvent.detail].
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
- can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
- navigating to inaccessible pages. Defaults to `false`.
- Deprecated: This option will default to `true` in the future.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it.
- steps : Union[int, None]
- Defaults to 1. Sends `n` interpolated `mousemove` events to represent travel between Playwright's current cursor
- position and the provided destination. When set to 1, emits a single `mousemove` event at the destination location.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.click(
- modifiers=mapping.to_impl(modifiers),
- position=position,
- delay=delay,
- button=button,
- clickCount=click_count,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- trial=trial,
- steps=steps,
- )
- )
- async def dblclick(
- self,
- *,
- modifiers: typing.Optional[
- typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]
- ] = None,
- position: typing.Optional[Position] = None,
- delay: typing.Optional[float] = None,
- button: typing.Optional[Literal["left", "middle", "right"]] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- steps: typing.Optional[int] = None,
- ) -> None:
- """ElementHandle.dblclick
- This method double clicks the element by performing the following steps:
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the element, unless `force` option is set.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to double click in the center of the element, or the specified `position`.
- If the element is detached from the DOM at any moment during the action, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- **NOTE** `elementHandle.dblclick()` dispatches two `click` events and a single `dblclick` event.
- Parameters
- ----------
- modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
- Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
- current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
- "Control" on Windows and Linux and to "Meta" on macOS.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- delay : Union[float, None]
- Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
- button : Union["left", "middle", "right", None]
- Defaults to `left`.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it.
- steps : Union[int, None]
- Defaults to 1. Sends `n` interpolated `mousemove` events to represent travel between Playwright's current cursor
- position and the provided destination. When set to 1, emits a single `mousemove` event at the destination location.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.dblclick(
- modifiers=mapping.to_impl(modifiers),
- position=position,
- delay=delay,
- button=button,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- trial=trial,
- steps=steps,
- )
- )
- async def select_option(
- self,
- value: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
- *,
- index: typing.Optional[typing.Union[int, typing.Sequence[int]]] = None,
- label: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
- element: typing.Optional[
- typing.Union["ElementHandle", typing.Sequence["ElementHandle"]]
- ] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- ) -> typing.List[str]:
- """ElementHandle.select_option
- This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, waits until all specified options are present in
- the `<select>` element and selects these options.
- If the target element is not a `<select>` element, this method throws an error. However, if the element is inside
- the `<label>` element that has an associated
- [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be used
- instead.
- Returns the array of option values that have been successfully selected.
- Triggers a `change` and `input` event once all the provided options have been selected.
- **Usage**
- ```py
- # Single selection matching the value or label
- await handle.select_option(\"blue\")
- # single selection matching the label
- await handle.select_option(label=\"blue\")
- # multiple selection
- await handle.select_option(value=[\"red\", \"green\", \"blue\"])
- ```
- Parameters
- ----------
- value : Union[Sequence[str], str, None]
- Options to select by value. If the `<select>` has the `multiple` attribute, all given options are selected,
- otherwise only the first option matching one of the passed options is selected. Optional.
- index : Union[Sequence[int], int, None]
- Options to select by index. Optional.
- label : Union[Sequence[str], str, None]
- Options to select by label. If the `<select>` has the `multiple` attribute, all given options are selected,
- otherwise only the first option matching one of the passed options is selected. Optional.
- element : Union[ElementHandle, Sequence[ElementHandle], None]
- Option elements to select. Optional.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- Returns
- -------
- List[str]
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.select_option(
- value=mapping.to_impl(value),
- index=mapping.to_impl(index),
- label=mapping.to_impl(label),
- element=mapping.to_impl(element),
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- )
- )
- async def tap(
- self,
- *,
- modifiers: typing.Optional[
- typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]
- ] = None,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """ElementHandle.tap
- This method taps the element by performing the following steps:
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the element, unless `force` option is set.
- 1. Scroll the element into view if needed.
- 1. Use `page.touchscreen` to tap the center of the element, or the specified `position`.
- If the element is detached from the DOM at any moment during the action, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- **NOTE** `elementHandle.tap()` requires that the `hasTouch` option of the browser context be set to true.
- Parameters
- ----------
- modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
- Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
- current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
- "Control" on Windows and Linux and to "Meta" on macOS.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.tap(
- modifiers=mapping.to_impl(modifiers),
- position=position,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- trial=trial,
- )
- )
- async def fill(
- self,
- value: str,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- force: typing.Optional[bool] = None,
- ) -> None:
- """ElementHandle.fill
- This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, focuses the element, fills it and triggers an
- `input` event after filling. Note that you can pass an empty string to clear the input field.
- If the target element is not an `<input>`, `<textarea>` or `[contenteditable]` element, this method throws an
- error. However, if the element is inside the `<label>` element that has an associated
- [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be filled
- instead.
- To send fine-grained keyboard events, use `locator.press_sequentially()`.
- Parameters
- ----------
- value : str
- Value to set for the `<input>`, `<textarea>` or `[contenteditable]` element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.fill(
- value=value,
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- force=force,
- )
- )
- async def select_text(
- self,
- *,
- force: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """ElementHandle.select_text
- This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, then focuses the element and selects all its
- text content.
- If the element is inside the `<label>` element that has an associated
- [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), focuses and selects text in
- the control instead.
- Parameters
- ----------
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.select_text(
- force=force, timeout=to_milliseconds(timeout)
- )
- )
- async def input_value(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> str:
- """ElementHandle.input_value
- Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element.
- Throws for non-input elements. However, if the element is inside the `<label>` element that has an associated
- [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the
- control.
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.input_value(timeout=to_milliseconds(timeout))
- )
- async def set_input_files(
- self,
- files: typing.Union[
- str,
- pathlib.Path,
- FilePayload,
- typing.Sequence[typing.Union[str, pathlib.Path]],
- typing.Sequence[FilePayload],
- ],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- ) -> None:
- """ElementHandle.set_input_files
- Sets the value of the file input to these file paths or files. If some of the `filePaths` are relative paths, then
- they are resolved relative to the current working directory. For empty array, clears the selected files. For inputs
- with a `[webkitdirectory]` attribute, only a single directory path is supported.
- This method expects `ElementHandle` to point to an
- [input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside
- the `<label>` element that has an associated
- [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead.
- Parameters
- ----------
- files : Union[Sequence[Union[pathlib.Path, str]], Sequence[{name: str, mimeType: str, buffer: bytes}], pathlib.Path, str, {name: str, mimeType: str, buffer: bytes}]
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.set_input_files(
- files=mapping.to_impl(files),
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- )
- )
- async def focus(self) -> None:
- """ElementHandle.focus
- Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
- """
- return mapping.from_maybe_impl(await self._impl_obj.focus())
- async def type(
- self,
- text: str,
- *,
- delay: typing.Optional[float] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- ) -> None:
- """ElementHandle.type
- Focuses the element, and then sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the
- text.
- To press a special key, like `Control` or `ArrowDown`, use `element_handle.press()`.
- **Usage**
- Parameters
- ----------
- text : str
- A text to type into a focused element.
- delay : Union[float, None]
- Time to wait between key presses in milliseconds. Defaults to 0.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.type(
- text=text,
- delay=delay,
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- )
- )
- async def press(
- self,
- key: str,
- *,
- delay: typing.Optional[float] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- ) -> None:
- """ElementHandle.press
- Focuses the element, and then uses `keyboard.down()` and `keyboard.up()`.
- `key` can specify the intended
- [keyboardEvent.key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) value or a single character
- to generate the text for. A superset of the `key` values can be found
- [here](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values). Examples of the keys are:
- `F1` - `F12`, `Digit0`- `Digit9`, `KeyA`- `KeyZ`, `Backquote`, `Minus`, `Equal`, `Backslash`, `Backspace`, `Tab`,
- `Delete`, `Escape`, `ArrowDown`, `End`, `Enter`, `Home`, `Insert`, `PageDown`, `PageUp`, `ArrowRight`, `ArrowUp`,
- etc.
- Following modification shortcuts are also supported: `Shift`, `Control`, `Alt`, `Meta`, `ShiftLeft`,
- `ControlOrMeta`.
- Holding down `Shift` will type the text that corresponds to the `key` in the upper case.
- If `key` is a single character, it is case-sensitive, so the values `a` and `A` will generate different respective
- texts.
- Shortcuts such as `key: \"Control+o\"`, `key: \"Control++` or `key: \"Control+Shift+T\"` are supported as well. When
- specified with the modifier, modifier is pressed and being held while the subsequent key is being pressed.
- Parameters
- ----------
- key : str
- Name of the key to press or a character to generate, such as `ArrowLeft` or `a`.
- delay : Union[float, None]
- Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
- can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
- navigating to inaccessible pages. Defaults to `false`.
- Deprecated: This option will default to `true` in the future.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.press(
- key=key,
- delay=delay,
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- )
- )
- async def set_checked(
- self,
- checked: bool,
- *,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """ElementHandle.set_checked
- This method checks or unchecks an element by performing the following steps:
- 1. Ensure that element is a checkbox or a radio input. If not, this method throws.
- 1. If the element already has the right checked state, this method returns immediately.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If
- the element is detached during the checks, the whole action is retried.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to click in the center of the element.
- 1. Ensure that the element is now checked or unchecked. If not, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- Parameters
- ----------
- checked : bool
- Whether to check or uncheck the checkbox.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.set_checked(
- checked=checked,
- position=position,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- trial=trial,
- )
- )
- async def check(
- self,
- *,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """ElementHandle.check
- This method checks the element by performing the following steps:
- 1. Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already
- checked, this method returns immediately.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the element, unless `force` option is set.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to click in the center of the element.
- 1. Ensure that the element is now checked. If not, this method throws.
- If the element is detached from the DOM at any moment during the action, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- Parameters
- ----------
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.check(
- position=position,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- trial=trial,
- )
- )
- async def uncheck(
- self,
- *,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """ElementHandle.uncheck
- This method checks the element by performing the following steps:
- 1. Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already
- unchecked, this method returns immediately.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the element, unless `force` option is set.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to click in the center of the element.
- 1. Ensure that the element is now unchecked. If not, this method throws.
- If the element is detached from the DOM at any moment during the action, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- Parameters
- ----------
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.uncheck(
- position=position,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- trial=trial,
- )
- )
- async def bounding_box(self) -> typing.Optional[FloatRect]:
- """ElementHandle.bounding_box
- This method returns the bounding box of the element, or `null` if the element is not visible. The bounding box is
- calculated relative to the main frame viewport - which is usually the same as the browser window.
- Scrolling affects the returned bounding box, similarly to
- [Element.getBoundingClientRect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect).
- That means `x` and/or `y` may be negative.
- Elements from child frames return the bounding box relative to the main frame, unlike the
- [Element.getBoundingClientRect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect).
- Assuming the page is static, it is safe to use bounding box coordinates to perform input. For example, the
- following snippet should click the center of the element.
- **Usage**
- ```py
- box = await element_handle.bounding_box()
- await page.mouse.click(box[\"x\"] + box[\"width\"] / 2, box[\"y\"] + box[\"height\"] / 2)
- ```
- Returns
- -------
- Union[{x: float, y: float, width: float, height: float}, None]
- """
- return mapping.from_impl_nullable(await self._impl_obj.bounding_box())
- async def screenshot(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- type: typing.Optional[Literal["jpeg", "png"]] = None,
- path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- quality: typing.Optional[int] = None,
- omit_background: typing.Optional[bool] = None,
- animations: typing.Optional[Literal["allow", "disabled"]] = None,
- caret: typing.Optional[Literal["hide", "initial"]] = None,
- scale: typing.Optional[Literal["css", "device"]] = None,
- mask: typing.Optional[typing.Sequence["Locator"]] = None,
- mask_color: typing.Optional[str] = None,
- style: typing.Optional[str] = None,
- ) -> bytes:
- """ElementHandle.screenshot
- This method captures a screenshot of the page, clipped to the size and position of this particular element. If the
- element is covered by other elements, it will not be actually visible on the screenshot. If the element is a
- scrollable container, only the currently scrolled content will be visible on the screenshot.
- This method waits for the [actionability](https://playwright.dev/python/docs/actionability) checks, then scrolls element into view before taking
- a screenshot. If the element is detached from DOM, the method throws an error.
- Returns the buffer with the captured screenshot.
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- type : Union["jpeg", "png", None]
- Specify screenshot type, defaults to `png`.
- path : Union[pathlib.Path, str, None]
- The file path to save the image to. The screenshot type will be inferred from file extension. If `path` is a
- relative path, then it is resolved relative to the current working directory. If no path is provided, the image
- won't be saved to the disk.
- quality : Union[int, None]
- The quality of the image, between 0-100. Not applicable to `png` images.
- omit_background : Union[bool, None]
- Hides default white background and allows capturing screenshots with transparency. Not applicable to `jpeg` images.
- Defaults to `false`.
- animations : Union["allow", "disabled", None]
- When set to `"disabled"`, stops CSS animations, CSS transitions and Web Animations. Animations get different
- treatment depending on their duration:
- - finite animations are fast-forwarded to completion, so they'll fire `transitionend` event.
- - infinite animations are canceled to initial state, and then played over after the screenshot.
- Defaults to `"allow"` that leaves animations untouched.
- caret : Union["hide", "initial", None]
- When set to `"hide"`, screenshot will hide text caret. When set to `"initial"`, text caret behavior will not be
- changed. Defaults to `"hide"`.
- scale : Union["css", "device", None]
- When set to `"css"`, screenshot will have a single pixel per each css pixel on the page. For high-dpi devices, this
- will keep screenshots small. Using `"device"` option will produce a single pixel per each device pixel, so
- screenshots of high-dpi devices will be twice as large or even larger.
- Defaults to `"device"`.
- mask : Union[Sequence[Locator], None]
- Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink
- box `#FF00FF` (customized by `maskColor`) that completely covers its bounding box. The mask is also applied to
- invisible elements, see [Matching only visible elements](../locators.md#matching-only-visible-elements) to disable
- that.
- mask_color : Union[str, None]
- Specify the color of the overlay box for masked elements, in
- [CSS color format](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value). Default color is pink `#FF00FF`.
- style : Union[str, None]
- Text of the stylesheet to apply while making the screenshot. This is where you can hide dynamic elements, make
- elements invisible or change their properties to help you creating repeatable screenshots. This stylesheet pierces
- the Shadow DOM and applies to the inner frames.
- Returns
- -------
- bytes
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.screenshot(
- timeout=to_milliseconds(timeout),
- type=type,
- path=path,
- quality=quality,
- omitBackground=omit_background,
- animations=animations,
- caret=caret,
- scale=scale,
- mask=mapping.to_impl(mask),
- maskColor=mask_color,
- style=style,
- )
- )
- async def query_selector(self, selector: str) -> typing.Optional["ElementHandle"]:
- """ElementHandle.query_selector
- The method finds an element matching the specified selector in the `ElementHandle`'s subtree. If no elements match
- the selector, returns `null`.
- Parameters
- ----------
- selector : str
- A selector to query for.
- Returns
- -------
- Union[ElementHandle, None]
- """
- return mapping.from_impl_nullable(
- await self._impl_obj.query_selector(selector=selector)
- )
- async def query_selector_all(self, selector: str) -> typing.List["ElementHandle"]:
- """ElementHandle.query_selector_all
- The method finds all elements matching the specified selector in the `ElementHandle`s subtree. If no elements match
- the selector, returns empty array.
- Parameters
- ----------
- selector : str
- A selector to query for.
- Returns
- -------
- List[ElementHandle]
- """
- return mapping.from_impl_list(
- await self._impl_obj.query_selector_all(selector=selector)
- )
- async def eval_on_selector(
- self, selector: str, expression: str, arg: typing.Optional[typing.Any] = None
- ) -> typing.Any:
- """ElementHandle.eval_on_selector
- Returns the return value of `expression`.
- The method finds an element matching the specified selector in the `ElementHandle`s subtree and passes it as a
- first argument to `expression`. If no elements match the selector, the method throws an error.
- If `expression` returns a [Promise], then `element_handle.eval_on_selector()` would wait for the promise to
- resolve and return its value.
- **Usage**
- ```py
- tweet_handle = await page.query_selector(\".tweet\")
- assert await tweet_handle.eval_on_selector(\".like\", \"node => node.innerText\") == \"100\"
- assert await tweet_handle.eval_on_selector(\".retweets\", \"node => node.innerText\") == \"10\"
- ```
- Parameters
- ----------
- selector : str
- A selector to query for.
- expression : str
- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
- function is automatically invoked.
- arg : Union[Any, None]
- Optional argument to pass to `expression`.
- Returns
- -------
- Any
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.eval_on_selector(
- selector=selector, expression=expression, arg=mapping.to_impl(arg)
- )
- )
- async def eval_on_selector_all(
- self, selector: str, expression: str, arg: typing.Optional[typing.Any] = None
- ) -> typing.Any:
- """ElementHandle.eval_on_selector_all
- Returns the return value of `expression`.
- The method finds all elements matching the specified selector in the `ElementHandle`'s subtree and passes an array
- of matched elements as a first argument to `expression`.
- If `expression` returns a [Promise], then `element_handle.eval_on_selector_all()` would wait for the promise to
- resolve and return its value.
- **Usage**
- ```html
- <div class=\"feed\">
- <div class=\"tweet\">Hello!</div>
- <div class=\"tweet\">Hi!</div>
- </div>
- ```
- ```py
- feed_handle = await page.query_selector(\".feed\")
- assert await feed_handle.eval_on_selector_all(\".tweet\", \"nodes => nodes.map(n => n.innerText)\") == [\"hello!\", \"hi!\"]
- ```
- Parameters
- ----------
- selector : str
- A selector to query for.
- expression : str
- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
- function is automatically invoked.
- arg : Union[Any, None]
- Optional argument to pass to `expression`.
- Returns
- -------
- Any
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.eval_on_selector_all(
- selector=selector, expression=expression, arg=mapping.to_impl(arg)
- )
- )
- async def wait_for_element_state(
- self,
- state: Literal[
- "disabled", "editable", "enabled", "hidden", "stable", "visible"
- ],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """ElementHandle.wait_for_element_state
- Returns when the element satisfies the `state`.
- Depending on the `state` parameter, this method waits for one of the [actionability](https://playwright.dev/python/docs/actionability) checks to
- pass. This method throws when the element is detached while waiting, unless waiting for the `\"hidden\"` state.
- - `\"visible\"` Wait until the element is [visible](https://playwright.dev/python/docs/actionability#visible).
- - `\"hidden\"` Wait until the element is [not visible](https://playwright.dev/python/docs/actionability#visible) or not attached. Note that
- waiting for hidden does not throw when the element detaches.
- - `\"stable\"` Wait until the element is both [visible](https://playwright.dev/python/docs/actionability#visible) and
- [stable](https://playwright.dev/python/docs/actionability#stable).
- - `\"enabled\"` Wait until the element is [enabled](https://playwright.dev/python/docs/actionability#enabled).
- - `\"disabled\"` Wait until the element is [not enabled](https://playwright.dev/python/docs/actionability#enabled).
- - `\"editable\"` Wait until the element is [editable](https://playwright.dev/python/docs/actionability#editable).
- If the element does not satisfy the condition for the `timeout` milliseconds, this method will throw.
- Parameters
- ----------
- state : Union["disabled", "editable", "enabled", "hidden", "stable", "visible"]
- A state to wait for, see below for more details.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.wait_for_element_state(
- state=state, timeout=to_milliseconds(timeout)
- )
- )
- async def wait_for_selector(
- self,
- selector: str,
- *,
- state: typing.Optional[
- Literal["attached", "detached", "hidden", "visible"]
- ] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- strict: typing.Optional[bool] = None,
- ) -> typing.Optional["ElementHandle"]:
- """ElementHandle.wait_for_selector
- Returns element specified by selector when it satisfies `state` option. Returns `null` if waiting for `hidden` or
- `detached`.
- Wait for the `selector` relative to the element handle to satisfy `state` option (either appear/disappear from dom,
- or become visible/hidden). If at the moment of calling the method `selector` already satisfies the condition, the
- method will return immediately. If the selector doesn't satisfy the condition for the `timeout` milliseconds, the
- function will throw.
- **Usage**
- ```py
- await page.set_content(\"<div><span></span></div>\")
- div = await page.query_selector(\"div\")
- # waiting for the \"span\" selector relative to the div.
- span = await div.wait_for_selector(\"span\", state=\"attached\")
- ```
- **NOTE** This method does not work across navigations, use `page.wait_for_selector()` instead.
- Parameters
- ----------
- selector : str
- A selector to query for.
- state : Union["attached", "detached", "hidden", "visible", None]
- Defaults to `'visible'`. Can be either:
- - `'attached'` - wait for element to be present in DOM.
- - `'detached'` - wait for element to not be present in DOM.
- - `'visible'` - wait for element to have non-empty bounding box and no `visibility:hidden`. Note that element
- without any content or with `display:none` has an empty bounding box and is not considered visible.
- - `'hidden'` - wait for element to be either detached from DOM, or have an empty bounding box or
- `visibility:hidden`. This is opposite to the `'visible'` option.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- Returns
- -------
- Union[ElementHandle, None]
- """
- return mapping.from_impl_nullable(
- await self._impl_obj.wait_for_selector(
- selector=selector,
- state=state,
- timeout=to_milliseconds(timeout),
- strict=strict,
- )
- )
- mapping.register(ElementHandleImpl, ElementHandle)
- class FileChooser(AsyncBase):
- @property
- def page(self) -> "Page":
- """FileChooser.page
- Returns page this file chooser belongs to.
- Returns
- -------
- Page
- """
- return mapping.from_impl(self._impl_obj.page)
- @property
- def element(self) -> "ElementHandle":
- """FileChooser.element
- Returns input element associated with this file chooser.
- Returns
- -------
- ElementHandle
- """
- return mapping.from_impl(self._impl_obj.element)
- def is_multiple(self) -> bool:
- """FileChooser.is_multiple
- Returns whether this file chooser accepts multiple files.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(self._impl_obj.is_multiple())
- async def set_files(
- self,
- files: typing.Union[
- str,
- pathlib.Path,
- FilePayload,
- typing.Sequence[typing.Union[str, pathlib.Path]],
- typing.Sequence[FilePayload],
- ],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- ) -> None:
- """FileChooser.set_files
- Sets the value of the file input this chooser is associated with. If some of the `filePaths` are relative paths,
- then they are resolved relative to the current working directory. For empty array, clears the selected files.
- Parameters
- ----------
- files : Union[Sequence[Union[pathlib.Path, str]], Sequence[{name: str, mimeType: str, buffer: bytes}], pathlib.Path, str, {name: str, mimeType: str, buffer: bytes}]
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.set_files(
- files=mapping.to_impl(files),
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- )
- )
- mapping.register(FileChooserImpl, FileChooser)
- class Frame(AsyncBase):
- @property
- def page(self) -> "Page":
- """Frame.page
- Returns the page containing this frame.
- Returns
- -------
- Page
- """
- return mapping.from_impl(self._impl_obj.page)
- @property
- def name(self) -> str:
- """Frame.name
- Returns frame's name attribute as specified in the tag.
- If the name is empty, returns the id attribute instead.
- **NOTE** This value is calculated once when the frame is created, and will not update if the attribute is changed
- later.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.name)
- @property
- def url(self) -> str:
- """Frame.url
- Returns frame's url.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.url)
- @property
- def parent_frame(self) -> typing.Optional["Frame"]:
- """Frame.parent_frame
- Parent frame, if any. Detached frames and main frames return `null`.
- Returns
- -------
- Union[Frame, None]
- """
- return mapping.from_impl_nullable(self._impl_obj.parent_frame)
- @property
- def child_frames(self) -> typing.List["Frame"]:
- """Frame.child_frames
- Returns
- -------
- List[Frame]
- """
- return mapping.from_impl_list(self._impl_obj.child_frames)
- async def goto(
- self,
- url: str,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- wait_until: typing.Optional[
- Literal["commit", "domcontentloaded", "load", "networkidle"]
- ] = None,
- referer: typing.Optional[str] = None,
- ) -> typing.Optional["Response"]:
- """Frame.goto
- Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of
- the last redirect.
- The method will throw an error if:
- - there's an SSL error (e.g. in case of self-signed certificates).
- - target URL is invalid.
- - the `timeout` is exceeded during navigation.
- - the remote server does not respond or is unreachable.
- - the main resource failed to load.
- The method will not throw an error when any valid HTTP status code is returned by the remote server, including 404
- \"Not Found\" and 500 \"Internal Server Error\". The status code for such responses can be retrieved by calling
- `response.status()`.
- **NOTE** The method either throws an error or returns a main resource response. The only exceptions are navigation
- to `about:blank` or navigation to the same URL with a different hash, which would succeed and return `null`.
- **NOTE** Headless mode doesn't support navigation to a PDF document. See the
- [upstream issue](https://bugs.chromium.org/p/chromium/issues/detail?id=761295).
- Parameters
- ----------
- url : str
- URL to navigate frame to. The url should include scheme, e.g. `https://`.
- timeout : Union[float, None]
- Maximum operation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_navigation_timeout()`,
- `browser_context.set_default_timeout()`, `page.set_default_navigation_timeout()` or
- `page.set_default_timeout()` methods.
- wait_until : Union["commit", "domcontentloaded", "load", "networkidle", None]
- When to consider operation succeeded, defaults to `load`. Events can be either:
- - `'domcontentloaded'` - consider operation to be finished when the `DOMContentLoaded` event is fired.
- - `'load'` - consider operation to be finished when the `load` event is fired.
- - `'networkidle'` - **DISCOURAGED** consider operation to be finished when there are no network connections for
- at least `500` ms. Don't use this method for testing, rely on web assertions to assess readiness instead.
- - `'commit'` - consider operation to be finished when network response is received and the document started
- loading.
- referer : Union[str, None]
- Referer header value. If provided it will take preference over the referer header value set by
- `page.set_extra_http_headers()`.
- Returns
- -------
- Union[Response, None]
- """
- return mapping.from_impl_nullable(
- await self._impl_obj.goto(
- url=url,
- timeout=to_milliseconds(timeout),
- waitUntil=wait_until,
- referer=referer,
- )
- )
- def expect_navigation(
- self,
- *,
- url: typing.Optional[
- typing.Union[str, typing.Pattern[str], typing.Callable[[str], bool]]
- ] = None,
- wait_until: typing.Optional[
- Literal["commit", "domcontentloaded", "load", "networkidle"]
- ] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> AsyncEventContextManager["Response"]:
- """Frame.expect_navigation
- Waits for the frame navigation and returns the main resource response. In case of multiple redirects, the
- navigation will resolve with the response of the last redirect. In case of navigation to a different anchor or
- navigation due to History API usage, the navigation will resolve with `null`.
- **Usage**
- This method waits for the frame to navigate to a new URL. It is useful for when you run code which will indirectly
- cause the frame to navigate. Consider this example:
- ```py
- async with frame.expect_navigation():
- await frame.click(\"a.delayed-navigation\") # clicking the link will indirectly cause a navigation
- # Resolves after navigation has finished
- ```
- **NOTE** Usage of the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) to change the URL
- is considered a navigation.
- Parameters
- ----------
- url : Union[Callable[[str], bool], Pattern[str], str, None]
- A glob pattern, regex pattern, or predicate receiving [URL] to match while waiting for the navigation. Note that if
- the parameter is a string without wildcard characters, the method will wait for navigation to URL that is exactly
- equal to the string.
- wait_until : Union["commit", "domcontentloaded", "load", "networkidle", None]
- When to consider operation succeeded, defaults to `load`. Events can be either:
- - `'domcontentloaded'` - consider operation to be finished when the `DOMContentLoaded` event is fired.
- - `'load'` - consider operation to be finished when the `load` event is fired.
- - `'networkidle'` - **DISCOURAGED** consider operation to be finished when there are no network connections for
- at least `500` ms. Don't use this method for testing, rely on web assertions to assess readiness instead.
- - `'commit'` - consider operation to be finished when network response is received and the document started
- loading.
- timeout : Union[float, None]
- Maximum operation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_navigation_timeout()`,
- `browser_context.set_default_timeout()`, `page.set_default_navigation_timeout()` or
- `page.set_default_timeout()` methods.
- Returns
- -------
- EventContextManager[Response]
- """
- return AsyncEventContextManager(
- self._impl_obj.expect_navigation(
- url=self._wrap_handler(url),
- waitUntil=wait_until,
- timeout=to_milliseconds(timeout),
- ).future
- )
- async def wait_for_url(
- self,
- url: typing.Union[str, typing.Pattern[str], typing.Callable[[str], bool]],
- *,
- wait_until: typing.Optional[
- Literal["commit", "domcontentloaded", "load", "networkidle"]
- ] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """Frame.wait_for_url
- Waits for the frame to navigate to the given URL.
- **Usage**
- ```py
- await frame.click(\"a.delayed-navigation\") # clicking the link will indirectly cause a navigation
- await frame.wait_for_url(\"**/target.html\")
- ```
- Parameters
- ----------
- url : Union[Callable[[str], bool], Pattern[str], str]
- A glob pattern, regex pattern, or predicate receiving [URL] to match while waiting for the navigation. Note that if
- the parameter is a string without wildcard characters, the method will wait for navigation to URL that is exactly
- equal to the string.
- wait_until : Union["commit", "domcontentloaded", "load", "networkidle", None]
- When to consider operation succeeded, defaults to `load`. Events can be either:
- - `'domcontentloaded'` - consider operation to be finished when the `DOMContentLoaded` event is fired.
- - `'load'` - consider operation to be finished when the `load` event is fired.
- - `'networkidle'` - **DISCOURAGED** consider operation to be finished when there are no network connections for
- at least `500` ms. Don't use this method for testing, rely on web assertions to assess readiness instead.
- - `'commit'` - consider operation to be finished when network response is received and the document started
- loading.
- timeout : Union[float, None]
- Maximum operation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_navigation_timeout()`,
- `browser_context.set_default_timeout()`, `page.set_default_navigation_timeout()` or
- `page.set_default_timeout()` methods.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.wait_for_url(
- url=self._wrap_handler(url),
- waitUntil=wait_until,
- timeout=to_milliseconds(timeout),
- )
- )
- async def wait_for_load_state(
- self,
- state: typing.Optional[
- Literal["domcontentloaded", "load", "networkidle"]
- ] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """Frame.wait_for_load_state
- Waits for the required load state to be reached.
- This returns when the frame reaches a required load state, `load` by default. The navigation must have been
- committed when this method is called. If current document has already reached the required state, resolves
- immediately.
- **NOTE** Most of the time, this method is not needed because Playwright
- [auto-waits before every action](https://playwright.dev/python/docs/actionability).
- **Usage**
- ```py
- await frame.click(\"button\") # click triggers navigation.
- await frame.wait_for_load_state() # the promise resolves after \"load\" event.
- ```
- Parameters
- ----------
- state : Union["domcontentloaded", "load", "networkidle", None]
- Optional load state to wait for, defaults to `load`. If the state has been already reached while loading current
- document, the method resolves immediately. Can be one of:
- - `'load'` - wait for the `load` event to be fired.
- - `'domcontentloaded'` - wait for the `DOMContentLoaded` event to be fired.
- - `'networkidle'` - **DISCOURAGED** wait until there are no network connections for at least `500` ms. Don't use
- this method for testing, rely on web assertions to assess readiness instead.
- timeout : Union[float, None]
- Maximum operation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_navigation_timeout()`,
- `browser_context.set_default_timeout()`, `page.set_default_navigation_timeout()` or
- `page.set_default_timeout()` methods.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.wait_for_load_state(
- state=state, timeout=to_milliseconds(timeout)
- )
- )
- async def frame_element(self) -> "ElementHandle":
- """Frame.frame_element
- Returns the `frame` or `iframe` element handle which corresponds to this frame.
- This is an inverse of `element_handle.content_frame()`. Note that returned handle actually belongs to the
- parent frame.
- This method throws an error if the frame has been detached before `frameElement()` returns.
- **Usage**
- ```py
- frame_element = await frame.frame_element()
- content_frame = await frame_element.content_frame()
- assert frame == content_frame
- ```
- Returns
- -------
- ElementHandle
- """
- return mapping.from_impl(await self._impl_obj.frame_element())
- async def evaluate(
- self, expression: str, arg: typing.Optional[typing.Any] = None
- ) -> typing.Any:
- """Frame.evaluate
- Returns the return value of `expression`.
- If the function passed to the `frame.evaluate()` returns a [Promise], then `frame.evaluate()` would
- wait for the promise to resolve and return its value.
- If the function passed to the `frame.evaluate()` returns a non-[Serializable] value, then
- `frame.evaluate()` returns `undefined`. Playwright also supports transferring some additional values that
- are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`.
- **Usage**
- ```py
- result = await frame.evaluate(\"([x, y]) => Promise.resolve(x * y)\", [7, 8])
- print(result) # prints \"56\"
- ```
- A string can also be passed in instead of a function.
- ```py
- print(await frame.evaluate(\"1 + 2\")) # prints \"3\"
- x = 10
- print(await frame.evaluate(f\"1 + {x}\")) # prints \"11\"
- ```
- `ElementHandle` instances can be passed as an argument to the `frame.evaluate()`:
- ```py
- body_handle = await frame.evaluate(\"document.body\")
- html = await frame.evaluate(\"([body, suffix]) => body.innerHTML + suffix\", [body_handle, \"hello\"])
- await body_handle.dispose()
- ```
- Parameters
- ----------
- expression : str
- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
- function is automatically invoked.
- arg : Union[Any, None]
- Optional argument to pass to `expression`.
- Returns
- -------
- Any
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.evaluate(
- expression=expression, arg=mapping.to_impl(arg)
- )
- )
- async def evaluate_handle(
- self, expression: str, arg: typing.Optional[typing.Any] = None
- ) -> "JSHandle":
- """Frame.evaluate_handle
- Returns the return value of `expression` as a `JSHandle`.
- The only difference between `frame.evaluate()` and `frame.evaluate_handle()` is that
- `frame.evaluate_handle()` returns `JSHandle`.
- If the function, passed to the `frame.evaluate_handle()`, returns a [Promise], then
- `frame.evaluate_handle()` would wait for the promise to resolve and return its value.
- **Usage**
- ```py
- a_window_handle = await frame.evaluate_handle(\"Promise.resolve(window)\")
- a_window_handle # handle for the window object.
- ```
- A string can also be passed in instead of a function.
- ```py
- a_handle = await page.evaluate_handle(\"document\") # handle for the \"document\"
- ```
- `JSHandle` instances can be passed as an argument to the `frame.evaluate_handle()`:
- ```py
- a_handle = await page.evaluate_handle(\"document.body\")
- result_handle = await page.evaluate_handle(\"body => body.innerHTML\", a_handle)
- print(await result_handle.json_value())
- await result_handle.dispose()
- ```
- Parameters
- ----------
- expression : str
- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
- function is automatically invoked.
- arg : Union[Any, None]
- Optional argument to pass to `expression`.
- Returns
- -------
- JSHandle
- """
- return mapping.from_impl(
- await self._impl_obj.evaluate_handle(
- expression=expression, arg=mapping.to_impl(arg)
- )
- )
- async def query_selector(
- self, selector: str, *, strict: typing.Optional[bool] = None
- ) -> typing.Optional["ElementHandle"]:
- """Frame.query_selector
- Returns the ElementHandle pointing to the frame element.
- **NOTE** The use of `ElementHandle` is discouraged, use `Locator` objects and web-first assertions instead.
- The method finds an element matching the specified selector within the frame. If no elements match the selector,
- returns `null`.
- Parameters
- ----------
- selector : str
- A selector to query for.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- Returns
- -------
- Union[ElementHandle, None]
- """
- return mapping.from_impl_nullable(
- await self._impl_obj.query_selector(selector=selector, strict=strict)
- )
- async def query_selector_all(self, selector: str) -> typing.List["ElementHandle"]:
- """Frame.query_selector_all
- Returns the ElementHandles pointing to the frame elements.
- **NOTE** The use of `ElementHandle` is discouraged, use `Locator` objects instead.
- The method finds all elements matching the specified selector within the frame. If no elements match the selector,
- returns empty array.
- Parameters
- ----------
- selector : str
- A selector to query for.
- Returns
- -------
- List[ElementHandle]
- """
- return mapping.from_impl_list(
- await self._impl_obj.query_selector_all(selector=selector)
- )
- async def wait_for_selector(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- state: typing.Optional[
- Literal["attached", "detached", "hidden", "visible"]
- ] = None,
- ) -> typing.Optional["ElementHandle"]:
- """Frame.wait_for_selector
- Returns when element specified by selector satisfies `state` option. Returns `null` if waiting for `hidden` or
- `detached`.
- **NOTE** Playwright automatically waits for element to be ready before performing an action. Using `Locator`
- objects and web-first assertions make the code wait-for-selector-free.
- Wait for the `selector` to satisfy `state` option (either appear/disappear from dom, or become visible/hidden). If
- at the moment of calling the method `selector` already satisfies the condition, the method will return immediately.
- If the selector doesn't satisfy the condition for the `timeout` milliseconds, the function will throw.
- **Usage**
- This method works across navigations:
- ```py
- import asyncio
- from playwright.async_api import async_playwright, Playwright
- async def run(playwright: Playwright):
- chromium = playwright.chromium
- browser = await chromium.launch()
- page = await browser.new_page()
- for current_url in [\"https://google.com\", \"https://bbc.com\"]:
- await page.goto(current_url, wait_until=\"domcontentloaded\")
- element = await page.main_frame.wait_for_selector(\"img\")
- print(\"Loaded image: \" + str(await element.get_attribute(\"src\")))
- await browser.close()
- async def main():
- async with async_playwright() as playwright:
- await run(playwright)
- asyncio.run(main())
- ```
- Parameters
- ----------
- selector : str
- A selector to query for.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- state : Union["attached", "detached", "hidden", "visible", None]
- Defaults to `'visible'`. Can be either:
- - `'attached'` - wait for element to be present in DOM.
- - `'detached'` - wait for element to not be present in DOM.
- - `'visible'` - wait for element to have non-empty bounding box and no `visibility:hidden`. Note that element
- without any content or with `display:none` has an empty bounding box and is not considered visible.
- - `'hidden'` - wait for element to be either detached from DOM, or have an empty bounding box or
- `visibility:hidden`. This is opposite to the `'visible'` option.
- Returns
- -------
- Union[ElementHandle, None]
- """
- return mapping.from_impl_nullable(
- await self._impl_obj.wait_for_selector(
- selector=selector,
- strict=strict,
- timeout=to_milliseconds(timeout),
- state=state,
- )
- )
- async def is_checked(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> bool:
- """Frame.is_checked
- Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.is_checked(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def is_disabled(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> bool:
- """Frame.is_disabled
- Returns whether the element is disabled, the opposite of [enabled](https://playwright.dev/python/docs/actionability#enabled).
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.is_disabled(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def is_editable(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> bool:
- """Frame.is_editable
- Returns whether the element is [editable](https://playwright.dev/python/docs/actionability#editable).
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.is_editable(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def is_enabled(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> bool:
- """Frame.is_enabled
- Returns whether the element is [enabled](https://playwright.dev/python/docs/actionability#enabled).
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.is_enabled(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def is_hidden(
- self, selector: str, *, strict: typing.Optional[bool] = None
- ) -> bool:
- """Frame.is_hidden
- Returns whether the element is hidden, the opposite of [visible](https://playwright.dev/python/docs/actionability#visible). `selector` that
- does not match any elements is considered hidden.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.is_hidden(selector=selector, strict=strict)
- )
- async def is_visible(
- self, selector: str, *, strict: typing.Optional[bool] = None
- ) -> bool:
- """Frame.is_visible
- Returns whether the element is [visible](https://playwright.dev/python/docs/actionability#visible). `selector` that does not match any elements
- is considered not visible.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.is_visible(selector=selector, strict=strict)
- )
- async def dispatch_event(
- self,
- selector: str,
- type: str,
- event_init: typing.Optional[typing.Dict] = None,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """Frame.dispatch_event
- The snippet below dispatches the `click` event on the element. Regardless of the visibility state of the element,
- `click` is dispatched. This is equivalent to calling
- [element.click()](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/click).
- **Usage**
- ```py
- await frame.dispatch_event(\"button#submit\", \"click\")
- ```
- Under the hood, it creates an instance of an event based on the given `type`, initializes it with `eventInit`
- properties and dispatches it on the element. Events are `composed`, `cancelable` and bubble by default.
- Since `eventInit` is event-specific, please refer to the events documentation for the lists of initial properties:
- - [DeviceMotionEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent/DeviceMotionEvent)
- - [DeviceOrientationEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceOrientationEvent/DeviceOrientationEvent)
- - [DragEvent](https://developer.mozilla.org/en-US/docs/Web/API/DragEvent/DragEvent)
- - [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event/Event)
- - [FocusEvent](https://developer.mozilla.org/en-US/docs/Web/API/FocusEvent/FocusEvent)
- - [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/KeyboardEvent)
- - [MouseEvent](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/MouseEvent)
- - [PointerEvent](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/PointerEvent)
- - [TouchEvent](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent/TouchEvent)
- - [WheelEvent](https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/WheelEvent)
- You can also specify `JSHandle` as the property value if you want live objects to be passed into the event:
- ```py
- # note you can only create data_transfer in chromium and firefox
- data_transfer = await frame.evaluate_handle(\"new DataTransfer()\")
- await frame.dispatch_event(\"#source\", \"dragstart\", { \"dataTransfer\": data_transfer })
- ```
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- type : str
- DOM event type: `"click"`, `"dragstart"`, etc.
- event_init : Union[Dict, None]
- Optional event-specific initialization properties.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.dispatch_event(
- selector=selector,
- type=type,
- eventInit=mapping.to_impl(event_init),
- strict=strict,
- timeout=to_milliseconds(timeout),
- )
- )
- async def eval_on_selector(
- self,
- selector: str,
- expression: str,
- arg: typing.Optional[typing.Any] = None,
- *,
- strict: typing.Optional[bool] = None,
- ) -> typing.Any:
- """Frame.eval_on_selector
- Returns the return value of `expression`.
- The method finds an element matching the specified selector within the frame and passes it as a first argument to
- `expression`. If no elements match the selector, the method throws an error.
- If `expression` returns a [Promise], then `frame.eval_on_selector()` would wait for the promise to resolve
- and return its value.
- **Usage**
- ```py
- search_value = await frame.eval_on_selector(\"#search\", \"el => el.value\")
- preload_href = await frame.eval_on_selector(\"link[rel=preload]\", \"el => el.href\")
- html = await frame.eval_on_selector(\".main-container\", \"(e, suffix) => e.outerHTML + suffix\", \"hello\")
- ```
- Parameters
- ----------
- selector : str
- A selector to query for.
- expression : str
- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
- function is automatically invoked.
- arg : Union[Any, None]
- Optional argument to pass to `expression`.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- Returns
- -------
- Any
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.eval_on_selector(
- selector=selector,
- expression=expression,
- arg=mapping.to_impl(arg),
- strict=strict,
- )
- )
- async def eval_on_selector_all(
- self, selector: str, expression: str, arg: typing.Optional[typing.Any] = None
- ) -> typing.Any:
- """Frame.eval_on_selector_all
- Returns the return value of `expression`.
- The method finds all elements matching the specified selector within the frame and passes an array of matched
- elements as a first argument to `expression`.
- If `expression` returns a [Promise], then `frame.eval_on_selector_all()` would wait for the promise to resolve
- and return its value.
- **Usage**
- ```py
- divs_counts = await frame.eval_on_selector_all(\"div\", \"(divs, min) => divs.length >= min\", 10)
- ```
- Parameters
- ----------
- selector : str
- A selector to query for.
- expression : str
- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
- function is automatically invoked.
- arg : Union[Any, None]
- Optional argument to pass to `expression`.
- Returns
- -------
- Any
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.eval_on_selector_all(
- selector=selector, expression=expression, arg=mapping.to_impl(arg)
- )
- )
- async def content(self) -> str:
- """Frame.content
- Gets the full HTML contents of the frame, including the doctype.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(await self._impl_obj.content())
- async def set_content(
- self,
- html: str,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- wait_until: typing.Optional[
- Literal["commit", "domcontentloaded", "load", "networkidle"]
- ] = None,
- ) -> None:
- """Frame.set_content
- This method internally calls [document.write()](https://developer.mozilla.org/en-US/docs/Web/API/Document/write),
- inheriting all its specific characteristics and behaviors.
- Parameters
- ----------
- html : str
- HTML markup to assign to the page.
- timeout : Union[float, None]
- Maximum operation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_navigation_timeout()`,
- `browser_context.set_default_timeout()`, `page.set_default_navigation_timeout()` or
- `page.set_default_timeout()` methods.
- wait_until : Union["commit", "domcontentloaded", "load", "networkidle", None]
- When to consider operation succeeded, defaults to `load`. Events can be either:
- - `'domcontentloaded'` - consider operation to be finished when the `DOMContentLoaded` event is fired.
- - `'load'` - consider operation to be finished when the `load` event is fired.
- - `'networkidle'` - **DISCOURAGED** consider operation to be finished when there are no network connections for
- at least `500` ms. Don't use this method for testing, rely on web assertions to assess readiness instead.
- - `'commit'` - consider operation to be finished when network response is received and the document started
- loading.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.set_content(
- html=html, timeout=to_milliseconds(timeout), waitUntil=wait_until
- )
- )
- def is_detached(self) -> bool:
- """Frame.is_detached
- Returns `true` if the frame has been detached, or `false` otherwise.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(self._impl_obj.is_detached())
- async def add_script_tag(
- self,
- *,
- url: typing.Optional[str] = None,
- path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- content: typing.Optional[str] = None,
- type: typing.Optional[str] = None,
- ) -> "ElementHandle":
- """Frame.add_script_tag
- Returns the added tag when the script's onload fires or when the script content was injected into frame.
- Adds a `<script>` tag into the page with the desired url or content.
- Parameters
- ----------
- url : Union[str, None]
- URL of a script to be added.
- path : Union[pathlib.Path, str, None]
- Path to the JavaScript file to be injected into frame. If `path` is a relative path, then it is resolved relative
- to the current working directory.
- content : Union[str, None]
- Raw JavaScript content to be injected into frame.
- type : Union[str, None]
- Script type. Use 'module' in order to load a JavaScript ES6 module. See
- [script](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script) for more details.
- Returns
- -------
- ElementHandle
- """
- return mapping.from_impl(
- await self._impl_obj.add_script_tag(
- url=url, path=path, content=content, type=type
- )
- )
- async def add_style_tag(
- self,
- *,
- url: typing.Optional[str] = None,
- path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- content: typing.Optional[str] = None,
- ) -> "ElementHandle":
- """Frame.add_style_tag
- Returns the added tag when the stylesheet's onload fires or when the CSS content was injected into frame.
- Adds a `<link rel=\"stylesheet\">` tag into the page with the desired url or a `<style type=\"text/css\">` tag with the
- content.
- Parameters
- ----------
- url : Union[str, None]
- URL of the `<link>` tag.
- path : Union[pathlib.Path, str, None]
- Path to the CSS file to be injected into frame. If `path` is a relative path, then it is resolved relative to the
- current working directory.
- content : Union[str, None]
- Raw CSS content to be injected into frame.
- Returns
- -------
- ElementHandle
- """
- return mapping.from_impl(
- await self._impl_obj.add_style_tag(url=url, path=path, content=content)
- )
- async def click(
- self,
- selector: str,
- *,
- modifiers: typing.Optional[
- typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]
- ] = None,
- position: typing.Optional[Position] = None,
- delay: typing.Optional[float] = None,
- button: typing.Optional[Literal["left", "middle", "right"]] = None,
- click_count: typing.Optional[int] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """Frame.click
- This method clicks an element matching `selector` by performing the following steps:
- 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If
- the element is detached during the checks, the whole action is retried.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to click in the center of the element, or the specified `position`.
- 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
- Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
- current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
- "Control" on Windows and Linux and to "Meta" on macOS.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- delay : Union[float, None]
- Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
- button : Union["left", "middle", "right", None]
- Defaults to `left`.
- click_count : Union[int, None]
- defaults to 1. See [UIEvent.detail].
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
- can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
- navigating to inaccessible pages. Defaults to `false`.
- Deprecated: This option will default to `true` in the future.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard
- `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys
- are pressed.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.click(
- selector=selector,
- modifiers=mapping.to_impl(modifiers),
- position=position,
- delay=delay,
- button=button,
- clickCount=click_count,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- strict=strict,
- trial=trial,
- )
- )
- async def dblclick(
- self,
- selector: str,
- *,
- modifiers: typing.Optional[
- typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]
- ] = None,
- position: typing.Optional[Position] = None,
- delay: typing.Optional[float] = None,
- button: typing.Optional[Literal["left", "middle", "right"]] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """Frame.dblclick
- This method double clicks an element matching `selector` by performing the following steps:
- 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If
- the element is detached during the checks, the whole action is retried.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to double click in the center of the element, or the specified `position`. if
- the first click of the `dblclick()` triggers a navigation event, this method will throw.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- **NOTE** `frame.dblclick()` dispatches two `click` events and a single `dblclick` event.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
- Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
- current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
- "Control" on Windows and Linux and to "Meta" on macOS.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- delay : Union[float, None]
- Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
- button : Union["left", "middle", "right", None]
- Defaults to `left`.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard
- `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys
- are pressed.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.dblclick(
- selector=selector,
- modifiers=mapping.to_impl(modifiers),
- position=position,
- delay=delay,
- button=button,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- strict=strict,
- trial=trial,
- )
- )
- async def tap(
- self,
- selector: str,
- *,
- modifiers: typing.Optional[
- typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]
- ] = None,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """Frame.tap
- This method taps an element matching `selector` by performing the following steps:
- 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If
- the element is detached during the checks, the whole action is retried.
- 1. Scroll the element into view if needed.
- 1. Use `page.touchscreen` to tap the center of the element, or the specified `position`.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- **NOTE** `frame.tap()` requires that the `hasTouch` option of the browser context be set to true.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
- Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
- current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
- "Control" on Windows and Linux and to "Meta" on macOS.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard
- `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys
- are pressed.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.tap(
- selector=selector,
- modifiers=mapping.to_impl(modifiers),
- position=position,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- strict=strict,
- trial=trial,
- )
- )
- async def fill(
- self,
- selector: str,
- value: str,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- force: typing.Optional[bool] = None,
- ) -> None:
- """Frame.fill
- This method waits for an element matching `selector`, waits for [actionability](https://playwright.dev/python/docs/actionability) checks,
- focuses the element, fills it and triggers an `input` event after filling. Note that you can pass an empty string
- to clear the input field.
- If the target element is not an `<input>`, `<textarea>` or `[contenteditable]` element, this method throws an
- error. However, if the element is inside the `<label>` element that has an associated
- [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be filled
- instead.
- To send fine-grained keyboard events, use `locator.press_sequentially()`.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- value : str
- Value to fill for the `<input>`, `<textarea>` or `[contenteditable]` element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.fill(
- selector=selector,
- value=value,
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- strict=strict,
- force=force,
- )
- )
- def locator(
- self,
- selector: str,
- *,
- has_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- has_not_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- has: typing.Optional["Locator"] = None,
- has_not: typing.Optional["Locator"] = None,
- ) -> "Locator":
- """Frame.locator
- The method returns an element locator that can be used to perform actions on this page / frame. Locator is resolved
- to the element immediately before performing an action, so a series of actions on the same locator can in fact be
- performed on different DOM elements. That would happen if the DOM structure between those actions has changed.
- [Learn more about locators](https://playwright.dev/python/docs/locators).
- [Learn more about locators](https://playwright.dev/python/docs/locators).
- Parameters
- ----------
- selector : str
- A selector to use when resolving DOM element.
- has_text : Union[Pattern[str], str, None]
- Matches elements containing specified text somewhere inside, possibly in a child or a descendant element. When
- passed a [string], matching is case-insensitive and searches for a substring. For example, `"Playwright"` matches
- `<article><div>Playwright</div></article>`.
- has_not_text : Union[Pattern[str], str, None]
- Matches elements that do not contain specified text somewhere inside, possibly in a child or a descendant element.
- When passed a [string], matching is case-insensitive and searches for a substring.
- has : Union[Locator, None]
- Narrows down the results of the method to those which contain elements matching this relative locator. For example,
- `article` that has `text=Playwright` matches `<article><div>Playwright</div></article>`.
- Inner locator **must be relative** to the outer locator and is queried starting with the outer locator match, not
- the document root. For example, you can find `content` that has `div` in
- `<article><content><div>Playwright</div></content></article>`. However, looking for `content` that has `article
- div` will fail, because the inner locator must be relative and should not use any elements outside the `content`.
- Note that outer and inner locators must belong to the same frame. Inner locator must not contain `FrameLocator`s.
- has_not : Union[Locator, None]
- Matches elements that do not contain an element that matches an inner locator. Inner locator is queried against the
- outer one. For example, `article` that does not have `div` matches `<article><span>Playwright</span></article>`.
- Note that outer and inner locators must belong to the same frame. Inner locator must not contain `FrameLocator`s.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(
- self._impl_obj.locator(
- selector=selector,
- hasText=has_text,
- hasNotText=has_not_text,
- has=has._impl_obj if has else None,
- hasNot=has_not._impl_obj if has_not else None,
- )
- )
- def get_by_alt_text(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """Frame.get_by_alt_text
- Allows locating elements by their alt text.
- **Usage**
- For example, this method will find the image by alt text \"Playwright logo\":
- ```html
- <img alt='Playwright logo'>
- ```
- ```py
- await page.get_by_alt_text(\"Playwright logo\").click()
- ```
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_alt_text(text=text, exact=exact))
- def get_by_label(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """Frame.get_by_label
- Allows locating input elements by the text of the associated `<label>` or `aria-labelledby` element, or by the
- `aria-label` attribute.
- **Usage**
- For example, this method will find inputs by label \"Username\" and \"Password\" in the following DOM:
- ```html
- <input aria-label=\"Username\">
- <label for=\"password-input\">Password:</label>
- <input id=\"password-input\">
- ```
- ```py
- await page.get_by_label(\"Username\").fill(\"john\")
- await page.get_by_label(\"Password\").fill(\"secret\")
- ```
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_label(text=text, exact=exact))
- def get_by_placeholder(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """Frame.get_by_placeholder
- Allows locating input elements by the placeholder text.
- **Usage**
- For example, consider the following DOM structure.
- ```html
- <input type=\"email\" placeholder=\"name@example.com\" />
- ```
- You can fill the input after locating it by the placeholder text:
- ```py
- await page.get_by_placeholder(\"name@example.com\").fill(\"playwright@microsoft.com\")
- ```
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(
- self._impl_obj.get_by_placeholder(text=text, exact=exact)
- )
- def get_by_role(
- self,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "blockquote",
- "button",
- "caption",
- "cell",
- "checkbox",
- "code",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "deletion",
- "dialog",
- "directory",
- "document",
- "emphasis",
- "feed",
- "figure",
- "form",
- "generic",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "insertion",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "meter",
- "navigation",
- "none",
- "note",
- "option",
- "paragraph",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "strong",
- "subscript",
- "superscript",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "time",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ],
- *,
- checked: typing.Optional[bool] = None,
- disabled: typing.Optional[bool] = None,
- expanded: typing.Optional[bool] = None,
- include_hidden: typing.Optional[bool] = None,
- level: typing.Optional[int] = None,
- name: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- pressed: typing.Optional[bool] = None,
- selected: typing.Optional[bool] = None,
- exact: typing.Optional[bool] = None,
- description: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- ) -> "Locator":
- """Frame.get_by_role
- Allows locating elements by their [ARIA role](https://www.w3.org/TR/wai-aria-1.2/#roles),
- [ARIA attributes](https://www.w3.org/TR/wai-aria-1.2/#aria-attributes) and
- [accessible name](https://w3c.github.io/accname/#dfn-accessible-name).
- **Usage**
- Consider the following DOM structure.
- ```html
- <h3>Sign up</h3>
- <label>
- <input type=\"checkbox\" /> Subscribe
- </label>
- <br/>
- <button>Submit</button>
- ```
- You can locate each element by its implicit role:
- ```py
- await expect(page.get_by_role(\"heading\", name=\"Sign up\")).to_be_visible()
- await page.get_by_role(\"checkbox\", name=\"Subscribe\").check()
- await page.get_by_role(\"button\", name=re.compile(\"submit\", re.IGNORECASE)).click()
- ```
- **Details**
- Role selector **does not replace** accessibility audits and conformance tests, but rather gives early feedback
- about the ARIA guidelines.
- Many html elements have an implicitly [defined role](https://w3c.github.io/html-aam/#html-element-role-mappings)
- that is recognized by the role selector. You can find all the
- [supported roles here](https://www.w3.org/TR/wai-aria-1.2/#role_definitions). ARIA guidelines **do not recommend**
- duplicating implicit roles and attributes by setting `role` and/or `aria-*` attributes to default values.
- Parameters
- ----------
- role : Union["alert", "alertdialog", "application", "article", "banner", "blockquote", "button", "caption", "cell", "checkbox", "code", "columnheader", "combobox", "complementary", "contentinfo", "definition", "deletion", "dialog", "directory", "document", "emphasis", "feed", "figure", "form", "generic", "grid", "gridcell", "group", "heading", "img", "insertion", "link", "list", "listbox", "listitem", "log", "main", "marquee", "math", "menu", "menubar", "menuitem", "menuitemcheckbox", "menuitemradio", "meter", "navigation", "none", "note", "option", "paragraph", "presentation", "progressbar", "radio", "radiogroup", "region", "row", "rowgroup", "rowheader", "scrollbar", "search", "searchbox", "separator", "slider", "spinbutton", "status", "strong", "subscript", "superscript", "switch", "tab", "table", "tablist", "tabpanel", "term", "textbox", "time", "timer", "toolbar", "tooltip", "tree", "treegrid", "treeitem"]
- Required aria role.
- checked : Union[bool, None]
- An attribute that is usually set by `aria-checked` or native `<input type=checkbox>` controls.
- Learn more about [`aria-checked`](https://www.w3.org/TR/wai-aria-1.2/#aria-checked).
- disabled : Union[bool, None]
- An attribute that is usually set by `aria-disabled` or `disabled`.
- **NOTE** Unlike most other attributes, `disabled` is inherited through the DOM hierarchy. Learn more about
- [`aria-disabled`](https://www.w3.org/TR/wai-aria-1.2/#aria-disabled).
- expanded : Union[bool, None]
- An attribute that is usually set by `aria-expanded`.
- Learn more about [`aria-expanded`](https://www.w3.org/TR/wai-aria-1.2/#aria-expanded).
- include_hidden : Union[bool, None]
- Option that controls whether hidden elements are matched. By default, only non-hidden elements, as
- [defined by ARIA](https://www.w3.org/TR/wai-aria-1.2/#tree_exclusion), are matched by role selector.
- Learn more about [`aria-hidden`](https://www.w3.org/TR/wai-aria-1.2/#aria-hidden).
- level : Union[int, None]
- A number attribute that is usually present for roles `heading`, `listitem`, `row`, `treeitem`, with default values
- for `<h1>-<h6>` elements.
- Learn more about [`aria-level`](https://www.w3.org/TR/wai-aria-1.2/#aria-level).
- name : Union[Pattern[str], str, None]
- Option to match the [accessible name](https://w3c.github.io/accname/#dfn-accessible-name). By default, matching is
- case-insensitive and searches for a substring, use `exact` to control this behavior.
- Learn more about [accessible name](https://w3c.github.io/accname/#dfn-accessible-name).
- pressed : Union[bool, None]
- An attribute that is usually set by `aria-pressed`.
- Learn more about [`aria-pressed`](https://www.w3.org/TR/wai-aria-1.2/#aria-pressed).
- selected : Union[bool, None]
- An attribute that is usually set by `aria-selected`.
- Learn more about [`aria-selected`](https://www.w3.org/TR/wai-aria-1.2/#aria-selected).
- exact : Union[bool, None]
- Whether `name` and `description` are matched exactly: case-sensitive and whole-string. Defaults to false. Ignored
- when the value is a regular expression. Note that exact match still trims whitespace.
- description : Union[Pattern[str], str, None]
- Option to match the [accessible description](https://w3c.github.io/accname/#dfn-accessible-description). By
- default, matching is case-insensitive and searches for a substring, use `exact` to control this behavior.
- Learn more about [accessible description](https://w3c.github.io/accname/#dfn-accessible-description).
- Returns
- -------
- Locator
- """
- return mapping.from_impl(
- self._impl_obj.get_by_role(
- role=role,
- checked=checked,
- disabled=disabled,
- expanded=expanded,
- includeHidden=include_hidden,
- level=level,
- name=name,
- pressed=pressed,
- selected=selected,
- exact=exact,
- description=description,
- )
- )
- def get_by_test_id(
- self, test_id: typing.Union[str, typing.Pattern[str]]
- ) -> "Locator":
- """Frame.get_by_test_id
- Locate element by the test id.
- **Usage**
- Consider the following DOM structure.
- ```html
- <button data-testid=\"directions\">Itinéraire</button>
- ```
- You can locate the element by its test id:
- ```py
- await page.get_by_test_id(\"directions\").click()
- ```
- **Details**
- By default, the `data-testid` attribute is used as a test id. Use `selectors.set_test_id_attribute()` to
- configure a different test id attribute if necessary.
- Parameters
- ----------
- test_id : Union[Pattern[str], str]
- Id to locate the element by.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_test_id(testId=test_id))
- def get_by_text(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """Frame.get_by_text
- Allows locating elements that contain given text.
- See also `locator.filter()` that allows to match by another criteria, like an accessible role, and then
- filter by the text content.
- **Usage**
- Consider the following DOM structure:
- ```html
- <div>Hello <span>world</span></div>
- <div>Hello</div>
- ```
- You can locate by text substring, exact string, or a regular expression:
- ```py
- # Matches <span>
- page.get_by_text(\"world\")
- # Matches first <div>
- page.get_by_text(\"Hello world\")
- # Matches second <div>
- page.get_by_text(\"Hello\", exact=True)
- # Matches both <div>s
- page.get_by_text(re.compile(\"Hello\"))
- # Matches second <div>
- page.get_by_text(re.compile(\"^hello$\", re.IGNORECASE))
- ```
- **Details**
- Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into
- one, turns line breaks into spaces and ignores leading and trailing whitespace.
- Input elements of the type `button` and `submit` are matched by their `value` instead of the text content. For
- example, locating by text `\"Log in\"` matches `<input type=button value=\"Log in\">`.
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_text(text=text, exact=exact))
- def get_by_title(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """Frame.get_by_title
- Allows locating elements by their title attribute.
- **Usage**
- Consider the following DOM structure.
- ```html
- <span title='Issues count'>25 issues</span>
- ```
- You can check the issues count after locating it by the title text:
- ```py
- await expect(page.get_by_title(\"Issues count\")).to_have_text(\"25 issues\")
- ```
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_title(text=text, exact=exact))
- def frame_locator(self, selector: str) -> "FrameLocator":
- """Frame.frame_locator
- When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements
- in that iframe.
- **Usage**
- Following snippet locates element with text \"Submit\" in the iframe with id `my-frame`, like `<iframe
- id=\"my-frame\">`:
- ```py
- locator = frame.frame_locator(\"#my-iframe\").get_by_text(\"Submit\")
- await locator.click()
- ```
- Parameters
- ----------
- selector : str
- A selector to use when resolving DOM element.
- Returns
- -------
- FrameLocator
- """
- return mapping.from_impl(self._impl_obj.frame_locator(selector=selector))
- async def focus(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """Frame.focus
- This method fetches an element with `selector` and focuses it. If there's no element matching `selector`, the
- method waits until a matching element appears in the DOM.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.focus(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def text_content(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> typing.Optional[str]:
- """Frame.text_content
- Returns `element.textContent`.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- Union[str, None]
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.text_content(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def inner_text(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> str:
- """Frame.inner_text
- Returns `element.innerText`.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.inner_text(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def inner_html(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> str:
- """Frame.inner_html
- Returns `element.innerHTML`.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.inner_html(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def get_attribute(
- self,
- selector: str,
- name: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> typing.Optional[str]:
- """Frame.get_attribute
- Returns element attribute value.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- name : str
- Attribute name to get the value for.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- Union[str, None]
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.get_attribute(
- selector=selector,
- name=name,
- strict=strict,
- timeout=to_milliseconds(timeout),
- )
- )
- async def hover(
- self,
- selector: str,
- *,
- modifiers: typing.Optional[
- typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]
- ] = None,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- force: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """Frame.hover
- This method hovers over an element matching `selector` by performing the following steps:
- 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If
- the element is detached during the checks, the whole action is retried.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to hover over the center of the element, or the specified `position`.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
- Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
- current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
- "Control" on Windows and Linux and to "Meta" on macOS.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard
- `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys
- are pressed.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.hover(
- selector=selector,
- modifiers=mapping.to_impl(modifiers),
- position=position,
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- force=force,
- strict=strict,
- trial=trial,
- )
- )
- async def drag_and_drop(
- self,
- source: str,
- target: str,
- *,
- source_position: typing.Optional[Position] = None,
- target_position: typing.Optional[Position] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- trial: typing.Optional[bool] = None,
- steps: typing.Optional[int] = None,
- ) -> None:
- """Frame.drag_and_drop
- Parameters
- ----------
- source : str
- A selector to search for an element to drag. If there are multiple elements satisfying the selector, the first will
- be used.
- target : str
- A selector to search for an element to drop onto. If there are multiple elements satisfying the selector, the first
- will be used.
- source_position : Union[{x: float, y: float}, None]
- Clicks on the source element at this point relative to the top-left corner of the element's padding box. If not
- specified, some visible point of the element is used.
- target_position : Union[{x: float, y: float}, None]
- Drops on the target element at this point relative to the top-left corner of the element's padding box. If not
- specified, some visible point of the element is used.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it.
- steps : Union[int, None]
- Defaults to 1. Sends `n` interpolated `mousemove` events to represent travel between the `mousedown` and `mouseup`
- of the drag. When set to 1, emits a single `mousemove` event at the destination location.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.drag_and_drop(
- source=source,
- target=target,
- sourcePosition=source_position,
- targetPosition=target_position,
- force=force,
- noWaitAfter=no_wait_after,
- strict=strict,
- timeout=to_milliseconds(timeout),
- trial=trial,
- steps=steps,
- )
- )
- async def select_option(
- self,
- selector: str,
- value: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
- *,
- index: typing.Optional[typing.Union[int, typing.Sequence[int]]] = None,
- label: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
- element: typing.Optional[
- typing.Union["ElementHandle", typing.Sequence["ElementHandle"]]
- ] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- force: typing.Optional[bool] = None,
- ) -> typing.List[str]:
- """Frame.select_option
- This method waits for an element matching `selector`, waits for [actionability](https://playwright.dev/python/docs/actionability) checks, waits
- until all specified options are present in the `<select>` element and selects these options.
- If the target element is not a `<select>` element, this method throws an error. However, if the element is inside
- the `<label>` element that has an associated
- [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be used
- instead.
- Returns the array of option values that have been successfully selected.
- Triggers a `change` and `input` event once all the provided options have been selected.
- **Usage**
- ```py
- # Single selection matching the value or label
- await frame.select_option(\"select#colors\", \"blue\")
- # single selection matching the label
- await frame.select_option(\"select#colors\", label=\"blue\")
- # multiple selection
- await frame.select_option(\"select#colors\", value=[\"red\", \"green\", \"blue\"])
- ```
- Parameters
- ----------
- selector : str
- A selector to query for.
- value : Union[Sequence[str], str, None]
- Options to select by value. If the `<select>` has the `multiple` attribute, all given options are selected,
- otherwise only the first option matching one of the passed options is selected. Optional.
- index : Union[Sequence[int], int, None]
- Options to select by index. Optional.
- label : Union[Sequence[str], str, None]
- Options to select by label. If the `<select>` has the `multiple` attribute, all given options are selected,
- otherwise only the first option matching one of the passed options is selected. Optional.
- element : Union[ElementHandle, Sequence[ElementHandle], None]
- Option elements to select. Optional.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- Returns
- -------
- List[str]
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.select_option(
- selector=selector,
- value=mapping.to_impl(value),
- index=mapping.to_impl(index),
- label=mapping.to_impl(label),
- element=mapping.to_impl(element),
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- strict=strict,
- force=force,
- )
- )
- async def input_value(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> str:
- """Frame.input_value
- Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element.
- Throws for non-input elements. However, if the element is inside the `<label>` element that has an associated
- [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the
- control.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.input_value(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def set_input_files(
- self,
- selector: str,
- files: typing.Union[
- str,
- pathlib.Path,
- FilePayload,
- typing.Sequence[typing.Union[str, pathlib.Path]],
- typing.Sequence[FilePayload],
- ],
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- ) -> None:
- """Frame.set_input_files
- Sets the value of the file input to these file paths or files. If some of the `filePaths` are relative paths, then
- they are resolved relative to the current working directory. For empty array, clears the selected files.
- This method expects `selector` to point to an
- [input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside
- the `<label>` element that has an associated
- [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- files : Union[Sequence[Union[pathlib.Path, str]], Sequence[{name: str, mimeType: str, buffer: bytes}], pathlib.Path, str, {name: str, mimeType: str, buffer: bytes}]
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.set_input_files(
- selector=selector,
- files=mapping.to_impl(files),
- strict=strict,
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- )
- )
- async def type(
- self,
- selector: str,
- text: str,
- *,
- delay: typing.Optional[float] = None,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- ) -> None:
- """Frame.type
- Sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text. `frame.type` can be used
- to send fine-grained keyboard events. To fill values in form fields, use `frame.fill()`.
- To press a special key, like `Control` or `ArrowDown`, use `keyboard.press()`.
- **Usage**
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- text : str
- A text to type into a focused element.
- delay : Union[float, None]
- Time to wait between key presses in milliseconds. Defaults to 0.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.type(
- selector=selector,
- text=text,
- delay=delay,
- strict=strict,
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- )
- )
- async def press(
- self,
- selector: str,
- key: str,
- *,
- delay: typing.Optional[float] = None,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- ) -> None:
- """Frame.press
- `key` can specify the intended
- [keyboardEvent.key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) value or a single character
- to generate the text for. A superset of the `key` values can be found
- [here](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values). Examples of the keys are:
- `F1` - `F12`, `Digit0`- `Digit9`, `KeyA`- `KeyZ`, `Backquote`, `Minus`, `Equal`, `Backslash`, `Backspace`, `Tab`,
- `Delete`, `Escape`, `ArrowDown`, `End`, `Enter`, `Home`, `Insert`, `PageDown`, `PageUp`, `ArrowRight`, `ArrowUp`,
- etc.
- Following modification shortcuts are also supported: `Shift`, `Control`, `Alt`, `Meta`, `ShiftLeft`,
- `ControlOrMeta`. `ControlOrMeta` resolves to `Control` on Windows and Linux and to `Meta` on macOS.
- Holding down `Shift` will type the text that corresponds to the `key` in the upper case.
- If `key` is a single character, it is case-sensitive, so the values `a` and `A` will generate different respective
- texts.
- Shortcuts such as `key: \"Control+o\"`, `key: \"Control++` or `key: \"Control+Shift+T\"` are supported as well. When
- specified with the modifier, modifier is pressed and being held while the subsequent key is being pressed.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- key : str
- Name of the key to press or a character to generate, such as `ArrowLeft` or `a`.
- delay : Union[float, None]
- Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
- can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
- navigating to inaccessible pages. Defaults to `false`.
- Deprecated: This option will default to `true` in the future.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.press(
- selector=selector,
- key=key,
- delay=delay,
- strict=strict,
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- )
- )
- async def check(
- self,
- selector: str,
- *,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """Frame.check
- This method checks an element matching `selector` by performing the following steps:
- 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
- 1. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is
- already checked, this method returns immediately.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If
- the element is detached during the checks, the whole action is retried.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to click in the center of the element.
- 1. Ensure that the element is now checked. If not, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.check(
- selector=selector,
- position=position,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- strict=strict,
- trial=trial,
- )
- )
- async def uncheck(
- self,
- selector: str,
- *,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """Frame.uncheck
- This method checks an element matching `selector` by performing the following steps:
- 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
- 1. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is
- already unchecked, this method returns immediately.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If
- the element is detached during the checks, the whole action is retried.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to click in the center of the element.
- 1. Ensure that the element is now unchecked. If not, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.uncheck(
- selector=selector,
- position=position,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- strict=strict,
- trial=trial,
- )
- )
- async def wait_for_timeout(
- self, timeout: typing.Union[float, datetime.timedelta]
- ) -> None:
- """Frame.wait_for_timeout
- Waits for the given `timeout` in milliseconds.
- Note that `frame.waitForTimeout()` should only be used for debugging. Tests using the timer in production are going
- to be flaky. Use signals such as network events, selectors becoming visible and others instead.
- Parameters
- ----------
- timeout : float
- A timeout to wait for
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.wait_for_timeout(timeout=to_milliseconds(timeout))
- )
- async def wait_for_function(
- self,
- expression: str,
- *,
- arg: typing.Optional[typing.Any] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- polling: typing.Optional[typing.Union[float, Literal["raf"]]] = None,
- ) -> "JSHandle":
- """Frame.wait_for_function
- Returns when the `expression` returns a truthy value, returns that value.
- **Usage**
- The `frame.wait_for_function()` can be used to observe viewport size change:
- ```py
- import asyncio
- from playwright.async_api import async_playwright, Playwright
- async def run(playwright: Playwright):
- webkit = playwright.webkit
- browser = await webkit.launch()
- page = await browser.new_page()
- await page.evaluate(\"window.x = 0; setTimeout(() => { window.x = 100 }, 1000);\")
- await page.main_frame.wait_for_function(\"() => window.x > 0\")
- await browser.close()
- async def main():
- async with async_playwright() as playwright:
- await run(playwright)
- asyncio.run(main())
- ```
- To pass an argument to the predicate of `frame.waitForFunction` function:
- ```py
- selector = \".foo\"
- await frame.wait_for_function(\"selector => !!document.querySelector(selector)\", selector)
- ```
- Parameters
- ----------
- expression : str
- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
- function is automatically invoked.
- arg : Union[Any, None]
- Optional argument to pass to `expression`.
- timeout : Union[float, None]
- Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The
- default value can be changed by using the `browser_context.set_default_timeout()` or
- `page.set_default_timeout()` methods.
- polling : Union["raf", float, None]
- If `polling` is `'raf'`, then `expression` is constantly executed in `requestAnimationFrame` callback. If `polling`
- is a number, then it is treated as an interval in milliseconds at which the function would be executed. Defaults to
- `raf`.
- Returns
- -------
- JSHandle
- """
- return mapping.from_impl(
- await self._impl_obj.wait_for_function(
- expression=expression,
- arg=mapping.to_impl(arg),
- timeout=to_milliseconds(timeout),
- polling=polling,
- )
- )
- async def title(self) -> str:
- """Frame.title
- Returns the page title.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(await self._impl_obj.title())
- async def set_checked(
- self,
- selector: str,
- checked: bool,
- *,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """Frame.set_checked
- This method checks or unchecks an element matching `selector` by performing the following steps:
- 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
- 1. Ensure that matched element is a checkbox or a radio input. If not, this method throws.
- 1. If the element already has the right checked state, this method returns immediately.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If
- the element is detached during the checks, the whole action is retried.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to click in the center of the element.
- 1. Ensure that the element is now checked or unchecked. If not, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- checked : bool
- Whether to check or uncheck the checkbox.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.set_checked(
- selector=selector,
- checked=checked,
- position=position,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- strict=strict,
- trial=trial,
- )
- )
- mapping.register(FrameImpl, Frame)
- class FrameLocator(AsyncBase):
- @property
- def first(self) -> "FrameLocator":
- """FrameLocator.first
- Returns locator to the first matching frame.
- Returns
- -------
- FrameLocator
- """
- return mapping.from_impl(self._impl_obj.first)
- @property
- def last(self) -> "FrameLocator":
- """FrameLocator.last
- Returns locator to the last matching frame.
- Returns
- -------
- FrameLocator
- """
- return mapping.from_impl(self._impl_obj.last)
- @property
- def owner(self) -> "Locator":
- """FrameLocator.owner
- Returns a `Locator` object pointing to the same `iframe` as this frame locator.
- Useful when you have a `FrameLocator` object obtained somewhere, and later on would like to interact with the
- `iframe` element.
- For a reverse operation, use `locator.content_frame()`.
- **Usage**
- ```py
- frame_locator = page.locator(\"iframe[name=\\\"embedded\\\"]\").content_frame
- # ...
- locator = frame_locator.owner
- await expect(locator).to_be_visible()
- ```
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.owner)
- def locator(
- self,
- selector_or_locator: typing.Union["Locator", str],
- *,
- has_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- has_not_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- has: typing.Optional["Locator"] = None,
- has_not: typing.Optional["Locator"] = None,
- ) -> "Locator":
- """FrameLocator.locator
- The method finds an element matching the specified selector in the locator's subtree. It also accepts filter
- options, similar to `locator.filter()` method.
- [Learn more about locators](https://playwright.dev/python/docs/locators).
- Parameters
- ----------
- selector_or_locator : Union[Locator, str]
- A selector or locator to use when resolving DOM element.
- has_text : Union[Pattern[str], str, None]
- Matches elements containing specified text somewhere inside, possibly in a child or a descendant element. When
- passed a [string], matching is case-insensitive and searches for a substring. For example, `"Playwright"` matches
- `<article><div>Playwright</div></article>`.
- has_not_text : Union[Pattern[str], str, None]
- Matches elements that do not contain specified text somewhere inside, possibly in a child or a descendant element.
- When passed a [string], matching is case-insensitive and searches for a substring.
- has : Union[Locator, None]
- Narrows down the results of the method to those which contain elements matching this relative locator. For example,
- `article` that has `text=Playwright` matches `<article><div>Playwright</div></article>`.
- Inner locator **must be relative** to the outer locator and is queried starting with the outer locator match, not
- the document root. For example, you can find `content` that has `div` in
- `<article><content><div>Playwright</div></content></article>`. However, looking for `content` that has `article
- div` will fail, because the inner locator must be relative and should not use any elements outside the `content`.
- Note that outer and inner locators must belong to the same frame. Inner locator must not contain `FrameLocator`s.
- has_not : Union[Locator, None]
- Matches elements that do not contain an element that matches an inner locator. Inner locator is queried against the
- outer one. For example, `article` that does not have `div` matches `<article><span>Playwright</span></article>`.
- Note that outer and inner locators must belong to the same frame. Inner locator must not contain `FrameLocator`s.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(
- self._impl_obj.locator(
- selectorOrLocator=selector_or_locator,
- hasText=has_text,
- hasNotText=has_not_text,
- has=has._impl_obj if has else None,
- hasNot=has_not._impl_obj if has_not else None,
- )
- )
- def get_by_alt_text(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """FrameLocator.get_by_alt_text
- Allows locating elements by their alt text.
- **Usage**
- For example, this method will find the image by alt text \"Playwright logo\":
- ```html
- <img alt='Playwright logo'>
- ```
- ```py
- await page.get_by_alt_text(\"Playwright logo\").click()
- ```
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_alt_text(text=text, exact=exact))
- def get_by_label(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """FrameLocator.get_by_label
- Allows locating input elements by the text of the associated `<label>` or `aria-labelledby` element, or by the
- `aria-label` attribute.
- **Usage**
- For example, this method will find inputs by label \"Username\" and \"Password\" in the following DOM:
- ```html
- <input aria-label=\"Username\">
- <label for=\"password-input\">Password:</label>
- <input id=\"password-input\">
- ```
- ```py
- await page.get_by_label(\"Username\").fill(\"john\")
- await page.get_by_label(\"Password\").fill(\"secret\")
- ```
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_label(text=text, exact=exact))
- def get_by_placeholder(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """FrameLocator.get_by_placeholder
- Allows locating input elements by the placeholder text.
- **Usage**
- For example, consider the following DOM structure.
- ```html
- <input type=\"email\" placeholder=\"name@example.com\" />
- ```
- You can fill the input after locating it by the placeholder text:
- ```py
- await page.get_by_placeholder(\"name@example.com\").fill(\"playwright@microsoft.com\")
- ```
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(
- self._impl_obj.get_by_placeholder(text=text, exact=exact)
- )
- def get_by_role(
- self,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "blockquote",
- "button",
- "caption",
- "cell",
- "checkbox",
- "code",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "deletion",
- "dialog",
- "directory",
- "document",
- "emphasis",
- "feed",
- "figure",
- "form",
- "generic",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "insertion",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "meter",
- "navigation",
- "none",
- "note",
- "option",
- "paragraph",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "strong",
- "subscript",
- "superscript",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "time",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ],
- *,
- checked: typing.Optional[bool] = None,
- disabled: typing.Optional[bool] = None,
- expanded: typing.Optional[bool] = None,
- include_hidden: typing.Optional[bool] = None,
- level: typing.Optional[int] = None,
- name: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- pressed: typing.Optional[bool] = None,
- selected: typing.Optional[bool] = None,
- exact: typing.Optional[bool] = None,
- description: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- ) -> "Locator":
- """FrameLocator.get_by_role
- Allows locating elements by their [ARIA role](https://www.w3.org/TR/wai-aria-1.2/#roles),
- [ARIA attributes](https://www.w3.org/TR/wai-aria-1.2/#aria-attributes) and
- [accessible name](https://w3c.github.io/accname/#dfn-accessible-name).
- **Usage**
- Consider the following DOM structure.
- ```html
- <h3>Sign up</h3>
- <label>
- <input type=\"checkbox\" /> Subscribe
- </label>
- <br/>
- <button>Submit</button>
- ```
- You can locate each element by its implicit role:
- ```py
- await expect(page.get_by_role(\"heading\", name=\"Sign up\")).to_be_visible()
- await page.get_by_role(\"checkbox\", name=\"Subscribe\").check()
- await page.get_by_role(\"button\", name=re.compile(\"submit\", re.IGNORECASE)).click()
- ```
- **Details**
- Role selector **does not replace** accessibility audits and conformance tests, but rather gives early feedback
- about the ARIA guidelines.
- Many html elements have an implicitly [defined role](https://w3c.github.io/html-aam/#html-element-role-mappings)
- that is recognized by the role selector. You can find all the
- [supported roles here](https://www.w3.org/TR/wai-aria-1.2/#role_definitions). ARIA guidelines **do not recommend**
- duplicating implicit roles and attributes by setting `role` and/or `aria-*` attributes to default values.
- Parameters
- ----------
- role : Union["alert", "alertdialog", "application", "article", "banner", "blockquote", "button", "caption", "cell", "checkbox", "code", "columnheader", "combobox", "complementary", "contentinfo", "definition", "deletion", "dialog", "directory", "document", "emphasis", "feed", "figure", "form", "generic", "grid", "gridcell", "group", "heading", "img", "insertion", "link", "list", "listbox", "listitem", "log", "main", "marquee", "math", "menu", "menubar", "menuitem", "menuitemcheckbox", "menuitemradio", "meter", "navigation", "none", "note", "option", "paragraph", "presentation", "progressbar", "radio", "radiogroup", "region", "row", "rowgroup", "rowheader", "scrollbar", "search", "searchbox", "separator", "slider", "spinbutton", "status", "strong", "subscript", "superscript", "switch", "tab", "table", "tablist", "tabpanel", "term", "textbox", "time", "timer", "toolbar", "tooltip", "tree", "treegrid", "treeitem"]
- Required aria role.
- checked : Union[bool, None]
- An attribute that is usually set by `aria-checked` or native `<input type=checkbox>` controls.
- Learn more about [`aria-checked`](https://www.w3.org/TR/wai-aria-1.2/#aria-checked).
- disabled : Union[bool, None]
- An attribute that is usually set by `aria-disabled` or `disabled`.
- **NOTE** Unlike most other attributes, `disabled` is inherited through the DOM hierarchy. Learn more about
- [`aria-disabled`](https://www.w3.org/TR/wai-aria-1.2/#aria-disabled).
- expanded : Union[bool, None]
- An attribute that is usually set by `aria-expanded`.
- Learn more about [`aria-expanded`](https://www.w3.org/TR/wai-aria-1.2/#aria-expanded).
- include_hidden : Union[bool, None]
- Option that controls whether hidden elements are matched. By default, only non-hidden elements, as
- [defined by ARIA](https://www.w3.org/TR/wai-aria-1.2/#tree_exclusion), are matched by role selector.
- Learn more about [`aria-hidden`](https://www.w3.org/TR/wai-aria-1.2/#aria-hidden).
- level : Union[int, None]
- A number attribute that is usually present for roles `heading`, `listitem`, `row`, `treeitem`, with default values
- for `<h1>-<h6>` elements.
- Learn more about [`aria-level`](https://www.w3.org/TR/wai-aria-1.2/#aria-level).
- name : Union[Pattern[str], str, None]
- Option to match the [accessible name](https://w3c.github.io/accname/#dfn-accessible-name). By default, matching is
- case-insensitive and searches for a substring, use `exact` to control this behavior.
- Learn more about [accessible name](https://w3c.github.io/accname/#dfn-accessible-name).
- pressed : Union[bool, None]
- An attribute that is usually set by `aria-pressed`.
- Learn more about [`aria-pressed`](https://www.w3.org/TR/wai-aria-1.2/#aria-pressed).
- selected : Union[bool, None]
- An attribute that is usually set by `aria-selected`.
- Learn more about [`aria-selected`](https://www.w3.org/TR/wai-aria-1.2/#aria-selected).
- exact : Union[bool, None]
- Whether `name` and `description` are matched exactly: case-sensitive and whole-string. Defaults to false. Ignored
- when the value is a regular expression. Note that exact match still trims whitespace.
- description : Union[Pattern[str], str, None]
- Option to match the [accessible description](https://w3c.github.io/accname/#dfn-accessible-description). By
- default, matching is case-insensitive and searches for a substring, use `exact` to control this behavior.
- Learn more about [accessible description](https://w3c.github.io/accname/#dfn-accessible-description).
- Returns
- -------
- Locator
- """
- return mapping.from_impl(
- self._impl_obj.get_by_role(
- role=role,
- checked=checked,
- disabled=disabled,
- expanded=expanded,
- includeHidden=include_hidden,
- level=level,
- name=name,
- pressed=pressed,
- selected=selected,
- exact=exact,
- description=description,
- )
- )
- def get_by_test_id(
- self, test_id: typing.Union[str, typing.Pattern[str]]
- ) -> "Locator":
- """FrameLocator.get_by_test_id
- Locate element by the test id.
- **Usage**
- Consider the following DOM structure.
- ```html
- <button data-testid=\"directions\">Itinéraire</button>
- ```
- You can locate the element by its test id:
- ```py
- await page.get_by_test_id(\"directions\").click()
- ```
- **Details**
- By default, the `data-testid` attribute is used as a test id. Use `selectors.set_test_id_attribute()` to
- configure a different test id attribute if necessary.
- Parameters
- ----------
- test_id : Union[Pattern[str], str]
- Id to locate the element by.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_test_id(testId=test_id))
- def get_by_text(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """FrameLocator.get_by_text
- Allows locating elements that contain given text.
- See also `locator.filter()` that allows to match by another criteria, like an accessible role, and then
- filter by the text content.
- **Usage**
- Consider the following DOM structure:
- ```html
- <div>Hello <span>world</span></div>
- <div>Hello</div>
- ```
- You can locate by text substring, exact string, or a regular expression:
- ```py
- # Matches <span>
- page.get_by_text(\"world\")
- # Matches first <div>
- page.get_by_text(\"Hello world\")
- # Matches second <div>
- page.get_by_text(\"Hello\", exact=True)
- # Matches both <div>s
- page.get_by_text(re.compile(\"Hello\"))
- # Matches second <div>
- page.get_by_text(re.compile(\"^hello$\", re.IGNORECASE))
- ```
- **Details**
- Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into
- one, turns line breaks into spaces and ignores leading and trailing whitespace.
- Input elements of the type `button` and `submit` are matched by their `value` instead of the text content. For
- example, locating by text `\"Log in\"` matches `<input type=button value=\"Log in\">`.
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_text(text=text, exact=exact))
- def get_by_title(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """FrameLocator.get_by_title
- Allows locating elements by their title attribute.
- **Usage**
- Consider the following DOM structure.
- ```html
- <span title='Issues count'>25 issues</span>
- ```
- You can check the issues count after locating it by the title text:
- ```py
- await expect(page.get_by_title(\"Issues count\")).to_have_text(\"25 issues\")
- ```
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_title(text=text, exact=exact))
- def frame_locator(self, selector: str) -> "FrameLocator":
- """FrameLocator.frame_locator
- When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements
- in that iframe.
- Parameters
- ----------
- selector : str
- A selector to use when resolving DOM element.
- Returns
- -------
- FrameLocator
- """
- return mapping.from_impl(self._impl_obj.frame_locator(selector=selector))
- def nth(self, index: int) -> "FrameLocator":
- """FrameLocator.nth
- Returns locator to the n-th matching frame. It's zero based, `nth(0)` selects the first frame.
- Parameters
- ----------
- index : int
- Returns
- -------
- FrameLocator
- """
- return mapping.from_impl(self._impl_obj.nth(index=index))
- mapping.register(FrameLocatorImpl, FrameLocator)
- class Worker(AsyncBase):
- @typing.overload
- def on(
- self,
- event: Literal["close"],
- f: typing.Callable[["Worker"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when this dedicated [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) is
- terminated."""
- @typing.overload
- def on(
- self,
- event: Literal["console"],
- f: typing.Callable[
- ["ConsoleMessage"], "typing.Union[typing.Awaitable[None], None]"
- ],
- ) -> None:
- """
- Emitted when JavaScript within the worker calls one of console API methods, e.g. `console.log` or `console.dir`.
- """
- def on(
- self,
- event: str,
- f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]],
- ) -> None:
- return super().on(event=event, f=f)
- @typing.overload
- def once(
- self,
- event: Literal["close"],
- f: typing.Callable[["Worker"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when this dedicated [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) is
- terminated."""
- @typing.overload
- def once(
- self,
- event: Literal["console"],
- f: typing.Callable[
- ["ConsoleMessage"], "typing.Union[typing.Awaitable[None], None]"
- ],
- ) -> None:
- """
- Emitted when JavaScript within the worker calls one of console API methods, e.g. `console.log` or `console.dir`.
- """
- def once(
- self,
- event: str,
- f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]],
- ) -> None:
- return super().once(event=event, f=f)
- @property
- def url(self) -> str:
- """Worker.url
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.url)
- async def evaluate(
- self, expression: str, arg: typing.Optional[typing.Any] = None
- ) -> typing.Any:
- """Worker.evaluate
- Returns the return value of `expression`.
- If the function passed to the `worker.evaluate()` returns a [Promise], then `worker.evaluate()`
- would wait for the promise to resolve and return its value.
- If the function passed to the `worker.evaluate()` returns a non-[Serializable] value, then
- `worker.evaluate()` returns `undefined`. Playwright also supports transferring some additional values that
- are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`.
- Parameters
- ----------
- expression : str
- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
- function is automatically invoked.
- arg : Union[Any, None]
- Optional argument to pass to `expression`.
- Returns
- -------
- Any
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.evaluate(
- expression=expression, arg=mapping.to_impl(arg)
- )
- )
- async def evaluate_handle(
- self, expression: str, arg: typing.Optional[typing.Any] = None
- ) -> "JSHandle":
- """Worker.evaluate_handle
- Returns the return value of `expression` as a `JSHandle`.
- The only difference between `worker.evaluate()` and `worker.evaluate_handle()` is that
- `worker.evaluate_handle()` returns `JSHandle`.
- If the function passed to the `worker.evaluate_handle()` returns a [Promise], then
- `worker.evaluate_handle()` would wait for the promise to resolve and return its value.
- Parameters
- ----------
- expression : str
- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
- function is automatically invoked.
- arg : Union[Any, None]
- Optional argument to pass to `expression`.
- Returns
- -------
- JSHandle
- """
- return mapping.from_impl(
- await self._impl_obj.evaluate_handle(
- expression=expression, arg=mapping.to_impl(arg)
- )
- )
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["close"],
- predicate: typing.Optional[typing.Callable[["Worker"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Worker"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["console"],
- predicate: typing.Optional[typing.Callable[["ConsoleMessage"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["ConsoleMessage"]: ...
- @typing.overload
- def expect_event(
- self,
- event: str,
- predicate: typing.Optional[typing.Callable[..., bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager[typing.Any]: ...
- def expect_event(
- self,
- event: str,
- predicate: typing.Optional[typing.Callable] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> AsyncEventContextManager:
- """Worker.expect_event
- Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy
- value. Will throw an error if the page is closed before the event is fired. Returns the event data value.
- **Usage**
- ```py
- async with worker.expect_event(\"console\") as event_info:
- await worker.evaluate(\"console.log(42)\")
- message = await event_info.value
- ```
- Parameters
- ----------
- event : str
- Event name, same one typically passed into `*.on(event)`.
- predicate : Union[Callable, None]
- Receives the event data and resolves to truthy value when the waiting should resolve.
- timeout : Union[float, None]
- Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The
- default value can be changed by using the `browser_context.set_default_timeout()`.
- Returns
- -------
- EventContextManager
- """
- return AsyncEventContextManager(
- self._impl_obj.expect_event(
- event=event,
- predicate=self._wrap_handler(predicate),
- timeout=to_milliseconds(timeout),
- ).future
- )
- mapping.register(WorkerImpl, Worker)
- class Selectors(AsyncBase):
- async def register(
- self,
- name: str,
- script: typing.Optional[str] = None,
- *,
- path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- content_script: typing.Optional[bool] = None,
- ) -> None:
- """Selectors.register
- Selectors must be registered before creating the page.
- **Usage**
- An example of registering selector engine that queries elements based on a tag name:
- ```py
- import asyncio
- from playwright.async_api import async_playwright, Playwright
- async def run(playwright: Playwright):
- tag_selector = \"\"\"
- {
- // Returns the first element matching given selector in the root's subtree.
- query(root, selector) {
- return root.querySelector(selector);
- },
- // Returns all elements matching given selector in the root's subtree.
- queryAll(root, selector) {
- return Array.from(root.querySelectorAll(selector));
- }
- }\"\"\"
- # Register the engine. Selectors will be prefixed with \"tag=\".
- await playwright.selectors.register(\"tag\", tag_selector)
- browser = await playwright.chromium.launch()
- page = await browser.new_page()
- await page.set_content('<div><button>Click me</button></div>')
- # Use the selector prefixed with its name.
- button = await page.query_selector('tag=button')
- # Combine it with built-in locators.
- await page.locator('tag=div').get_by_text('Click me').click()
- # Can use it in any methods supporting selectors.
- button_count = await page.locator('tag=button').count()
- print(button_count)
- await browser.close()
- async def main():
- async with async_playwright() as playwright:
- await run(playwright)
- asyncio.run(main())
- ```
- Parameters
- ----------
- name : str
- Name that is used in selectors as a prefix, e.g. `{name: 'foo'}` enables `foo=myselectorbody` selectors. May only
- contain `[a-zA-Z0-9_]` characters.
- script : Union[str, None]
- Raw script content.
- path : Union[pathlib.Path, str, None]
- Path to the JavaScript file. If `path` is a relative path, then it is resolved relative to the current working
- directory.
- content_script : Union[bool, None]
- Whether to run this selector engine in isolated JavaScript environment. This environment has access to the same
- DOM, but not any JavaScript objects from the frame's scripts. Defaults to `false`. Note that running as a content
- script is not guaranteed when this engine is used together with other registered engines.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.register(
- name=name, script=script, path=path, contentScript=content_script
- )
- )
- def set_test_id_attribute(self, attribute_name: str) -> None:
- """Selectors.set_test_id_attribute
- Defines custom attribute name to be used in `page.get_by_test_id()`. `data-testid` is used by default.
- Parameters
- ----------
- attribute_name : str
- Test id attribute name.
- """
- return mapping.from_maybe_impl(
- self._impl_obj.set_test_id_attribute(attributeName=attribute_name)
- )
- mapping.register(SelectorsImpl, Selectors)
- class Clock(AsyncBase):
- async def install(
- self,
- *,
- time: typing.Optional[typing.Union[float, str, datetime.datetime]] = None,
- ) -> None:
- """Clock.install
- Install fake implementations for the following time-related functions:
- - `Date`
- - `setTimeout`
- - `clearTimeout`
- - `setInterval`
- - `clearInterval`
- - `requestAnimationFrame`
- - `cancelAnimationFrame`
- - `requestIdleCallback`
- - `cancelIdleCallback`
- - `performance`
- Fake timers are used to manually control the flow of time in tests. They allow you to advance time, fire timers,
- and control the behavior of time-dependent functions. See `clock.run_for()` and
- `clock.fast_forward()` for more information.
- Parameters
- ----------
- time : Union[datetime.datetime, float, str, None]
- Time to initialize with, current system time by default.
- """
- return mapping.from_maybe_impl(await self._impl_obj.install(time=time))
- async def fast_forward(self, ticks: typing.Union[int, str]) -> None:
- """Clock.fast_forward
- Advance the clock by jumping forward in time. Only fires due timers at most once. This is equivalent to user
- closing the laptop lid for a while and reopening it later, after given time.
- **Usage**
- ```py
- await page.clock.fast_forward(1000)
- await page.clock.fast_forward(\"30:00\")
- ```
- Parameters
- ----------
- ticks : Union[int, str]
- Time may be the number of milliseconds to advance the clock by or a human-readable string. Valid string formats are
- "08" for eight seconds, "01:00" for one minute and "02:34:10" for two hours, 34 minutes and ten seconds.
- """
- return mapping.from_maybe_impl(await self._impl_obj.fast_forward(ticks=ticks))
- async def pause_at(self, time: typing.Union[float, str, datetime.datetime]) -> None:
- """Clock.pause_at
- Advance the clock by jumping forward in time and pause the time. Once this method is called, no timers are fired
- unless `clock.run_for()`, `clock.fast_forward()`, `clock.pause_at()` or
- `clock.resume()` is called.
- Only fires due timers at most once. This is equivalent to user closing the laptop lid for a while and reopening it
- at the specified time and pausing.
- **Usage**
- ```py
- await page.clock.pause_at(datetime.datetime(2020, 2, 2))
- await page.clock.pause_at(\"2020-02-02\")
- ```
- For best results, install the clock before navigating the page and set it to a time slightly before the intended
- test time. This ensures that all timers run normally during page loading, preventing the page from getting stuck.
- Once the page has fully loaded, you can safely use `clock.pause_at()` to pause the clock.
- ```py
- # Initialize clock with some time before the test time and let the page load
- # naturally. `Date.now` will progress as the timers fire.
- await page.clock.install(time=datetime.datetime(2024, 12, 10, 8, 0, 0))
- await page.goto(\"http://localhost:3333\")
- await page.clock.pause_at(datetime.datetime(2024, 12, 10, 10, 0, 0))
- ```
- Parameters
- ----------
- time : Union[datetime.datetime, float, str]
- Time to pause at.
- """
- return mapping.from_maybe_impl(await self._impl_obj.pause_at(time=time))
- async def resume(self) -> None:
- """Clock.resume
- Resumes timers. Once this method is called, time resumes flowing, timers are fired as usual.
- """
- return mapping.from_maybe_impl(await self._impl_obj.resume())
- async def run_for(self, ticks: typing.Union[int, str]) -> None:
- """Clock.run_for
- Advance the clock, firing all the time-related callbacks.
- **Usage**
- ```py
- await page.clock.run_for(1000);
- await page.clock.run_for(\"30:00\")
- ```
- Parameters
- ----------
- ticks : Union[int, str]
- Time may be the number of milliseconds to advance the clock by or a human-readable string. Valid string formats are
- "08" for eight seconds, "01:00" for one minute and "02:34:10" for two hours, 34 minutes and ten seconds.
- """
- return mapping.from_maybe_impl(await self._impl_obj.run_for(ticks=ticks))
- async def set_fixed_time(
- self, time: typing.Union[float, str, datetime.datetime]
- ) -> None:
- """Clock.set_fixed_time
- Makes `Date.now` and `new Date()` return fixed fake time at all times, keeps all the timers running.
- Use this method for simple scenarios where you only need to test with a predefined time. For more advanced
- scenarios, use `clock.install()` instead. Read docs on [clock emulation](https://playwright.dev/python/docs/clock) to learn more.
- **Usage**
- ```py
- await page.clock.set_fixed_time(datetime.datetime.now())
- await page.clock.set_fixed_time(datetime.datetime(2020, 2, 2))
- await page.clock.set_fixed_time(\"2020-02-02\")
- ```
- Parameters
- ----------
- time : Union[datetime.datetime, float, str]
- Time to be set.
- """
- return mapping.from_maybe_impl(await self._impl_obj.set_fixed_time(time=time))
- async def set_system_time(
- self, time: typing.Union[float, str, datetime.datetime]
- ) -> None:
- """Clock.set_system_time
- Sets system time, but does not trigger any timers. Use this to test how the web page reacts to a time shift, for
- example switching from summer to winter time, or changing time zones.
- **Usage**
- ```py
- await page.clock.set_system_time(datetime.datetime.now())
- await page.clock.set_system_time(datetime.datetime(2020, 2, 2))
- await page.clock.set_system_time(\"2020-02-02\")
- ```
- Parameters
- ----------
- time : Union[datetime.datetime, float, str]
- Time to be set.
- """
- return mapping.from_maybe_impl(await self._impl_obj.set_system_time(time=time))
- mapping.register(ClockImpl, Clock)
- class ConsoleMessage(AsyncBase):
- @property
- def type(
- self,
- ) -> typing.Union[
- Literal["assert"],
- Literal["clear"],
- Literal["count"],
- Literal["debug"],
- Literal["dir"],
- Literal["dirxml"],
- Literal["endGroup"],
- Literal["error"],
- Literal["info"],
- Literal["log"],
- Literal["profile"],
- Literal["profileEnd"],
- Literal["startGroup"],
- Literal["startGroupCollapsed"],
- Literal["table"],
- Literal["time"],
- Literal["timeEnd"],
- Literal["trace"],
- Literal["warning"],
- ]:
- """ConsoleMessage.type
- Returns
- -------
- Union["assert", "clear", "count", "debug", "dir", "dirxml", "endGroup", "error", "info", "log", "profile", "profileEnd", "startGroup", "startGroupCollapsed", "table", "time", "timeEnd", "trace", "warning"]
- """
- return mapping.from_maybe_impl(self._impl_obj.type)
- @property
- def text(self) -> str:
- """ConsoleMessage.text
- The text of the console message.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.text)
- @property
- def args(self) -> typing.List["JSHandle"]:
- """ConsoleMessage.args
- List of arguments passed to a `console` function call. See also `page.on('console')`.
- Returns
- -------
- List[JSHandle]
- """
- return mapping.from_impl_list(self._impl_obj.args)
- @property
- def location(self) -> SourceLocation:
- """ConsoleMessage.location
- Returns
- -------
- {url: str, line: int, column: int, lineNumber: int, columnNumber: int}
- """
- return mapping.from_impl(self._impl_obj.location)
- @property
- def timestamp(self) -> float:
- """ConsoleMessage.timestamp
- The timestamp of the console message in milliseconds since the Unix epoch.
- Returns
- -------
- float
- """
- return mapping.from_maybe_impl(self._impl_obj.timestamp)
- @property
- def page(self) -> typing.Optional["Page"]:
- """ConsoleMessage.page
- The page that produced this console message, if any.
- Returns
- -------
- Union[Page, None]
- """
- return mapping.from_impl_nullable(self._impl_obj.page)
- @property
- def worker(self) -> typing.Optional["Worker"]:
- """ConsoleMessage.worker
- The web worker or service worker that produced this console message, if any. Note that console messages from web
- workers also have non-null `console_message.page()`.
- Returns
- -------
- Union[Worker, None]
- """
- return mapping.from_impl_nullable(self._impl_obj.worker)
- mapping.register(ConsoleMessageImpl, ConsoleMessage)
- class Debugger(AsyncBase):
- @typing.overload
- def on(
- self,
- event: Literal["pausedstatechanged"],
- f: typing.Callable[["None"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when the debugger pauses or resumes."""
- @typing.overload
- def on(
- self,
- event: str,
- f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]],
- ) -> None: ...
- def on(
- self,
- event: str,
- f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]],
- ) -> None:
- return super().on(event=event, f=f)
- @typing.overload
- def once(
- self,
- event: Literal["pausedstatechanged"],
- f: typing.Callable[["None"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when the debugger pauses or resumes."""
- @typing.overload
- def once(
- self,
- event: str,
- f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]],
- ) -> None: ...
- def once(
- self,
- event: str,
- f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]],
- ) -> None:
- return super().once(event=event, f=f)
- @property
- def paused_details(self) -> typing.Optional[DebuggerPausedDetails]:
- """Debugger.paused_details
- Returns details about the currently paused call. Returns `null` if the debugger is not paused.
- Returns
- -------
- Union[{location: {file: str, line: Union[int, None], column: Union[int, None]}, title: str}, None]
- """
- return mapping.from_impl_nullable(self._impl_obj.paused_details)
- async def request_pause(self) -> None:
- """Debugger.request_pause
- Configures the debugger to pause before the next action is executed.
- Throws if the debugger is already paused. Use `debugger.next()` or `debugger.run_to()` to step while
- paused.
- Note that `page.pause()` is equivalent to a \"debugger\" statement — it pauses execution at the call site
- immediately. On the contrary, `debugger.request_pause()` is equivalent to \"pause on next statement\" — it
- configures the debugger to pause before the next action is executed.
- """
- return mapping.from_maybe_impl(await self._impl_obj.request_pause())
- async def resume(self) -> None:
- """Debugger.resume
- Resumes script execution. Throws if the debugger is not paused.
- """
- return mapping.from_maybe_impl(await self._impl_obj.resume())
- async def next(self) -> None:
- """Debugger.next
- Resumes script execution and pauses again before the next action. Throws if the debugger is not paused.
- """
- return mapping.from_maybe_impl(await self._impl_obj.next())
- async def run_to(self, location: DebuggerLocation) -> None:
- """Debugger.run_to
- Resumes script execution and pauses when an action originates from the given source location. Throws if the
- debugger is not paused.
- Parameters
- ----------
- location : {file: str, line: Union[int, None], column: Union[int, None]}
- The source location to pause at.
- """
- return mapping.from_maybe_impl(await self._impl_obj.run_to(location=location))
- mapping.register(DebuggerImpl, Debugger)
- class Dialog(AsyncBase):
- @property
- def type(self) -> str:
- """Dialog.type
- Returns dialog's type, can be one of `alert`, `beforeunload`, `confirm` or `prompt`.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.type)
- @property
- def message(self) -> str:
- """Dialog.message
- A message displayed in the dialog.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.message)
- @property
- def default_value(self) -> str:
- """Dialog.default_value
- If dialog is prompt, returns default prompt value. Otherwise, returns empty string.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.default_value)
- @property
- def page(self) -> typing.Optional["Page"]:
- """Dialog.page
- The page that initiated this dialog, if available.
- Returns
- -------
- Union[Page, None]
- """
- return mapping.from_impl_nullable(self._impl_obj.page)
- async def accept(self, prompt_text: typing.Optional[str] = None) -> None:
- """Dialog.accept
- Returns when the dialog has been accepted.
- Parameters
- ----------
- prompt_text : Union[str, None]
- A text to enter in prompt. Does not cause any effects if the dialog's `type` is not prompt. Optional.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.accept(promptText=prompt_text)
- )
- async def dismiss(self) -> None:
- """Dialog.dismiss
- Returns when the dialog has been dismissed.
- """
- return mapping.from_maybe_impl(await self._impl_obj.dismiss())
- mapping.register(DialogImpl, Dialog)
- class Download(AsyncBase):
- @property
- def page(self) -> "Page":
- """Download.page
- Get the page that the download belongs to.
- Returns
- -------
- Page
- """
- return mapping.from_impl(self._impl_obj.page)
- @property
- def url(self) -> str:
- """Download.url
- Returns downloaded url.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.url)
- @property
- def suggested_filename(self) -> str:
- """Download.suggested_filename
- Returns suggested filename for this download. It is typically computed by the browser from the
- [`Content-Disposition`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition) response
- header or the `download` attribute. See the spec on [whatwg](https://html.spec.whatwg.org/#downloading-resources).
- Different browsers can use different logic for computing it.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.suggested_filename)
- async def delete(self) -> None:
- """Download.delete
- Deletes the downloaded file. Will wait for the download to finish if necessary.
- """
- return mapping.from_maybe_impl(await self._impl_obj.delete())
- async def failure(self) -> typing.Optional[str]:
- """Download.failure
- Returns download error if any. Will wait for the download to finish if necessary.
- Returns
- -------
- Union[str, None]
- """
- return mapping.from_maybe_impl(await self._impl_obj.failure())
- async def path(self) -> pathlib.Path:
- """Download.path
- Returns path to the downloaded file for a successful download, or throws for a failed/canceled download. The method
- will wait for the download to finish if necessary. The method throws when connected remotely.
- Note that the download's file name is a random GUID, use `download.suggested_filename()` to get suggested
- file name.
- Returns
- -------
- pathlib.Path
- """
- return mapping.from_maybe_impl(await self._impl_obj.path())
- async def save_as(self, path: typing.Union[str, pathlib.Path]) -> None:
- """Download.save_as
- Copy the download to a user-specified path. It is safe to call this method while the download is still in progress.
- Will wait for the download to finish if necessary.
- **Usage**
- ```py
- await download.save_as(\"/path/to/save/at/\" + download.suggested_filename)
- ```
- Parameters
- ----------
- path : Union[pathlib.Path, str]
- Path where the download should be copied.
- """
- return mapping.from_maybe_impl(await self._impl_obj.save_as(path=path))
- async def cancel(self) -> None:
- """Download.cancel
- Cancels a download. Will not fail if the download is already finished or canceled. Upon successful cancellations,
- `download.failure()` would resolve to `'canceled'`.
- """
- return mapping.from_maybe_impl(await self._impl_obj.cancel())
- mapping.register(DownloadImpl, Download)
- class Screencast(AsyncBase):
- async def start(
- self,
- *,
- on_frame: typing.Optional[
- typing.Callable[[ScreencastFrame], typing.Any]
- ] = None,
- path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- quality: typing.Optional[int] = None,
- ) -> "AsyncContextManager":
- """Screencast.start
- Starts the screencast. When `path` is provided, it saves video recording to the specified file. When `onFrame` is
- provided, delivers JPEG-encoded frames to the callback. Both can be used together.
- **Usage**
- Parameters
- ----------
- on_frame : Union[Callable[[{data: bytes, viewportWidth: int, viewportHeight: int}], Any], None]
- Callback that receives JPEG-encoded frame data along with the page viewport size at the time of capture.
- path : Union[pathlib.Path, str, None]
- Path where the video should be saved when the screencast is stopped. When provided, video recording is started.
- quality : Union[int, None]
- The quality of the image, between 0-100.
- Returns
- -------
- AsyncContextManager
- """
- return mapping.from_impl(
- await self._impl_obj.start(
- onFrame=self._wrap_handler(on_frame), path=path, quality=quality
- )
- )
- async def stop(self) -> None:
- """Screencast.stop
- Stops the screencast and video recording if active. If a video was being recorded, saves it to the path specified
- in `screencast.start()`.
- """
- return mapping.from_maybe_impl(await self._impl_obj.stop())
- async def show_actions(
- self,
- *,
- duration: typing.Optional[float] = None,
- position: typing.Optional[
- Literal[
- "bottom", "bottom-left", "bottom-right", "top", "top-left", "top-right"
- ]
- ] = None,
- font_size: typing.Optional[int] = None,
- ) -> "AsyncContextManager":
- """Screencast.show_actions
- Enables visual annotations on interacted elements. Returns a disposable that stops showing actions when disposed.
- Parameters
- ----------
- duration : Union[float, None]
- How long each annotation is displayed in milliseconds. Defaults to `500`.
- position : Union["bottom", "bottom-left", "bottom-right", "top", "top-left", "top-right", None]
- Position of the action title overlay. Defaults to `"top-right"`.
- font_size : Union[int, None]
- Font size of the action title in pixels. Defaults to `24`.
- Returns
- -------
- AsyncContextManager
- """
- return mapping.from_impl(
- await self._impl_obj.show_actions(
- duration=duration, position=position, fontSize=font_size
- )
- )
- async def hide_actions(self) -> None:
- """Screencast.hide_actions
- Removes action decorations.
- """
- return mapping.from_maybe_impl(await self._impl_obj.hide_actions())
- async def show_overlay(
- self, html: str, *, duration: typing.Optional[float] = None
- ) -> "AsyncContextManager":
- """Screencast.show_overlay
- Adds an overlay with the given HTML content. The overlay is displayed on top of the page until removed. Returns a
- disposable that removes the overlay when disposed.
- Parameters
- ----------
- html : str
- HTML content for the overlay.
- duration : Union[float, None]
- Duration in milliseconds after which the overlay is automatically removed. Overlay stays until dismissed if not
- provided.
- Returns
- -------
- AsyncContextManager
- """
- return mapping.from_impl(
- await self._impl_obj.show_overlay(html=html, duration=duration)
- )
- async def show_chapter(
- self,
- title: str,
- *,
- description: typing.Optional[str] = None,
- duration: typing.Optional[float] = None,
- ) -> None:
- """Screencast.show_chapter
- Shows a chapter overlay with a title and optional description, centered on the page with a blurred backdrop. Useful
- for narrating video recordings. The overlay is removed after the specified duration, or 2000ms.
- Parameters
- ----------
- title : str
- Title text displayed prominently in the overlay.
- description : Union[str, None]
- Optional description text displayed below the title.
- duration : Union[float, None]
- Duration in milliseconds after which the overlay is automatically removed. Defaults to `2000`.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.show_chapter(
- title=title, description=description, duration=duration
- )
- )
- async def show_overlays(self) -> None:
- """Screencast.show_overlays
- Shows overlays.
- """
- return mapping.from_maybe_impl(await self._impl_obj.show_overlays())
- async def hide_overlays(self) -> None:
- """Screencast.hide_overlays
- Hides overlays without removing them.
- """
- return mapping.from_maybe_impl(await self._impl_obj.hide_overlays())
- mapping.register(ScreencastImpl, Screencast)
- class Video(AsyncBase):
- async def path(self) -> pathlib.Path:
- """Video.path
- Returns the file system path this video will be recorded to. The video is guaranteed to be written to the
- filesystem upon closing the browser context. This method throws when connected remotely.
- Returns
- -------
- pathlib.Path
- """
- return mapping.from_maybe_impl(await self._impl_obj.path())
- async def save_as(self, path: typing.Union[str, pathlib.Path]) -> None:
- """Video.save_as
- Saves the video to a user-specified path. It is safe to call this method while the video is still in progress, or
- after the page has closed. This method waits until the page is closed and the video is fully saved.
- Parameters
- ----------
- path : Union[pathlib.Path, str]
- Path where the video should be saved.
- """
- return mapping.from_maybe_impl(await self._impl_obj.save_as(path=path))
- async def delete(self) -> None:
- """Video.delete
- Deletes the video file. Will wait for the video to finish if necessary.
- """
- return mapping.from_maybe_impl(await self._impl_obj.delete())
- mapping.register(VideoImpl, Video)
- class Page(AsyncContextManager):
- @typing.overload
- def on(
- self,
- event: Literal["close"],
- f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when the page closes."""
- @typing.overload
- def on(
- self,
- event: Literal["console"],
- f: typing.Callable[
- ["ConsoleMessage"], "typing.Union[typing.Awaitable[None], None]"
- ],
- ) -> None:
- """
- Emitted when JavaScript within the page calls one of console API methods, e.g. `console.log` or `console.dir`.
- The arguments passed into `console.log` are available on the `ConsoleMessage` event handler argument.
- **Usage**
- ```py
- async def print_args(msg):
- values = []
- for arg in msg.args:
- values.append(await arg.json_value())
- print(values)
- page.on(\"console\", print_args)
- await page.evaluate(\"console.log('hello', 5, { foo: 'bar' })\")
- ```"""
- @typing.overload
- def on(
- self,
- event: Literal["crash"],
- f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when the page crashes. Browser pages might crash if they try to allocate too much memory. When the page
- crashes, ongoing and subsequent operations will throw.
- The most common way to deal with crashes is to catch an exception:
- ```py
- try:
- # crash might happen during a click.
- await page.click(\"button\")
- # or while waiting for an event.
- await page.wait_for_event(\"popup\")
- except Error as e:
- pass
- # when the page crashes, exception message contains \"crash\".
- ```"""
- @typing.overload
- def on(
- self,
- event: Literal["dialog"],
- f: typing.Callable[["Dialog"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a JavaScript dialog appears, such as `alert`, `prompt`, `confirm` or `beforeunload`. Listener **must**
- either `dialog.accept()` or `dialog.dismiss()` the dialog - otherwise the page will
- [freeze](https://developer.mozilla.org/en-US/docs/Web/JavaScript/EventLoop#never_blocking) waiting for the dialog,
- and actions like click will never finish.
- **Usage**
- ```python
- page.on(\"dialog\", lambda dialog: dialog.accept())
- ```
- **NOTE** When no `page.on('dialog')` or `browser_context.on('dialog')` listeners are present, all dialogs are
- automatically dismissed."""
- @typing.overload
- def on(
- self,
- event: Literal["domcontentloaded"],
- f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when the JavaScript
- [`DOMContentLoaded`](https://developer.mozilla.org/en-US/docs/Web/Events/DOMContentLoaded) event is dispatched.
- """
- @typing.overload
- def on(
- self,
- event: Literal["download"],
- f: typing.Callable[["Download"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when attachment download started. User can access basic file operations on downloaded content via the
- passed `Download` instance."""
- @typing.overload
- def on(
- self,
- event: Literal["filechooser"],
- f: typing.Callable[
- ["FileChooser"], "typing.Union[typing.Awaitable[None], None]"
- ],
- ) -> None:
- """
- Emitted when a file chooser is supposed to appear, such as after clicking the `<input type=file>`. Playwright can
- respond to it via setting the input files using `file_chooser.set_files()` that can be uploaded after that.
- ```py
- page.on(\"filechooser\", lambda file_chooser: file_chooser.set_files(\"/tmp/myfile.pdf\"))
- ```"""
- @typing.overload
- def on(
- self,
- event: Literal["frameattached"],
- f: typing.Callable[["Frame"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a frame is attached."""
- @typing.overload
- def on(
- self,
- event: Literal["framedetached"],
- f: typing.Callable[["Frame"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a frame is detached."""
- @typing.overload
- def on(
- self,
- event: Literal["framenavigated"],
- f: typing.Callable[["Frame"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a frame is navigated to a new url."""
- @typing.overload
- def on(
- self,
- event: Literal["load"],
- f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when the JavaScript [`load`](https://developer.mozilla.org/en-US/docs/Web/Events/load) event is dispatched.
- """
- @typing.overload
- def on(
- self,
- event: Literal["pageerror"],
- f: typing.Callable[["Error"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when an uncaught exception happens within the page.
- ```py
- # Log all uncaught errors to the terminal
- page.on(\"pageerror\", lambda exc: print(f\"uncaught exception: {exc}\"))
- # Navigate to a page with an exception.
- await page.goto(\"data:text/html,<script>throw new Error('test')</script>\")
- ```"""
- @typing.overload
- def on(
- self,
- event: Literal["popup"],
- f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when the page opens a new tab or window. This event is emitted in addition to the
- `browser_context.on('page')`, but only for popups relevant to this page.
- The earliest moment that page is available is when it has navigated to the initial url. For example, when opening a
- popup with `window.open('http://example.com')`, this event will fire when the network request to
- \"http://example.com\" is done and its response has started loading in the popup. If you would like to route/listen
- to this network request, use `browser_context.route()` and `browser_context.on('request')` respectively
- instead of similar methods on the `Page`.
- ```py
- async with page.expect_event(\"popup\") as page_info:
- await page.get_by_text(\"open the popup\").click()
- popup = await page_info.value
- print(await popup.evaluate(\"location.href\"))
- ```
- **NOTE** Use `page.wait_for_load_state()` to wait until the page gets to a particular state (you should not
- need it in most cases)."""
- @typing.overload
- def on(
- self,
- event: Literal["request"],
- f: typing.Callable[["Request"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a page issues a request. The [request] object is read-only. In order to intercept and mutate requests,
- see `page.route()` or `browser_context.route()`."""
- @typing.overload
- def on(
- self,
- event: Literal["requestfailed"],
- f: typing.Callable[["Request"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a request fails, for example by timing out.
- ```python
- page.on(\"requestfailed\", lambda request: print(request.url + \" \" + request.failure.error_text))
- ```
- **NOTE** HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request
- will complete with `page.on('request_finished')` event and not with `page.on('request_failed')`. A request will
- only be considered failed when the client cannot get an HTTP response from the server, e.g. due to network error
- net::ERR_FAILED."""
- @typing.overload
- def on(
- self,
- event: Literal["requestfinished"],
- f: typing.Callable[["Request"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a request finishes successfully after downloading the response body. For a successful response, the
- sequence of events is `request`, `response` and `requestfinished`."""
- @typing.overload
- def on(
- self,
- event: Literal["response"],
- f: typing.Callable[["Response"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when [response] status and headers are received for a request. For a successful response, the sequence of
- events is `request`, `response` and `requestfinished`."""
- @typing.overload
- def on(
- self,
- event: Literal["websocket"],
- f: typing.Callable[["WebSocket"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when `WebSocket` request is sent."""
- @typing.overload
- def on(
- self,
- event: Literal["worker"],
- f: typing.Callable[["Worker"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a dedicated [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) is spawned
- by the page."""
- def on(
- self,
- event: str,
- f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]],
- ) -> None:
- return super().on(event=event, f=f)
- @typing.overload
- def once(
- self,
- event: Literal["close"],
- f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when the page closes."""
- @typing.overload
- def once(
- self,
- event: Literal["console"],
- f: typing.Callable[
- ["ConsoleMessage"], "typing.Union[typing.Awaitable[None], None]"
- ],
- ) -> None:
- """
- Emitted when JavaScript within the page calls one of console API methods, e.g. `console.log` or `console.dir`.
- The arguments passed into `console.log` are available on the `ConsoleMessage` event handler argument.
- **Usage**
- ```py
- async def print_args(msg):
- values = []
- for arg in msg.args:
- values.append(await arg.json_value())
- print(values)
- page.on(\"console\", print_args)
- await page.evaluate(\"console.log('hello', 5, { foo: 'bar' })\")
- ```"""
- @typing.overload
- def once(
- self,
- event: Literal["crash"],
- f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when the page crashes. Browser pages might crash if they try to allocate too much memory. When the page
- crashes, ongoing and subsequent operations will throw.
- The most common way to deal with crashes is to catch an exception:
- ```py
- try:
- # crash might happen during a click.
- await page.click(\"button\")
- # or while waiting for an event.
- await page.wait_for_event(\"popup\")
- except Error as e:
- pass
- # when the page crashes, exception message contains \"crash\".
- ```"""
- @typing.overload
- def once(
- self,
- event: Literal["dialog"],
- f: typing.Callable[["Dialog"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a JavaScript dialog appears, such as `alert`, `prompt`, `confirm` or `beforeunload`. Listener **must**
- either `dialog.accept()` or `dialog.dismiss()` the dialog - otherwise the page will
- [freeze](https://developer.mozilla.org/en-US/docs/Web/JavaScript/EventLoop#never_blocking) waiting for the dialog,
- and actions like click will never finish.
- **Usage**
- ```python
- page.on(\"dialog\", lambda dialog: dialog.accept())
- ```
- **NOTE** When no `page.on('dialog')` or `browser_context.on('dialog')` listeners are present, all dialogs are
- automatically dismissed."""
- @typing.overload
- def once(
- self,
- event: Literal["domcontentloaded"],
- f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when the JavaScript
- [`DOMContentLoaded`](https://developer.mozilla.org/en-US/docs/Web/Events/DOMContentLoaded) event is dispatched.
- """
- @typing.overload
- def once(
- self,
- event: Literal["download"],
- f: typing.Callable[["Download"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when attachment download started. User can access basic file operations on downloaded content via the
- passed `Download` instance."""
- @typing.overload
- def once(
- self,
- event: Literal["filechooser"],
- f: typing.Callable[
- ["FileChooser"], "typing.Union[typing.Awaitable[None], None]"
- ],
- ) -> None:
- """
- Emitted when a file chooser is supposed to appear, such as after clicking the `<input type=file>`. Playwright can
- respond to it via setting the input files using `file_chooser.set_files()` that can be uploaded after that.
- ```py
- page.on(\"filechooser\", lambda file_chooser: file_chooser.set_files(\"/tmp/myfile.pdf\"))
- ```"""
- @typing.overload
- def once(
- self,
- event: Literal["frameattached"],
- f: typing.Callable[["Frame"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a frame is attached."""
- @typing.overload
- def once(
- self,
- event: Literal["framedetached"],
- f: typing.Callable[["Frame"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a frame is detached."""
- @typing.overload
- def once(
- self,
- event: Literal["framenavigated"],
- f: typing.Callable[["Frame"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a frame is navigated to a new url."""
- @typing.overload
- def once(
- self,
- event: Literal["load"],
- f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when the JavaScript [`load`](https://developer.mozilla.org/en-US/docs/Web/Events/load) event is dispatched.
- """
- @typing.overload
- def once(
- self,
- event: Literal["pageerror"],
- f: typing.Callable[["Error"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when an uncaught exception happens within the page.
- ```py
- # Log all uncaught errors to the terminal
- page.on(\"pageerror\", lambda exc: print(f\"uncaught exception: {exc}\"))
- # Navigate to a page with an exception.
- await page.goto(\"data:text/html,<script>throw new Error('test')</script>\")
- ```"""
- @typing.overload
- def once(
- self,
- event: Literal["popup"],
- f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when the page opens a new tab or window. This event is emitted in addition to the
- `browser_context.on('page')`, but only for popups relevant to this page.
- The earliest moment that page is available is when it has navigated to the initial url. For example, when opening a
- popup with `window.open('http://example.com')`, this event will fire when the network request to
- \"http://example.com\" is done and its response has started loading in the popup. If you would like to route/listen
- to this network request, use `browser_context.route()` and `browser_context.on('request')` respectively
- instead of similar methods on the `Page`.
- ```py
- async with page.expect_event(\"popup\") as page_info:
- await page.get_by_text(\"open the popup\").click()
- popup = await page_info.value
- print(await popup.evaluate(\"location.href\"))
- ```
- **NOTE** Use `page.wait_for_load_state()` to wait until the page gets to a particular state (you should not
- need it in most cases)."""
- @typing.overload
- def once(
- self,
- event: Literal["request"],
- f: typing.Callable[["Request"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a page issues a request. The [request] object is read-only. In order to intercept and mutate requests,
- see `page.route()` or `browser_context.route()`."""
- @typing.overload
- def once(
- self,
- event: Literal["requestfailed"],
- f: typing.Callable[["Request"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a request fails, for example by timing out.
- ```python
- page.on(\"requestfailed\", lambda request: print(request.url + \" \" + request.failure.error_text))
- ```
- **NOTE** HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request
- will complete with `page.on('request_finished')` event and not with `page.on('request_failed')`. A request will
- only be considered failed when the client cannot get an HTTP response from the server, e.g. due to network error
- net::ERR_FAILED."""
- @typing.overload
- def once(
- self,
- event: Literal["requestfinished"],
- f: typing.Callable[["Request"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a request finishes successfully after downloading the response body. For a successful response, the
- sequence of events is `request`, `response` and `requestfinished`."""
- @typing.overload
- def once(
- self,
- event: Literal["response"],
- f: typing.Callable[["Response"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when [response] status and headers are received for a request. For a successful response, the sequence of
- events is `request`, `response` and `requestfinished`."""
- @typing.overload
- def once(
- self,
- event: Literal["websocket"],
- f: typing.Callable[["WebSocket"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when `WebSocket` request is sent."""
- @typing.overload
- def once(
- self,
- event: Literal["worker"],
- f: typing.Callable[["Worker"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a dedicated [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) is spawned
- by the page."""
- def once(
- self,
- event: str,
- f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]],
- ) -> None:
- return super().once(event=event, f=f)
- @property
- def keyboard(self) -> "Keyboard":
- """Page.keyboard
- Returns
- -------
- Keyboard
- """
- return mapping.from_impl(self._impl_obj.keyboard)
- @property
- def mouse(self) -> "Mouse":
- """Page.mouse
- Returns
- -------
- Mouse
- """
- return mapping.from_impl(self._impl_obj.mouse)
- @property
- def touchscreen(self) -> "Touchscreen":
- """Page.touchscreen
- Returns
- -------
- Touchscreen
- """
- return mapping.from_impl(self._impl_obj.touchscreen)
- @property
- def context(self) -> "BrowserContext":
- """Page.context
- Get the browser context that the page belongs to.
- Returns
- -------
- BrowserContext
- """
- return mapping.from_impl(self._impl_obj.context)
- @property
- def clock(self) -> "Clock":
- """Page.clock
- Playwright has ability to mock clock and passage of time.
- Returns
- -------
- Clock
- """
- return mapping.from_impl(self._impl_obj.clock)
- @property
- def main_frame(self) -> "Frame":
- """Page.main_frame
- The page's main frame. Page is guaranteed to have a main frame which persists during navigations.
- Returns
- -------
- Frame
- """
- return mapping.from_impl(self._impl_obj.main_frame)
- @property
- def frames(self) -> typing.List["Frame"]:
- """Page.frames
- An array of all frames attached to the page.
- Returns
- -------
- List[Frame]
- """
- return mapping.from_impl_list(self._impl_obj.frames)
- @property
- def url(self) -> str:
- """Page.url
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.url)
- @property
- def viewport_size(self) -> typing.Optional[ViewportSize]:
- """Page.viewport_size
- Returns
- -------
- Union[{width: int, height: int}, None]
- """
- return mapping.from_impl_nullable(self._impl_obj.viewport_size)
- @property
- def workers(self) -> typing.List["Worker"]:
- """Page.workers
- This method returns all of the dedicated
- [WebWorkers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) associated with the page.
- **NOTE** This does not contain ServiceWorkers
- Returns
- -------
- List[Worker]
- """
- return mapping.from_impl_list(self._impl_obj.workers)
- @property
- def request(self) -> "APIRequestContext":
- """Page.request
- API testing helper associated with this page. This method returns the same instance as
- `browser_context.request` on the page's context. See `browser_context.request` for more
- details.
- Returns
- -------
- APIRequestContext
- """
- return mapping.from_impl(self._impl_obj.request)
- @property
- def video(self) -> typing.Optional["Video"]:
- """Page.video
- Video object associated with this page. Can be used to access the video file when using the `recordVideo` context
- option.
- Returns
- -------
- Union[Video, None]
- """
- return mapping.from_impl_nullable(self._impl_obj.video)
- @property
- def screencast(self) -> "Screencast":
- """Page.screencast
- `Screencast` object associated with this page.
- **Usage**
- Returns
- -------
- Screencast
- """
- return mapping.from_impl(self._impl_obj.screencast)
- async def opener(self) -> typing.Optional["Page"]:
- """Page.opener
- Returns the opener for popup pages and `null` for others. If the opener has been closed already the returns `null`.
- Returns
- -------
- Union[Page, None]
- """
- return mapping.from_impl_nullable(await self._impl_obj.opener())
- def frame(
- self,
- name: typing.Optional[str] = None,
- *,
- url: typing.Optional[
- typing.Union[str, typing.Pattern[str], typing.Callable[[str], bool]]
- ] = None,
- ) -> typing.Optional["Frame"]:
- """Page.frame
- Returns frame matching the specified criteria. Either `name` or `url` must be specified.
- **Usage**
- ```py
- frame = page.frame(name=\"frame-name\")
- ```
- Parameters
- ----------
- name : Union[str, None]
- Frame name specified in the `iframe`'s `name` attribute. Optional.
- url : Union[Callable[[str], bool], Pattern[str], str, None]
- A glob pattern, regex pattern or predicate receiving frame's `url` as a [URL] object. Optional.
- Returns
- -------
- Union[Frame, None]
- """
- return mapping.from_impl_nullable(
- self._impl_obj.frame(name=name, url=self._wrap_handler(url))
- )
- def set_default_navigation_timeout(
- self, timeout: typing.Union[float, datetime.timedelta]
- ) -> None:
- """Page.set_default_navigation_timeout
- This setting will change the default maximum navigation time for the following methods and related shortcuts:
- - `page.go_back()`
- - `page.go_forward()`
- - `page.goto()`
- - `page.reload()`
- - `page.set_content()`
- - `page.expect_navigation()`
- - `page.wait_for_url()`
- **NOTE** `page.set_default_navigation_timeout()` takes priority over `page.set_default_timeout()`,
- `browser_context.set_default_timeout()` and `browser_context.set_default_navigation_timeout()`.
- Parameters
- ----------
- timeout : float
- Maximum navigation time in milliseconds
- """
- return mapping.from_maybe_impl(
- self._impl_obj.set_default_navigation_timeout(
- timeout=to_milliseconds(timeout)
- )
- )
- def set_default_timeout(
- self, timeout: typing.Union[float, datetime.timedelta]
- ) -> None:
- """Page.set_default_timeout
- This setting will change the default maximum time for all the methods accepting `timeout` option.
- **NOTE** `page.set_default_navigation_timeout()` takes priority over `page.set_default_timeout()`.
- Parameters
- ----------
- timeout : float
- Maximum time in milliseconds. Pass `0` to disable timeout.
- """
- return mapping.from_maybe_impl(
- self._impl_obj.set_default_timeout(timeout=to_milliseconds(timeout))
- )
- async def query_selector(
- self, selector: str, *, strict: typing.Optional[bool] = None
- ) -> typing.Optional["ElementHandle"]:
- """Page.query_selector
- The method finds an element matching the specified selector within the page. If no elements match the selector, the
- return value resolves to `null`. To wait for an element on the page, use `locator.wait_for()`.
- Parameters
- ----------
- selector : str
- A selector to query for.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- Returns
- -------
- Union[ElementHandle, None]
- """
- return mapping.from_impl_nullable(
- await self._impl_obj.query_selector(selector=selector, strict=strict)
- )
- async def query_selector_all(self, selector: str) -> typing.List["ElementHandle"]:
- """Page.query_selector_all
- The method finds all elements matching the specified selector within the page. If no elements match the selector,
- the return value resolves to `[]`.
- Parameters
- ----------
- selector : str
- A selector to query for.
- Returns
- -------
- List[ElementHandle]
- """
- return mapping.from_impl_list(
- await self._impl_obj.query_selector_all(selector=selector)
- )
- async def wait_for_selector(
- self,
- selector: str,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- state: typing.Optional[
- Literal["attached", "detached", "hidden", "visible"]
- ] = None,
- strict: typing.Optional[bool] = None,
- ) -> typing.Optional["ElementHandle"]:
- """Page.wait_for_selector
- Returns when element specified by selector satisfies `state` option. Returns `null` if waiting for `hidden` or
- `detached`.
- **NOTE** Playwright automatically waits for element to be ready before performing an action. Using `Locator`
- objects and web-first assertions makes the code wait-for-selector-free.
- Wait for the `selector` to satisfy `state` option (either appear/disappear from dom, or become visible/hidden). If
- at the moment of calling the method `selector` already satisfies the condition, the method will return immediately.
- If the selector doesn't satisfy the condition for the `timeout` milliseconds, the function will throw.
- **Usage**
- This method works across navigations:
- ```py
- import asyncio
- from playwright.async_api import async_playwright, Playwright
- async def run(playwright: Playwright):
- chromium = playwright.chromium
- browser = await chromium.launch()
- page = await browser.new_page()
- for current_url in [\"https://google.com\", \"https://bbc.com\"]:
- await page.goto(current_url, wait_until=\"domcontentloaded\")
- element = await page.wait_for_selector(\"img\")
- print(\"Loaded image: \" + str(await element.get_attribute(\"src\")))
- await browser.close()
- async def main():
- async with async_playwright() as playwright:
- await run(playwright)
- asyncio.run(main())
- ```
- Parameters
- ----------
- selector : str
- A selector to query for.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- state : Union["attached", "detached", "hidden", "visible", None]
- Defaults to `'visible'`. Can be either:
- - `'attached'` - wait for element to be present in DOM.
- - `'detached'` - wait for element to not be present in DOM.
- - `'visible'` - wait for element to have non-empty bounding box and no `visibility:hidden`. Note that element
- without any content or with `display:none` has an empty bounding box and is not considered visible.
- - `'hidden'` - wait for element to be either detached from DOM, or have an empty bounding box or
- `visibility:hidden`. This is opposite to the `'visible'` option.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- Returns
- -------
- Union[ElementHandle, None]
- """
- return mapping.from_impl_nullable(
- await self._impl_obj.wait_for_selector(
- selector=selector,
- timeout=to_milliseconds(timeout),
- state=state,
- strict=strict,
- )
- )
- async def is_checked(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> bool:
- """Page.is_checked
- Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.is_checked(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def is_disabled(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> bool:
- """Page.is_disabled
- Returns whether the element is disabled, the opposite of [enabled](https://playwright.dev/python/docs/actionability#enabled).
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.is_disabled(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def is_editable(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> bool:
- """Page.is_editable
- Returns whether the element is [editable](https://playwright.dev/python/docs/actionability#editable).
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.is_editable(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def is_enabled(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> bool:
- """Page.is_enabled
- Returns whether the element is [enabled](https://playwright.dev/python/docs/actionability#enabled).
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.is_enabled(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def is_hidden(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> bool:
- """Page.is_hidden
- Returns whether the element is hidden, the opposite of [visible](https://playwright.dev/python/docs/actionability#visible). `selector` that
- does not match any elements is considered hidden.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Deprecated: This option is ignored. `page.is_hidden()` does not wait for the↵element to become hidden and returns immediately.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.is_hidden(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def is_visible(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> bool:
- """Page.is_visible
- Returns whether the element is [visible](https://playwright.dev/python/docs/actionability#visible). `selector` that does not match any elements
- is considered not visible.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Deprecated: This option is ignored. `page.is_visible()` does not wait↵for the element to become visible and returns immediately.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.is_visible(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def dispatch_event(
- self,
- selector: str,
- type: str,
- event_init: typing.Optional[typing.Dict] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- strict: typing.Optional[bool] = None,
- ) -> None:
- """Page.dispatch_event
- The snippet below dispatches the `click` event on the element. Regardless of the visibility state of the element,
- `click` is dispatched. This is equivalent to calling
- [element.click()](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/click).
- **Usage**
- ```py
- await page.dispatch_event(\"button#submit\", \"click\")
- ```
- Under the hood, it creates an instance of an event based on the given `type`, initializes it with `eventInit`
- properties and dispatches it on the element. Events are `composed`, `cancelable` and bubble by default.
- Since `eventInit` is event-specific, please refer to the events documentation for the lists of initial properties:
- - [DeviceMotionEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent/DeviceMotionEvent)
- - [DeviceOrientationEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceOrientationEvent/DeviceOrientationEvent)
- - [DragEvent](https://developer.mozilla.org/en-US/docs/Web/API/DragEvent/DragEvent)
- - [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event/Event)
- - [FocusEvent](https://developer.mozilla.org/en-US/docs/Web/API/FocusEvent/FocusEvent)
- - [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/KeyboardEvent)
- - [MouseEvent](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/MouseEvent)
- - [PointerEvent](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/PointerEvent)
- - [TouchEvent](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent/TouchEvent)
- - [WheelEvent](https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/WheelEvent)
- You can also specify `JSHandle` as the property value if you want live objects to be passed into the event:
- ```py
- # note you can only create data_transfer in chromium and firefox
- data_transfer = await page.evaluate_handle(\"new DataTransfer()\")
- await page.dispatch_event(\"#source\", \"dragstart\", { \"dataTransfer\": data_transfer })
- ```
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- type : str
- DOM event type: `"click"`, `"dragstart"`, etc.
- event_init : Union[Dict, None]
- Optional event-specific initialization properties.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.dispatch_event(
- selector=selector,
- type=type,
- eventInit=mapping.to_impl(event_init),
- timeout=to_milliseconds(timeout),
- strict=strict,
- )
- )
- async def evaluate(
- self, expression: str, arg: typing.Optional[typing.Any] = None
- ) -> typing.Any:
- """Page.evaluate
- Returns the value of the `expression` invocation.
- If the function passed to the `page.evaluate()` returns a [Promise], then `page.evaluate()` would
- wait for the promise to resolve and return its value.
- If the function passed to the `page.evaluate()` returns a non-[Serializable] value, then
- `page.evaluate()` resolves to `undefined`. Playwright also supports transferring some additional values
- that are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`.
- **Usage**
- Passing argument to `expression`:
- ```py
- result = await page.evaluate(\"([x, y]) => Promise.resolve(x * y)\", [7, 8])
- print(result) # prints \"56\"
- ```
- A string can also be passed in instead of a function:
- ```py
- print(await page.evaluate(\"1 + 2\")) # prints \"3\"
- x = 10
- print(await page.evaluate(f\"1 + {x}\")) # prints \"11\"
- ```
- `ElementHandle` instances can be passed as an argument to the `page.evaluate()`:
- ```py
- body_handle = await page.evaluate(\"document.body\")
- html = await page.evaluate(\"([body, suffix]) => body.innerHTML + suffix\", [body_handle, \"hello\"])
- await body_handle.dispose()
- ```
- Parameters
- ----------
- expression : str
- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
- function is automatically invoked.
- arg : Union[Any, None]
- Optional argument to pass to `expression`.
- Returns
- -------
- Any
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.evaluate(
- expression=expression, arg=mapping.to_impl(arg)
- )
- )
- async def evaluate_handle(
- self, expression: str, arg: typing.Optional[typing.Any] = None
- ) -> "JSHandle":
- """Page.evaluate_handle
- Returns the value of the `expression` invocation as a `JSHandle`.
- The only difference between `page.evaluate()` and `page.evaluate_handle()` is that
- `page.evaluate_handle()` returns `JSHandle`.
- If the function passed to the `page.evaluate_handle()` returns a [Promise], then
- `page.evaluate_handle()` would wait for the promise to resolve and return its value.
- **Usage**
- ```py
- a_window_handle = await page.evaluate_handle(\"Promise.resolve(window)\")
- a_window_handle # handle for the window object.
- ```
- A string can also be passed in instead of a function:
- ```py
- a_handle = await page.evaluate_handle(\"document\") # handle for the \"document\"
- ```
- `JSHandle` instances can be passed as an argument to the `page.evaluate_handle()`:
- ```py
- a_handle = await page.evaluate_handle(\"document.body\")
- result_handle = await page.evaluate_handle(\"body => body.innerHTML\", a_handle)
- print(await result_handle.json_value())
- await result_handle.dispose()
- ```
- Parameters
- ----------
- expression : str
- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
- function is automatically invoked.
- arg : Union[Any, None]
- Optional argument to pass to `expression`.
- Returns
- -------
- JSHandle
- """
- return mapping.from_impl(
- await self._impl_obj.evaluate_handle(
- expression=expression, arg=mapping.to_impl(arg)
- )
- )
- async def eval_on_selector(
- self,
- selector: str,
- expression: str,
- arg: typing.Optional[typing.Any] = None,
- *,
- strict: typing.Optional[bool] = None,
- ) -> typing.Any:
- """Page.eval_on_selector
- The method finds an element matching the specified selector within the page and passes it as a first argument to
- `expression`. If no elements match the selector, the method throws an error. Returns the value of `expression`.
- If `expression` returns a [Promise], then `page.eval_on_selector()` would wait for the promise to resolve and
- return its value.
- **Usage**
- ```py
- search_value = await page.eval_on_selector(\"#search\", \"el => el.value\")
- preload_href = await page.eval_on_selector(\"link[rel=preload]\", \"el => el.href\")
- html = await page.eval_on_selector(\".main-container\", \"(e, suffix) => e.outer_html + suffix\", \"hello\")
- ```
- Parameters
- ----------
- selector : str
- A selector to query for.
- expression : str
- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
- function is automatically invoked.
- arg : Union[Any, None]
- Optional argument to pass to `expression`.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- Returns
- -------
- Any
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.eval_on_selector(
- selector=selector,
- expression=expression,
- arg=mapping.to_impl(arg),
- strict=strict,
- )
- )
- async def eval_on_selector_all(
- self, selector: str, expression: str, arg: typing.Optional[typing.Any] = None
- ) -> typing.Any:
- """Page.eval_on_selector_all
- The method finds all elements matching the specified selector within the page and passes an array of matched
- elements as a first argument to `expression`. Returns the result of `expression` invocation.
- If `expression` returns a [Promise], then `page.eval_on_selector_all()` would wait for the promise to resolve
- and return its value.
- **Usage**
- ```py
- div_counts = await page.eval_on_selector_all(\"div\", \"(divs, min) => divs.length >= min\", 10)
- ```
- Parameters
- ----------
- selector : str
- A selector to query for.
- expression : str
- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
- function is automatically invoked.
- arg : Union[Any, None]
- Optional argument to pass to `expression`.
- Returns
- -------
- Any
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.eval_on_selector_all(
- selector=selector, expression=expression, arg=mapping.to_impl(arg)
- )
- )
- async def add_script_tag(
- self,
- *,
- url: typing.Optional[str] = None,
- path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- content: typing.Optional[str] = None,
- type: typing.Optional[str] = None,
- ) -> "ElementHandle":
- """Page.add_script_tag
- Adds a `<script>` tag into the page with the desired url or content. Returns the added tag when the script's onload
- fires or when the script content was injected into frame.
- Parameters
- ----------
- url : Union[str, None]
- URL of a script to be added.
- path : Union[pathlib.Path, str, None]
- Path to the JavaScript file to be injected into frame. If `path` is a relative path, then it is resolved relative
- to the current working directory.
- content : Union[str, None]
- Raw JavaScript content to be injected into frame.
- type : Union[str, None]
- Script type. Use 'module' in order to load a JavaScript ES6 module. See
- [script](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script) for more details.
- Returns
- -------
- ElementHandle
- """
- return mapping.from_impl(
- await self._impl_obj.add_script_tag(
- url=url, path=path, content=content, type=type
- )
- )
- async def add_style_tag(
- self,
- *,
- url: typing.Optional[str] = None,
- path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- content: typing.Optional[str] = None,
- ) -> "ElementHandle":
- """Page.add_style_tag
- Adds a `<link rel=\"stylesheet\">` tag into the page with the desired url or a `<style type=\"text/css\">` tag with the
- content. Returns the added tag when the stylesheet's onload fires or when the CSS content was injected into frame.
- Parameters
- ----------
- url : Union[str, None]
- URL of the `<link>` tag.
- path : Union[pathlib.Path, str, None]
- Path to the CSS file to be injected into frame. If `path` is a relative path, then it is resolved relative to the
- current working directory.
- content : Union[str, None]
- Raw CSS content to be injected into frame.
- Returns
- -------
- ElementHandle
- """
- return mapping.from_impl(
- await self._impl_obj.add_style_tag(url=url, path=path, content=content)
- )
- async def expose_function(
- self, name: str, callback: typing.Callable
- ) -> "AsyncContextManager":
- """Page.expose_function
- The method adds a function called `name` on the `window` object of every frame in the page. When called, the
- function executes `callback` and returns a [Promise] which resolves to the return value of `callback`.
- If the `callback` returns a [Promise], it will be awaited.
- See `browser_context.expose_function()` for context-wide exposed function.
- **NOTE** Functions installed via `page.expose_function()` survive navigations.
- **Usage**
- An example of adding a `sha256` function to the page:
- ```py
- import asyncio
- import hashlib
- from playwright.async_api import async_playwright, Playwright
- def sha256(text):
- m = hashlib.sha256()
- m.update(bytes(text, \"utf8\"))
- return m.hexdigest()
- async def run(playwright: Playwright):
- webkit = playwright.webkit
- browser = await webkit.launch(headless=False)
- page = await browser.new_page()
- await page.expose_function(\"sha256\", sha256)
- await page.set_content(\"\"\"
- <script>
- async function onClick() {
- document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');
- }
- </script>
- <button onclick=\"onClick()\">Click me</button>
- <div></div>
- \"\"\")
- await page.click(\"button\")
- async def main():
- async with async_playwright() as playwright:
- await run(playwright)
- asyncio.run(main())
- ```
- Parameters
- ----------
- name : str
- Name of the function on the window object
- callback : Callable
- Callback function which will be called in Playwright's context.
- Returns
- -------
- AsyncContextManager
- """
- return mapping.from_impl(
- await self._impl_obj.expose_function(
- name=name, callback=self._wrap_handler(callback)
- )
- )
- async def expose_binding(
- self, name: str, callback: typing.Callable
- ) -> "AsyncContextManager":
- """Page.expose_binding
- The method adds a function called `name` on the `window` object of every frame in this page. When called, the
- function executes `callback` and returns a [Promise] which resolves to the return value of `callback`. If the
- `callback` returns a [Promise], it will be awaited.
- The first argument of the `callback` function contains information about the caller: `{ browserContext:
- BrowserContext, page: Page, frame: Frame }`.
- See `browser_context.expose_binding()` for the context-wide version.
- **NOTE** Functions installed via `page.expose_binding()` survive navigations.
- **Usage**
- An example of exposing page URL to all frames in a page:
- ```py
- import asyncio
- from playwright.async_api import async_playwright, Playwright
- async def run(playwright: Playwright):
- webkit = playwright.webkit
- browser = await webkit.launch(headless=False)
- context = await browser.new_context()
- page = await context.new_page()
- await page.expose_binding(\"pageURL\", lambda source: source[\"page\"].url)
- await page.set_content(\"\"\"
- <script>
- async function onClick() {
- document.querySelector('div').textContent = await window.pageURL();
- }
- </script>
- <button onclick=\"onClick()\">Click me</button>
- <div></div>
- \"\"\")
- await page.click(\"button\")
- async def main():
- async with async_playwright() as playwright:
- await run(playwright)
- asyncio.run(main())
- ```
- Parameters
- ----------
- name : str
- Name of the function on the window object.
- callback : Callable
- Callback function that will be called in the Playwright's context.
- Returns
- -------
- AsyncContextManager
- """
- return mapping.from_impl(
- await self._impl_obj.expose_binding(
- name=name, callback=self._wrap_handler(callback)
- )
- )
- async def set_extra_http_headers(self, headers: typing.Dict[str, str]) -> None:
- """Page.set_extra_http_headers
- The extra HTTP headers will be sent with every request the page initiates.
- **NOTE** `page.set_extra_http_headers()` does not guarantee the order of headers in the outgoing requests.
- Parameters
- ----------
- headers : Dict[str, str]
- An object containing additional HTTP headers to be sent with every request. All header values must be strings.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.set_extra_http_headers(
- headers=mapping.to_impl(headers)
- )
- )
- async def content(self) -> str:
- """Page.content
- Gets the full HTML contents of the page, including the doctype.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(await self._impl_obj.content())
- async def set_content(
- self,
- html: str,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- wait_until: typing.Optional[
- Literal["commit", "domcontentloaded", "load", "networkidle"]
- ] = None,
- ) -> None:
- """Page.set_content
- This method internally calls [document.write()](https://developer.mozilla.org/en-US/docs/Web/API/Document/write),
- inheriting all its specific characteristics and behaviors.
- Parameters
- ----------
- html : str
- HTML markup to assign to the page.
- timeout : Union[float, None]
- Maximum operation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_navigation_timeout()`,
- `browser_context.set_default_timeout()`, `page.set_default_navigation_timeout()` or
- `page.set_default_timeout()` methods.
- wait_until : Union["commit", "domcontentloaded", "load", "networkidle", None]
- When to consider operation succeeded, defaults to `load`. Events can be either:
- - `'domcontentloaded'` - consider operation to be finished when the `DOMContentLoaded` event is fired.
- - `'load'` - consider operation to be finished when the `load` event is fired.
- - `'networkidle'` - **DISCOURAGED** consider operation to be finished when there are no network connections for
- at least `500` ms. Don't use this method for testing, rely on web assertions to assess readiness instead.
- - `'commit'` - consider operation to be finished when network response is received and the document started
- loading.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.set_content(
- html=html, timeout=to_milliseconds(timeout), waitUntil=wait_until
- )
- )
- async def goto(
- self,
- url: str,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- wait_until: typing.Optional[
- Literal["commit", "domcontentloaded", "load", "networkidle"]
- ] = None,
- referer: typing.Optional[str] = None,
- ) -> typing.Optional["Response"]:
- """Page.goto
- Returns the main resource response. In case of multiple redirects, the navigation will resolve with the first
- non-redirect response.
- The method will throw an error if:
- - there's an SSL error (e.g. in case of self-signed certificates).
- - target URL is invalid.
- - the `timeout` is exceeded during navigation.
- - the remote server does not respond or is unreachable.
- - the main resource failed to load.
- The method will not throw an error when any valid HTTP status code is returned by the remote server, including 404
- \"Not Found\" and 500 \"Internal Server Error\". The status code for such responses can be retrieved by calling
- `response.status()`.
- **NOTE** The method either throws an error or returns a main resource response. The only exceptions are navigation
- to `about:blank` or navigation to the same URL with a different hash, which would succeed and return `null`.
- **NOTE** Headless mode doesn't support navigation to a PDF document. See the
- [upstream issue](https://bugs.chromium.org/p/chromium/issues/detail?id=761295).
- Parameters
- ----------
- url : str
- URL to navigate page to. The url should include scheme, e.g. `https://`. When a `baseURL` via the context options
- was provided and the passed URL is a path, it gets merged via the
- [`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor.
- timeout : Union[float, None]
- Maximum operation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_navigation_timeout()`,
- `browser_context.set_default_timeout()`, `page.set_default_navigation_timeout()` or
- `page.set_default_timeout()` methods.
- wait_until : Union["commit", "domcontentloaded", "load", "networkidle", None]
- When to consider operation succeeded, defaults to `load`. Events can be either:
- - `'domcontentloaded'` - consider operation to be finished when the `DOMContentLoaded` event is fired.
- - `'load'` - consider operation to be finished when the `load` event is fired.
- - `'networkidle'` - **DISCOURAGED** consider operation to be finished when there are no network connections for
- at least `500` ms. Don't use this method for testing, rely on web assertions to assess readiness instead.
- - `'commit'` - consider operation to be finished when network response is received and the document started
- loading.
- referer : Union[str, None]
- Referer header value. If provided it will take preference over the referer header value set by
- `page.set_extra_http_headers()`.
- Returns
- -------
- Union[Response, None]
- """
- return mapping.from_impl_nullable(
- await self._impl_obj.goto(
- url=url,
- timeout=to_milliseconds(timeout),
- waitUntil=wait_until,
- referer=referer,
- )
- )
- async def reload(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- wait_until: typing.Optional[
- Literal["commit", "domcontentloaded", "load", "networkidle"]
- ] = None,
- ) -> typing.Optional["Response"]:
- """Page.reload
- This method reloads the current page, in the same way as if the user had triggered a browser refresh. Returns the
- main resource response. In case of multiple redirects, the navigation will resolve with the response of the last
- redirect.
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum operation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_navigation_timeout()`,
- `browser_context.set_default_timeout()`, `page.set_default_navigation_timeout()` or
- `page.set_default_timeout()` methods.
- wait_until : Union["commit", "domcontentloaded", "load", "networkidle", None]
- When to consider operation succeeded, defaults to `load`. Events can be either:
- - `'domcontentloaded'` - consider operation to be finished when the `DOMContentLoaded` event is fired.
- - `'load'` - consider operation to be finished when the `load` event is fired.
- - `'networkidle'` - **DISCOURAGED** consider operation to be finished when there are no network connections for
- at least `500` ms. Don't use this method for testing, rely on web assertions to assess readiness instead.
- - `'commit'` - consider operation to be finished when network response is received and the document started
- loading.
- Returns
- -------
- Union[Response, None]
- """
- return mapping.from_impl_nullable(
- await self._impl_obj.reload(
- timeout=to_milliseconds(timeout), waitUntil=wait_until
- )
- )
- async def wait_for_load_state(
- self,
- state: typing.Optional[
- Literal["domcontentloaded", "load", "networkidle"]
- ] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """Page.wait_for_load_state
- Returns when the required load state has been reached.
- This resolves when the page reaches a required load state, `load` by default. The navigation must have been
- committed when this method is called. If current document has already reached the required state, resolves
- immediately.
- **NOTE** Most of the time, this method is not needed because Playwright
- [auto-waits before every action](https://playwright.dev/python/docs/actionability).
- **Usage**
- ```py
- await page.get_by_role(\"button\").click() # click triggers navigation.
- await page.wait_for_load_state() # the promise resolves after \"load\" event.
- ```
- ```py
- async with page.expect_popup() as page_info:
- await page.get_by_role(\"button\").click() # click triggers a popup.
- popup = await page_info.value
- # Wait for the \"DOMContentLoaded\" event.
- await popup.wait_for_load_state(\"domcontentloaded\")
- print(await popup.title()) # popup is ready to use.
- ```
- Parameters
- ----------
- state : Union["domcontentloaded", "load", "networkidle", None]
- Optional load state to wait for, defaults to `load`. If the state has been already reached while loading current
- document, the method resolves immediately. Can be one of:
- - `'load'` - wait for the `load` event to be fired.
- - `'domcontentloaded'` - wait for the `DOMContentLoaded` event to be fired.
- - `'networkidle'` - **DISCOURAGED** wait until there are no network connections for at least `500` ms. Don't use
- this method for testing, rely on web assertions to assess readiness instead.
- timeout : Union[float, None]
- Maximum operation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_navigation_timeout()`,
- `browser_context.set_default_timeout()`, `page.set_default_navigation_timeout()` or
- `page.set_default_timeout()` methods.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.wait_for_load_state(
- state=state, timeout=to_milliseconds(timeout)
- )
- )
- async def wait_for_url(
- self,
- url: typing.Union[str, typing.Pattern[str], typing.Callable[[str], bool]],
- *,
- wait_until: typing.Optional[
- Literal["commit", "domcontentloaded", "load", "networkidle"]
- ] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """Page.wait_for_url
- Waits for the main frame to navigate to the given URL.
- **Usage**
- ```py
- await page.click(\"a.delayed-navigation\") # clicking the link will indirectly cause a navigation
- await page.wait_for_url(\"**/target.html\")
- ```
- Parameters
- ----------
- url : Union[Callable[[str], bool], Pattern[str], str]
- A glob pattern, regex pattern, or predicate receiving [URL] to match while waiting for the navigation. Note that if
- the parameter is a string without wildcard characters, the method will wait for navigation to URL that is exactly
- equal to the string.
- wait_until : Union["commit", "domcontentloaded", "load", "networkidle", None]
- When to consider operation succeeded, defaults to `load`. Events can be either:
- - `'domcontentloaded'` - consider operation to be finished when the `DOMContentLoaded` event is fired.
- - `'load'` - consider operation to be finished when the `load` event is fired.
- - `'networkidle'` - **DISCOURAGED** consider operation to be finished when there are no network connections for
- at least `500` ms. Don't use this method for testing, rely on web assertions to assess readiness instead.
- - `'commit'` - consider operation to be finished when network response is received and the document started
- loading.
- timeout : Union[float, None]
- Maximum operation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_navigation_timeout()`,
- `browser_context.set_default_timeout()`, `page.set_default_navigation_timeout()` or
- `page.set_default_timeout()` methods.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.wait_for_url(
- url=self._wrap_handler(url),
- waitUntil=wait_until,
- timeout=to_milliseconds(timeout),
- )
- )
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["close"],
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Page": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["console"],
- predicate: typing.Optional[typing.Callable[["ConsoleMessage"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "ConsoleMessage": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["crash"],
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Page": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["dialog"],
- predicate: typing.Optional[typing.Callable[["Dialog"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Dialog": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["domcontentloaded"],
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Page": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["download"],
- predicate: typing.Optional[typing.Callable[["Download"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Download": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["filechooser"],
- predicate: typing.Optional[typing.Callable[["FileChooser"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "FileChooser": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["frameattached"],
- predicate: typing.Optional[typing.Callable[["Frame"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Frame": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["framedetached"],
- predicate: typing.Optional[typing.Callable[["Frame"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Frame": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["framenavigated"],
- predicate: typing.Optional[typing.Callable[["Frame"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Frame": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["load"],
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Page": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["pageerror"],
- predicate: typing.Optional[typing.Callable[["Error"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Error": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["popup"],
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Page": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["request"],
- predicate: typing.Optional[typing.Callable[["Request"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Request": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["requestfailed"],
- predicate: typing.Optional[typing.Callable[["Request"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Request": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["requestfinished"],
- predicate: typing.Optional[typing.Callable[["Request"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Request": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["response"],
- predicate: typing.Optional[typing.Callable[["Response"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Response": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["websocket"],
- predicate: typing.Optional[typing.Callable[["WebSocket"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "WebSocket": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["worker"],
- predicate: typing.Optional[typing.Callable[["Worker"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Worker": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: str,
- predicate: typing.Optional[typing.Callable[..., bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> typing.Any: ...
- async def wait_for_event(
- self,
- event: str,
- predicate: typing.Optional[typing.Callable] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> typing.Any:
- """Page.wait_for_event
- **NOTE** In most cases, you should use `page.expect_event()`.
- Waits for given `event` to fire. If predicate is provided, it passes event's value into the `predicate` function
- and waits for `predicate(event)` to return a truthy value. Will throw an error if the page is closed before the
- `event` is fired.
- Parameters
- ----------
- event : str
- Event name, same one typically passed into `*.on(event)`.
- predicate : Union[Callable, None]
- Receives the event data and resolves to truthy value when the waiting should resolve.
- timeout : Union[float, None]
- Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The
- default value can be changed by using the `browser_context.set_default_timeout()`.
- Returns
- -------
- Any
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.wait_for_event(
- event=event,
- predicate=self._wrap_handler(predicate),
- timeout=to_milliseconds(timeout),
- )
- )
- async def go_back(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- wait_until: typing.Optional[
- Literal["commit", "domcontentloaded", "load", "networkidle"]
- ] = None,
- ) -> typing.Optional["Response"]:
- """Page.go_back
- Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of
- the last redirect. If cannot go back, returns `null`.
- Navigate to the previous page in history.
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum operation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_navigation_timeout()`,
- `browser_context.set_default_timeout()`, `page.set_default_navigation_timeout()` or
- `page.set_default_timeout()` methods.
- wait_until : Union["commit", "domcontentloaded", "load", "networkidle", None]
- When to consider operation succeeded, defaults to `load`. Events can be either:
- - `'domcontentloaded'` - consider operation to be finished when the `DOMContentLoaded` event is fired.
- - `'load'` - consider operation to be finished when the `load` event is fired.
- - `'networkidle'` - **DISCOURAGED** consider operation to be finished when there are no network connections for
- at least `500` ms. Don't use this method for testing, rely on web assertions to assess readiness instead.
- - `'commit'` - consider operation to be finished when network response is received and the document started
- loading.
- Returns
- -------
- Union[Response, None]
- """
- return mapping.from_impl_nullable(
- await self._impl_obj.go_back(
- timeout=to_milliseconds(timeout), waitUntil=wait_until
- )
- )
- async def go_forward(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- wait_until: typing.Optional[
- Literal["commit", "domcontentloaded", "load", "networkidle"]
- ] = None,
- ) -> typing.Optional["Response"]:
- """Page.go_forward
- Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of
- the last redirect. If cannot go forward, returns `null`.
- Navigate to the next page in history.
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum operation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_navigation_timeout()`,
- `browser_context.set_default_timeout()`, `page.set_default_navigation_timeout()` or
- `page.set_default_timeout()` methods.
- wait_until : Union["commit", "domcontentloaded", "load", "networkidle", None]
- When to consider operation succeeded, defaults to `load`. Events can be either:
- - `'domcontentloaded'` - consider operation to be finished when the `DOMContentLoaded` event is fired.
- - `'load'` - consider operation to be finished when the `load` event is fired.
- - `'networkidle'` - **DISCOURAGED** consider operation to be finished when there are no network connections for
- at least `500` ms. Don't use this method for testing, rely on web assertions to assess readiness instead.
- - `'commit'` - consider operation to be finished when network response is received and the document started
- loading.
- Returns
- -------
- Union[Response, None]
- """
- return mapping.from_impl_nullable(
- await self._impl_obj.go_forward(
- timeout=to_milliseconds(timeout), waitUntil=wait_until
- )
- )
- async def request_gc(self) -> None:
- """Page.request_gc
- Request the page to perform garbage collection. Note that there is no guarantee that all unreachable objects will
- be collected.
- This is useful to help detect memory leaks. For example, if your page has a large object `'suspect'` that might be
- leaked, you can check that it does not leak by using a
- [`WeakRef`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakRef).
- ```py
- # 1. In your page, save a WeakRef for the \"suspect\".
- await page.evaluate(\"globalThis.suspectWeakRef = new WeakRef(suspect)\")
- # 2. Request garbage collection.
- await page.request_gc()
- # 3. Check that weak ref does not deref to the original object.
- assert await page.evaluate(\"!globalThis.suspectWeakRef.deref()\")
- ```
- """
- return mapping.from_maybe_impl(await self._impl_obj.request_gc())
- async def emulate_media(
- self,
- *,
- media: typing.Optional[Literal["null", "print", "screen"]] = None,
- color_scheme: typing.Optional[
- Literal["dark", "light", "no-preference", "null"]
- ] = None,
- reduced_motion: typing.Optional[
- Literal["no-preference", "null", "reduce"]
- ] = None,
- forced_colors: typing.Optional[Literal["active", "none", "null"]] = None,
- contrast: typing.Optional[Literal["more", "no-preference", "null"]] = None,
- ) -> None:
- """Page.emulate_media
- This method changes the `CSS media type` through the `media` argument, and/or the `'prefers-colors-scheme'` media
- feature, using the `colorScheme` argument.
- **Usage**
- ```py
- await page.evaluate(\"matchMedia('screen').matches\")
- # → True
- await page.evaluate(\"matchMedia('print').matches\")
- # → False
- await page.emulate_media(media=\"print\")
- await page.evaluate(\"matchMedia('screen').matches\")
- # → False
- await page.evaluate(\"matchMedia('print').matches\")
- # → True
- await page.emulate_media()
- await page.evaluate(\"matchMedia('screen').matches\")
- # → True
- await page.evaluate(\"matchMedia('print').matches\")
- # → False
- ```
- ```py
- await page.emulate_media(color_scheme=\"dark\")
- await page.evaluate(\"matchMedia('(prefers-color-scheme: dark)').matches\")
- # → True
- await page.evaluate(\"matchMedia('(prefers-color-scheme: light)').matches\")
- # → False
- ```
- Parameters
- ----------
- media : Union["null", "print", "screen", None]
- Changes the CSS media type of the page. The only allowed values are `'Screen'`, `'Print'` and `'Null'`. Passing
- `'Null'` disables CSS media emulation.
- color_scheme : Union["dark", "light", "no-preference", "null", None]
- Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
- media feature, supported values are `'light'` and `'dark'`. Passing `'Null'` disables color scheme emulation.
- `'no-preference'` is deprecated.
- reduced_motion : Union["no-preference", "null", "reduce", None]
- Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. Passing
- `null` disables reduced motion emulation.
- forced_colors : Union["active", "none", "null", None]
- contrast : Union["more", "no-preference", "null", None]
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.emulate_media(
- media=media,
- colorScheme=color_scheme,
- reducedMotion=reduced_motion,
- forcedColors=forced_colors,
- contrast=contrast,
- )
- )
- async def set_viewport_size(self, viewport_size: ViewportSize) -> None:
- """Page.set_viewport_size
- In the case of multiple pages in a single browser, each page can have its own viewport size. However,
- `browser.new_context()` allows to set viewport size (and more) for all pages in the context at once.
- `page.set_viewport_size()` will resize the page. A lot of websites don't expect phones to change size, so you
- should set the viewport size before navigating to the page. `page.set_viewport_size()` will also reset
- `screen` size, use `browser.new_context()` with `screen` and `viewport` parameters if you need better
- control of these properties.
- **Usage**
- ```py
- page = await browser.new_page()
- await page.set_viewport_size({\"width\": 640, \"height\": 480})
- await page.goto(\"https://example.com\")
- ```
- Parameters
- ----------
- viewport_size : {width: int, height: int}
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.set_viewport_size(viewportSize=viewport_size)
- )
- async def bring_to_front(self) -> None:
- """Page.bring_to_front
- Brings page to front (activates tab).
- """
- return mapping.from_maybe_impl(await self._impl_obj.bring_to_front())
- async def hide_highlight(self) -> None:
- """Page.hide_highlight
- Hide all locator highlight overlays previously added by `locator.highlight()` on this page.
- """
- return mapping.from_maybe_impl(await self._impl_obj.hide_highlight())
- async def add_init_script(
- self,
- script: typing.Optional[str] = None,
- *,
- path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- ) -> "AsyncContextManager":
- """Page.add_init_script
- Adds a script which would be evaluated in one of the following scenarios:
- - Whenever the page is navigated.
- - Whenever the child frame is attached or navigated. In this case, the script is evaluated in the context of the
- newly attached frame.
- The script is evaluated after the document was created but before any of its scripts were run. This is useful to
- amend the JavaScript environment, e.g. to seed `Math.random`.
- **Usage**
- An example of overriding `Math.random` before the page loads:
- ```py
- # in your playwright script, assuming the preload.js file is in same directory
- await page.add_init_script(path=\"./preload.js\")
- ```
- **NOTE** The order of evaluation of multiple scripts installed via `browser_context.add_init_script()` and
- `page.add_init_script()` is not defined.
- Parameters
- ----------
- script : Union[str, None]
- Script to be evaluated in all pages in the browser context. Optional.
- path : Union[pathlib.Path, str, None]
- Path to the JavaScript file. If `path` is a relative path, then it is resolved relative to the current working
- directory. Optional.
- Returns
- -------
- AsyncContextManager
- """
- return mapping.from_impl(
- await self._impl_obj.add_init_script(script=script, path=path)
- )
- async def route(
- self,
- url: typing.Union[str, typing.Pattern[str], typing.Callable[[str], bool]],
- handler: typing.Union[
- typing.Callable[["Route"], typing.Any],
- typing.Callable[["Route", "Request"], typing.Any],
- ],
- *,
- times: typing.Optional[int] = None,
- ) -> "AsyncContextManager":
- """Page.route
- Routing provides the capability to modify network requests that are made by a page.
- Once routing is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or
- aborted.
- **NOTE** The handler will only be called for the first url if the response is a redirect.
- **NOTE** `page.route()` will not intercept requests intercepted by Service Worker. See
- [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when
- using request interception by setting `serviceWorkers` to `'block'`.
- **NOTE** `page.route()` will not intercept the first request of a popup page. Use
- `browser_context.route()` instead.
- **Usage**
- An example of a naive handler that aborts all image requests:
- ```py
- page = await browser.new_page()
- await page.route(\"**/*.{png,jpg,jpeg}\", lambda route: route.abort())
- await page.goto(\"https://example.com\")
- await browser.close()
- ```
- or the same snippet using a regex pattern instead:
- ```py
- page = await browser.new_page()
- await page.route(re.compile(r\"(\\.png$)|(\\.jpg$)\"), lambda route: route.abort())
- await page.goto(\"https://example.com\")
- await browser.close()
- ```
- It is possible to examine the request to decide the route action. For example, mocking all requests that contain
- some post data, and leaving all other requests as is:
- ```py
- async def handle_route(route: Route):
- if (\"my-string\" in route.request.post_data):
- await route.fulfill(body=\"mocked-data\")
- else:
- await route.continue_()
- await page.route(\"/api/**\", handle_route)
- ```
- If a request matches multiple registered routes, the most recently registered route takes precedence.
- Page routes take precedence over browser context routes (set up with `browser_context.route()`) when request
- matches both handlers.
- To remove a route with its handler you can use `page.unroute()`.
- **NOTE** Enabling routing disables http cache.
- Parameters
- ----------
- url : Union[Callable[[str], bool], Pattern[str], str]
- A glob pattern, regex pattern, or predicate that receives a [URL] to match during routing. If `baseURL` is set in
- the context options and the provided URL is a string that does not start with `*`, it is resolved using the
- [`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor.
- handler : Union[Callable[[Route, Request], Any], Callable[[Route], Any]]
- handler function to route the request.
- times : Union[int, None]
- How often a route should be used. By default it will be used every time.
- Returns
- -------
- AsyncContextManager
- """
- return mapping.from_impl(
- await self._impl_obj.route(
- url=self._wrap_handler(url),
- handler=self._wrap_handler(handler),
- times=times,
- )
- )
- async def unroute(
- self,
- url: typing.Union[str, typing.Pattern[str], typing.Callable[[str], bool]],
- handler: typing.Optional[
- typing.Union[
- typing.Callable[["Route"], typing.Any],
- typing.Callable[["Route", "Request"], typing.Any],
- ]
- ] = None,
- ) -> None:
- """Page.unroute
- Removes a route created with `page.route()`. When `handler` is not specified, removes all routes for the
- `url`.
- Parameters
- ----------
- url : Union[Callable[[str], bool], Pattern[str], str]
- A glob pattern, regex pattern, or predicate receiving [URL] to match while routing.
- handler : Union[Callable[[Route, Request], Any], Callable[[Route], Any], None]
- Optional handler function to route the request.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.unroute(
- url=self._wrap_handler(url), handler=self._wrap_handler(handler)
- )
- )
- async def route_web_socket(
- self,
- url: typing.Union[str, typing.Pattern[str], typing.Callable[[str], bool]],
- handler: typing.Callable[["WebSocketRoute"], typing.Any],
- ) -> None:
- """Page.route_web_socket
- This method allows to modify websocket connections that are made by the page.
- Note that only `WebSocket`s created after this method was called will be routed. It is recommended to call this
- method before navigating the page.
- **Usage**
- Below is an example of a simple mock that responds to a single message. See `WebSocketRoute` for more details and
- examples.
- ```py
- def message_handler(ws: WebSocketRoute, message: Union[str, bytes]):
- if message == \"request\":
- ws.send(\"response\")
- def handler(ws: WebSocketRoute):
- ws.on_message(lambda message: message_handler(ws, message))
- await page.route_web_socket(\"/ws\", handler)
- ```
- Parameters
- ----------
- url : Union[Callable[[str], bool], Pattern[str], str]
- Only WebSockets with the url matching this pattern will be routed. A string pattern can be relative to the
- `baseURL` context option.
- handler : Callable[[WebSocketRoute], Any]
- Handler function to route the WebSocket.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.route_web_socket(
- url=self._wrap_handler(url), handler=self._wrap_handler(handler)
- )
- )
- async def unroute_all(
- self,
- *,
- behavior: typing.Optional[Literal["default", "ignoreErrors", "wait"]] = None,
- ) -> None:
- """Page.unroute_all
- Removes all routes created with `page.route()` and `page.route_from_har()`.
- Parameters
- ----------
- behavior : Union["default", "ignoreErrors", "wait", None]
- Specifies whether to wait for already running handlers and what to do if they throw errors:
- - `'default'` - do not wait for current handler calls (if any) to finish, if unrouted handler throws, it may
- result in unhandled error
- - `'wait'` - wait for current handler calls (if any) to finish
- - `'ignoreErrors'` - do not wait for current handler calls (if any) to finish, all errors thrown by the handlers
- after unrouting are silently caught
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.unroute_all(behavior=behavior)
- )
- async def route_from_har(
- self,
- har: typing.Union[pathlib.Path, str],
- *,
- url: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- not_found: typing.Optional[Literal["abort", "fallback"]] = None,
- update: typing.Optional[bool] = None,
- update_content: typing.Optional[Literal["attach", "embed"]] = None,
- update_mode: typing.Optional[Literal["full", "minimal"]] = None,
- ) -> None:
- """Page.route_from_har
- If specified the network requests that are made in the page will be served from the HAR file. Read more about
- [Replaying from HAR](https://playwright.dev/python/docs/mock#replaying-from-har).
- Playwright will not serve requests intercepted by Service Worker from the HAR file. See
- [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when
- using request interception by setting `serviceWorkers` to `'block'`.
- Parameters
- ----------
- har : Union[pathlib.Path, str]
- Path to a [HAR](http://www.softwareishard.com/blog/har-12-spec) file with prerecorded network data. If `path` is a
- relative path, then it is resolved relative to the current working directory.
- url : Union[Pattern[str], str, None]
- A glob pattern, regular expression or predicate to match the request URL. Only requests with URL matching the
- pattern will be served from the HAR file. If not specified, all requests are served from the HAR file.
- not_found : Union["abort", "fallback", None]
- - If set to 'abort' any request not found in the HAR file will be aborted.
- - If set to 'fallback' missing requests will be sent to the network.
- Defaults to abort.
- update : Union[bool, None]
- If specified, updates the given HAR with the actual network information instead of serving from file. The file is
- written to disk when `browser_context.close()` is called.
- update_content : Union["attach", "embed", None]
- Optional setting to control resource content management. If `attach` is specified, resources are persisted as
- separate files or entries in the ZIP archive. If `embed` is specified, content is stored inline the HAR file.
- update_mode : Union["full", "minimal", None]
- When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page,
- cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to
- `minimal`.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.route_from_har(
- har=har,
- url=url,
- notFound=not_found,
- update=update,
- updateContent=update_content,
- updateMode=update_mode,
- )
- )
- async def screenshot(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- type: typing.Optional[Literal["jpeg", "png"]] = None,
- path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- quality: typing.Optional[int] = None,
- omit_background: typing.Optional[bool] = None,
- full_page: typing.Optional[bool] = None,
- clip: typing.Optional[FloatRect] = None,
- animations: typing.Optional[Literal["allow", "disabled"]] = None,
- caret: typing.Optional[Literal["hide", "initial"]] = None,
- scale: typing.Optional[Literal["css", "device"]] = None,
- mask: typing.Optional[typing.Sequence["Locator"]] = None,
- mask_color: typing.Optional[str] = None,
- style: typing.Optional[str] = None,
- ) -> bytes:
- """Page.screenshot
- Returns the buffer with the captured screenshot.
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- type : Union["jpeg", "png", None]
- Specify screenshot type, defaults to `png`.
- path : Union[pathlib.Path, str, None]
- The file path to save the image to. The screenshot type will be inferred from file extension. If `path` is a
- relative path, then it is resolved relative to the current working directory. If no path is provided, the image
- won't be saved to the disk.
- quality : Union[int, None]
- The quality of the image, between 0-100. Not applicable to `png` images.
- omit_background : Union[bool, None]
- Hides default white background and allows capturing screenshots with transparency. Not applicable to `jpeg` images.
- Defaults to `false`.
- full_page : Union[bool, None]
- When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Defaults to
- `false`.
- clip : Union[{x: float, y: float, width: float, height: float}, None]
- An object which specifies clipping of the resulting image.
- animations : Union["allow", "disabled", None]
- When set to `"disabled"`, stops CSS animations, CSS transitions and Web Animations. Animations get different
- treatment depending on their duration:
- - finite animations are fast-forwarded to completion, so they'll fire `transitionend` event.
- - infinite animations are canceled to initial state, and then played over after the screenshot.
- Defaults to `"allow"` that leaves animations untouched.
- caret : Union["hide", "initial", None]
- When set to `"hide"`, screenshot will hide text caret. When set to `"initial"`, text caret behavior will not be
- changed. Defaults to `"hide"`.
- scale : Union["css", "device", None]
- When set to `"css"`, screenshot will have a single pixel per each css pixel on the page. For high-dpi devices, this
- will keep screenshots small. Using `"device"` option will produce a single pixel per each device pixel, so
- screenshots of high-dpi devices will be twice as large or even larger.
- Defaults to `"device"`.
- mask : Union[Sequence[Locator], None]
- Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink
- box `#FF00FF` (customized by `maskColor`) that completely covers its bounding box. The mask is also applied to
- invisible elements, see [Matching only visible elements](../locators.md#matching-only-visible-elements) to disable
- that.
- mask_color : Union[str, None]
- Specify the color of the overlay box for masked elements, in
- [CSS color format](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value). Default color is pink `#FF00FF`.
- style : Union[str, None]
- Text of the stylesheet to apply while making the screenshot. This is where you can hide dynamic elements, make
- elements invisible or change their properties to help you creating repeatable screenshots. This stylesheet pierces
- the Shadow DOM and applies to the inner frames.
- Returns
- -------
- bytes
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.screenshot(
- timeout=to_milliseconds(timeout),
- type=type,
- path=path,
- quality=quality,
- omitBackground=omit_background,
- fullPage=full_page,
- clip=clip,
- animations=animations,
- caret=caret,
- scale=scale,
- mask=mapping.to_impl(mask),
- maskColor=mask_color,
- style=style,
- )
- )
- async def title(self) -> str:
- """Page.title
- Returns the page's title.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(await self._impl_obj.title())
- async def aria_snapshot(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- depth: typing.Optional[int] = None,
- mode: typing.Optional[Literal["ai", "default"]] = None,
- boxes: typing.Optional[bool] = None,
- ) -> str:
- """Page.aria_snapshot
- Captures the aria snapshot of the page. Read more about [aria snapshots](https://playwright.dev/python/docs/aria-snapshots).
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- depth : Union[int, None]
- When specified, limits the depth of the snapshot.
- mode : Union["ai", "default", None]
- When set to `"ai"`, returns a snapshot optimized for AI consumption: including element references like `[ref=e2]`
- and snapshots of `<iframe>`s. Defaults to `"default"`.
- boxes : Union[bool, None]
- When `true`, appends each element's bounding box as `[box=x,y,width,height]` to the snapshot. Coordinates are
- relative to the viewport, in CSS pixels, as returned by
- [`Element.getBoundingClientRect()`](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect).
- Defaults to `false`.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.aria_snapshot(
- timeout=to_milliseconds(timeout), depth=depth, mode=mode, boxes=boxes
- )
- )
- async def close(
- self,
- *,
- run_before_unload: typing.Optional[bool] = None,
- reason: typing.Optional[str] = None,
- ) -> None:
- """Page.close
- If `runBeforeUnload` is `false`, does not run any unload handlers and waits for the page to be closed. If
- `runBeforeUnload` is `true` the method will run unload handlers, but will **not** wait for the page to close.
- By default, `page.close()` **does not** run `beforeunload` handlers.
- **NOTE** if `runBeforeUnload` is passed as true, a `beforeunload` dialog might be summoned and should be handled
- manually via `page.on('dialog')` event.
- Parameters
- ----------
- run_before_unload : Union[bool, None]
- Defaults to `false`. Whether to run the
- [before unload](https://developer.mozilla.org/en-US/docs/Web/Events/beforeunload) page handlers.
- reason : Union[str, None]
- The reason to be reported to the operations interrupted by the page closure.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.close(runBeforeUnload=run_before_unload, reason=reason)
- )
- def is_closed(self) -> bool:
- """Page.is_closed
- Indicates that the page has been closed.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(self._impl_obj.is_closed())
- async def click(
- self,
- selector: str,
- *,
- modifiers: typing.Optional[
- typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]
- ] = None,
- position: typing.Optional[Position] = None,
- delay: typing.Optional[float] = None,
- button: typing.Optional[Literal["left", "middle", "right"]] = None,
- click_count: typing.Optional[int] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- ) -> None:
- """Page.click
- This method clicks an element matching `selector` by performing the following steps:
- 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If
- the element is detached during the checks, the whole action is retried.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to click in the center of the element, or the specified `position`.
- 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
- Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
- current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
- "Control" on Windows and Linux and to "Meta" on macOS.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- delay : Union[float, None]
- Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
- button : Union["left", "middle", "right", None]
- Defaults to `left`.
- click_count : Union[int, None]
- defaults to 1. See [UIEvent.detail].
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
- can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
- navigating to inaccessible pages. Defaults to `false`.
- Deprecated: This option will default to `true` in the future.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard
- `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys
- are pressed.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.click(
- selector=selector,
- modifiers=mapping.to_impl(modifiers),
- position=position,
- delay=delay,
- button=button,
- clickCount=click_count,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- trial=trial,
- strict=strict,
- )
- )
- async def dblclick(
- self,
- selector: str,
- *,
- modifiers: typing.Optional[
- typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]
- ] = None,
- position: typing.Optional[Position] = None,
- delay: typing.Optional[float] = None,
- button: typing.Optional[Literal["left", "middle", "right"]] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """Page.dblclick
- This method double clicks an element matching `selector` by performing the following steps:
- 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If
- the element is detached during the checks, the whole action is retried.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to double click in the center of the element, or the specified `position`.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- **NOTE** `page.dblclick()` dispatches two `click` events and a single `dblclick` event.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
- Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
- current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
- "Control" on Windows and Linux and to "Meta" on macOS.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- delay : Union[float, None]
- Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
- button : Union["left", "middle", "right", None]
- Defaults to `left`.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard
- `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys
- are pressed.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.dblclick(
- selector=selector,
- modifiers=mapping.to_impl(modifiers),
- position=position,
- delay=delay,
- button=button,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- strict=strict,
- trial=trial,
- )
- )
- async def tap(
- self,
- selector: str,
- *,
- modifiers: typing.Optional[
- typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]
- ] = None,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """Page.tap
- This method taps an element matching `selector` by performing the following steps:
- 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If
- the element is detached during the checks, the whole action is retried.
- 1. Scroll the element into view if needed.
- 1. Use `page.touchscreen` to tap the center of the element, or the specified `position`.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- **NOTE** `page.tap()` the method will throw if `hasTouch` option of the browser context is false.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
- Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
- current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
- "Control" on Windows and Linux and to "Meta" on macOS.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard
- `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys
- are pressed.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.tap(
- selector=selector,
- modifiers=mapping.to_impl(modifiers),
- position=position,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- strict=strict,
- trial=trial,
- )
- )
- async def fill(
- self,
- selector: str,
- value: str,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- force: typing.Optional[bool] = None,
- ) -> None:
- """Page.fill
- This method waits for an element matching `selector`, waits for [actionability](https://playwright.dev/python/docs/actionability) checks,
- focuses the element, fills it and triggers an `input` event after filling. Note that you can pass an empty string
- to clear the input field.
- If the target element is not an `<input>`, `<textarea>` or `[contenteditable]` element, this method throws an
- error. However, if the element is inside the `<label>` element that has an associated
- [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be filled
- instead.
- To send fine-grained keyboard events, use `locator.press_sequentially()`.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- value : str
- Value to fill for the `<input>`, `<textarea>` or `[contenteditable]` element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.fill(
- selector=selector,
- value=value,
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- strict=strict,
- force=force,
- )
- )
- def locator(
- self,
- selector: str,
- *,
- has_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- has_not_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- has: typing.Optional["Locator"] = None,
- has_not: typing.Optional["Locator"] = None,
- ) -> "Locator":
- """Page.locator
- The method returns an element locator that can be used to perform actions on this page / frame. Locator is resolved
- to the element immediately before performing an action, so a series of actions on the same locator can in fact be
- performed on different DOM elements. That would happen if the DOM structure between those actions has changed.
- [Learn more about locators](https://playwright.dev/python/docs/locators).
- Parameters
- ----------
- selector : str
- A selector to use when resolving DOM element.
- has_text : Union[Pattern[str], str, None]
- Matches elements containing specified text somewhere inside, possibly in a child or a descendant element. When
- passed a [string], matching is case-insensitive and searches for a substring. For example, `"Playwright"` matches
- `<article><div>Playwright</div></article>`.
- has_not_text : Union[Pattern[str], str, None]
- Matches elements that do not contain specified text somewhere inside, possibly in a child or a descendant element.
- When passed a [string], matching is case-insensitive and searches for a substring.
- has : Union[Locator, None]
- Narrows down the results of the method to those which contain elements matching this relative locator. For example,
- `article` that has `text=Playwright` matches `<article><div>Playwright</div></article>`.
- Inner locator **must be relative** to the outer locator and is queried starting with the outer locator match, not
- the document root. For example, you can find `content` that has `div` in
- `<article><content><div>Playwright</div></content></article>`. However, looking for `content` that has `article
- div` will fail, because the inner locator must be relative and should not use any elements outside the `content`.
- Note that outer and inner locators must belong to the same frame. Inner locator must not contain `FrameLocator`s.
- has_not : Union[Locator, None]
- Matches elements that do not contain an element that matches an inner locator. Inner locator is queried against the
- outer one. For example, `article` that does not have `div` matches `<article><span>Playwright</span></article>`.
- Note that outer and inner locators must belong to the same frame. Inner locator must not contain `FrameLocator`s.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(
- self._impl_obj.locator(
- selector=selector,
- hasText=has_text,
- hasNotText=has_not_text,
- has=has._impl_obj if has else None,
- hasNot=has_not._impl_obj if has_not else None,
- )
- )
- def get_by_alt_text(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """Page.get_by_alt_text
- Allows locating elements by their alt text.
- **Usage**
- For example, this method will find the image by alt text \"Playwright logo\":
- ```html
- <img alt='Playwright logo'>
- ```
- ```py
- await page.get_by_alt_text(\"Playwright logo\").click()
- ```
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_alt_text(text=text, exact=exact))
- def get_by_label(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """Page.get_by_label
- Allows locating input elements by the text of the associated `<label>` or `aria-labelledby` element, or by the
- `aria-label` attribute.
- **Usage**
- For example, this method will find inputs by label \"Username\" and \"Password\" in the following DOM:
- ```html
- <input aria-label=\"Username\">
- <label for=\"password-input\">Password:</label>
- <input id=\"password-input\">
- ```
- ```py
- await page.get_by_label(\"Username\").fill(\"john\")
- await page.get_by_label(\"Password\").fill(\"secret\")
- ```
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_label(text=text, exact=exact))
- def get_by_placeholder(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """Page.get_by_placeholder
- Allows locating input elements by the placeholder text.
- **Usage**
- For example, consider the following DOM structure.
- ```html
- <input type=\"email\" placeholder=\"name@example.com\" />
- ```
- You can fill the input after locating it by the placeholder text:
- ```py
- await page.get_by_placeholder(\"name@example.com\").fill(\"playwright@microsoft.com\")
- ```
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(
- self._impl_obj.get_by_placeholder(text=text, exact=exact)
- )
- def get_by_role(
- self,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "blockquote",
- "button",
- "caption",
- "cell",
- "checkbox",
- "code",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "deletion",
- "dialog",
- "directory",
- "document",
- "emphasis",
- "feed",
- "figure",
- "form",
- "generic",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "insertion",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "meter",
- "navigation",
- "none",
- "note",
- "option",
- "paragraph",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "strong",
- "subscript",
- "superscript",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "time",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ],
- *,
- checked: typing.Optional[bool] = None,
- disabled: typing.Optional[bool] = None,
- expanded: typing.Optional[bool] = None,
- include_hidden: typing.Optional[bool] = None,
- level: typing.Optional[int] = None,
- name: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- pressed: typing.Optional[bool] = None,
- selected: typing.Optional[bool] = None,
- exact: typing.Optional[bool] = None,
- description: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- ) -> "Locator":
- """Page.get_by_role
- Allows locating elements by their [ARIA role](https://www.w3.org/TR/wai-aria-1.2/#roles),
- [ARIA attributes](https://www.w3.org/TR/wai-aria-1.2/#aria-attributes) and
- [accessible name](https://w3c.github.io/accname/#dfn-accessible-name).
- **Usage**
- Consider the following DOM structure.
- ```html
- <h3>Sign up</h3>
- <label>
- <input type=\"checkbox\" /> Subscribe
- </label>
- <br/>
- <button>Submit</button>
- ```
- You can locate each element by its implicit role:
- ```py
- await expect(page.get_by_role(\"heading\", name=\"Sign up\")).to_be_visible()
- await page.get_by_role(\"checkbox\", name=\"Subscribe\").check()
- await page.get_by_role(\"button\", name=re.compile(\"submit\", re.IGNORECASE)).click()
- ```
- **Details**
- Role selector **does not replace** accessibility audits and conformance tests, but rather gives early feedback
- about the ARIA guidelines.
- Many html elements have an implicitly [defined role](https://w3c.github.io/html-aam/#html-element-role-mappings)
- that is recognized by the role selector. You can find all the
- [supported roles here](https://www.w3.org/TR/wai-aria-1.2/#role_definitions). ARIA guidelines **do not recommend**
- duplicating implicit roles and attributes by setting `role` and/or `aria-*` attributes to default values.
- Parameters
- ----------
- role : Union["alert", "alertdialog", "application", "article", "banner", "blockquote", "button", "caption", "cell", "checkbox", "code", "columnheader", "combobox", "complementary", "contentinfo", "definition", "deletion", "dialog", "directory", "document", "emphasis", "feed", "figure", "form", "generic", "grid", "gridcell", "group", "heading", "img", "insertion", "link", "list", "listbox", "listitem", "log", "main", "marquee", "math", "menu", "menubar", "menuitem", "menuitemcheckbox", "menuitemradio", "meter", "navigation", "none", "note", "option", "paragraph", "presentation", "progressbar", "radio", "radiogroup", "region", "row", "rowgroup", "rowheader", "scrollbar", "search", "searchbox", "separator", "slider", "spinbutton", "status", "strong", "subscript", "superscript", "switch", "tab", "table", "tablist", "tabpanel", "term", "textbox", "time", "timer", "toolbar", "tooltip", "tree", "treegrid", "treeitem"]
- Required aria role.
- checked : Union[bool, None]
- An attribute that is usually set by `aria-checked` or native `<input type=checkbox>` controls.
- Learn more about [`aria-checked`](https://www.w3.org/TR/wai-aria-1.2/#aria-checked).
- disabled : Union[bool, None]
- An attribute that is usually set by `aria-disabled` or `disabled`.
- **NOTE** Unlike most other attributes, `disabled` is inherited through the DOM hierarchy. Learn more about
- [`aria-disabled`](https://www.w3.org/TR/wai-aria-1.2/#aria-disabled).
- expanded : Union[bool, None]
- An attribute that is usually set by `aria-expanded`.
- Learn more about [`aria-expanded`](https://www.w3.org/TR/wai-aria-1.2/#aria-expanded).
- include_hidden : Union[bool, None]
- Option that controls whether hidden elements are matched. By default, only non-hidden elements, as
- [defined by ARIA](https://www.w3.org/TR/wai-aria-1.2/#tree_exclusion), are matched by role selector.
- Learn more about [`aria-hidden`](https://www.w3.org/TR/wai-aria-1.2/#aria-hidden).
- level : Union[int, None]
- A number attribute that is usually present for roles `heading`, `listitem`, `row`, `treeitem`, with default values
- for `<h1>-<h6>` elements.
- Learn more about [`aria-level`](https://www.w3.org/TR/wai-aria-1.2/#aria-level).
- name : Union[Pattern[str], str, None]
- Option to match the [accessible name](https://w3c.github.io/accname/#dfn-accessible-name). By default, matching is
- case-insensitive and searches for a substring, use `exact` to control this behavior.
- Learn more about [accessible name](https://w3c.github.io/accname/#dfn-accessible-name).
- pressed : Union[bool, None]
- An attribute that is usually set by `aria-pressed`.
- Learn more about [`aria-pressed`](https://www.w3.org/TR/wai-aria-1.2/#aria-pressed).
- selected : Union[bool, None]
- An attribute that is usually set by `aria-selected`.
- Learn more about [`aria-selected`](https://www.w3.org/TR/wai-aria-1.2/#aria-selected).
- exact : Union[bool, None]
- Whether `name` and `description` are matched exactly: case-sensitive and whole-string. Defaults to false. Ignored
- when the value is a regular expression. Note that exact match still trims whitespace.
- description : Union[Pattern[str], str, None]
- Option to match the [accessible description](https://w3c.github.io/accname/#dfn-accessible-description). By
- default, matching is case-insensitive and searches for a substring, use `exact` to control this behavior.
- Learn more about [accessible description](https://w3c.github.io/accname/#dfn-accessible-description).
- Returns
- -------
- Locator
- """
- return mapping.from_impl(
- self._impl_obj.get_by_role(
- role=role,
- checked=checked,
- disabled=disabled,
- expanded=expanded,
- includeHidden=include_hidden,
- level=level,
- name=name,
- pressed=pressed,
- selected=selected,
- exact=exact,
- description=description,
- )
- )
- def get_by_test_id(
- self, test_id: typing.Union[str, typing.Pattern[str]]
- ) -> "Locator":
- """Page.get_by_test_id
- Locate element by the test id.
- **Usage**
- Consider the following DOM structure.
- ```html
- <button data-testid=\"directions\">Itinéraire</button>
- ```
- You can locate the element by its test id:
- ```py
- await page.get_by_test_id(\"directions\").click()
- ```
- **Details**
- By default, the `data-testid` attribute is used as a test id. Use `selectors.set_test_id_attribute()` to
- configure a different test id attribute if necessary.
- Parameters
- ----------
- test_id : Union[Pattern[str], str]
- Id to locate the element by.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_test_id(testId=test_id))
- def get_by_text(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """Page.get_by_text
- Allows locating elements that contain given text.
- See also `locator.filter()` that allows to match by another criteria, like an accessible role, and then
- filter by the text content.
- **Usage**
- Consider the following DOM structure:
- ```html
- <div>Hello <span>world</span></div>
- <div>Hello</div>
- ```
- You can locate by text substring, exact string, or a regular expression:
- ```py
- # Matches <span>
- page.get_by_text(\"world\")
- # Matches first <div>
- page.get_by_text(\"Hello world\")
- # Matches second <div>
- page.get_by_text(\"Hello\", exact=True)
- # Matches both <div>s
- page.get_by_text(re.compile(\"Hello\"))
- # Matches second <div>
- page.get_by_text(re.compile(\"^hello$\", re.IGNORECASE))
- ```
- **Details**
- Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into
- one, turns line breaks into spaces and ignores leading and trailing whitespace.
- Input elements of the type `button` and `submit` are matched by their `value` instead of the text content. For
- example, locating by text `\"Log in\"` matches `<input type=button value=\"Log in\">`.
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_text(text=text, exact=exact))
- def get_by_title(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """Page.get_by_title
- Allows locating elements by their title attribute.
- **Usage**
- Consider the following DOM structure.
- ```html
- <span title='Issues count'>25 issues</span>
- ```
- You can check the issues count after locating it by the title text:
- ```py
- await expect(page.get_by_title(\"Issues count\")).to_have_text(\"25 issues\")
- ```
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_title(text=text, exact=exact))
- def frame_locator(self, selector: str) -> "FrameLocator":
- """Page.frame_locator
- When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements
- in that iframe.
- **Usage**
- Following snippet locates element with text \"Submit\" in the iframe with id `my-frame`, like `<iframe
- id=\"my-frame\">`:
- ```py
- locator = page.frame_locator(\"#my-iframe\").get_by_text(\"Submit\")
- await locator.click()
- ```
- Parameters
- ----------
- selector : str
- A selector to use when resolving DOM element.
- Returns
- -------
- FrameLocator
- """
- return mapping.from_impl(self._impl_obj.frame_locator(selector=selector))
- async def focus(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """Page.focus
- This method fetches an element with `selector` and focuses it. If there's no element matching `selector`, the
- method waits until a matching element appears in the DOM.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.focus(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def text_content(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> typing.Optional[str]:
- """Page.text_content
- Returns `element.textContent`.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- Union[str, None]
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.text_content(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def inner_text(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> str:
- """Page.inner_text
- Returns `element.innerText`.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.inner_text(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def inner_html(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> str:
- """Page.inner_html
- Returns `element.innerHTML`.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.inner_html(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def get_attribute(
- self,
- selector: str,
- name: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> typing.Optional[str]:
- """Page.get_attribute
- Returns element attribute value.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- name : str
- Attribute name to get the value for.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- Union[str, None]
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.get_attribute(
- selector=selector,
- name=name,
- strict=strict,
- timeout=to_milliseconds(timeout),
- )
- )
- async def hover(
- self,
- selector: str,
- *,
- modifiers: typing.Optional[
- typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]
- ] = None,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- force: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """Page.hover
- This method hovers over an element matching `selector` by performing the following steps:
- 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If
- the element is detached during the checks, the whole action is retried.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to hover over the center of the element, or the specified `position`.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
- Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
- current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
- "Control" on Windows and Linux and to "Meta" on macOS.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard
- `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys
- are pressed.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.hover(
- selector=selector,
- modifiers=mapping.to_impl(modifiers),
- position=position,
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- force=force,
- strict=strict,
- trial=trial,
- )
- )
- async def drag_and_drop(
- self,
- source: str,
- target: str,
- *,
- source_position: typing.Optional[Position] = None,
- target_position: typing.Optional[Position] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- strict: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- steps: typing.Optional[int] = None,
- ) -> None:
- """Page.drag_and_drop
- This method drags the source element to the target element. It will first move to the source element, perform a
- `mousedown`, then move to the target element and perform a `mouseup`.
- **Usage**
- ```py
- await page.drag_and_drop(\"#source\", \"#target\")
- # or specify exact positions relative to the top-left corners of the elements:
- await page.drag_and_drop(
- \"#source\",
- \"#target\",
- source_position={\"x\": 34, \"y\": 7},
- target_position={\"x\": 10, \"y\": 20}
- )
- ```
- Parameters
- ----------
- source : str
- A selector to search for an element to drag. If there are multiple elements satisfying the selector, the first will
- be used.
- target : str
- A selector to search for an element to drop onto. If there are multiple elements satisfying the selector, the first
- will be used.
- source_position : Union[{x: float, y: float}, None]
- Clicks on the source element at this point relative to the top-left corner of the element's padding box. If not
- specified, some visible point of the element is used.
- target_position : Union[{x: float, y: float}, None]
- Drops on the target element at this point relative to the top-left corner of the element's padding box. If not
- specified, some visible point of the element is used.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it.
- steps : Union[int, None]
- Defaults to 1. Sends `n` interpolated `mousemove` events to represent travel between the `mousedown` and `mouseup`
- of the drag. When set to 1, emits a single `mousemove` event at the destination location.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.drag_and_drop(
- source=source,
- target=target,
- sourcePosition=source_position,
- targetPosition=target_position,
- force=force,
- noWaitAfter=no_wait_after,
- timeout=to_milliseconds(timeout),
- strict=strict,
- trial=trial,
- steps=steps,
- )
- )
- async def select_option(
- self,
- selector: str,
- value: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
- *,
- index: typing.Optional[typing.Union[int, typing.Sequence[int]]] = None,
- label: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
- element: typing.Optional[
- typing.Union["ElementHandle", typing.Sequence["ElementHandle"]]
- ] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- force: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- ) -> typing.List[str]:
- """Page.select_option
- This method waits for an element matching `selector`, waits for [actionability](https://playwright.dev/python/docs/actionability) checks, waits
- until all specified options are present in the `<select>` element and selects these options.
- If the target element is not a `<select>` element, this method throws an error. However, if the element is inside
- the `<label>` element that has an associated
- [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be used
- instead.
- Returns the array of option values that have been successfully selected.
- Triggers a `change` and `input` event once all the provided options have been selected.
- **Usage**
- ```py
- # Single selection matching the value or label
- await page.select_option(\"select#colors\", \"blue\")
- # single selection matching the label
- await page.select_option(\"select#colors\", label=\"blue\")
- # multiple selection
- await page.select_option(\"select#colors\", value=[\"red\", \"green\", \"blue\"])
- ```
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- value : Union[Sequence[str], str, None]
- Options to select by value. If the `<select>` has the `multiple` attribute, all given options are selected,
- otherwise only the first option matching one of the passed options is selected. Optional.
- index : Union[Sequence[int], int, None]
- Options to select by index. Optional.
- label : Union[Sequence[str], str, None]
- Options to select by label. If the `<select>` has the `multiple` attribute, all given options are selected,
- otherwise only the first option matching one of the passed options is selected. Optional.
- element : Union[ElementHandle, Sequence[ElementHandle], None]
- Option elements to select. Optional.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- Returns
- -------
- List[str]
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.select_option(
- selector=selector,
- value=mapping.to_impl(value),
- index=mapping.to_impl(index),
- label=mapping.to_impl(label),
- element=mapping.to_impl(element),
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- force=force,
- strict=strict,
- )
- )
- async def input_value(
- self,
- selector: str,
- *,
- strict: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> str:
- """Page.input_value
- Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element.
- Throws for non-input elements. However, if the element is inside the `<label>` element that has an associated
- [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the
- control.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.input_value(
- selector=selector, strict=strict, timeout=to_milliseconds(timeout)
- )
- )
- async def set_input_files(
- self,
- selector: str,
- files: typing.Union[
- str,
- pathlib.Path,
- FilePayload,
- typing.Sequence[typing.Union[str, pathlib.Path]],
- typing.Sequence[FilePayload],
- ],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- strict: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- ) -> None:
- """Page.set_input_files
- Sets the value of the file input to these file paths or files. If some of the `filePaths` are relative paths, then
- they are resolved relative to the current working directory. For empty array, clears the selected files. For inputs
- with a `[webkitdirectory]` attribute, only a single directory path is supported.
- This method expects `selector` to point to an
- [input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside
- the `<label>` element that has an associated
- [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- files : Union[Sequence[Union[pathlib.Path, str]], Sequence[{name: str, mimeType: str, buffer: bytes}], pathlib.Path, str, {name: str, mimeType: str, buffer: bytes}]
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.set_input_files(
- selector=selector,
- files=mapping.to_impl(files),
- timeout=to_milliseconds(timeout),
- strict=strict,
- noWaitAfter=no_wait_after,
- )
- )
- async def type(
- self,
- selector: str,
- text: str,
- *,
- delay: typing.Optional[float] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- ) -> None:
- """Page.type
- Sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text. `page.type` can be used to
- send fine-grained keyboard events. To fill values in form fields, use `page.fill()`.
- To press a special key, like `Control` or `ArrowDown`, use `keyboard.press()`.
- **Usage**
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- text : str
- A text to type into a focused element.
- delay : Union[float, None]
- Time to wait between key presses in milliseconds. Defaults to 0.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.type(
- selector=selector,
- text=text,
- delay=delay,
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- strict=strict,
- )
- )
- async def press(
- self,
- selector: str,
- key: str,
- *,
- delay: typing.Optional[float] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- ) -> None:
- """Page.press
- Focuses the element, and then uses `keyboard.down()` and `keyboard.up()`.
- `key` can specify the intended
- [keyboardEvent.key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) value or a single character
- to generate the text for. A superset of the `key` values can be found
- [here](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values). Examples of the keys are:
- `F1` - `F12`, `Digit0`- `Digit9`, `KeyA`- `KeyZ`, `Backquote`, `Minus`, `Equal`, `Backslash`, `Backspace`, `Tab`,
- `Delete`, `Escape`, `ArrowDown`, `End`, `Enter`, `Home`, `Insert`, `PageDown`, `PageUp`, `ArrowRight`, `ArrowUp`,
- etc.
- Following modification shortcuts are also supported: `Shift`, `Control`, `Alt`, `Meta`, `ShiftLeft`,
- `ControlOrMeta`. `ControlOrMeta` resolves to `Control` on Windows and Linux and to `Meta` on macOS.
- Holding down `Shift` will type the text that corresponds to the `key` in the upper case.
- If `key` is a single character, it is case-sensitive, so the values `a` and `A` will generate different respective
- texts.
- Shortcuts such as `key: \"Control+o\"`, `key: \"Control++` or `key: \"Control+Shift+T\"` are supported as well. When
- specified with the modifier, modifier is pressed and being held while the subsequent key is being pressed.
- **Usage**
- ```py
- page = await browser.new_page()
- await page.goto(\"https://keycode.info\")
- await page.press(\"body\", \"A\")
- await page.screenshot(path=\"a.png\")
- await page.press(\"body\", \"ArrowLeft\")
- await page.screenshot(path=\"arrow_left.png\")
- await page.press(\"body\", \"Shift+O\")
- await page.screenshot(path=\"o.png\")
- await browser.close()
- ```
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- key : str
- Name of the key to press or a character to generate, such as `ArrowLeft` or `a`.
- delay : Union[float, None]
- Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
- can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
- navigating to inaccessible pages. Defaults to `false`.
- Deprecated: This option will default to `true` in the future.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.press(
- selector=selector,
- key=key,
- delay=delay,
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- strict=strict,
- )
- )
- async def check(
- self,
- selector: str,
- *,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """Page.check
- This method checks an element matching `selector` by performing the following steps:
- 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
- 1. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is
- already checked, this method returns immediately.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If
- the element is detached during the checks, the whole action is retried.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to click in the center of the element.
- 1. Ensure that the element is now checked. If not, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.check(
- selector=selector,
- position=position,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- strict=strict,
- trial=trial,
- )
- )
- async def uncheck(
- self,
- selector: str,
- *,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """Page.uncheck
- This method unchecks an element matching `selector` by performing the following steps:
- 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
- 1. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is
- already unchecked, this method returns immediately.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If
- the element is detached during the checks, the whole action is retried.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to click in the center of the element.
- 1. Ensure that the element is now unchecked. If not, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.uncheck(
- selector=selector,
- position=position,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- strict=strict,
- trial=trial,
- )
- )
- async def wait_for_timeout(
- self, timeout: typing.Union[float, datetime.timedelta]
- ) -> None:
- """Page.wait_for_timeout
- Waits for the given `timeout` in milliseconds.
- Note that `page.waitForTimeout()` should only be used for debugging. Tests using the timer in production are going
- to be flaky. Use signals such as network events, selectors becoming visible and others instead.
- **Usage**
- ```py
- # wait for 1 second
- await page.wait_for_timeout(1000)
- ```
- Parameters
- ----------
- timeout : float
- A timeout to wait for
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.wait_for_timeout(timeout=to_milliseconds(timeout))
- )
- async def wait_for_function(
- self,
- expression: str,
- *,
- arg: typing.Optional[typing.Any] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- polling: typing.Optional[typing.Union[float, Literal["raf"]]] = None,
- ) -> "JSHandle":
- """Page.wait_for_function
- Returns when the `expression` returns a truthy value. It resolves to a JSHandle of the truthy value.
- **Usage**
- The `page.wait_for_function()` can be used to observe viewport size change:
- ```py
- import asyncio
- from playwright.async_api import async_playwright, Playwright
- async def run(playwright: Playwright):
- webkit = playwright.webkit
- browser = await webkit.launch()
- page = await browser.new_page()
- await page.evaluate(\"window.x = 0; setTimeout(() => { window.x = 100 }, 1000);\")
- await page.wait_for_function(\"() => window.x > 0\")
- await browser.close()
- async def main():
- async with async_playwright() as playwright:
- await run(playwright)
- asyncio.run(main())
- ```
- To pass an argument to the predicate of `page.wait_for_function()` function:
- ```py
- selector = \".foo\"
- await page.wait_for_function(\"selector => !!document.querySelector(selector)\", selector)
- ```
- Parameters
- ----------
- expression : str
- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
- function is automatically invoked.
- arg : Union[Any, None]
- Optional argument to pass to `expression`.
- timeout : Union[float, None]
- Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The
- default value can be changed by using the `browser_context.set_default_timeout()` or
- `page.set_default_timeout()` methods.
- polling : Union["raf", float, None]
- If `polling` is `'raf'`, then `expression` is constantly executed in `requestAnimationFrame` callback. If `polling`
- is a number, then it is treated as an interval in milliseconds at which the function would be executed. Defaults to
- `raf`.
- Returns
- -------
- JSHandle
- """
- return mapping.from_impl(
- await self._impl_obj.wait_for_function(
- expression=expression,
- arg=mapping.to_impl(arg),
- timeout=to_milliseconds(timeout),
- polling=polling,
- )
- )
- async def pause(self) -> None:
- """Page.pause
- Pauses script execution. Playwright will stop executing the script and wait for the user to either press the
- 'Resume' button in the page overlay or to call `playwright.resume()` in the DevTools console.
- User can inspect selectors or perform manual steps while paused. Resume will continue running the original script
- from the place it was paused.
- **NOTE** This method requires Playwright to be started in a headed mode, with a falsy `headless` option.
- """
- return mapping.from_maybe_impl(await self._impl_obj.pause())
- async def pdf(
- self,
- *,
- scale: typing.Optional[float] = None,
- display_header_footer: typing.Optional[bool] = None,
- header_template: typing.Optional[str] = None,
- footer_template: typing.Optional[str] = None,
- print_background: typing.Optional[bool] = None,
- landscape: typing.Optional[bool] = None,
- page_ranges: typing.Optional[str] = None,
- format: typing.Optional[str] = None,
- width: typing.Optional[typing.Union[str, float]] = None,
- height: typing.Optional[typing.Union[str, float]] = None,
- prefer_css_page_size: typing.Optional[bool] = None,
- margin: typing.Optional[PdfMargins] = None,
- path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- outline: typing.Optional[bool] = None,
- tagged: typing.Optional[bool] = None,
- ) -> bytes:
- """Page.pdf
- Returns the PDF buffer.
- `page.pdf()` generates a pdf of the page with `print` css media. To generate a pdf with `screen` media, call
- `page.emulate_media()` before calling `page.pdf()`:
- **NOTE** By default, `page.pdf()` generates a pdf with modified colors for printing. Use the
- [`-webkit-print-color-adjust`](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-print-color-adjust)
- property to force rendering of exact colors.
- **Usage**
- ```py
- # generates a pdf with \"screen\" media type.
- await page.emulate_media(media=\"screen\")
- await page.pdf(path=\"page.pdf\")
- ```
- The `width`, `height`, and `margin` options accept values labeled with units. Unlabeled values are treated as
- pixels.
- A few examples:
- - `page.pdf({width: 100})` - prints with width set to 100 pixels
- - `page.pdf({width: '100px'})` - prints with width set to 100 pixels
- - `page.pdf({width: '10cm'})` - prints with width set to 10 centimeters.
- All possible units are:
- - `px` - pixel
- - `in` - inch
- - `cm` - centimeter
- - `mm` - millimeter
- The `format` options are:
- - `Letter`: 8.5in x 11in
- - `Legal`: 8.5in x 14in
- - `Tabloid`: 11in x 17in
- - `Ledger`: 17in x 11in
- - `A0`: 33.1in x 46.8in
- - `A1`: 23.4in x 33.1in
- - `A2`: 16.54in x 23.4in
- - `A3`: 11.7in x 16.54in
- - `A4`: 8.27in x 11.7in
- - `A5`: 5.83in x 8.27in
- - `A6`: 4.13in x 5.83in
- **NOTE** `headerTemplate` and `footerTemplate` markup have the following limitations: > 1. Script tags inside
- templates are not evaluated. > 2. Page styles are not visible inside templates.
- Parameters
- ----------
- scale : Union[float, None]
- Scale of the webpage rendering. Defaults to `1`. Scale amount must be between 0.1 and 2.
- display_header_footer : Union[bool, None]
- Display header and footer. Defaults to `false`.
- header_template : Union[str, None]
- HTML template for the print header. Should be valid HTML markup with following classes used to inject printing
- values into them:
- - `'date'` formatted print date
- - `'title'` document title
- - `'url'` document location
- - `'pageNumber'` current page number
- - `'totalPages'` total pages in the document
- footer_template : Union[str, None]
- HTML template for the print footer. Should use the same format as the `headerTemplate`.
- print_background : Union[bool, None]
- Print background graphics. Defaults to `false`.
- landscape : Union[bool, None]
- Paper orientation. Defaults to `false`.
- page_ranges : Union[str, None]
- Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.
- format : Union[str, None]
- Paper format. If set, takes priority over `width` or `height` options. Defaults to 'Letter'.
- width : Union[float, str, None]
- Paper width, accepts values labeled with units.
- height : Union[float, str, None]
- Paper height, accepts values labeled with units.
- prefer_css_page_size : Union[bool, None]
- Give any CSS `@page` size declared in the page priority over what is declared in `width` and `height` or `format`
- options. Defaults to `false`, which will scale the content to fit the paper size.
- margin : Union[{top: Union[float, str, None], right: Union[float, str, None], bottom: Union[float, str, None], left: Union[float, str, None]}, None]
- Paper margins, defaults to none.
- path : Union[pathlib.Path, str, None]
- The file path to save the PDF to. If `path` is a relative path, then it is resolved relative to the current working
- directory. If no path is provided, the PDF won't be saved to the disk.
- outline : Union[bool, None]
- Whether or not to embed the document outline into the PDF. Defaults to `false`.
- tagged : Union[bool, None]
- Whether or not to generate tagged (accessible) PDF. Defaults to `false`.
- Returns
- -------
- bytes
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.pdf(
- scale=scale,
- displayHeaderFooter=display_header_footer,
- headerTemplate=header_template,
- footerTemplate=footer_template,
- printBackground=print_background,
- landscape=landscape,
- pageRanges=page_ranges,
- format=format,
- width=width,
- height=height,
- preferCSSPageSize=prefer_css_page_size,
- margin=margin,
- path=path,
- outline=outline,
- tagged=tagged,
- )
- )
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["close"],
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Page"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["console"],
- predicate: typing.Optional[typing.Callable[["ConsoleMessage"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["ConsoleMessage"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["crash"],
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Page"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["dialog"],
- predicate: typing.Optional[typing.Callable[["Dialog"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Dialog"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["domcontentloaded"],
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Page"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["download"],
- predicate: typing.Optional[typing.Callable[["Download"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Download"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["filechooser"],
- predicate: typing.Optional[typing.Callable[["FileChooser"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["FileChooser"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["frameattached"],
- predicate: typing.Optional[typing.Callable[["Frame"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Frame"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["framedetached"],
- predicate: typing.Optional[typing.Callable[["Frame"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Frame"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["framenavigated"],
- predicate: typing.Optional[typing.Callable[["Frame"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Frame"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["load"],
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Page"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["pageerror"],
- predicate: typing.Optional[typing.Callable[["Error"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Error"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["popup"],
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Page"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["request"],
- predicate: typing.Optional[typing.Callable[["Request"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Request"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["requestfailed"],
- predicate: typing.Optional[typing.Callable[["Request"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Request"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["requestfinished"],
- predicate: typing.Optional[typing.Callable[["Request"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Request"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["response"],
- predicate: typing.Optional[typing.Callable[["Response"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Response"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["websocket"],
- predicate: typing.Optional[typing.Callable[["WebSocket"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["WebSocket"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["worker"],
- predicate: typing.Optional[typing.Callable[["Worker"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Worker"]: ...
- @typing.overload
- def expect_event(
- self,
- event: str,
- predicate: typing.Optional[typing.Callable[..., bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager[typing.Any]: ...
- def expect_event(
- self,
- event: str,
- predicate: typing.Optional[typing.Callable] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> AsyncEventContextManager:
- """Page.expect_event
- Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy
- value. Will throw an error if the page is closed before the event is fired. Returns the event data value.
- **Usage**
- ```py
- async with page.expect_event(\"framenavigated\") as event_info:
- await page.get_by_role(\"button\")
- frame = await event_info.value
- ```
- Parameters
- ----------
- event : str
- Event name, same one typically passed into `*.on(event)`.
- predicate : Union[Callable, None]
- Receives the event data and resolves to truthy value when the waiting should resolve.
- timeout : Union[float, None]
- Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The
- default value can be changed by using the `browser_context.set_default_timeout()`.
- Returns
- -------
- EventContextManager
- """
- return AsyncEventContextManager(
- self._impl_obj.expect_event(
- event=event,
- predicate=self._wrap_handler(predicate),
- timeout=to_milliseconds(timeout),
- ).future
- )
- def expect_console_message(
- self,
- predicate: typing.Optional[typing.Callable[["ConsoleMessage"], bool]] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> AsyncEventContextManager["ConsoleMessage"]:
- """Page.expect_console_message
- Performs action and waits for a `ConsoleMessage` to be logged by in the page. If predicate is provided, it passes
- `ConsoleMessage` value into the `predicate` function and waits for `predicate(message)` to return a truthy value.
- Will throw an error if the page is closed before the `page.on('console')` event is fired.
- Parameters
- ----------
- predicate : Union[Callable[[ConsoleMessage], bool], None]
- Receives the `ConsoleMessage` object and resolves to truthy value when the waiting should resolve.
- timeout : Union[float, None]
- Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The
- default value can be changed by using the `browser_context.set_default_timeout()`.
- Returns
- -------
- EventContextManager[ConsoleMessage]
- """
- return AsyncEventContextManager(
- self._impl_obj.expect_console_message(
- predicate=self._wrap_handler(predicate),
- timeout=to_milliseconds(timeout),
- ).future
- )
- def expect_download(
- self,
- predicate: typing.Optional[typing.Callable[["Download"], bool]] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> AsyncEventContextManager["Download"]:
- """Page.expect_download
- Performs action and waits for a new `Download`. If predicate is provided, it passes `Download` value into the
- `predicate` function and waits for `predicate(download)` to return a truthy value. Will throw an error if the page
- is closed before the download event is fired.
- Parameters
- ----------
- predicate : Union[Callable[[Download], bool], None]
- Receives the `Download` object and resolves to truthy value when the waiting should resolve.
- timeout : Union[float, None]
- Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The
- default value can be changed by using the `browser_context.set_default_timeout()`.
- Returns
- -------
- EventContextManager[Download]
- """
- return AsyncEventContextManager(
- self._impl_obj.expect_download(
- predicate=self._wrap_handler(predicate),
- timeout=to_milliseconds(timeout),
- ).future
- )
- def expect_file_chooser(
- self,
- predicate: typing.Optional[typing.Callable[["FileChooser"], bool]] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> AsyncEventContextManager["FileChooser"]:
- """Page.expect_file_chooser
- Performs action and waits for a new `FileChooser` to be created. If predicate is provided, it passes `FileChooser`
- value into the `predicate` function and waits for `predicate(fileChooser)` to return a truthy value. Will throw an
- error if the page is closed before the file chooser is opened.
- Parameters
- ----------
- predicate : Union[Callable[[FileChooser], bool], None]
- Receives the `FileChooser` object and resolves to truthy value when the waiting should resolve.
- timeout : Union[float, None]
- Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The
- default value can be changed by using the `browser_context.set_default_timeout()`.
- Returns
- -------
- EventContextManager[FileChooser]
- """
- return AsyncEventContextManager(
- self._impl_obj.expect_file_chooser(
- predicate=self._wrap_handler(predicate),
- timeout=to_milliseconds(timeout),
- ).future
- )
- def expect_navigation(
- self,
- *,
- url: typing.Optional[
- typing.Union[str, typing.Pattern[str], typing.Callable[[str], bool]]
- ] = None,
- wait_until: typing.Optional[
- Literal["commit", "domcontentloaded", "load", "networkidle"]
- ] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> AsyncEventContextManager["Response"]:
- """Page.expect_navigation
- Waits for the main frame navigation and returns the main resource response. In case of multiple redirects, the
- navigation will resolve with the response of the last redirect. In case of navigation to a different anchor or
- navigation due to History API usage, the navigation will resolve with `null`.
- **Usage**
- This resolves when the page navigates to a new URL or reloads. It is useful for when you run code which will
- indirectly cause the page to navigate. e.g. The click target has an `onclick` handler that triggers navigation from
- a `setTimeout`. Consider this example:
- ```py
- async with page.expect_navigation():
- # This action triggers the navigation after a timeout.
- await page.get_by_text(\"Navigate after timeout\").click()
- # Resolves after navigation has finished
- ```
- **NOTE** Usage of the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) to change the URL
- is considered a navigation.
- Parameters
- ----------
- url : Union[Callable[[str], bool], Pattern[str], str, None]
- A glob pattern, regex pattern, or predicate receiving [URL] to match while waiting for the navigation. Note that if
- the parameter is a string without wildcard characters, the method will wait for navigation to URL that is exactly
- equal to the string.
- wait_until : Union["commit", "domcontentloaded", "load", "networkidle", None]
- When to consider operation succeeded, defaults to `load`. Events can be either:
- - `'domcontentloaded'` - consider operation to be finished when the `DOMContentLoaded` event is fired.
- - `'load'` - consider operation to be finished when the `load` event is fired.
- - `'networkidle'` - **DISCOURAGED** consider operation to be finished when there are no network connections for
- at least `500` ms. Don't use this method for testing, rely on web assertions to assess readiness instead.
- - `'commit'` - consider operation to be finished when network response is received and the document started
- loading.
- timeout : Union[float, None]
- Maximum operation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_navigation_timeout()`,
- `browser_context.set_default_timeout()`, `page.set_default_navigation_timeout()` or
- `page.set_default_timeout()` methods.
- Returns
- -------
- EventContextManager[Response]
- """
- return AsyncEventContextManager(
- self._impl_obj.expect_navigation(
- url=self._wrap_handler(url),
- waitUntil=wait_until,
- timeout=to_milliseconds(timeout),
- ).future
- )
- def expect_popup(
- self,
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> AsyncEventContextManager["Page"]:
- """Page.expect_popup
- Performs action and waits for a popup `Page`. If predicate is provided, it passes [Popup] value into the
- `predicate` function and waits for `predicate(page)` to return a truthy value. Will throw an error if the page is
- closed before the popup event is fired.
- Parameters
- ----------
- predicate : Union[Callable[[Page], bool], None]
- Receives the `Page` object and resolves to truthy value when the waiting should resolve.
- timeout : Union[float, None]
- Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The
- default value can be changed by using the `browser_context.set_default_timeout()`.
- Returns
- -------
- EventContextManager[Page]
- """
- return AsyncEventContextManager(
- self._impl_obj.expect_popup(
- predicate=self._wrap_handler(predicate),
- timeout=to_milliseconds(timeout),
- ).future
- )
- def expect_request(
- self,
- url_or_predicate: typing.Union[
- str,
- typing.Pattern[str],
- typing.Callable[["Request"], typing.Union[bool, typing.Awaitable[bool]]],
- ],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> AsyncEventContextManager["Request"]:
- """Page.expect_request
- Waits for the matching request and returns it. See [waiting for event](https://playwright.dev/python/docs/events#waiting-for-event) for more
- details about events.
- **Usage**
- ```py
- async with page.expect_request(\"http://example.com/resource\") as first:
- await page.get_by_text(\"trigger request\").click()
- first_request = await first.value
- # or with a lambda
- async with page.expect_request(lambda request: request.url == \"http://example.com\" and request.method == \"get\") as second:
- await page.get_by_text(\"trigger request\").click()
- second_request = await second.value
- ```
- Parameters
- ----------
- url_or_predicate : Union[Callable[[Request], Union[bool, typing.Awaitable[bool]]], Pattern[str], str]
- Request URL string, regex or predicate receiving `Request` object. When a `baseURL` via the context options was
- provided and the passed URL is a path, it gets merged via the
- [`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor.
- timeout : Union[float, None]
- Maximum wait time in milliseconds, defaults to 30 seconds, pass `0` to disable the timeout. The default value can
- be changed by using the `page.set_default_timeout()` method.
- Returns
- -------
- EventContextManager[Request]
- """
- return AsyncEventContextManager(
- self._impl_obj.expect_request(
- urlOrPredicate=self._wrap_handler(url_or_predicate),
- timeout=to_milliseconds(timeout),
- ).future
- )
- def expect_request_finished(
- self,
- predicate: typing.Optional[typing.Callable[["Request"], bool]] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> AsyncEventContextManager["Request"]:
- """Page.expect_request_finished
- Performs action and waits for a `Request` to finish loading. If predicate is provided, it passes `Request` value
- into the `predicate` function and waits for `predicate(request)` to return a truthy value. Will throw an error if
- the page is closed before the `page.on('request_finished')` event is fired.
- Parameters
- ----------
- predicate : Union[Callable[[Request], bool], None]
- Receives the `Request` object and resolves to truthy value when the waiting should resolve.
- timeout : Union[float, None]
- Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The
- default value can be changed by using the `browser_context.set_default_timeout()`.
- Returns
- -------
- EventContextManager[Request]
- """
- return AsyncEventContextManager(
- self._impl_obj.expect_request_finished(
- predicate=self._wrap_handler(predicate),
- timeout=to_milliseconds(timeout),
- ).future
- )
- def expect_response(
- self,
- url_or_predicate: typing.Union[
- str,
- typing.Pattern[str],
- typing.Callable[["Response"], typing.Union[bool, typing.Awaitable[bool]]],
- ],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> AsyncEventContextManager["Response"]:
- """Page.expect_response
- Returns the matched response. See [waiting for event](https://playwright.dev/python/docs/events#waiting-for-event) for more details about
- events.
- **Usage**
- ```py
- async with page.expect_response(\"https://example.com/resource\") as response_info:
- await page.get_by_text(\"trigger response\").click()
- response = await response_info.value
- return response.ok
- # or with a lambda
- async with page.expect_response(lambda response: response.url == \"https://example.com\" and response.status == 200 and response.request.method == \"get\") as response_info:
- await page.get_by_text(\"trigger response\").click()
- response = await response_info.value
- return response.ok
- ```
- Parameters
- ----------
- url_or_predicate : Union[Callable[[Response], Union[bool, typing.Awaitable[bool]]], Pattern[str], str]
- Request URL string, regex or predicate receiving `Response` object. When a `baseURL` via the context options was
- provided and the passed URL is a path, it gets merged via the
- [`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor.
- timeout : Union[float, None]
- Maximum wait time in milliseconds, defaults to 30 seconds, pass `0` to disable the timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- EventContextManager[Response]
- """
- return AsyncEventContextManager(
- self._impl_obj.expect_response(
- urlOrPredicate=self._wrap_handler(url_or_predicate),
- timeout=to_milliseconds(timeout),
- ).future
- )
- def expect_websocket(
- self,
- predicate: typing.Optional[typing.Callable[["WebSocket"], bool]] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> AsyncEventContextManager["WebSocket"]:
- """Page.expect_websocket
- Performs action and waits for a new `WebSocket`. If predicate is provided, it passes `WebSocket` value into the
- `predicate` function and waits for `predicate(webSocket)` to return a truthy value. Will throw an error if the page
- is closed before the WebSocket event is fired.
- Parameters
- ----------
- predicate : Union[Callable[[WebSocket], bool], None]
- Receives the `WebSocket` object and resolves to truthy value when the waiting should resolve.
- timeout : Union[float, None]
- Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The
- default value can be changed by using the `browser_context.set_default_timeout()`.
- Returns
- -------
- EventContextManager[WebSocket]
- """
- return AsyncEventContextManager(
- self._impl_obj.expect_websocket(
- predicate=self._wrap_handler(predicate),
- timeout=to_milliseconds(timeout),
- ).future
- )
- def expect_worker(
- self,
- predicate: typing.Optional[typing.Callable[["Worker"], bool]] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> AsyncEventContextManager["Worker"]:
- """Page.expect_worker
- Performs action and waits for a new `Worker`. If predicate is provided, it passes `Worker` value into the
- `predicate` function and waits for `predicate(worker)` to return a truthy value. Will throw an error if the page is
- closed before the worker event is fired.
- Parameters
- ----------
- predicate : Union[Callable[[Worker], bool], None]
- Receives the `Worker` object and resolves to truthy value when the waiting should resolve.
- timeout : Union[float, None]
- Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The
- default value can be changed by using the `browser_context.set_default_timeout()`.
- Returns
- -------
- EventContextManager[Worker]
- """
- return AsyncEventContextManager(
- self._impl_obj.expect_worker(
- predicate=self._wrap_handler(predicate),
- timeout=to_milliseconds(timeout),
- ).future
- )
- async def set_checked(
- self,
- selector: str,
- checked: bool,
- *,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- strict: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """Page.set_checked
- This method checks or unchecks an element matching `selector` by performing the following steps:
- 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
- 1. Ensure that matched element is a checkbox or a radio input. If not, this method throws.
- 1. If the element already has the right checked state, this method returns immediately.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If
- the element is detached during the checks, the whole action is retried.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to click in the center of the element.
- 1. Ensure that the element is now checked or unchecked. If not, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- Parameters
- ----------
- selector : str
- A selector to search for an element. If there are multiple elements satisfying the selector, the first will be
- used.
- checked : bool
- Whether to check or uncheck the checkbox.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- strict : Union[bool, None]
- When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
- element, the call throws an exception.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.set_checked(
- selector=selector,
- checked=checked,
- position=position,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- strict=strict,
- trial=trial,
- )
- )
- async def add_locator_handler(
- self,
- locator: "Locator",
- handler: typing.Union[
- typing.Callable[["Locator"], typing.Any], typing.Callable[[], typing.Any]
- ],
- *,
- no_wait_after: typing.Optional[bool] = None,
- times: typing.Optional[int] = None,
- ) -> None:
- """Page.add_locator_handler
- When testing a web page, sometimes unexpected overlays like a \"Sign up\" dialog appear and block actions you want to
- automate, e.g. clicking a button. These overlays don't always show up in the same way or at the same time, making
- them tricky to handle in automated tests.
- This method lets you set up a special function, called a handler, that activates when it detects that overlay is
- visible. The handler's job is to remove the overlay, allowing your test to continue as if the overlay wasn't there.
- Things to keep in mind:
- - When an overlay is shown predictably, we recommend explicitly waiting for it in your test and dismissing it as
- a part of your normal test flow, instead of using `page.add_locator_handler()`.
- - Playwright checks for the overlay every time before executing or retrying an action that requires an
- [actionability check](https://playwright.dev/python/docs/actionability), or before performing an auto-waiting assertion check. When overlay
- is visible, Playwright calls the handler first, and then proceeds with the action/assertion. Note that the
- handler is only called when you perform an action/assertion - if the overlay becomes visible but you don't
- perform any actions, the handler will not be triggered.
- - After executing the handler, Playwright will ensure that overlay that triggered the handler is not visible
- anymore. You can opt-out of this behavior with `noWaitAfter`.
- - The execution time of the handler counts towards the timeout of the action/assertion that executed the handler.
- If your handler takes too long, it might cause timeouts.
- - You can register multiple handlers. However, only a single handler will be running at a time. Make sure the
- actions within a handler don't depend on another handler.
- **NOTE** Running the handler will alter your page state mid-test. For example it will change the currently focused
- element and move the mouse. Make sure that actions that run after the handler are self-contained and do not rely on
- the focus and mouse state being unchanged.
- For example, consider a test that calls `locator.focus()` followed by `keyboard.press()`. If your
- handler clicks a button between these two actions, the focused element most likely will be wrong, and key press
- will happen on the unexpected element. Use `locator.press()` instead to avoid this problem.
- Another example is a series of mouse actions, where `mouse.move()` is followed by `mouse.down()`.
- Again, when the handler runs between these two actions, the mouse position will be wrong during the mouse down.
- Prefer self-contained actions like `locator.click()` that do not rely on the state being unchanged by a
- handler.
- **Usage**
- An example that closes a \"Sign up to the newsletter\" dialog when it appears:
- ```py
- # Setup the handler.
- def handler():
- page.get_by_role(\"button\", name=\"No thanks\").click()
- page.add_locator_handler(page.get_by_text(\"Sign up to the newsletter\"), handler)
- # Write the test as usual.
- page.goto(\"https://example.com\")
- page.get_by_role(\"button\", name=\"Start here\").click()
- ```
- An example that skips the \"Confirm your security details\" page when it is shown:
- ```py
- # Setup the handler.
- def handler():
- page.get_by_role(\"button\", name=\"Remind me later\").click()
- page.add_locator_handler(page.get_by_text(\"Confirm your security details\"), handler)
- # Write the test as usual.
- page.goto(\"https://example.com\")
- page.get_by_role(\"button\", name=\"Start here\").click()
- ```
- An example with a custom callback on every actionability check. It uses a `<body>` locator that is always visible,
- so the handler is called before every actionability check. It is important to specify `noWaitAfter`, because the
- handler does not hide the `<body>` element.
- ```py
- # Setup the handler.
- def handler():
- page.evaluate(\"window.removeObstructionsForTestIfNeeded()\")
- page.add_locator_handler(page.locator(\"body\"), handler, no_wait_after=True)
- # Write the test as usual.
- page.goto(\"https://example.com\")
- page.get_by_role(\"button\", name=\"Start here\").click()
- ```
- Handler takes the original locator as an argument. You can also automatically remove the handler after a number of
- invocations by setting `times`:
- ```py
- def handler(locator):
- locator.click()
- page.add_locator_handler(page.get_by_label(\"Close\"), handler, times=1)
- ```
- Parameters
- ----------
- locator : Locator
- Locator that triggers the handler.
- handler : Union[Callable[[Locator], Any], Callable[[], Any]]
- Function that should be run once `locator` appears. This function should get rid of the element that blocks actions
- like click.
- no_wait_after : Union[bool, None]
- By default, after calling the handler Playwright will wait until the overlay becomes hidden, and only then
- Playwright will continue with the action/assertion that triggered the handler. This option allows to opt-out of
- this behavior, so that overlay can stay visible after the handler has run.
- times : Union[int, None]
- Specifies the maximum number of times this handler should be called. Unlimited by default.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.add_locator_handler(
- locator=locator._impl_obj,
- handler=self._wrap_handler(handler),
- noWaitAfter=no_wait_after,
- times=times,
- )
- )
- async def remove_locator_handler(self, locator: "Locator") -> None:
- """Page.remove_locator_handler
- Removes all locator handlers added by `page.add_locator_handler()` for a specific locator.
- Parameters
- ----------
- locator : Locator
- Locator passed to `page.add_locator_handler()`.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.remove_locator_handler(locator=locator._impl_obj)
- )
- async def requests(self) -> typing.List["Request"]:
- """Page.requests
- Returns up to (currently) 100 last network request from this page. See `page.on('request')` for more details.
- Returned requests should be accessed immediately, otherwise they might be collected to prevent unbounded memory
- growth as new requests come in. Once collected, retrieving most information about the request is impossible.
- Note that requests reported through the `page.on('request')` request are not collected, so there is a trade off
- between efficient memory usage with `page.requests()` and the amount of available information reported
- through `page.on('request')`.
- Returns
- -------
- List[Request]
- """
- return mapping.from_impl_list(await self._impl_obj.requests())
- async def console_messages(
- self, *, filter: typing.Optional[Literal["all", "since-navigation"]] = None
- ) -> typing.List["ConsoleMessage"]:
- """Page.console_messages
- Returns up to (currently) 200 last console messages from this page. See `page.on('console')` for more details.
- Parameters
- ----------
- filter : Union["all", "since-navigation", None]
- Controls which messages are returned:
- Returns
- -------
- List[ConsoleMessage]
- """
- return mapping.from_impl_list(
- await self._impl_obj.console_messages(filter=filter)
- )
- async def page_errors(
- self, *, filter: typing.Optional[Literal["all", "since-navigation"]] = None
- ) -> typing.List["Error"]:
- """Page.page_errors
- Returns up to (currently) 200 last page errors from this page. See `page.on('page_error')` for more details.
- Parameters
- ----------
- filter : Union["all", "since-navigation", None]
- Controls which errors are returned:
- Returns
- -------
- List[Error]
- """
- return mapping.from_impl_list(await self._impl_obj.page_errors(filter=filter))
- async def clear_console_messages(self) -> None:
- """Page.clear_console_messages
- Clears all stored console messages from this page. Subsequent calls to `page.console_messages()` will only
- return messages logged after the clear.
- """
- return mapping.from_maybe_impl(await self._impl_obj.clear_console_messages())
- async def clear_page_errors(self) -> None:
- """Page.clear_page_errors
- Clears all stored page errors from this page. Subsequent calls to `page.page_errors()` will only return
- errors thrown after the clear.
- """
- return mapping.from_maybe_impl(await self._impl_obj.clear_page_errors())
- async def pick_locator(self) -> "Locator":
- """Page.pick_locator
- Enters pick locator mode where hovering over page elements highlights them and shows the corresponding locator.
- Once the user clicks an element, the mode is deactivated and the `Locator` for the picked element is returned.
- **Usage**
- ```py
- locator = await page.pick_locator()
- print(locator)
- ```
- Returns
- -------
- Locator
- """
- return mapping.from_impl(await self._impl_obj.pick_locator())
- async def cancel_pick_locator(self) -> None:
- """Page.cancel_pick_locator
- Cancels an ongoing `page.pick_locator()` call by deactivating pick locator mode. If no pick locator mode is
- active, this method is a no-op.
- """
- return mapping.from_maybe_impl(await self._impl_obj.cancel_pick_locator())
- mapping.register(PageImpl, Page)
- class WebError(AsyncBase):
- @property
- def page(self) -> typing.Optional["Page"]:
- """WebError.page
- The page that produced this unhandled exception, if any.
- Returns
- -------
- Union[Page, None]
- """
- return mapping.from_impl_nullable(self._impl_obj.page)
- @property
- def error(self) -> "Error":
- """WebError.error
- Unhandled error that was thrown.
- Returns
- -------
- Error
- """
- return mapping.from_impl(self._impl_obj.error)
- @property
- def location(self) -> WebErrorLocation:
- """WebError.location
- Returns
- -------
- {url: str, line: int, column: int}
- """
- return mapping.from_impl(self._impl_obj.location)
- mapping.register(WebErrorImpl, WebError)
- class BrowserContext(AsyncContextManager):
- @typing.overload
- def on(
- self,
- event: Literal["backgroundpage"],
- f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- This event is not emitted."""
- @typing.overload
- def on(
- self,
- event: Literal["close"],
- f: typing.Callable[
- ["BrowserContext"], "typing.Union[typing.Awaitable[None], None]"
- ],
- ) -> None:
- """
- Emitted when Browser context gets closed. This might happen because of one of the following:
- - Browser context is closed.
- - Browser application is closed or crashed.
- - The `browser.close()` method was called."""
- @typing.overload
- def on(
- self,
- event: Literal["console"],
- f: typing.Callable[
- ["ConsoleMessage"], "typing.Union[typing.Awaitable[None], None]"
- ],
- ) -> None:
- """
- Emitted when JavaScript within the page calls one of console API methods, e.g. `console.log` or `console.dir`.
- The arguments passed into `console.log` and the page are available on the `ConsoleMessage` event handler argument.
- **Usage**
- ```py
- async def print_args(msg):
- values = []
- for arg in msg.args:
- values.append(await arg.json_value())
- print(values)
- context.on(\"console\", print_args)
- await page.evaluate(\"console.log('hello', 5, { foo: 'bar' })\")
- ```"""
- @typing.overload
- def on(
- self,
- event: Literal["dialog"],
- f: typing.Callable[["Dialog"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a JavaScript dialog appears, such as `alert`, `prompt`, `confirm` or `beforeunload`. Listener **must**
- either `dialog.accept()` or `dialog.dismiss()` the dialog - otherwise the page will
- [freeze](https://developer.mozilla.org/en-US/docs/Web/JavaScript/EventLoop#never_blocking) waiting for the dialog,
- and actions like click will never finish.
- **Usage**
- ```python
- context.on(\"dialog\", lambda dialog: dialog.accept())
- ```
- **NOTE** When no `page.on('dialog')` or `browser_context.on('dialog')` listeners are present, all dialogs are
- automatically dismissed."""
- @typing.overload
- def on(
- self,
- event: Literal["download"],
- f: typing.Callable[["Download"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when attachment download started in any page belonging to this context. User can access basic file
- operations on downloaded content via the passed `Download` instance. See also `page.on('download')` to receive
- events about a specific page."""
- @typing.overload
- def on(
- self,
- event: Literal["frameattached"],
- f: typing.Callable[["Frame"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a frame is attached in any page belonging to this context. See also `page.on('frame_attached')` to
- receive events about a specific page."""
- @typing.overload
- def on(
- self,
- event: Literal["framedetached"],
- f: typing.Callable[["Frame"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a frame is detached in any page belonging to this context. See also `page.on('frame_detached')` to
- receive events about a specific page."""
- @typing.overload
- def on(
- self,
- event: Literal["framenavigated"],
- f: typing.Callable[["Frame"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a frame is navigated to a new url in any page belonging to this context. See also
- `page.on('frame_navigated')` to receive events about navigations in a specific page.
- """
- @typing.overload
- def on(
- self,
- event: Literal["page"],
- f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- The event is emitted when a new Page is created in the BrowserContext. The page may still be loading. The event
- will also fire for popup pages. See also `page.on('popup')` to receive events about popups relevant to a
- specific page.
- The earliest moment that page is available is when it has navigated to the initial url. For example, when opening a
- popup with `window.open('http://example.com')`, this event will fire when the network request to
- \"http://example.com\" is done and its response has started loading in the popup. If you would like to route/listen
- to this network request, use `browser_context.route()` and `browser_context.on('request')` respectively
- instead of similar methods on the `Page`.
- ```py
- async with context.expect_page() as page_info:
- await page.get_by_text(\"open new page\").click(),
- page = await page_info.value
- print(await page.evaluate(\"location.href\"))
- ```
- **NOTE** Use `page.wait_for_load_state()` to wait until the page gets to a particular state (you should not
- need it in most cases)."""
- @typing.overload
- def on(
- self,
- event: Literal["pageclose"],
- f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a page in this context is closed. See also `page.on('close')` to receive events about a specific
- page."""
- @typing.overload
- def on(
- self,
- event: Literal["pageload"],
- f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when the JavaScript [`load`](https://developer.mozilla.org/en-US/docs/Web/Events/load) event is dispatched
- in any page belonging to this context. See also `page.on('load')` to receive events about a specific page.
- """
- @typing.overload
- def on(
- self,
- event: Literal["weberror"],
- f: typing.Callable[["WebError"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when exception is unhandled in any of the pages in this context. To listen for errors from a particular
- page, use `page.on('page_error')` instead."""
- @typing.overload
- def on(
- self,
- event: Literal["request"],
- f: typing.Callable[["Request"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a request is issued from any pages created through this context. The [request] object is read-only. To
- only listen for requests from a particular page, use `page.on('request')`.
- In order to intercept and mutate requests, see `browser_context.route()` or `page.route()`.
- """
- @typing.overload
- def on(
- self,
- event: Literal["requestfailed"],
- f: typing.Callable[["Request"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a request fails, for example by timing out. To only listen for failed requests from a particular page,
- use `page.on('request_failed')`.
- **NOTE** HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request
- will complete with `browser_context.on('request_finished')` event and not with
- `browser_context.on('request_failed')`."""
- @typing.overload
- def on(
- self,
- event: Literal["requestfinished"],
- f: typing.Callable[["Request"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a request finishes successfully after downloading the response body. For a successful response, the
- sequence of events is `request`, `response` and `requestfinished`. To listen for successful requests from a
- particular page, use `page.on('request_finished')`."""
- @typing.overload
- def on(
- self,
- event: Literal["response"],
- f: typing.Callable[["Response"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when [response] status and headers are received for a request. For a successful response, the sequence of
- events is `request`, `response` and `requestfinished`. To listen for response events from a particular page, use
- `page.on('response')`."""
- @typing.overload
- def on(
- self,
- event: Literal["serviceworker"],
- f: typing.Callable[["Worker"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- **NOTE** Service workers are only supported on Chromium-based browsers.
- Emitted when new service worker is created in the context."""
- def on(
- self,
- event: str,
- f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]],
- ) -> None:
- return super().on(event=event, f=f)
- @typing.overload
- def once(
- self,
- event: Literal["backgroundpage"],
- f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- This event is not emitted."""
- @typing.overload
- def once(
- self,
- event: Literal["close"],
- f: typing.Callable[
- ["BrowserContext"], "typing.Union[typing.Awaitable[None], None]"
- ],
- ) -> None:
- """
- Emitted when Browser context gets closed. This might happen because of one of the following:
- - Browser context is closed.
- - Browser application is closed or crashed.
- - The `browser.close()` method was called."""
- @typing.overload
- def once(
- self,
- event: Literal["console"],
- f: typing.Callable[
- ["ConsoleMessage"], "typing.Union[typing.Awaitable[None], None]"
- ],
- ) -> None:
- """
- Emitted when JavaScript within the page calls one of console API methods, e.g. `console.log` or `console.dir`.
- The arguments passed into `console.log` and the page are available on the `ConsoleMessage` event handler argument.
- **Usage**
- ```py
- async def print_args(msg):
- values = []
- for arg in msg.args:
- values.append(await arg.json_value())
- print(values)
- context.on(\"console\", print_args)
- await page.evaluate(\"console.log('hello', 5, { foo: 'bar' })\")
- ```"""
- @typing.overload
- def once(
- self,
- event: Literal["dialog"],
- f: typing.Callable[["Dialog"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a JavaScript dialog appears, such as `alert`, `prompt`, `confirm` or `beforeunload`. Listener **must**
- either `dialog.accept()` or `dialog.dismiss()` the dialog - otherwise the page will
- [freeze](https://developer.mozilla.org/en-US/docs/Web/JavaScript/EventLoop#never_blocking) waiting for the dialog,
- and actions like click will never finish.
- **Usage**
- ```python
- context.on(\"dialog\", lambda dialog: dialog.accept())
- ```
- **NOTE** When no `page.on('dialog')` or `browser_context.on('dialog')` listeners are present, all dialogs are
- automatically dismissed."""
- @typing.overload
- def once(
- self,
- event: Literal["download"],
- f: typing.Callable[["Download"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when attachment download started in any page belonging to this context. User can access basic file
- operations on downloaded content via the passed `Download` instance. See also `page.on('download')` to receive
- events about a specific page."""
- @typing.overload
- def once(
- self,
- event: Literal["frameattached"],
- f: typing.Callable[["Frame"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a frame is attached in any page belonging to this context. See also `page.on('frame_attached')` to
- receive events about a specific page."""
- @typing.overload
- def once(
- self,
- event: Literal["framedetached"],
- f: typing.Callable[["Frame"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a frame is detached in any page belonging to this context. See also `page.on('frame_detached')` to
- receive events about a specific page."""
- @typing.overload
- def once(
- self,
- event: Literal["framenavigated"],
- f: typing.Callable[["Frame"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a frame is navigated to a new url in any page belonging to this context. See also
- `page.on('frame_navigated')` to receive events about navigations in a specific page.
- """
- @typing.overload
- def once(
- self,
- event: Literal["page"],
- f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- The event is emitted when a new Page is created in the BrowserContext. The page may still be loading. The event
- will also fire for popup pages. See also `page.on('popup')` to receive events about popups relevant to a
- specific page.
- The earliest moment that page is available is when it has navigated to the initial url. For example, when opening a
- popup with `window.open('http://example.com')`, this event will fire when the network request to
- \"http://example.com\" is done and its response has started loading in the popup. If you would like to route/listen
- to this network request, use `browser_context.route()` and `browser_context.on('request')` respectively
- instead of similar methods on the `Page`.
- ```py
- async with context.expect_page() as page_info:
- await page.get_by_text(\"open new page\").click(),
- page = await page_info.value
- print(await page.evaluate(\"location.href\"))
- ```
- **NOTE** Use `page.wait_for_load_state()` to wait until the page gets to a particular state (you should not
- need it in most cases)."""
- @typing.overload
- def once(
- self,
- event: Literal["pageclose"],
- f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a page in this context is closed. See also `page.on('close')` to receive events about a specific
- page."""
- @typing.overload
- def once(
- self,
- event: Literal["pageload"],
- f: typing.Callable[["Page"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when the JavaScript [`load`](https://developer.mozilla.org/en-US/docs/Web/Events/load) event is dispatched
- in any page belonging to this context. See also `page.on('load')` to receive events about a specific page.
- """
- @typing.overload
- def once(
- self,
- event: Literal["weberror"],
- f: typing.Callable[["WebError"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when exception is unhandled in any of the pages in this context. To listen for errors from a particular
- page, use `page.on('page_error')` instead."""
- @typing.overload
- def once(
- self,
- event: Literal["request"],
- f: typing.Callable[["Request"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a request is issued from any pages created through this context. The [request] object is read-only. To
- only listen for requests from a particular page, use `page.on('request')`.
- In order to intercept and mutate requests, see `browser_context.route()` or `page.route()`.
- """
- @typing.overload
- def once(
- self,
- event: Literal["requestfailed"],
- f: typing.Callable[["Request"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a request fails, for example by timing out. To only listen for failed requests from a particular page,
- use `page.on('request_failed')`.
- **NOTE** HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request
- will complete with `browser_context.on('request_finished')` event and not with
- `browser_context.on('request_failed')`."""
- @typing.overload
- def once(
- self,
- event: Literal["requestfinished"],
- f: typing.Callable[["Request"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when a request finishes successfully after downloading the response body. For a successful response, the
- sequence of events is `request`, `response` and `requestfinished`. To listen for successful requests from a
- particular page, use `page.on('request_finished')`."""
- @typing.overload
- def once(
- self,
- event: Literal["response"],
- f: typing.Callable[["Response"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when [response] status and headers are received for a request. For a successful response, the sequence of
- events is `request`, `response` and `requestfinished`. To listen for response events from a particular page, use
- `page.on('response')`."""
- @typing.overload
- def once(
- self,
- event: Literal["serviceworker"],
- f: typing.Callable[["Worker"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- **NOTE** Service workers are only supported on Chromium-based browsers.
- Emitted when new service worker is created in the context."""
- def once(
- self,
- event: str,
- f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]],
- ) -> None:
- return super().once(event=event, f=f)
- @property
- def pages(self) -> typing.List["Page"]:
- """BrowserContext.pages
- Returns all open pages in the context.
- Returns
- -------
- List[Page]
- """
- return mapping.from_impl_list(self._impl_obj.pages)
- @property
- def browser(self) -> typing.Optional["Browser"]:
- """BrowserContext.browser
- Gets the browser instance that owns the context. Returns `null` if the context is created outside of normal
- browser, e.g. Android or Electron.
- Returns
- -------
- Union[Browser, None]
- """
- return mapping.from_impl_nullable(self._impl_obj.browser)
- @property
- def background_pages(self) -> typing.List["Page"]:
- """BrowserContext.background_pages
- Returns an empty list.
- Returns
- -------
- List[Page]
- """
- return mapping.from_impl_list(self._impl_obj.background_pages)
- @property
- def service_workers(self) -> typing.List["Worker"]:
- """BrowserContext.service_workers
- **NOTE** Service workers are only supported on Chromium-based browsers.
- All existing service workers in the context.
- Returns
- -------
- List[Worker]
- """
- return mapping.from_impl_list(self._impl_obj.service_workers)
- @property
- def tracing(self) -> "Tracing":
- """BrowserContext.tracing
- Returns
- -------
- Tracing
- """
- return mapping.from_impl(self._impl_obj.tracing)
- @property
- def debugger(self) -> "Debugger":
- """BrowserContext.debugger
- Debugger allows to pause and resume the execution.
- Returns
- -------
- Debugger
- """
- return mapping.from_impl(self._impl_obj.debugger)
- @property
- def request(self) -> "APIRequestContext":
- """BrowserContext.request
- API testing helper associated with this context. Requests made with this API will use context cookies.
- Returns
- -------
- APIRequestContext
- """
- return mapping.from_impl(self._impl_obj.request)
- @property
- def clock(self) -> "Clock":
- """BrowserContext.clock
- Playwright has ability to mock clock and passage of time.
- Returns
- -------
- Clock
- """
- return mapping.from_impl(self._impl_obj.clock)
- def set_default_navigation_timeout(
- self, timeout: typing.Union[float, datetime.timedelta]
- ) -> None:
- """BrowserContext.set_default_navigation_timeout
- This setting will change the default maximum navigation time for the following methods and related shortcuts:
- - `page.go_back()`
- - `page.go_forward()`
- - `page.goto()`
- - `page.reload()`
- - `page.set_content()`
- - `page.expect_navigation()`
- **NOTE** `page.set_default_navigation_timeout()` and `page.set_default_timeout()` take priority over
- `browser_context.set_default_navigation_timeout()`.
- Parameters
- ----------
- timeout : float
- Maximum navigation time in milliseconds
- """
- return mapping.from_maybe_impl(
- self._impl_obj.set_default_navigation_timeout(
- timeout=to_milliseconds(timeout)
- )
- )
- def set_default_timeout(
- self, timeout: typing.Union[float, datetime.timedelta]
- ) -> None:
- """BrowserContext.set_default_timeout
- This setting will change the default maximum time for all the methods accepting `timeout` option.
- **NOTE** `page.set_default_navigation_timeout()`, `page.set_default_timeout()` and
- `browser_context.set_default_navigation_timeout()` take priority over
- `browser_context.set_default_timeout()`.
- Parameters
- ----------
- timeout : float
- Maximum time in milliseconds. Pass `0` to disable timeout.
- """
- return mapping.from_maybe_impl(
- self._impl_obj.set_default_timeout(timeout=to_milliseconds(timeout))
- )
- async def new_page(self) -> "Page":
- """BrowserContext.new_page
- Creates a new page in the browser context.
- Returns
- -------
- Page
- """
- return mapping.from_impl(await self._impl_obj.new_page())
- async def cookies(
- self, urls: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None
- ) -> typing.List[Cookie]:
- """BrowserContext.cookies
- If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those
- URLs are returned.
- Parameters
- ----------
- urls : Union[Sequence[str], str, None]
- Optional list of URLs.
- Returns
- -------
- List[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"], partitionKey: Union[str, None]}]
- """
- return mapping.from_impl_list(
- await self._impl_obj.cookies(urls=mapping.to_impl(urls))
- )
- async def add_cookies(self, cookies: typing.Sequence[SetCookieParam]) -> None:
- """BrowserContext.add_cookies
- Adds cookies into this browser context. All pages within this context will have these cookies installed. Cookies
- can be obtained via `browser_context.cookies()`.
- **Usage**
- ```py
- await browser_context.add_cookies([cookie_object1, cookie_object2])
- ```
- Parameters
- ----------
- cookies : Sequence[{name: str, value: str, url: Union[str, None], domain: Union[str, None], path: Union[str, None], expires: Union[float, None], httpOnly: Union[bool, None], secure: Union[bool, None], sameSite: Union["Lax", "None", "Strict", None], partitionKey: Union[str, None]}]
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.add_cookies(cookies=mapping.to_impl(cookies))
- )
- async def clear_cookies(
- self,
- *,
- name: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- domain: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- path: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- ) -> None:
- """BrowserContext.clear_cookies
- Removes cookies from context. Accepts optional filter.
- **Usage**
- ```py
- await context.clear_cookies()
- await context.clear_cookies(name=\"session-id\")
- await context.clear_cookies(domain=\"my-origin.com\")
- await context.clear_cookies(path=\"/api/v1\")
- await context.clear_cookies(name=\"session-id\", domain=\"my-origin.com\")
- ```
- Parameters
- ----------
- name : Union[Pattern[str], str, None]
- Only removes cookies with the given name.
- domain : Union[Pattern[str], str, None]
- Only removes cookies with the given domain.
- path : Union[Pattern[str], str, None]
- Only removes cookies with the given path.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.clear_cookies(name=name, domain=domain, path=path)
- )
- async def grant_permissions(
- self, permissions: typing.Sequence[str], *, origin: typing.Optional[str] = None
- ) -> None:
- """BrowserContext.grant_permissions
- Grants specified permissions to the browser context. Only grants corresponding permissions to the given origin if
- specified.
- Parameters
- ----------
- permissions : Sequence[str]
- A list of permissions to grant.
- **NOTE** Supported permissions differ between browsers, and even between different versions of the same browser.
- Any permission may stop working after an update.
- Here are some permissions that may be supported by some browsers:
- - `'accelerometer'`
- - `'ambient-light-sensor'`
- - `'background-sync'`
- - `'camera'`
- - `'clipboard-read'`
- - `'clipboard-write'`
- - `'geolocation'`
- - `'gyroscope'`
- - `'local-fonts'`
- - `'local-network-access'`
- - `'magnetometer'`
- - `'microphone'`
- - `'midi-sysex'` (system-exclusive midi)
- - `'midi'`
- - `'notifications'`
- - `'payment-handler'`
- - `'storage-access'`
- - `'screen-wake-lock'`
- origin : Union[str, None]
- The [origin] to grant permissions to, e.g. "https://example.com".
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.grant_permissions(
- permissions=mapping.to_impl(permissions), origin=origin
- )
- )
- async def clear_permissions(self) -> None:
- """BrowserContext.clear_permissions
- Clears all permission overrides for the browser context.
- **Usage**
- ```py
- context = await browser.new_context()
- await context.grant_permissions([\"clipboard-read\"])
- # do stuff ..
- context.clear_permissions()
- ```
- """
- return mapping.from_maybe_impl(await self._impl_obj.clear_permissions())
- async def set_geolocation(
- self, geolocation: typing.Optional[Geolocation] = None
- ) -> None:
- """BrowserContext.set_geolocation
- Sets the context's geolocation. Passing `null` or `undefined` emulates position unavailable.
- **Usage**
- ```py
- await browser_context.set_geolocation({\"latitude\": 59.95, \"longitude\": 30.31667})
- ```
- **NOTE** Consider using `browser_context.grant_permissions()` to grant permissions for the browser context
- pages to read its geolocation.
- Parameters
- ----------
- geolocation : Union[{latitude: float, longitude: float, accuracy: Union[float, None]}, None]
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.set_geolocation(geolocation=geolocation)
- )
- async def set_extra_http_headers(self, headers: typing.Dict[str, str]) -> None:
- """BrowserContext.set_extra_http_headers
- The extra HTTP headers will be sent with every request initiated by any page in the context. These headers are
- merged with page-specific extra HTTP headers set with `page.set_extra_http_headers()`. If page overrides a
- particular header, page-specific header value will be used instead of the browser context header value.
- **NOTE** `browser_context.set_extra_http_headers()` does not guarantee the order of headers in the outgoing
- requests.
- Parameters
- ----------
- headers : Dict[str, str]
- An object containing additional HTTP headers to be sent with every request. All header values must be strings.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.set_extra_http_headers(
- headers=mapping.to_impl(headers)
- )
- )
- async def set_offline(self, offline: bool) -> None:
- """BrowserContext.set_offline
- Parameters
- ----------
- offline : bool
- Whether to emulate network being offline for the browser context.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.set_offline(offline=offline)
- )
- async def add_init_script(
- self,
- script: typing.Optional[str] = None,
- *,
- path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- ) -> "AsyncContextManager":
- """BrowserContext.add_init_script
- Adds a script which would be evaluated in one of the following scenarios:
- - Whenever a page is created in the browser context or is navigated.
- - Whenever a child frame is attached or navigated in any page in the browser context. In this case, the script is
- evaluated in the context of the newly attached frame.
- The script is evaluated after the document was created but before any of its scripts were run. This is useful to
- amend the JavaScript environment, e.g. to seed `Math.random`.
- **Usage**
- An example of overriding `Math.random` before the page loads:
- ```py
- # in your playwright script, assuming the preload.js file is in same directory.
- await browser_context.add_init_script(path=\"preload.js\")
- ```
- **NOTE** The order of evaluation of multiple scripts installed via `browser_context.add_init_script()` and
- `page.add_init_script()` is not defined.
- Parameters
- ----------
- script : Union[str, None]
- Script to be evaluated in all pages in the browser context. Optional.
- path : Union[pathlib.Path, str, None]
- Path to the JavaScript file. If `path` is a relative path, then it is resolved relative to the current working
- directory. Optional.
- Returns
- -------
- AsyncContextManager
- """
- return mapping.from_impl(
- await self._impl_obj.add_init_script(script=script, path=path)
- )
- async def expose_binding(
- self, name: str, callback: typing.Callable
- ) -> "AsyncContextManager":
- """BrowserContext.expose_binding
- The method adds a function called `name` on the `window` object of every frame in every page in the context. When
- called, the function executes `callback` and returns a [Promise] which resolves to the return value of `callback`.
- If the `callback` returns a [Promise], it will be awaited.
- The first argument of the `callback` function contains information about the caller: `{ browserContext:
- BrowserContext, page: Page, frame: Frame }`.
- See `page.expose_binding()` for page-only version.
- **Usage**
- An example of exposing page URL to all frames in all pages in the context:
- ```py
- import asyncio
- from playwright.async_api import async_playwright, Playwright
- async def run(playwright: Playwright):
- webkit = playwright.webkit
- browser = await webkit.launch(headless=False)
- context = await browser.new_context()
- await context.expose_binding(\"pageURL\", lambda source: source[\"page\"].url)
- page = await context.new_page()
- await page.set_content(\"\"\"
- <script>
- async function onClick() {
- document.querySelector('div').textContent = await window.pageURL();
- }
- </script>
- <button onclick=\"onClick()\">Click me</button>
- <div></div>
- \"\"\")
- await page.get_by_role(\"button\").click()
- async def main():
- async with async_playwright() as playwright:
- await run(playwright)
- asyncio.run(main())
- ```
- Parameters
- ----------
- name : str
- Name of the function on the window object.
- callback : Callable
- Callback function that will be called in the Playwright's context.
- Returns
- -------
- AsyncContextManager
- """
- return mapping.from_impl(
- await self._impl_obj.expose_binding(
- name=name, callback=self._wrap_handler(callback)
- )
- )
- async def expose_function(
- self, name: str, callback: typing.Callable
- ) -> "AsyncContextManager":
- """BrowserContext.expose_function
- The method adds a function called `name` on the `window` object of every frame in every page in the context. When
- called, the function executes `callback` and returns a [Promise] which resolves to the return value of `callback`.
- If the `callback` returns a [Promise], it will be awaited.
- See `page.expose_function()` for page-only version.
- **Usage**
- An example of adding a `sha256` function to all pages in the context:
- ```py
- import asyncio
- import hashlib
- from playwright.async_api import async_playwright, Playwright
- def sha256(text: str) -> str:
- m = hashlib.sha256()
- m.update(bytes(text, \"utf8\"))
- return m.hexdigest()
- async def run(playwright: Playwright):
- webkit = playwright.webkit
- browser = await webkit.launch(headless=False)
- context = await browser.new_context()
- await context.expose_function(\"sha256\", sha256)
- page = await context.new_page()
- await page.set_content(\"\"\"
- <script>
- async function onClick() {
- document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');
- }
- </script>
- <button onclick=\"onClick()\">Click me</button>
- <div></div>
- \"\"\")
- await page.get_by_role(\"button\").click()
- async def main():
- async with async_playwright() as playwright:
- await run(playwright)
- asyncio.run(main())
- ```
- Parameters
- ----------
- name : str
- Name of the function on the window object.
- callback : Callable
- Callback function that will be called in the Playwright's context.
- Returns
- -------
- AsyncContextManager
- """
- return mapping.from_impl(
- await self._impl_obj.expose_function(
- name=name, callback=self._wrap_handler(callback)
- )
- )
- async def route(
- self,
- url: typing.Union[str, typing.Pattern[str], typing.Callable[[str], bool]],
- handler: typing.Union[
- typing.Callable[["Route"], typing.Any],
- typing.Callable[["Route", "Request"], typing.Any],
- ],
- *,
- times: typing.Optional[int] = None,
- ) -> "AsyncContextManager":
- """BrowserContext.route
- Routing provides the capability to modify network requests that are made by any page in the browser context. Once
- route is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted.
- **NOTE** `browser_context.route()` will not intercept requests intercepted by Service Worker. See
- [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when
- using request interception by setting `serviceWorkers` to `'block'`.
- **Usage**
- An example of a naive handler that aborts all image requests:
- ```py
- context = await browser.new_context()
- page = await context.new_page()
- await context.route(\"**/*.{png,jpg,jpeg}\", lambda route: route.abort())
- await page.goto(\"https://example.com\")
- await browser.close()
- ```
- or the same snippet using a regex pattern instead:
- ```py
- context = await browser.new_context()
- page = await context.new_page()
- await context.route(re.compile(r\"(\\.png$)|(\\.jpg$)\"), lambda route: route.abort())
- page = await context.new_page()
- await page.goto(\"https://example.com\")
- await browser.close()
- ```
- It is possible to examine the request to decide the route action. For example, mocking all requests that contain
- some post data, and leaving all other requests as is:
- ```py
- async def handle_route(route: Route):
- if (\"my-string\" in route.request.post_data):
- await route.fulfill(body=\"mocked-data\")
- else:
- await route.continue_()
- await context.route(\"/api/**\", handle_route)
- ```
- Page routes (set up with `page.route()`) take precedence over browser context routes when request matches
- both handlers.
- To remove a route with its handler you can use `browser_context.unroute()`.
- **NOTE** Enabling routing disables http cache.
- Parameters
- ----------
- url : Union[Callable[[str], bool], Pattern[str], str]
- A glob pattern, regex pattern, or predicate that receives a [URL] to match during routing. If `baseURL` is set in
- the context options and the provided URL is a string that does not start with `*`, it is resolved using the
- [`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor.
- handler : Union[Callable[[Route, Request], Any], Callable[[Route], Any]]
- handler function to route the request.
- times : Union[int, None]
- How often a route should be used. By default it will be used every time.
- Returns
- -------
- AsyncContextManager
- """
- return mapping.from_impl(
- await self._impl_obj.route(
- url=self._wrap_handler(url),
- handler=self._wrap_handler(handler),
- times=times,
- )
- )
- async def unroute(
- self,
- url: typing.Union[str, typing.Pattern[str], typing.Callable[[str], bool]],
- handler: typing.Optional[
- typing.Union[
- typing.Callable[["Route"], typing.Any],
- typing.Callable[["Route", "Request"], typing.Any],
- ]
- ] = None,
- ) -> None:
- """BrowserContext.unroute
- Removes a route created with `browser_context.route()`. When `handler` is not specified, removes all routes
- for the `url`.
- Parameters
- ----------
- url : Union[Callable[[str], bool], Pattern[str], str]
- A glob pattern, regex pattern, or predicate receiving [URL] used to register a routing with
- `browser_context.route()`.
- handler : Union[Callable[[Route, Request], Any], Callable[[Route], Any], None]
- Optional handler function used to register a routing with `browser_context.route()`.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.unroute(
- url=self._wrap_handler(url), handler=self._wrap_handler(handler)
- )
- )
- async def route_web_socket(
- self,
- url: typing.Union[str, typing.Pattern[str], typing.Callable[[str], bool]],
- handler: typing.Callable[["WebSocketRoute"], typing.Any],
- ) -> None:
- """BrowserContext.route_web_socket
- This method allows to modify websocket connections that are made by any page in the browser context.
- Note that only `WebSocket`s created after this method was called will be routed. It is recommended to call this
- method before creating any pages.
- **Usage**
- Below is an example of a simple handler that blocks some websocket messages. See `WebSocketRoute` for more details
- and examples.
- ```py
- def message_handler(ws: WebSocketRoute, message: Union[str, bytes]):
- if message == \"to-be-blocked\":
- return
- ws.send(message)
- async def handler(ws: WebSocketRoute):
- ws.route_send(lambda message: message_handler(ws, message))
- await ws.connect()
- await context.route_web_socket(\"/ws\", handler)
- ```
- Parameters
- ----------
- url : Union[Callable[[str], bool], Pattern[str], str]
- Only WebSockets with the url matching this pattern will be routed. A string pattern can be relative to the
- `baseURL` context option.
- handler : Callable[[WebSocketRoute], Any]
- Handler function to route the WebSocket.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.route_web_socket(
- url=self._wrap_handler(url), handler=self._wrap_handler(handler)
- )
- )
- async def unroute_all(
- self,
- *,
- behavior: typing.Optional[Literal["default", "ignoreErrors", "wait"]] = None,
- ) -> None:
- """BrowserContext.unroute_all
- Removes all routes created with `browser_context.route()` and `browser_context.route_from_har()`.
- Parameters
- ----------
- behavior : Union["default", "ignoreErrors", "wait", None]
- Specifies whether to wait for already running handlers and what to do if they throw errors:
- - `'default'` - do not wait for current handler calls (if any) to finish, if unrouted handler throws, it may
- result in unhandled error
- - `'wait'` - wait for current handler calls (if any) to finish
- - `'ignoreErrors'` - do not wait for current handler calls (if any) to finish, all errors thrown by the handlers
- after unrouting are silently caught
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.unroute_all(behavior=behavior)
- )
- async def route_from_har(
- self,
- har: typing.Union[pathlib.Path, str],
- *,
- url: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- not_found: typing.Optional[Literal["abort", "fallback"]] = None,
- update: typing.Optional[bool] = None,
- update_content: typing.Optional[Literal["attach", "embed"]] = None,
- update_mode: typing.Optional[Literal["full", "minimal"]] = None,
- ) -> None:
- """BrowserContext.route_from_har
- If specified the network requests that are made in the context will be served from the HAR file. Read more about
- [Replaying from HAR](https://playwright.dev/python/docs/mock#replaying-from-har).
- Playwright will not serve requests intercepted by Service Worker from the HAR file. See
- [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when
- using request interception by setting `serviceWorkers` to `'block'`.
- Parameters
- ----------
- har : Union[pathlib.Path, str]
- Path to a [HAR](http://www.softwareishard.com/blog/har-12-spec) file with prerecorded network data. If `path` is a
- relative path, then it is resolved relative to the current working directory.
- url : Union[Pattern[str], str, None]
- A glob pattern, regular expression or predicate to match the request URL. Only requests with URL matching the
- pattern will be served from the HAR file. If not specified, all requests are served from the HAR file.
- not_found : Union["abort", "fallback", None]
- - If set to 'abort' any request not found in the HAR file will be aborted.
- - If set to 'fallback' falls through to the next route handler in the handler chain.
- Defaults to abort.
- update : Union[bool, None]
- If specified, updates the given HAR with the actual network information instead of serving from file. The file is
- written to disk when `browser_context.close()` is called.
- update_content : Union["attach", "embed", None]
- Optional setting to control resource content management. If `attach` is specified, resources are persisted as
- separate files or entries in the ZIP archive. If `embed` is specified, content is stored inline the HAR file.
- update_mode : Union["full", "minimal", None]
- When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page,
- cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to
- `minimal`.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.route_from_har(
- har=har,
- url=url,
- notFound=not_found,
- update=update,
- updateContent=update_content,
- updateMode=update_mode,
- )
- )
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["backgroundpage"],
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Page"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["close"],
- predicate: typing.Optional[typing.Callable[["BrowserContext"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["BrowserContext"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["console"],
- predicate: typing.Optional[typing.Callable[["ConsoleMessage"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["ConsoleMessage"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["dialog"],
- predicate: typing.Optional[typing.Callable[["Dialog"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Dialog"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["download"],
- predicate: typing.Optional[typing.Callable[["Download"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Download"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["frameattached"],
- predicate: typing.Optional[typing.Callable[["Frame"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Frame"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["framedetached"],
- predicate: typing.Optional[typing.Callable[["Frame"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Frame"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["framenavigated"],
- predicate: typing.Optional[typing.Callable[["Frame"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Frame"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["page"],
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Page"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["pageclose"],
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Page"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["pageload"],
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Page"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["weberror"],
- predicate: typing.Optional[typing.Callable[["WebError"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["WebError"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["request"],
- predicate: typing.Optional[typing.Callable[["Request"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Request"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["requestfailed"],
- predicate: typing.Optional[typing.Callable[["Request"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Request"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["requestfinished"],
- predicate: typing.Optional[typing.Callable[["Request"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Request"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["response"],
- predicate: typing.Optional[typing.Callable[["Response"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Response"]: ...
- @typing.overload
- def expect_event(
- self,
- event: typing.Literal["serviceworker"],
- predicate: typing.Optional[typing.Callable[["Worker"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager["Worker"]: ...
- @typing.overload
- def expect_event(
- self,
- event: str,
- predicate: typing.Optional[typing.Callable[..., bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> AsyncEventContextManager[typing.Any]: ...
- def expect_event(
- self,
- event: str,
- predicate: typing.Optional[typing.Callable] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> AsyncEventContextManager:
- """BrowserContext.expect_event
- Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy
- value. Will throw an error if the context closes before the event is fired. Returns the event data value.
- **Usage**
- ```py
- async with context.expect_event(\"page\") as event_info:
- await page.get_by_role(\"button\").click()
- page = await event_info.value
- ```
- Parameters
- ----------
- event : str
- Event name, same one would pass into `browserContext.on(event)`.
- predicate : Union[Callable, None]
- Receives the event data and resolves to truthy value when the waiting should resolve.
- timeout : Union[float, None]
- Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The
- default value can be changed by using the `browser_context.set_default_timeout()`.
- Returns
- -------
- EventContextManager
- """
- return AsyncEventContextManager(
- self._impl_obj.expect_event(
- event=event,
- predicate=self._wrap_handler(predicate),
- timeout=to_milliseconds(timeout),
- ).future
- )
- def is_closed(self) -> bool:
- """BrowserContext.is_closed
- Indicates that the browser context is in the process of closing or has already been closed.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(self._impl_obj.is_closed())
- async def close(self, *, reason: typing.Optional[str] = None) -> None:
- """BrowserContext.close
- Closes the browser context. All the pages that belong to the browser context will be closed.
- **NOTE** The default browser context cannot be closed.
- Parameters
- ----------
- reason : Union[str, None]
- The reason to be reported to the operations interrupted by the context closure.
- """
- return mapping.from_maybe_impl(await self._impl_obj.close(reason=reason))
- async def storage_state(
- self,
- *,
- path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- indexed_db: typing.Optional[bool] = None,
- ) -> StorageState:
- """BrowserContext.storage_state
- Returns storage state for this browser context, contains current cookies, local storage snapshot and IndexedDB
- snapshot.
- Parameters
- ----------
- path : Union[pathlib.Path, str, None]
- The file path to save the storage state to. If `path` is a relative path, then it is resolved relative to current
- working directory. If no path is provided, storage state is still returned, but won't be saved to the disk.
- indexed_db : Union[bool, None]
- Set to `true` to include [IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) in the storage
- state snapshot. If your application uses IndexedDB to store authentication tokens, like Firebase Authentication,
- enable this.
- Returns
- -------
- {cookies: List[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"]}], origins: List[{origin: str, localStorage: List[{name: str, value: str}]}]}
- """
- return mapping.from_impl(
- await self._impl_obj.storage_state(path=path, indexedDB=indexed_db)
- )
- async def set_storage_state(
- self, storage_state: typing.Union[StorageState, str, pathlib.Path]
- ) -> None:
- """BrowserContext.set_storage_state
- Clears the existing cookies, local storage and IndexedDB entries for all origins and sets the new storage state.
- **Usage**
- ```py
- # Load storage state from a file and apply it to the context.
- await context.set_storage_state(\"state.json\")
- ```
- Parameters
- ----------
- storage_state : Union[pathlib.Path, str, {cookies: Sequence[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"]}], origins: Sequence[{origin: str, localStorage: Sequence[{name: str, value: str}]}]}]
- Learn more about [storage state and auth](../auth.md).
- Populates context with given storage state. This option can be used to initialize context with logged-in
- information obtained via `browser_context.storage_state()`.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.set_storage_state(storageState=storage_state)
- )
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["backgroundpage"],
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Page": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["close"],
- predicate: typing.Optional[typing.Callable[["BrowserContext"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "BrowserContext": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["console"],
- predicate: typing.Optional[typing.Callable[["ConsoleMessage"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "ConsoleMessage": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["dialog"],
- predicate: typing.Optional[typing.Callable[["Dialog"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Dialog": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["download"],
- predicate: typing.Optional[typing.Callable[["Download"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Download": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["frameattached"],
- predicate: typing.Optional[typing.Callable[["Frame"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Frame": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["framedetached"],
- predicate: typing.Optional[typing.Callable[["Frame"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Frame": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["framenavigated"],
- predicate: typing.Optional[typing.Callable[["Frame"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Frame": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["page"],
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Page": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["pageclose"],
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Page": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["pageload"],
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Page": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["weberror"],
- predicate: typing.Optional[typing.Callable[["WebError"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "WebError": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["request"],
- predicate: typing.Optional[typing.Callable[["Request"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Request": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["requestfailed"],
- predicate: typing.Optional[typing.Callable[["Request"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Request": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["requestfinished"],
- predicate: typing.Optional[typing.Callable[["Request"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Request": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["response"],
- predicate: typing.Optional[typing.Callable[["Response"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Response": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: typing.Literal["serviceworker"],
- predicate: typing.Optional[typing.Callable[["Worker"], bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> "Worker": ...
- @typing.overload
- async def wait_for_event(
- self,
- event: str,
- predicate: typing.Optional[typing.Callable[..., bool]] = None,
- *,
- timeout: typing.Optional[float] = None,
- ) -> typing.Any: ...
- async def wait_for_event(
- self,
- event: str,
- predicate: typing.Optional[typing.Callable] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> typing.Any:
- """BrowserContext.wait_for_event
- **NOTE** In most cases, you should use `browser_context.expect_event()`.
- Waits for given `event` to fire. If predicate is provided, it passes event's value into the `predicate` function
- and waits for `predicate(event)` to return a truthy value. Will throw an error if the browser context is closed
- before the `event` is fired.
- Parameters
- ----------
- event : str
- Event name, same one typically passed into `*.on(event)`.
- predicate : Union[Callable, None]
- Receives the event data and resolves to truthy value when the waiting should resolve.
- timeout : Union[float, None]
- Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The
- default value can be changed by using the `browser_context.set_default_timeout()`.
- Returns
- -------
- Any
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.wait_for_event(
- event=event,
- predicate=self._wrap_handler(predicate),
- timeout=to_milliseconds(timeout),
- )
- )
- def expect_console_message(
- self,
- predicate: typing.Optional[typing.Callable[["ConsoleMessage"], bool]] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> AsyncEventContextManager["ConsoleMessage"]:
- """BrowserContext.expect_console_message
- Performs action and waits for a `ConsoleMessage` to be logged by in the pages in the context. If predicate is
- provided, it passes `ConsoleMessage` value into the `predicate` function and waits for `predicate(message)` to
- return a truthy value. Will throw an error if the page is closed before the `browser_context.on('console')` event
- is fired.
- Parameters
- ----------
- predicate : Union[Callable[[ConsoleMessage], bool], None]
- Receives the `ConsoleMessage` object and resolves to truthy value when the waiting should resolve.
- timeout : Union[float, None]
- Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The
- default value can be changed by using the `browser_context.set_default_timeout()`.
- Returns
- -------
- EventContextManager[ConsoleMessage]
- """
- return AsyncEventContextManager(
- self._impl_obj.expect_console_message(
- predicate=self._wrap_handler(predicate),
- timeout=to_milliseconds(timeout),
- ).future
- )
- def expect_page(
- self,
- predicate: typing.Optional[typing.Callable[["Page"], bool]] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> AsyncEventContextManager["Page"]:
- """BrowserContext.expect_page
- Performs action and waits for a new `Page` to be created in the context. If predicate is provided, it passes `Page`
- value into the `predicate` function and waits for `predicate(event)` to return a truthy value. Will throw an error
- if the context closes before new `Page` is created.
- Parameters
- ----------
- predicate : Union[Callable[[Page], bool], None]
- Receives the `Page` object and resolves to truthy value when the waiting should resolve.
- timeout : Union[float, None]
- Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The
- default value can be changed by using the `browser_context.set_default_timeout()`.
- Returns
- -------
- EventContextManager[Page]
- """
- return AsyncEventContextManager(
- self._impl_obj.expect_page(
- predicate=self._wrap_handler(predicate),
- timeout=to_milliseconds(timeout),
- ).future
- )
- async def new_cdp_session(
- self, page: typing.Union["Page", "Frame"]
- ) -> "CDPSession":
- """BrowserContext.new_cdp_session
- **NOTE** CDP sessions are only supported on Chromium-based browsers.
- Returns the newly created session.
- Parameters
- ----------
- page : Union[Frame, Page]
- Target to create new session for. For backwards-compatibility, this parameter is named `page`, but it can be a
- `Page` or `Frame` type.
- Returns
- -------
- CDPSession
- """
- return mapping.from_impl(await self._impl_obj.new_cdp_session(page=page))
- mapping.register(BrowserContextImpl, BrowserContext)
- class CDPSession(AsyncBase):
- @typing.overload
- def on(
- self,
- event: Literal["close"],
- f: typing.Callable[
- ["CDPSession"], "typing.Union[typing.Awaitable[None], None]"
- ],
- ) -> None:
- """
- Emitted when the session is closed, either because the target was closed or `session.detach()` was called.
- """
- @typing.overload
- def on(
- self,
- event: str,
- f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]],
- ) -> None: ...
- def on(
- self,
- event: str,
- f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]],
- ) -> None:
- return super().on(event=event, f=f)
- @typing.overload
- def once(
- self,
- event: Literal["close"],
- f: typing.Callable[
- ["CDPSession"], "typing.Union[typing.Awaitable[None], None]"
- ],
- ) -> None:
- """
- Emitted when the session is closed, either because the target was closed or `session.detach()` was called.
- """
- @typing.overload
- def once(
- self,
- event: str,
- f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]],
- ) -> None: ...
- def once(
- self,
- event: str,
- f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]],
- ) -> None:
- return super().once(event=event, f=f)
- async def send(
- self, method: str, params: typing.Optional[typing.Dict] = None
- ) -> typing.Dict:
- """CDPSession.send
- Parameters
- ----------
- method : str
- Protocol method name.
- params : Union[Dict, None]
- Optional method parameters.
- Returns
- -------
- Dict
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.send(method=method, params=mapping.to_impl(params))
- )
- async def detach(self) -> None:
- """CDPSession.detach
- Detaches the CDPSession from the target. Once detached, the CDPSession object won't emit any events and can't be
- used to send messages.
- """
- return mapping.from_maybe_impl(await self._impl_obj.detach())
- mapping.register(CDPSessionImpl, CDPSession)
- class Browser(AsyncContextManager):
- @typing.overload
- def on(
- self,
- event: Literal["context"],
- f: typing.Callable[
- ["BrowserContext"], "typing.Union[typing.Awaitable[None], None]"
- ],
- ) -> None:
- """
- Emitted when a new browser context is created."""
- @typing.overload
- def on(
- self,
- event: Literal["disconnected"],
- f: typing.Callable[["Browser"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when Browser gets disconnected from the browser application. This might happen because of one of the
- following:
- - Browser application is closed or crashed.
- - The `browser.close()` method was called."""
- def on(
- self,
- event: str,
- f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]],
- ) -> None:
- return super().on(event=event, f=f)
- @typing.overload
- def once(
- self,
- event: Literal["context"],
- f: typing.Callable[
- ["BrowserContext"], "typing.Union[typing.Awaitable[None], None]"
- ],
- ) -> None:
- """
- Emitted when a new browser context is created."""
- @typing.overload
- def once(
- self,
- event: Literal["disconnected"],
- f: typing.Callable[["Browser"], "typing.Union[typing.Awaitable[None], None]"],
- ) -> None:
- """
- Emitted when Browser gets disconnected from the browser application. This might happen because of one of the
- following:
- - Browser application is closed or crashed.
- - The `browser.close()` method was called."""
- def once(
- self,
- event: str,
- f: typing.Callable[..., typing.Union[typing.Awaitable[None], None]],
- ) -> None:
- return super().once(event=event, f=f)
- @property
- def contexts(self) -> typing.List["BrowserContext"]:
- """Browser.contexts
- Returns an array of all open browser contexts. In a newly created browser, this will return zero browser contexts.
- **Usage**
- ```py
- browser = await pw.webkit.launch()
- print(len(browser.contexts)) # prints `0`
- context = await browser.new_context()
- print(len(browser.contexts)) # prints `1`
- ```
- Returns
- -------
- List[BrowserContext]
- """
- return mapping.from_impl_list(self._impl_obj.contexts)
- @property
- def browser_type(self) -> "BrowserType":
- """Browser.browser_type
- Get the browser type (chromium, firefox or webkit) that the browser belongs to.
- Returns
- -------
- BrowserType
- """
- return mapping.from_impl(self._impl_obj.browser_type)
- @property
- def version(self) -> str:
- """Browser.version
- Returns the browser version.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.version)
- def is_connected(self) -> bool:
- """Browser.is_connected
- Indicates that the browser is connected.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(self._impl_obj.is_connected())
- async def new_context(
- self,
- *,
- viewport: typing.Optional[ViewportSize] = None,
- screen: typing.Optional[ViewportSize] = None,
- no_viewport: typing.Optional[bool] = None,
- ignore_https_errors: typing.Optional[bool] = None,
- java_script_enabled: typing.Optional[bool] = None,
- bypass_csp: typing.Optional[bool] = None,
- user_agent: typing.Optional[str] = None,
- locale: typing.Optional[str] = None,
- timezone_id: typing.Optional[str] = None,
- geolocation: typing.Optional[Geolocation] = None,
- permissions: typing.Optional[typing.Sequence[str]] = None,
- extra_http_headers: typing.Optional[typing.Dict[str, str]] = None,
- offline: typing.Optional[bool] = None,
- http_credentials: typing.Optional[HttpCredentials] = None,
- device_scale_factor: typing.Optional[float] = None,
- is_mobile: typing.Optional[bool] = None,
- has_touch: typing.Optional[bool] = None,
- color_scheme: typing.Optional[
- Literal["dark", "light", "no-preference", "null"]
- ] = None,
- reduced_motion: typing.Optional[
- Literal["no-preference", "null", "reduce"]
- ] = None,
- forced_colors: typing.Optional[Literal["active", "none", "null"]] = None,
- contrast: typing.Optional[Literal["more", "no-preference", "null"]] = None,
- accept_downloads: typing.Optional[bool] = None,
- default_browser_type: typing.Optional[str] = None,
- proxy: typing.Optional[ProxySettings] = None,
- record_har_path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- record_har_omit_content: typing.Optional[bool] = None,
- record_video_dir: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- record_video_size: typing.Optional[ViewportSize] = None,
- storage_state: typing.Optional[
- typing.Union[StorageState, str, pathlib.Path]
- ] = None,
- base_url: typing.Optional[str] = None,
- strict_selectors: typing.Optional[bool] = None,
- service_workers: typing.Optional[Literal["allow", "block"]] = None,
- record_har_url_filter: typing.Optional[
- typing.Union[typing.Pattern[str], str]
- ] = None,
- record_har_mode: typing.Optional[Literal["full", "minimal"]] = None,
- record_har_content: typing.Optional[Literal["attach", "embed", "omit"]] = None,
- client_certificates: typing.Optional[typing.List[ClientCertificate]] = None,
- ) -> "BrowserContext":
- """Browser.new_context
- Creates a new browser context. It won't share cookies/cache with other browser contexts.
- **NOTE** If directly using this method to create `BrowserContext`s, it is best practice to explicitly close the
- returned context via `browser_context.close()` when your code is done with the `BrowserContext`, and before
- calling `browser.close()`. This will ensure the `context` is closed gracefully and any artifacts—like HARs
- and videos—are fully flushed and saved.
- **Usage**
- ```py
- browser = await playwright.firefox.launch() # or \"chromium\" or \"webkit\".
- # create a new incognito browser context.
- context = await browser.new_context()
- # create a new page in a pristine context.
- page = await context.new_page()
- await page.goto(\"https://example.com\")
- # gracefully close up everything
- await context.close()
- await browser.close()
- ```
- Parameters
- ----------
- viewport : Union[{width: int, height: int}, None]
- Sets a consistent viewport for each page. Defaults to an 1280x720 viewport. `no_viewport` disables the fixed
- viewport. Learn more about [viewport emulation](../emulation.md#viewport).
- screen : Union[{width: int, height: int}, None]
- Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the
- `viewport` is set.
- no_viewport : Union[bool, None]
- Does not enforce fixed viewport, allows resizing window in the headed mode.
- ignore_https_errors : Union[bool, None]
- Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
- java_script_enabled : Union[bool, None]
- Whether or not to enable JavaScript in the context. Defaults to `true`. Learn more about
- [disabling JavaScript](../emulation.md#javascript-enabled).
- bypass_csp : Union[bool, None]
- Toggles bypassing page's Content-Security-Policy. Defaults to `false`.
- user_agent : Union[str, None]
- Specific user agent to use in this context.
- locale : Union[str, None]
- Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value,
- `Accept-Language` request header value as well as number and date formatting rules. Defaults to the system default
- locale. Learn more about emulation in our [emulation guide](../emulation.md#locale--timezone).
- timezone_id : Union[str, None]
- Changes the timezone of the context. See
- [ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)
- for a list of supported timezone IDs. Defaults to the system timezone.
- geolocation : Union[{latitude: float, longitude: float, accuracy: Union[float, None]}, None]
- permissions : Union[Sequence[str], None]
- A list of permissions to grant to all pages in this context. See `browser_context.grant_permissions()` for
- more details. Defaults to none.
- extra_http_headers : Union[Dict[str, str], None]
- An object containing additional HTTP headers to be sent with every request. Defaults to none.
- offline : Union[bool, None]
- Whether to emulate network being offline. Defaults to `false`. Learn more about
- [network emulation](../emulation.md#offline).
- http_credentials : Union[{username: str, password: str, origin: Union[str, None], send: Union["always", "unauthorized", None]}, None]
- Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication). If no
- origin is specified, the username and password are sent to any servers upon unauthorized responses.
- device_scale_factor : Union[float, None]
- Specify device scale factor (can be thought of as dpr). Defaults to `1`. Learn more about
- [emulating devices with device scale factor](../emulation.md#devices).
- is_mobile : Union[bool, None]
- Whether the `meta viewport` tag is taken into account and touch events are enabled. isMobile is a part of device,
- so you don't actually need to set it manually. Defaults to `false` and is not supported in Firefox. Learn more
- about [mobile emulation](../emulation.md#ismobile).
- has_touch : Union[bool, None]
- Specifies if viewport supports touch events. Defaults to false. Learn more about
- [mobile emulation](../emulation.md#devices).
- color_scheme : Union["dark", "light", "no-preference", "null", None]
- Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
- media feature, supported values are `'light'` and `'dark'`. See `page.emulate_media()` for more details.
- Passing `'null'` resets emulation to system defaults. Defaults to `'light'`.
- reduced_motion : Union["no-preference", "null", "reduce", None]
- Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See
- `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to
- `'no-preference'`.
- forced_colors : Union["active", "none", "null", None]
- Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See
- `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to
- `'none'`.
- contrast : Union["more", "no-preference", "null", None]
- Emulates `'prefers-contrast'` media feature, supported values are `'no-preference'`, `'more'`. See
- `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to
- `'no-preference'`.
- accept_downloads : Union[bool, None]
- Whether to automatically download all the attachments. Defaults to `true` where all the downloads are accepted.
- proxy : Union[{server: str, bypass: Union[str, None], username: Union[str, None], password: Union[str, None]}, None]
- Network proxy settings to use with this context. Defaults to none.
- record_har_path : Union[pathlib.Path, str, None]
- Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the specified HAR file
- on the filesystem. If not specified, the HAR is not recorded. Make sure to call `browser_context.close()`
- for the HAR to be saved.
- record_har_omit_content : Union[bool, None]
- Optional setting to control whether to omit request content from the HAR. Defaults to `false`.
- record_video_dir : Union[pathlib.Path, str, None]
- Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make
- sure to call `browser_context.close()` for videos to be saved.
- record_video_size : Union[{width: int, height: int}, None]
- Dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into
- 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page
- will be scaled down if necessary to fit the specified size.
- storage_state : Union[pathlib.Path, str, {cookies: Sequence[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"]}], origins: Sequence[{origin: str, localStorage: Sequence[{name: str, value: str}]}]}, None]
- Learn more about [storage state and auth](../auth.md).
- Populates context with given storage state. This option can be used to initialize context with logged-in
- information obtained via `browser_context.storage_state()`.
- base_url : Union[str, None]
- When using `page.goto()`, `page.route()`, `page.wait_for_url()`,
- `page.expect_request()`, or `page.expect_response()` it takes the base URL in consideration by
- using the [`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the
- corresponding URL. Unset by default. Examples:
- - baseURL: `http://localhost:3000` and navigating to `/bar.html` results in `http://localhost:3000/bar.html`
- - baseURL: `http://localhost:3000/foo/` and navigating to `./bar.html` results in
- `http://localhost:3000/foo/bar.html`
- - baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in
- `http://localhost:3000/bar.html`
- strict_selectors : Union[bool, None]
- If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on
- selectors that imply single target DOM element will throw when more than one element matches the selector. This
- option does not affect any Locator APIs (Locators are always strict). Defaults to `false`. See `Locator` to learn
- more about the strict mode.
- service_workers : Union["allow", "block", None]
- Whether to allow sites to register Service workers. Defaults to `'allow'`.
- - `'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be
- registered.
- - `'block'`: Playwright will block all registration of Service Workers.
- record_har_url_filter : Union[Pattern[str], str, None]
- record_har_mode : Union["full", "minimal", None]
- When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page,
- cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.
- record_har_content : Union["attach", "embed", "omit", None]
- Optional setting to control resource content management. If `omit` is specified, content is not persisted. If
- `attach` is specified, resources are persisted as separate files and all of these files are archived along with the
- HAR file. Defaults to `embed`, which stores content inline the HAR file as per HAR specification.
- client_certificates : Union[Sequence[{origin: str, certPath: Union[pathlib.Path, str, None], cert: Union[bytes, None], keyPath: Union[pathlib.Path, str, None], key: Union[bytes, None], pfxPath: Union[pathlib.Path, str, None], pfx: Union[bytes, None], passphrase: Union[str, None]}], None]
- TLS Client Authentication allows the server to request a client certificate and verify it.
- **Details**
- An array of client certificates to be used. Each certificate object must have either both `certPath` and `keyPath`,
- a single `pfxPath`, or their corresponding direct value equivalents (`cert` and `key`, or `pfx`). Optionally,
- `passphrase` property should be provided if the certificate is encrypted. The `origin` property should be provided
- with an exact match to the request origin that the certificate is valid for.
- Client certificate authentication is only active when at least one client certificate is provided. If you want to
- reject all client certificates sent by the server, you need to provide a client certificate with an `origin` that
- does not match any of the domains you plan to visit.
- **NOTE** When using WebKit on macOS, accessing `localhost` will not pick up client certificates. You can make it
- work by replacing `localhost` with `local.playwright`.
- Returns
- -------
- BrowserContext
- """
- return mapping.from_impl(
- await self._impl_obj.new_context(
- viewport=viewport,
- screen=screen,
- noViewport=no_viewport,
- ignoreHTTPSErrors=ignore_https_errors,
- javaScriptEnabled=java_script_enabled,
- bypassCSP=bypass_csp,
- userAgent=user_agent,
- locale=locale,
- timezoneId=timezone_id,
- geolocation=geolocation,
- permissions=mapping.to_impl(permissions),
- extraHTTPHeaders=mapping.to_impl(extra_http_headers),
- offline=offline,
- httpCredentials=http_credentials,
- deviceScaleFactor=device_scale_factor,
- isMobile=is_mobile,
- hasTouch=has_touch,
- colorScheme=color_scheme,
- reducedMotion=reduced_motion,
- forcedColors=forced_colors,
- contrast=contrast,
- acceptDownloads=accept_downloads,
- defaultBrowserType=default_browser_type,
- proxy=proxy,
- recordHarPath=record_har_path,
- recordHarOmitContent=record_har_omit_content,
- recordVideoDir=record_video_dir,
- recordVideoSize=record_video_size,
- storageState=storage_state,
- baseURL=base_url,
- strictSelectors=strict_selectors,
- serviceWorkers=service_workers,
- recordHarUrlFilter=record_har_url_filter,
- recordHarMode=record_har_mode,
- recordHarContent=record_har_content,
- clientCertificates=client_certificates,
- )
- )
- async def new_page(
- self,
- *,
- viewport: typing.Optional[ViewportSize] = None,
- screen: typing.Optional[ViewportSize] = None,
- no_viewport: typing.Optional[bool] = None,
- ignore_https_errors: typing.Optional[bool] = None,
- java_script_enabled: typing.Optional[bool] = None,
- bypass_csp: typing.Optional[bool] = None,
- user_agent: typing.Optional[str] = None,
- locale: typing.Optional[str] = None,
- timezone_id: typing.Optional[str] = None,
- geolocation: typing.Optional[Geolocation] = None,
- permissions: typing.Optional[typing.Sequence[str]] = None,
- extra_http_headers: typing.Optional[typing.Dict[str, str]] = None,
- offline: typing.Optional[bool] = None,
- http_credentials: typing.Optional[HttpCredentials] = None,
- device_scale_factor: typing.Optional[float] = None,
- is_mobile: typing.Optional[bool] = None,
- has_touch: typing.Optional[bool] = None,
- color_scheme: typing.Optional[
- Literal["dark", "light", "no-preference", "null"]
- ] = None,
- forced_colors: typing.Optional[Literal["active", "none", "null"]] = None,
- contrast: typing.Optional[Literal["more", "no-preference", "null"]] = None,
- reduced_motion: typing.Optional[
- Literal["no-preference", "null", "reduce"]
- ] = None,
- accept_downloads: typing.Optional[bool] = None,
- default_browser_type: typing.Optional[str] = None,
- proxy: typing.Optional[ProxySettings] = None,
- record_har_path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- record_har_omit_content: typing.Optional[bool] = None,
- record_video_dir: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- record_video_size: typing.Optional[ViewportSize] = None,
- storage_state: typing.Optional[
- typing.Union[StorageState, str, pathlib.Path]
- ] = None,
- base_url: typing.Optional[str] = None,
- strict_selectors: typing.Optional[bool] = None,
- service_workers: typing.Optional[Literal["allow", "block"]] = None,
- record_har_url_filter: typing.Optional[
- typing.Union[typing.Pattern[str], str]
- ] = None,
- record_har_mode: typing.Optional[Literal["full", "minimal"]] = None,
- record_har_content: typing.Optional[Literal["attach", "embed", "omit"]] = None,
- client_certificates: typing.Optional[typing.List[ClientCertificate]] = None,
- ) -> "Page":
- """Browser.new_page
- Creates a new page in a new browser context. Closing this page will close the context as well.
- This is a convenience API that should only be used for the single-page scenarios and short snippets. Production
- code and testing frameworks should explicitly create `browser.new_context()` followed by the
- `browser_context.new_page()` to control their exact life times.
- Parameters
- ----------
- viewport : Union[{width: int, height: int}, None]
- Sets a consistent viewport for each page. Defaults to an 1280x720 viewport. `no_viewport` disables the fixed
- viewport. Learn more about [viewport emulation](../emulation.md#viewport).
- screen : Union[{width: int, height: int}, None]
- Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the
- `viewport` is set.
- no_viewport : Union[bool, None]
- Does not enforce fixed viewport, allows resizing window in the headed mode.
- ignore_https_errors : Union[bool, None]
- Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
- java_script_enabled : Union[bool, None]
- Whether or not to enable JavaScript in the context. Defaults to `true`. Learn more about
- [disabling JavaScript](../emulation.md#javascript-enabled).
- bypass_csp : Union[bool, None]
- Toggles bypassing page's Content-Security-Policy. Defaults to `false`.
- user_agent : Union[str, None]
- Specific user agent to use in this context.
- locale : Union[str, None]
- Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value,
- `Accept-Language` request header value as well as number and date formatting rules. Defaults to the system default
- locale. Learn more about emulation in our [emulation guide](../emulation.md#locale--timezone).
- timezone_id : Union[str, None]
- Changes the timezone of the context. See
- [ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)
- for a list of supported timezone IDs. Defaults to the system timezone.
- geolocation : Union[{latitude: float, longitude: float, accuracy: Union[float, None]}, None]
- permissions : Union[Sequence[str], None]
- A list of permissions to grant to all pages in this context. See `browser_context.grant_permissions()` for
- more details. Defaults to none.
- extra_http_headers : Union[Dict[str, str], None]
- An object containing additional HTTP headers to be sent with every request. Defaults to none.
- offline : Union[bool, None]
- Whether to emulate network being offline. Defaults to `false`. Learn more about
- [network emulation](../emulation.md#offline).
- http_credentials : Union[{username: str, password: str, origin: Union[str, None], send: Union["always", "unauthorized", None]}, None]
- Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication). If no
- origin is specified, the username and password are sent to any servers upon unauthorized responses.
- device_scale_factor : Union[float, None]
- Specify device scale factor (can be thought of as dpr). Defaults to `1`. Learn more about
- [emulating devices with device scale factor](../emulation.md#devices).
- is_mobile : Union[bool, None]
- Whether the `meta viewport` tag is taken into account and touch events are enabled. isMobile is a part of device,
- so you don't actually need to set it manually. Defaults to `false` and is not supported in Firefox. Learn more
- about [mobile emulation](../emulation.md#ismobile).
- has_touch : Union[bool, None]
- Specifies if viewport supports touch events. Defaults to false. Learn more about
- [mobile emulation](../emulation.md#devices).
- color_scheme : Union["dark", "light", "no-preference", "null", None]
- Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
- media feature, supported values are `'light'` and `'dark'`. See `page.emulate_media()` for more details.
- Passing `'null'` resets emulation to system defaults. Defaults to `'light'`.
- forced_colors : Union["active", "none", "null", None]
- Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See
- `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to
- `'none'`.
- contrast : Union["more", "no-preference", "null", None]
- Emulates `'prefers-contrast'` media feature, supported values are `'no-preference'`, `'more'`. See
- `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to
- `'no-preference'`.
- reduced_motion : Union["no-preference", "null", "reduce", None]
- Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See
- `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to
- `'no-preference'`.
- accept_downloads : Union[bool, None]
- Whether to automatically download all the attachments. Defaults to `true` where all the downloads are accepted.
- proxy : Union[{server: str, bypass: Union[str, None], username: Union[str, None], password: Union[str, None]}, None]
- Network proxy settings to use with this context. Defaults to none.
- record_har_path : Union[pathlib.Path, str, None]
- Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the specified HAR file
- on the filesystem. If not specified, the HAR is not recorded. Make sure to call `browser_context.close()`
- for the HAR to be saved.
- record_har_omit_content : Union[bool, None]
- Optional setting to control whether to omit request content from the HAR. Defaults to `false`.
- record_video_dir : Union[pathlib.Path, str, None]
- Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make
- sure to call `browser_context.close()` for videos to be saved.
- record_video_size : Union[{width: int, height: int}, None]
- Dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into
- 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page
- will be scaled down if necessary to fit the specified size.
- storage_state : Union[pathlib.Path, str, {cookies: Sequence[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"]}], origins: Sequence[{origin: str, localStorage: Sequence[{name: str, value: str}]}]}, None]
- Learn more about [storage state and auth](../auth.md).
- Populates context with given storage state. This option can be used to initialize context with logged-in
- information obtained via `browser_context.storage_state()`.
- base_url : Union[str, None]
- When using `page.goto()`, `page.route()`, `page.wait_for_url()`,
- `page.expect_request()`, or `page.expect_response()` it takes the base URL in consideration by
- using the [`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the
- corresponding URL. Unset by default. Examples:
- - baseURL: `http://localhost:3000` and navigating to `/bar.html` results in `http://localhost:3000/bar.html`
- - baseURL: `http://localhost:3000/foo/` and navigating to `./bar.html` results in
- `http://localhost:3000/foo/bar.html`
- - baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in
- `http://localhost:3000/bar.html`
- strict_selectors : Union[bool, None]
- If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on
- selectors that imply single target DOM element will throw when more than one element matches the selector. This
- option does not affect any Locator APIs (Locators are always strict). Defaults to `false`. See `Locator` to learn
- more about the strict mode.
- service_workers : Union["allow", "block", None]
- Whether to allow sites to register Service workers. Defaults to `'allow'`.
- - `'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be
- registered.
- - `'block'`: Playwright will block all registration of Service Workers.
- record_har_url_filter : Union[Pattern[str], str, None]
- record_har_mode : Union["full", "minimal", None]
- When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page,
- cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.
- record_har_content : Union["attach", "embed", "omit", None]
- Optional setting to control resource content management. If `omit` is specified, content is not persisted. If
- `attach` is specified, resources are persisted as separate files and all of these files are archived along with the
- HAR file. Defaults to `embed`, which stores content inline the HAR file as per HAR specification.
- client_certificates : Union[Sequence[{origin: str, certPath: Union[pathlib.Path, str, None], cert: Union[bytes, None], keyPath: Union[pathlib.Path, str, None], key: Union[bytes, None], pfxPath: Union[pathlib.Path, str, None], pfx: Union[bytes, None], passphrase: Union[str, None]}], None]
- TLS Client Authentication allows the server to request a client certificate and verify it.
- **Details**
- An array of client certificates to be used. Each certificate object must have either both `certPath` and `keyPath`,
- a single `pfxPath`, or their corresponding direct value equivalents (`cert` and `key`, or `pfx`). Optionally,
- `passphrase` property should be provided if the certificate is encrypted. The `origin` property should be provided
- with an exact match to the request origin that the certificate is valid for.
- Client certificate authentication is only active when at least one client certificate is provided. If you want to
- reject all client certificates sent by the server, you need to provide a client certificate with an `origin` that
- does not match any of the domains you plan to visit.
- **NOTE** When using WebKit on macOS, accessing `localhost` will not pick up client certificates. You can make it
- work by replacing `localhost` with `local.playwright`.
- Returns
- -------
- Page
- """
- return mapping.from_impl(
- await self._impl_obj.new_page(
- viewport=viewport,
- screen=screen,
- noViewport=no_viewport,
- ignoreHTTPSErrors=ignore_https_errors,
- javaScriptEnabled=java_script_enabled,
- bypassCSP=bypass_csp,
- userAgent=user_agent,
- locale=locale,
- timezoneId=timezone_id,
- geolocation=geolocation,
- permissions=mapping.to_impl(permissions),
- extraHTTPHeaders=mapping.to_impl(extra_http_headers),
- offline=offline,
- httpCredentials=http_credentials,
- deviceScaleFactor=device_scale_factor,
- isMobile=is_mobile,
- hasTouch=has_touch,
- colorScheme=color_scheme,
- forcedColors=forced_colors,
- contrast=contrast,
- reducedMotion=reduced_motion,
- acceptDownloads=accept_downloads,
- defaultBrowserType=default_browser_type,
- proxy=proxy,
- recordHarPath=record_har_path,
- recordHarOmitContent=record_har_omit_content,
- recordVideoDir=record_video_dir,
- recordVideoSize=record_video_size,
- storageState=storage_state,
- baseURL=base_url,
- strictSelectors=strict_selectors,
- serviceWorkers=service_workers,
- recordHarUrlFilter=record_har_url_filter,
- recordHarMode=record_har_mode,
- recordHarContent=record_har_content,
- clientCertificates=client_certificates,
- )
- )
- async def close(self, *, reason: typing.Optional[str] = None) -> None:
- """Browser.close
- In case this browser is obtained using `browser_type.launch()`, closes the browser and all of its pages (if
- any were opened).
- In case this browser is connected to, clears all created contexts belonging to this browser and disconnects from
- the browser server.
- **NOTE** This is similar to force-quitting the browser. To close pages gracefully and ensure you receive page close
- events, call `browser_context.close()` on any `BrowserContext` instances you explicitly created earlier
- using `browser.new_context()` **before** calling `browser.close()`.
- The `Browser` object itself is considered to be disposed and cannot be used anymore.
- Parameters
- ----------
- reason : Union[str, None]
- The reason to be reported to the operations interrupted by the browser closure.
- """
- return mapping.from_maybe_impl(await self._impl_obj.close(reason=reason))
- async def new_browser_cdp_session(self) -> "CDPSession":
- """Browser.new_browser_cdp_session
- **NOTE** CDP Sessions are only supported on Chromium-based browsers.
- Returns the newly created browser session.
- Returns
- -------
- CDPSession
- """
- return mapping.from_impl(await self._impl_obj.new_browser_cdp_session())
- async def bind(
- self,
- title: str,
- *,
- workspace_dir: typing.Optional[str] = None,
- host: typing.Optional[str] = None,
- port: typing.Optional[int] = None,
- ) -> BrowserBindResult:
- """Browser.bind
- Binds the browser to a named pipe or web socket, making it available for other clients to connect to.
- Parameters
- ----------
- title : str
- Title of the browser server, used for identification.
- workspace_dir : Union[str, None]
- Working directory associated with this browser server.
- host : Union[str, None]
- Host to bind the web socket server to. When specified, a web socket server is created instead of a named pipe.
- port : Union[int, None]
- Port to bind the web socket server to. When specified, a web socket server is created instead of a named pipe. Use
- `0` to let the OS pick an available port.
- Returns
- -------
- {endpoint: str}
- """
- return mapping.from_impl(
- await self._impl_obj.bind(
- title=title, workspaceDir=workspace_dir, host=host, port=port
- )
- )
- async def unbind(self) -> None:
- """Browser.unbind
- Unbinds the browser server previously bound with `browser.bind()`.
- """
- return mapping.from_maybe_impl(await self._impl_obj.unbind())
- async def start_tracing(
- self,
- *,
- page: typing.Optional["Page"] = None,
- path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- screenshots: typing.Optional[bool] = None,
- categories: typing.Optional[typing.Sequence[str]] = None,
- ) -> None:
- """Browser.start_tracing
- **NOTE** This API controls
- [Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool) which is a low-level
- chromium-specific debugging tool. API to control [Playwright Tracing](https://playwright.dev/python/docs/trace-viewer) could be found
- [here](https://playwright.dev/python/docs/api/class-tracing).
- You can use `browser.start_tracing()` and `browser.stop_tracing()` to create a trace file that can be
- opened in Chrome DevTools performance panel.
- **Usage**
- ```py
- await browser.start_tracing(page, path=\"trace.json\")
- await page.goto(\"https://www.google.com\")
- await browser.stop_tracing()
- ```
- Parameters
- ----------
- page : Union[Page, None]
- Optional, if specified, tracing includes screenshots of the given page.
- path : Union[pathlib.Path, str, None]
- A path to write the trace file to.
- screenshots : Union[bool, None]
- captures screenshots in the trace.
- categories : Union[Sequence[str], None]
- specify custom categories to use instead of default.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.start_tracing(
- page=page._impl_obj if page else None,
- path=path,
- screenshots=screenshots,
- categories=mapping.to_impl(categories),
- )
- )
- async def stop_tracing(self) -> bytes:
- """Browser.stop_tracing
- **NOTE** This API controls
- [Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool) which is a low-level
- chromium-specific debugging tool. API to control [Playwright Tracing](https://playwright.dev/python/docs/trace-viewer) could be found
- [here](https://playwright.dev/python/docs/api/class-tracing).
- Returns the buffer with trace data.
- Returns
- -------
- bytes
- """
- return mapping.from_maybe_impl(await self._impl_obj.stop_tracing())
- mapping.register(BrowserImpl, Browser)
- class BrowserType(AsyncBase):
- @property
- def name(self) -> str:
- """BrowserType.name
- Returns browser name. For example: `'chromium'`, `'webkit'` or `'firefox'`.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.name)
- @property
- def executable_path(self) -> str:
- """BrowserType.executable_path
- A path where Playwright expects to find a bundled browser executable.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.executable_path)
- async def launch(
- self,
- *,
- executable_path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- channel: typing.Optional[str] = None,
- args: typing.Optional[typing.Sequence[str]] = None,
- ignore_default_args: typing.Optional[
- typing.Union[bool, typing.Sequence[str]]
- ] = None,
- handle_sigint: typing.Optional[bool] = None,
- handle_sigterm: typing.Optional[bool] = None,
- handle_sighup: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- env: typing.Optional[typing.Dict[str, typing.Union[str, float, bool]]] = None,
- headless: typing.Optional[bool] = None,
- proxy: typing.Optional[ProxySettings] = None,
- downloads_path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- slow_mo: typing.Optional[float] = None,
- traces_dir: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- artifacts_dir: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- chromium_sandbox: typing.Optional[bool] = None,
- firefox_user_prefs: typing.Optional[
- typing.Dict[str, typing.Union[str, float, bool]]
- ] = None,
- ) -> "Browser":
- """BrowserType.launch
- Returns the browser instance.
- **Usage**
- You can use `ignoreDefaultArgs` to filter out `--mute-audio` from default arguments:
- ```py
- browser = await playwright.chromium.launch( # or \"firefox\" or \"webkit\".
- ignore_default_args=[\"--mute-audio\"]
- )
- ```
- > **Chromium-only** Playwright can also be used to control the Google Chrome or Microsoft Edge browsers, but it
- works best with the version of Chromium it is bundled with. There is no guarantee it will work with any other
- version. Use `executablePath` option with extreme caution.
- >
- > If Google Chrome (rather than Chromium) is preferred, a
- [Chrome Canary](https://www.google.com/chrome/browser/canary.html) or
- [Dev Channel](https://www.chromium.org/getting-involved/dev-channel) build is suggested.
- >
- > Stock browsers like Google Chrome and Microsoft Edge are suitable for tests that require proprietary media codecs
- for video playback. See
- [this article](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for
- other differences between Chromium and Chrome.
- [This article](https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md)
- describes some differences for Linux users.
- Parameters
- ----------
- executable_path : Union[pathlib.Path, str, None]
- Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then it is
- resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium,
- Firefox or WebKit, use at your own risk.
- channel : Union[str, None]
- Browser distribution channel.
- Use "chromium" to [opt in to new headless mode](../browsers.md#chromium-new-headless-mode).
- Use "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", or
- "msedge-canary" to use branded [Google Chrome and Microsoft Edge](../browsers.md#google-chrome--microsoft-edge).
- args : Union[Sequence[str], None]
- **NOTE** Use custom browser args at your own risk, as some of them may break Playwright functionality.
- Additional arguments to pass to the browser instance. The list of Chromium flags can be found
- [here](https://peter.sh/experiments/chromium-command-line-switches/).
- ignore_default_args : Union[Sequence[str], bool, None]
- If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. If an array is
- given, then filters out the given default arguments. Dangerous option; use with care. Defaults to `false`.
- handle_sigint : Union[bool, None]
- Close the browser process on Ctrl-C. Defaults to `true`.
- handle_sigterm : Union[bool, None]
- Close the browser process on SIGTERM. Defaults to `true`.
- handle_sighup : Union[bool, None]
- Close the browser process on SIGHUP. Defaults to `true`.
- timeout : Union[float, None]
- Maximum time in milliseconds to wait for the browser instance to start. Defaults to `30000` (30 seconds). Pass `0`
- to disable timeout.
- env : Union[Dict[str, Union[bool, float, str]], None]
- Specify environment variables that will be visible to the browser. Defaults to `process.env`.
- headless : Union[bool, None]
- Whether to run browser in headless mode. More details for
- [Chromium](https://developers.google.com/web/updates/2017/04/headless-chrome) and
- [Firefox](https://hacks.mozilla.org/2017/12/using-headless-mode-in-firefox/). Defaults to `true`.
- proxy : Union[{server: str, bypass: Union[str, None], username: Union[str, None], password: Union[str, None]}, None]
- Network proxy settings.
- downloads_path : Union[pathlib.Path, str, None]
- If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and
- is deleted when browser is closed. In either case, the downloads are deleted when the browser context they were
- created in is closed.
- slow_mo : Union[float, None]
- Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going
- on.
- traces_dir : Union[pathlib.Path, str, None]
- If specified, traces are saved into this directory.
- artifacts_dir : Union[pathlib.Path, str, None]
- If specified, artifacts (traces, videos, downloads, HAR files, etc.) are saved into this directory. The directory
- is not cleaned up when the browser closes. If not specified, a temporary directory is used and cleaned up when the
- browser closes.
- chromium_sandbox : Union[bool, None]
- Enable Chromium sandboxing. Defaults to `false`.
- firefox_user_prefs : Union[Dict[str, Union[bool, float, str]], None]
- Firefox user preferences. Learn more about the Firefox user preferences at
- [`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox).
- You can also provide a path to a custom [`policies.json` file](https://mozilla.github.io/policy-templates/) via
- `PLAYWRIGHT_FIREFOX_POLICIES_JSON` environment variable.
- Returns
- -------
- Browser
- """
- return mapping.from_impl(
- await self._impl_obj.launch(
- executablePath=executable_path,
- channel=channel,
- args=mapping.to_impl(args),
- ignoreDefaultArgs=mapping.to_impl(ignore_default_args),
- handleSIGINT=handle_sigint,
- handleSIGTERM=handle_sigterm,
- handleSIGHUP=handle_sighup,
- timeout=to_milliseconds(timeout),
- env=mapping.to_impl(env),
- headless=headless,
- proxy=proxy,
- downloadsPath=downloads_path,
- slowMo=slow_mo,
- tracesDir=traces_dir,
- artifactsDir=artifacts_dir,
- chromiumSandbox=chromium_sandbox,
- firefoxUserPrefs=mapping.to_impl(firefox_user_prefs),
- )
- )
- async def launch_persistent_context(
- self,
- user_data_dir: typing.Union[str, pathlib.Path],
- *,
- channel: typing.Optional[str] = None,
- executable_path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- args: typing.Optional[typing.Sequence[str]] = None,
- ignore_default_args: typing.Optional[
- typing.Union[bool, typing.Sequence[str]]
- ] = None,
- handle_sigint: typing.Optional[bool] = None,
- handle_sigterm: typing.Optional[bool] = None,
- handle_sighup: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- env: typing.Optional[typing.Dict[str, typing.Union[str, float, bool]]] = None,
- headless: typing.Optional[bool] = None,
- proxy: typing.Optional[ProxySettings] = None,
- downloads_path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- slow_mo: typing.Optional[float] = None,
- viewport: typing.Optional[ViewportSize] = None,
- screen: typing.Optional[ViewportSize] = None,
- no_viewport: typing.Optional[bool] = None,
- ignore_https_errors: typing.Optional[bool] = None,
- java_script_enabled: typing.Optional[bool] = None,
- bypass_csp: typing.Optional[bool] = None,
- user_agent: typing.Optional[str] = None,
- locale: typing.Optional[str] = None,
- timezone_id: typing.Optional[str] = None,
- geolocation: typing.Optional[Geolocation] = None,
- permissions: typing.Optional[typing.Sequence[str]] = None,
- extra_http_headers: typing.Optional[typing.Dict[str, str]] = None,
- offline: typing.Optional[bool] = None,
- http_credentials: typing.Optional[HttpCredentials] = None,
- device_scale_factor: typing.Optional[float] = None,
- is_mobile: typing.Optional[bool] = None,
- has_touch: typing.Optional[bool] = None,
- color_scheme: typing.Optional[
- Literal["dark", "light", "no-preference", "null"]
- ] = None,
- reduced_motion: typing.Optional[
- Literal["no-preference", "null", "reduce"]
- ] = None,
- forced_colors: typing.Optional[Literal["active", "none", "null"]] = None,
- contrast: typing.Optional[Literal["more", "no-preference", "null"]] = None,
- accept_downloads: typing.Optional[bool] = None,
- traces_dir: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- artifacts_dir: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- chromium_sandbox: typing.Optional[bool] = None,
- firefox_user_prefs: typing.Optional[
- typing.Dict[str, typing.Union[str, float, bool]]
- ] = None,
- record_har_path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- record_har_omit_content: typing.Optional[bool] = None,
- record_video_dir: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- record_video_size: typing.Optional[ViewportSize] = None,
- base_url: typing.Optional[str] = None,
- strict_selectors: typing.Optional[bool] = None,
- service_workers: typing.Optional[Literal["allow", "block"]] = None,
- record_har_url_filter: typing.Optional[
- typing.Union[typing.Pattern[str], str]
- ] = None,
- record_har_mode: typing.Optional[Literal["full", "minimal"]] = None,
- record_har_content: typing.Optional[Literal["attach", "embed", "omit"]] = None,
- client_certificates: typing.Optional[typing.List[ClientCertificate]] = None,
- ) -> "BrowserContext":
- """BrowserType.launch_persistent_context
- Returns the persistent browser context instance.
- Launches browser that uses persistent storage located at `userDataDir` and returns the only context. Closing this
- context will automatically close the browser.
- Parameters
- ----------
- user_data_dir : Union[pathlib.Path, str]
- Path to a User Data Directory, which stores browser session data like cookies and local storage. Pass an empty
- string to create a temporary directory.
- More details for
- [Chromium](https://chromium.googlesource.com/chromium/src/+/master/docs/user_data_dir.md#introduction) and
- [Firefox](https://wiki.mozilla.org/Firefox/CommandLineOptions#User_profile). Chromium's user data directory is the
- **parent** directory of the "Profile Path" seen at `chrome://version`.
- Note that browsers do not allow launching multiple instances with the same User Data Directory.
- **NOTE** Chromium/Chrome: Due to recent Chrome policy changes, automating the default Chrome user profile is not
- supported. Pointing `userDataDir` to Chrome's main "User Data" directory (the profile used for your regular
- browsing) may result in pages not loading or the browser exiting. Create and use a separate directory (for example,
- an empty folder) as your automation profile instead. See https://developer.chrome.com/blog/remote-debugging-port
- for details.
- channel : Union[str, None]
- Browser distribution channel.
- Use "chromium" to [opt in to new headless mode](../browsers.md#chromium-new-headless-mode).
- Use "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", or
- "msedge-canary" to use branded [Google Chrome and Microsoft Edge](../browsers.md#google-chrome--microsoft-edge).
- executable_path : Union[pathlib.Path, str, None]
- Path to a browser executable to run instead of the bundled one. If `executablePath` is a relative path, then it is
- resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium,
- Firefox or WebKit, use at your own risk.
- args : Union[Sequence[str], None]
- **NOTE** Use custom browser args at your own risk, as some of them may break Playwright functionality.
- Additional arguments to pass to the browser instance. The list of Chromium flags can be found
- [here](https://peter.sh/experiments/chromium-command-line-switches/).
- ignore_default_args : Union[Sequence[str], bool, None]
- If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`. If an array is
- given, then filters out the given default arguments. Dangerous option; use with care. Defaults to `false`.
- handle_sigint : Union[bool, None]
- Close the browser process on Ctrl-C. Defaults to `true`.
- handle_sigterm : Union[bool, None]
- Close the browser process on SIGTERM. Defaults to `true`.
- handle_sighup : Union[bool, None]
- Close the browser process on SIGHUP. Defaults to `true`.
- timeout : Union[float, None]
- Maximum time in milliseconds to wait for the browser instance to start. Defaults to `30000` (30 seconds). Pass `0`
- to disable timeout.
- env : Union[Dict[str, Union[bool, float, str]], None]
- Specify environment variables that will be visible to the browser. Defaults to `process.env`.
- headless : Union[bool, None]
- Whether to run browser in headless mode. More details for
- [Chromium](https://developers.google.com/web/updates/2017/04/headless-chrome) and
- [Firefox](https://hacks.mozilla.org/2017/12/using-headless-mode-in-firefox/). Defaults to `true`.
- proxy : Union[{server: str, bypass: Union[str, None], username: Union[str, None], password: Union[str, None]}, None]
- Network proxy settings.
- downloads_path : Union[pathlib.Path, str, None]
- If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and
- is deleted when browser is closed. In either case, the downloads are deleted when the browser context they were
- created in is closed.
- slow_mo : Union[float, None]
- Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going
- on.
- viewport : Union[{width: int, height: int}, None]
- Sets a consistent viewport for each page. Defaults to an 1280x720 viewport. `no_viewport` disables the fixed
- viewport. Learn more about [viewport emulation](../emulation.md#viewport).
- screen : Union[{width: int, height: int}, None]
- Emulates consistent window screen size available inside web page via `window.screen`. Is only used when the
- `viewport` is set.
- no_viewport : Union[bool, None]
- Does not enforce fixed viewport, allows resizing window in the headed mode.
- ignore_https_errors : Union[bool, None]
- Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
- java_script_enabled : Union[bool, None]
- Whether or not to enable JavaScript in the context. Defaults to `true`. Learn more about
- [disabling JavaScript](../emulation.md#javascript-enabled).
- bypass_csp : Union[bool, None]
- Toggles bypassing page's Content-Security-Policy. Defaults to `false`.
- user_agent : Union[str, None]
- Specific user agent to use in this context.
- locale : Union[str, None]
- Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value,
- `Accept-Language` request header value as well as number and date formatting rules. Defaults to the system default
- locale. Learn more about emulation in our [emulation guide](../emulation.md#locale--timezone).
- timezone_id : Union[str, None]
- Changes the timezone of the context. See
- [ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)
- for a list of supported timezone IDs. Defaults to the system timezone.
- geolocation : Union[{latitude: float, longitude: float, accuracy: Union[float, None]}, None]
- permissions : Union[Sequence[str], None]
- A list of permissions to grant to all pages in this context. See `browser_context.grant_permissions()` for
- more details. Defaults to none.
- extra_http_headers : Union[Dict[str, str], None]
- An object containing additional HTTP headers to be sent with every request. Defaults to none.
- offline : Union[bool, None]
- Whether to emulate network being offline. Defaults to `false`. Learn more about
- [network emulation](../emulation.md#offline).
- http_credentials : Union[{username: str, password: str, origin: Union[str, None], send: Union["always", "unauthorized", None]}, None]
- Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication). If no
- origin is specified, the username and password are sent to any servers upon unauthorized responses.
- device_scale_factor : Union[float, None]
- Specify device scale factor (can be thought of as dpr). Defaults to `1`. Learn more about
- [emulating devices with device scale factor](../emulation.md#devices).
- is_mobile : Union[bool, None]
- Whether the `meta viewport` tag is taken into account and touch events are enabled. isMobile is a part of device,
- so you don't actually need to set it manually. Defaults to `false` and is not supported in Firefox. Learn more
- about [mobile emulation](../emulation.md#ismobile).
- has_touch : Union[bool, None]
- Specifies if viewport supports touch events. Defaults to false. Learn more about
- [mobile emulation](../emulation.md#devices).
- color_scheme : Union["dark", "light", "no-preference", "null", None]
- Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
- media feature, supported values are `'light'` and `'dark'`. See `page.emulate_media()` for more details.
- Passing `'null'` resets emulation to system defaults. Defaults to `'light'`.
- reduced_motion : Union["no-preference", "null", "reduce", None]
- Emulates `'prefers-reduced-motion'` media feature, supported values are `'reduce'`, `'no-preference'`. See
- `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to
- `'no-preference'`.
- forced_colors : Union["active", "none", "null", None]
- Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See
- `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to
- `'none'`.
- contrast : Union["more", "no-preference", "null", None]
- Emulates `'prefers-contrast'` media feature, supported values are `'no-preference'`, `'more'`. See
- `page.emulate_media()` for more details. Passing `'null'` resets emulation to system defaults. Defaults to
- `'no-preference'`.
- accept_downloads : Union[bool, None]
- Whether to automatically download all the attachments. Defaults to `true` where all the downloads are accepted.
- traces_dir : Union[pathlib.Path, str, None]
- If specified, traces are saved into this directory.
- artifacts_dir : Union[pathlib.Path, str, None]
- If specified, artifacts (traces, videos, downloads, HAR files, etc.) are saved into this directory. The directory
- is not cleaned up when the browser closes. If not specified, a temporary directory is used and cleaned up when the
- browser closes.
- chromium_sandbox : Union[bool, None]
- Enable Chromium sandboxing. Defaults to `false`.
- firefox_user_prefs : Union[Dict[str, Union[bool, float, str]], None]
- Firefox user preferences. Learn more about the Firefox user preferences at
- [`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox).
- You can also provide a path to a custom [`policies.json` file](https://mozilla.github.io/policy-templates/) via
- `PLAYWRIGHT_FIREFOX_POLICIES_JSON` environment variable.
- record_har_path : Union[pathlib.Path, str, None]
- Enables [HAR](http://www.softwareishard.com/blog/har-12-spec) recording for all pages into the specified HAR file
- on the filesystem. If not specified, the HAR is not recorded. Make sure to call `browser_context.close()`
- for the HAR to be saved.
- record_har_omit_content : Union[bool, None]
- Optional setting to control whether to omit request content from the HAR. Defaults to `false`.
- record_video_dir : Union[pathlib.Path, str, None]
- Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make
- sure to call `browser_context.close()` for videos to be saved.
- record_video_size : Union[{width: int, height: int}, None]
- Dimensions of the recorded videos. If not specified the size will be equal to `viewport` scaled down to fit into
- 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page
- will be scaled down if necessary to fit the specified size.
- base_url : Union[str, None]
- When using `page.goto()`, `page.route()`, `page.wait_for_url()`,
- `page.expect_request()`, or `page.expect_response()` it takes the base URL in consideration by
- using the [`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the
- corresponding URL. Unset by default. Examples:
- - baseURL: `http://localhost:3000` and navigating to `/bar.html` results in `http://localhost:3000/bar.html`
- - baseURL: `http://localhost:3000/foo/` and navigating to `./bar.html` results in
- `http://localhost:3000/foo/bar.html`
- - baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in
- `http://localhost:3000/bar.html`
- strict_selectors : Union[bool, None]
- If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on
- selectors that imply single target DOM element will throw when more than one element matches the selector. This
- option does not affect any Locator APIs (Locators are always strict). Defaults to `false`. See `Locator` to learn
- more about the strict mode.
- service_workers : Union["allow", "block", None]
- Whether to allow sites to register Service workers. Defaults to `'allow'`.
- - `'allow'`: [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) can be
- registered.
- - `'block'`: Playwright will block all registration of Service Workers.
- record_har_url_filter : Union[Pattern[str], str, None]
- record_har_mode : Union["full", "minimal", None]
- When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page,
- cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.
- record_har_content : Union["attach", "embed", "omit", None]
- Optional setting to control resource content management. If `omit` is specified, content is not persisted. If
- `attach` is specified, resources are persisted as separate files and all of these files are archived along with the
- HAR file. Defaults to `embed`, which stores content inline the HAR file as per HAR specification.
- client_certificates : Union[Sequence[{origin: str, certPath: Union[pathlib.Path, str, None], cert: Union[bytes, None], keyPath: Union[pathlib.Path, str, None], key: Union[bytes, None], pfxPath: Union[pathlib.Path, str, None], pfx: Union[bytes, None], passphrase: Union[str, None]}], None]
- TLS Client Authentication allows the server to request a client certificate and verify it.
- **Details**
- An array of client certificates to be used. Each certificate object must have either both `certPath` and `keyPath`,
- a single `pfxPath`, or their corresponding direct value equivalents (`cert` and `key`, or `pfx`). Optionally,
- `passphrase` property should be provided if the certificate is encrypted. The `origin` property should be provided
- with an exact match to the request origin that the certificate is valid for.
- Client certificate authentication is only active when at least one client certificate is provided. If you want to
- reject all client certificates sent by the server, you need to provide a client certificate with an `origin` that
- does not match any of the domains you plan to visit.
- **NOTE** When using WebKit on macOS, accessing `localhost` will not pick up client certificates. You can make it
- work by replacing `localhost` with `local.playwright`.
- Returns
- -------
- BrowserContext
- """
- return mapping.from_impl(
- await self._impl_obj.launch_persistent_context(
- userDataDir=user_data_dir,
- channel=channel,
- executablePath=executable_path,
- args=mapping.to_impl(args),
- ignoreDefaultArgs=mapping.to_impl(ignore_default_args),
- handleSIGINT=handle_sigint,
- handleSIGTERM=handle_sigterm,
- handleSIGHUP=handle_sighup,
- timeout=to_milliseconds(timeout),
- env=mapping.to_impl(env),
- headless=headless,
- proxy=proxy,
- downloadsPath=downloads_path,
- slowMo=slow_mo,
- viewport=viewport,
- screen=screen,
- noViewport=no_viewport,
- ignoreHTTPSErrors=ignore_https_errors,
- javaScriptEnabled=java_script_enabled,
- bypassCSP=bypass_csp,
- userAgent=user_agent,
- locale=locale,
- timezoneId=timezone_id,
- geolocation=geolocation,
- permissions=mapping.to_impl(permissions),
- extraHTTPHeaders=mapping.to_impl(extra_http_headers),
- offline=offline,
- httpCredentials=http_credentials,
- deviceScaleFactor=device_scale_factor,
- isMobile=is_mobile,
- hasTouch=has_touch,
- colorScheme=color_scheme,
- reducedMotion=reduced_motion,
- forcedColors=forced_colors,
- contrast=contrast,
- acceptDownloads=accept_downloads,
- tracesDir=traces_dir,
- artifactsDir=artifacts_dir,
- chromiumSandbox=chromium_sandbox,
- firefoxUserPrefs=mapping.to_impl(firefox_user_prefs),
- recordHarPath=record_har_path,
- recordHarOmitContent=record_har_omit_content,
- recordVideoDir=record_video_dir,
- recordVideoSize=record_video_size,
- baseURL=base_url,
- strictSelectors=strict_selectors,
- serviceWorkers=service_workers,
- recordHarUrlFilter=record_har_url_filter,
- recordHarMode=record_har_mode,
- recordHarContent=record_har_content,
- clientCertificates=client_certificates,
- )
- )
- async def connect_over_cdp(
- self,
- endpoint_url: str,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- slow_mo: typing.Optional[float] = None,
- headers: typing.Optional[typing.Dict[str, str]] = None,
- is_local: typing.Optional[bool] = None,
- no_defaults: typing.Optional[bool] = None,
- ) -> "Browser":
- """BrowserType.connect_over_cdp
- This method attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.
- The default browser context is accessible via `browser.contexts()`.
- **NOTE** Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.
- **NOTE** This connection is significantly lower fidelity than the Playwright protocol connection via
- `browser_type.connect()`. If you are experiencing issues or attempting to use advanced functionality, you
- probably want to use `browser_type.connect()`.
- **Usage**
- ```py
- browser = await playwright.chromium.connect_over_cdp(\"http://localhost:9222\")
- default_context = browser.contexts[0]
- page = default_context.pages[0]
- ```
- Parameters
- ----------
- endpoint_url : str
- A CDP websocket endpoint or http url to connect to. For example `http://localhost:9222/` or
- `ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4`.
- timeout : Union[float, None]
- Maximum time in milliseconds to wait for the connection to be established. Defaults to `30000` (30 seconds). Pass
- `0` to disable timeout.
- slow_mo : Union[float, None]
- Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going
- on. Defaults to 0.
- headers : Union[Dict[str, str], None]
- Additional HTTP headers to be sent with connect request. Optional.
- is_local : Union[bool, None]
- Tells Playwright that it runs on the same host as the CDP server. It will enable certain optimizations that rely
- upon the file system being the same between Playwright and the Browser.
- no_defaults : Union[bool, None]
- When true, Playwright will not apply its default overrides to the existing default browser context. Specifically,
- `acceptDownloads` is left at the browser's setting, focus emulation is not enabled, and media emulation options
- (such as `colorScheme`, `reducedMotion`, `forcedColors`, and `contrast`) are not applied. Useful when attaching to
- a user's daily-driver browser where these overrides would interfere with existing browser state. New contexts
- created via `browser.new_context()` are not affected. Defaults to `false`.
- Returns
- -------
- Browser
- """
- return mapping.from_impl(
- await self._impl_obj.connect_over_cdp(
- endpointURL=endpoint_url,
- timeout=to_milliseconds(timeout),
- slowMo=slow_mo,
- headers=mapping.to_impl(headers),
- isLocal=is_local,
- noDefaults=no_defaults,
- )
- )
- async def connect(
- self,
- endpoint: str,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- slow_mo: typing.Optional[float] = None,
- headers: typing.Optional[typing.Dict[str, str]] = None,
- expose_network: typing.Optional[str] = None,
- ) -> "Browser":
- """BrowserType.connect
- This method attaches Playwright to an existing browser instance created via `BrowserType.launchServer` in Node.js.
- **NOTE** The major and minor version of the Playwright instance that connects needs to match the version of
- Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).
- Parameters
- ----------
- endpoint : str
- A Playwright browser websocket endpoint to connect to. You obtain this endpoint via `BrowserServer.wsEndpoint`.
- timeout : Union[float, None]
- Maximum time in milliseconds to wait for the connection to be established. Defaults to `0` (no timeout).
- slow_mo : Union[float, None]
- Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going
- on. Defaults to 0.
- headers : Union[Dict[str, str], None]
- Additional HTTP headers to be sent with web socket connect request. Optional.
- expose_network : Union[str, None]
- This option exposes network available on the connecting client to the browser being connected to. Consists of a
- list of rules separated by comma.
- Available rules:
- 1. Hostname pattern, for example: `example.com`, `*.org:99`, `x.*.y.com`, `*foo.org`.
- 1. IP literal, for example: `127.0.0.1`, `0.0.0.0:99`, `[::1]`, `[0:0::1]:99`.
- 1. `<loopback>` that matches local loopback interfaces: `localhost`, `*.localhost`, `127.0.0.1`, `[::1]`.
- Some common examples:
- 1. `"*"` to expose all network.
- 1. `"<loopback>"` to expose localhost network.
- 1. `"*.test.internal-domain,*.staging.internal-domain,<loopback>"` to expose test/staging deployments and
- localhost.
- Returns
- -------
- Browser
- """
- return mapping.from_impl(
- await self._impl_obj.connect(
- endpoint=endpoint,
- timeout=to_milliseconds(timeout),
- slowMo=slow_mo,
- headers=mapping.to_impl(headers),
- exposeNetwork=expose_network,
- )
- )
- mapping.register(BrowserTypeImpl, BrowserType)
- class Playwright(AsyncBase):
- @property
- def devices(self) -> typing.Dict:
- """Playwright.devices
- Returns a dictionary of devices to be used with `browser.new_context()` or `browser.new_page()`.
- ```py
- import asyncio
- from playwright.async_api import async_playwright, Playwright
- async def run(playwright: Playwright):
- webkit = playwright.webkit
- iphone = playwright.devices[\"iPhone 6\"]
- browser = await webkit.launch()
- context = await browser.new_context(**iphone)
- page = await context.new_page()
- await page.goto(\"http://example.com\")
- # other actions...
- await browser.close()
- async def main():
- async with async_playwright() as playwright:
- await run(playwright)
- asyncio.run(main())
- ```
- Returns
- -------
- Dict
- """
- return mapping.from_maybe_impl(self._impl_obj.devices)
- @property
- def selectors(self) -> "Selectors":
- """Playwright.selectors
- Selectors can be used to install custom selector engines. See [extensibility](https://playwright.dev/python/docs/extensibility) for more
- information.
- Returns
- -------
- Selectors
- """
- return mapping.from_impl(self._impl_obj.selectors)
- @property
- def chromium(self) -> "BrowserType":
- """Playwright.chromium
- This object can be used to launch or connect to Chromium, returning instances of `Browser`.
- Returns
- -------
- BrowserType
- """
- return mapping.from_impl(self._impl_obj.chromium)
- @property
- def firefox(self) -> "BrowserType":
- """Playwright.firefox
- This object can be used to launch or connect to Firefox, returning instances of `Browser`.
- Returns
- -------
- BrowserType
- """
- return mapping.from_impl(self._impl_obj.firefox)
- @property
- def webkit(self) -> "BrowserType":
- """Playwright.webkit
- This object can be used to launch or connect to WebKit, returning instances of `Browser`.
- Returns
- -------
- BrowserType
- """
- return mapping.from_impl(self._impl_obj.webkit)
- @property
- def request(self) -> "APIRequest":
- """Playwright.request
- Exposes API that can be used for the Web API testing.
- Returns
- -------
- APIRequest
- """
- return mapping.from_impl(self._impl_obj.request)
- def __getitem__(self, value: str) -> "BrowserType":
- return mapping.from_impl(self._impl_obj.__getitem__(value=value))
- async def stop(self) -> None:
- """Playwright.stop
- Terminates this instance of Playwright in case it was created bypassing the Python context manager. This is useful
- in REPL applications.
- ```py
- from playwright.sync_api import sync_playwright
- playwright = sync_playwright().start()
- browser = playwright.chromium.launch()
- page = browser.new_page()
- page.goto(\"https://playwright.dev/\")
- page.screenshot(path=\"example.png\")
- browser.close()
- playwright.stop()
- ```
- """
- return mapping.from_maybe_impl(await self._impl_obj.stop())
- mapping.register(PlaywrightImpl, Playwright)
- class Tracing(AsyncBase):
- async def start(
- self,
- *,
- name: typing.Optional[str] = None,
- title: typing.Optional[str] = None,
- snapshots: typing.Optional[bool] = None,
- screenshots: typing.Optional[bool] = None,
- sources: typing.Optional[bool] = None,
- live: typing.Optional[bool] = None,
- ) -> None:
- """Tracing.start
- Start tracing.
- **NOTE** You probably want to
- [enable tracing in your config file](https://playwright.dev/docs/api/class-testoptions#test-options-trace) instead
- of using `Tracing.start`.
- The `context.tracing` API captures browser operations and network activity, but it doesn't record test assertions
- (like `expect` calls). We recommend
- [enabling tracing through Playwright Test configuration](https://playwright.dev/docs/api/class-testoptions#test-options-trace),
- which includes those assertions and provides a more complete trace for debugging test failures.
- **Usage**
- ```py
- await context.tracing.start(screenshots=True, snapshots=True)
- page = await context.new_page()
- await page.goto(\"https://playwright.dev\")
- await context.tracing.stop(path = \"trace.zip\")
- ```
- Parameters
- ----------
- name : Union[str, None]
- If specified, intermediate trace files are going to be saved into the files with the given name prefix inside the
- `tracesDir` directory specified in `browser_type.launch()`. To specify the final trace zip file name, you
- need to pass `path` option to `tracing.stop()` instead.
- title : Union[str, None]
- Trace name to be shown in the Trace Viewer.
- snapshots : Union[bool, None]
- If this option is true tracing will
- - capture DOM snapshot on every action
- - record network activity
- screenshots : Union[bool, None]
- Whether to capture screenshots during tracing. Screenshots are used to build a timeline preview.
- sources : Union[bool, None]
- Whether to include source files for trace actions.
- live : Union[bool, None]
- When enabled, the trace is written to an unarchived file that is updated in real time as actions occur, instead of
- caching changes and archiving them into a zip file at the end. This is useful for live trace viewing during test
- execution.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.start(
- name=name,
- title=title,
- snapshots=snapshots,
- screenshots=screenshots,
- sources=sources,
- live=live,
- )
- )
- async def start_chunk(
- self, *, title: typing.Optional[str] = None, name: typing.Optional[str] = None
- ) -> None:
- """Tracing.start_chunk
- Start a new trace chunk. If you'd like to record multiple traces on the same `BrowserContext`, use
- `tracing.start()` once, and then create multiple trace chunks with `tracing.start_chunk()` and
- `tracing.stop_chunk()`.
- **Usage**
- ```py
- await context.tracing.start(screenshots=True, snapshots=True)
- page = await context.new_page()
- await page.goto(\"https://playwright.dev\")
- await context.tracing.start_chunk()
- await page.get_by_text(\"Get Started\").click()
- # Everything between start_chunk and stop_chunk will be recorded in the trace.
- await context.tracing.stop_chunk(path = \"trace1.zip\")
- await context.tracing.start_chunk()
- await page.goto(\"http://example.com\")
- # Save a second trace file with different actions.
- await context.tracing.stop_chunk(path = \"trace2.zip\")
- ```
- Parameters
- ----------
- title : Union[str, None]
- Trace name to be shown in the Trace Viewer.
- name : Union[str, None]
- If specified, intermediate trace files are going to be saved into the files with the given name prefix inside the
- `tracesDir` directory specified in `browser_type.launch()`. To specify the final trace zip file name, you
- need to pass `path` option to `tracing.stop_chunk()` instead.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.start_chunk(title=title, name=name)
- )
- async def stop_chunk(
- self, *, path: typing.Optional[typing.Union[pathlib.Path, str]] = None
- ) -> None:
- """Tracing.stop_chunk
- Stop the trace chunk. See `tracing.start_chunk()` for more details about multiple trace chunks.
- Parameters
- ----------
- path : Union[pathlib.Path, str, None]
- Export trace collected since the last `tracing.start_chunk()` call into the file with the given path.
- """
- return mapping.from_maybe_impl(await self._impl_obj.stop_chunk(path=path))
- async def stop(
- self, *, path: typing.Optional[typing.Union[pathlib.Path, str]] = None
- ) -> None:
- """Tracing.stop
- Stop tracing.
- Parameters
- ----------
- path : Union[pathlib.Path, str, None]
- Export trace into the file with the given path.
- """
- return mapping.from_maybe_impl(await self._impl_obj.stop(path=path))
- async def group(
- self, name: str, *, location: typing.Optional[TracingGroupLocation] = None
- ) -> "AsyncContextManager":
- """Tracing.group
- **NOTE** Use `test.step` instead when available.
- Creates a new group within the trace, assigning any subsequent API calls to this group, until
- `tracing.group_end()` is called. Groups can be nested and will be visible in the trace viewer.
- **Usage**
- ```py
- # All actions between group and group_end
- # will be shown in the trace viewer as a group.
- page.context.tracing.group(\"Open Playwright.dev > API\")
- page.goto(\"https://playwright.dev/\")
- page.get_by_role(\"link\", name=\"API\").click()
- page.context.tracing.group_end()
- ```
- Parameters
- ----------
- name : str
- Group name shown in the trace viewer.
- location : Union[{file: str, line: Union[int, None], column: Union[int, None]}, None]
- Specifies a custom location for the group to be shown in the trace viewer. Defaults to the location of the
- `tracing.group()` call.
- Returns
- -------
- AsyncContextManager
- """
- return mapping.from_impl(
- await self._impl_obj.group(name=name, location=location)
- )
- async def group_end(self) -> None:
- """Tracing.group_end
- Closes the last group created by `tracing.group()`.
- """
- return mapping.from_maybe_impl(await self._impl_obj.group_end())
- async def start_har(
- self,
- path: typing.Union[pathlib.Path, str],
- *,
- content: typing.Optional[Literal["attach", "embed", "omit"]] = None,
- mode: typing.Optional[Literal["full", "minimal"]] = None,
- url_filter: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- ) -> "AsyncContextManager":
- """Tracing.start_har
- Start recording a HAR (HTTP Archive) of network activity in this context. The HAR file is written to disk when
- `tracing.stop_har()` is called, or when the returned `Disposable` is disposed.
- Only one HAR recording can be active at a time per `BrowserContext`.
- **Usage**
- ```py
- await context.tracing.start_har(\"trace.har\")
- page = await context.new_page()
- await page.goto(\"https://playwright.dev\")
- await context.tracing.stop_har()
- ```
- Parameters
- ----------
- path : Union[pathlib.Path, str]
- Path on the filesystem to write the HAR file to. If the file name ends with `.zip`, the HAR is saved as a zip
- archive with response bodies attached as separate files.
- content : Union["attach", "embed", "omit", None]
- Optional setting to control resource content management. If `omit` is specified, content is not persisted. If
- `attach` is specified, resources are persisted as separate files or entries in the ZIP archive. If `embed` is
- specified, content is stored inline the HAR file as per HAR specification. Defaults to `attach` for `.zip` output
- files and to `embed` for all other file extensions.
- mode : Union["full", "minimal", None]
- When set to `minimal`, only record information necessary for routing from HAR. This omits sizes, timing, page,
- cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to `full`.
- url_filter : Union[Pattern[str], str, None]
- A glob or regex pattern to filter requests that are stored in the HAR. Defaults to none.
- Returns
- -------
- AsyncContextManager
- """
- return mapping.from_impl(
- await self._impl_obj.start_har(
- path=path, content=content, mode=mode, urlFilter=url_filter
- )
- )
- async def stop_har(self) -> None:
- """Tracing.stop_har
- Stop HAR recording and save the HAR file to the path given to `tracing.start_har()`.
- """
- return mapping.from_maybe_impl(await self._impl_obj.stop_har())
- mapping.register(TracingImpl, Tracing)
- class Locator(AsyncBase):
- @property
- def page(self) -> "Page":
- """Locator.page
- A page this locator belongs to.
- Returns
- -------
- Page
- """
- return mapping.from_impl(self._impl_obj.page)
- @property
- def first(self) -> "Locator":
- """Locator.first
- Returns locator to the first matching element.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.first)
- @property
- def last(self) -> "Locator":
- """Locator.last
- Returns locator to the last matching element.
- **Usage**
- ```py
- banana = await page.get_by_role(\"listitem\").last
- ```
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.last)
- @property
- def content_frame(self) -> "FrameLocator":
- """Locator.content_frame
- Returns a `FrameLocator` object pointing to the same `iframe` as this locator.
- Useful when you have a `Locator` object obtained somewhere, and later on would like to interact with the content
- inside the frame.
- For a reverse operation, use `frame_locator.owner()`.
- **Usage**
- ```py
- locator = page.locator(\"iframe[name=\\\"embedded\\\"]\")
- # ...
- frame_locator = locator.content_frame
- await frame_locator.get_by_role(\"button\").click()
- ```
- Returns
- -------
- FrameLocator
- """
- return mapping.from_impl(self._impl_obj.content_frame)
- @property
- def description(self) -> typing.Optional[str]:
- """Locator.description
- Returns locator description previously set with `locator.describe()`. Returns `null` if no custom
- description has been set.
- **Usage**
- ```py
- button = page.get_by_role(\"button\").describe(\"Subscribe button\")
- print(button.description()) # \"Subscribe button\"
- input = page.get_by_role(\"textbox\")
- print(input.description()) # None
- ```
- Returns
- -------
- Union[str, None]
- """
- return mapping.from_maybe_impl(self._impl_obj.description)
- async def bounding_box(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> typing.Optional[FloatRect]:
- """Locator.bounding_box
- This method returns the bounding box of the element matching the locator, or `null` if the element is not visible.
- The bounding box is calculated relative to the main frame viewport - which is usually the same as the browser
- window.
- **Details**
- Scrolling affects the returned bounding box, similarly to
- [Element.getBoundingClientRect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect).
- That means `x` and/or `y` may be negative.
- Elements from child frames return the bounding box relative to the main frame, unlike the
- [Element.getBoundingClientRect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect).
- Assuming the page is static, it is safe to use bounding box coordinates to perform input. For example, the
- following snippet should click the center of the element.
- **Usage**
- ```py
- box = await page.get_by_role(\"button\").bounding_box()
- await page.mouse.click(box[\"x\"] + box[\"width\"] / 2, box[\"y\"] + box[\"height\"] / 2)
- ```
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- Union[{x: float, y: float, width: float, height: float}, None]
- """
- return mapping.from_impl_nullable(
- await self._impl_obj.bounding_box(timeout=to_milliseconds(timeout))
- )
- async def check(
- self,
- *,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """Locator.check
- Ensure that checkbox or radio element is checked.
- **Details**
- Performs the following steps:
- 1. Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already
- checked, this method returns immediately.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the element, unless `force` option is set.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to click in the center of the element.
- 1. Ensure that the element is now checked. If not, this method throws.
- If the element is detached from the DOM at any moment during the action, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- **Usage**
- ```py
- await page.get_by_role(\"checkbox\").check()
- ```
- Parameters
- ----------
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.check(
- position=position,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- trial=trial,
- )
- )
- async def click(
- self,
- *,
- modifiers: typing.Optional[
- typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]
- ] = None,
- position: typing.Optional[Position] = None,
- delay: typing.Optional[float] = None,
- button: typing.Optional[Literal["left", "middle", "right"]] = None,
- click_count: typing.Optional[int] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- steps: typing.Optional[int] = None,
- ) -> None:
- """Locator.click
- Click an element.
- **Details**
- This method clicks the element by performing the following steps:
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the element, unless `force` option is set.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to click in the center of the element, or the specified `position`.
- 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
- If the element is detached from the DOM at any moment during the action, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- **Usage**
- Click a button:
- ```py
- await page.get_by_role(\"button\").click()
- ```
- Shift-right-click at a specific position on a canvas:
- ```py
- await page.locator(\"canvas\").click(
- button=\"right\", modifiers=[\"Shift\"], position={\"x\": 23, \"y\": 32}
- )
- ```
- Parameters
- ----------
- modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
- Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
- current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
- "Control" on Windows and Linux and to "Meta" on macOS.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- delay : Union[float, None]
- Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
- button : Union["left", "middle", "right", None]
- Defaults to `left`.
- click_count : Union[int, None]
- defaults to 1. See [UIEvent.detail].
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
- can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
- navigating to inaccessible pages. Defaults to `false`.
- Deprecated: This option will default to `true` in the future.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard
- `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys
- are pressed.
- steps : Union[int, None]
- Defaults to 1. Sends `n` interpolated `mousemove` events to represent travel between Playwright's current cursor
- position and the provided destination. When set to 1, emits a single `mousemove` event at the destination location.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.click(
- modifiers=mapping.to_impl(modifiers),
- position=position,
- delay=delay,
- button=button,
- clickCount=click_count,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- trial=trial,
- steps=steps,
- )
- )
- async def dblclick(
- self,
- *,
- modifiers: typing.Optional[
- typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]
- ] = None,
- position: typing.Optional[Position] = None,
- delay: typing.Optional[float] = None,
- button: typing.Optional[Literal["left", "middle", "right"]] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- steps: typing.Optional[int] = None,
- ) -> None:
- """Locator.dblclick
- Double-click an element.
- **Details**
- This method double clicks the element by performing the following steps:
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the element, unless `force` option is set.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to double click in the center of the element, or the specified `position`.
- If the element is detached from the DOM at any moment during the action, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- **NOTE** `element.dblclick()` dispatches two `click` events and a single `dblclick` event.
- Parameters
- ----------
- modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
- Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
- current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
- "Control" on Windows and Linux and to "Meta" on macOS.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- delay : Union[float, None]
- Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
- button : Union["left", "middle", "right", None]
- Defaults to `left`.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard
- `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys
- are pressed.
- steps : Union[int, None]
- Defaults to 1. Sends `n` interpolated `mousemove` events to represent travel between Playwright's current cursor
- position and the provided destination. When set to 1, emits a single `mousemove` event at the destination location.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.dblclick(
- modifiers=mapping.to_impl(modifiers),
- position=position,
- delay=delay,
- button=button,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- trial=trial,
- steps=steps,
- )
- )
- async def dispatch_event(
- self,
- type: str,
- event_init: typing.Optional[typing.Dict] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """Locator.dispatch_event
- Programmatically dispatch an event on the matching element.
- **Usage**
- ```py
- await locator.dispatch_event(\"click\")
- ```
- **Details**
- The snippet above dispatches the `click` event on the element. Regardless of the visibility state of the element,
- `click` is dispatched. This is equivalent to calling
- [element.click()](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/click).
- Under the hood, it creates an instance of an event based on the given `type`, initializes it with `eventInit`
- properties and dispatches it on the element. Events are `composed`, `cancelable` and bubble by default.
- Since `eventInit` is event-specific, please refer to the events documentation for the lists of initial properties:
- - [DeviceMotionEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent/DeviceMotionEvent)
- - [DeviceOrientationEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceOrientationEvent/DeviceOrientationEvent)
- - [DragEvent](https://developer.mozilla.org/en-US/docs/Web/API/DragEvent/DragEvent)
- - [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event/Event)
- - [FocusEvent](https://developer.mozilla.org/en-US/docs/Web/API/FocusEvent/FocusEvent)
- - [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/KeyboardEvent)
- - [MouseEvent](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/MouseEvent)
- - [PointerEvent](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/PointerEvent)
- - [TouchEvent](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent/TouchEvent)
- - [WheelEvent](https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/WheelEvent)
- You can also specify `JSHandle` as the property value if you want live objects to be passed into the event:
- ```py
- data_transfer = await page.evaluate_handle(\"new DataTransfer()\")
- await locator.dispatch_event(\"#source\", \"dragstart\", {\"dataTransfer\": data_transfer})
- ```
- Parameters
- ----------
- type : str
- DOM event type: `"click"`, `"dragstart"`, etc.
- event_init : Union[Dict, None]
- Optional event-specific initialization properties.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.dispatch_event(
- type=type,
- eventInit=mapping.to_impl(event_init),
- timeout=to_milliseconds(timeout),
- )
- )
- async def evaluate(
- self,
- expression: str,
- arg: typing.Optional[typing.Any] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> typing.Any:
- """Locator.evaluate
- Execute JavaScript code in the page, taking the matching element as an argument.
- **Details**
- Returns the return value of `expression`, called with the matching element as a first argument, and `arg` as a
- second argument.
- If `expression` returns a [Promise], this method will wait for the promise to resolve and return its value.
- If `expression` throws or rejects, this method throws.
- **Usage**
- Passing argument to `expression`:
- ```py
- result = await page.get_by_testid(\"myId\").evaluate(\"(element, [x, y]) => element.textContent + ' ' + x * y\", [7, 8])
- print(result) # prints \"myId text 56\"
- ```
- Parameters
- ----------
- expression : str
- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
- function is automatically invoked.
- arg : Union[Any, None]
- Optional argument to pass to `expression`.
- timeout : Union[float, None]
- Maximum time in milliseconds to wait for the locator before evaluating. Note that after locator is resolved,
- evaluation itself is not limited by the timeout. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.
- Returns
- -------
- Any
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.evaluate(
- expression=expression,
- arg=mapping.to_impl(arg),
- timeout=to_milliseconds(timeout),
- )
- )
- async def evaluate_all(
- self, expression: str, arg: typing.Optional[typing.Any] = None
- ) -> typing.Any:
- """Locator.evaluate_all
- Execute JavaScript code in the page, taking all matching elements as an argument.
- **Details**
- Returns the return value of `expression`, called with an array of all matching elements as a first argument, and
- `arg` as a second argument.
- If `expression` returns a [Promise], this method will wait for the promise to resolve and return its value.
- If `expression` throws or rejects, this method throws.
- **Usage**
- ```py
- locator = page.locator(\"div\")
- more_than_ten = await locator.evaluate_all(\"(divs, min) => divs.length > min\", 10)
- ```
- Parameters
- ----------
- expression : str
- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
- function is automatically invoked.
- arg : Union[Any, None]
- Optional argument to pass to `expression`.
- Returns
- -------
- Any
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.evaluate_all(
- expression=expression, arg=mapping.to_impl(arg)
- )
- )
- async def evaluate_handle(
- self,
- expression: str,
- arg: typing.Optional[typing.Any] = None,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> "JSHandle":
- """Locator.evaluate_handle
- Execute JavaScript code in the page, taking the matching element as an argument, and return a `JSHandle` with the
- result.
- **Details**
- Returns the return value of `expression` as a`JSHandle`, called with the matching element as a first argument, and
- `arg` as a second argument.
- The only difference between `locator.evaluate()` and `locator.evaluate_handle()` is that
- `locator.evaluate_handle()` returns `JSHandle`.
- If `expression` returns a [Promise], this method will wait for the promise to resolve and return its value.
- If `expression` throws or rejects, this method throws.
- See `page.evaluate_handle()` for more details.
- Parameters
- ----------
- expression : str
- JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the
- function is automatically invoked.
- arg : Union[Any, None]
- Optional argument to pass to `expression`.
- timeout : Union[float, None]
- Maximum time in milliseconds to wait for the locator before evaluating. Note that after locator is resolved,
- evaluation itself is not limited by the timeout. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.
- Returns
- -------
- JSHandle
- """
- return mapping.from_impl(
- await self._impl_obj.evaluate_handle(
- expression=expression,
- arg=mapping.to_impl(arg),
- timeout=to_milliseconds(timeout),
- )
- )
- async def fill(
- self,
- value: str,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- force: typing.Optional[bool] = None,
- ) -> None:
- """Locator.fill
- Set a value to the input field.
- **Usage**
- ```py
- await page.get_by_role(\"textbox\").fill(\"example value\")
- ```
- **Details**
- This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, focuses the element, fills it and triggers an
- `input` event after filling. Note that you can pass an empty string to clear the input field.
- If the target element is not an `<input>`, `<textarea>` or `[contenteditable]` element, this method throws an
- error. However, if the element is inside the `<label>` element that has an associated
- [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be filled
- instead.
- To send fine-grained keyboard events, use `locator.press_sequentially()`.
- Parameters
- ----------
- value : str
- Value to set for the `<input>`, `<textarea>` or `[contenteditable]` element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.fill(
- value=value,
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- force=force,
- )
- )
- async def clear(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- force: typing.Optional[bool] = None,
- ) -> None:
- """Locator.clear
- Clear the input field.
- **Details**
- This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, focuses the element, clears it and triggers an
- `input` event after clearing.
- If the target element is not an `<input>`, `<textarea>` or `[contenteditable]` element, this method throws an
- error. However, if the element is inside the `<label>` element that has an associated
- [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be cleared
- instead.
- **Usage**
- ```py
- await page.get_by_role(\"textbox\").clear()
- ```
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.clear(
- timeout=to_milliseconds(timeout), noWaitAfter=no_wait_after, force=force
- )
- )
- def locator(
- self,
- selector_or_locator: typing.Union[str, "Locator"],
- *,
- has_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- has_not_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- has: typing.Optional["Locator"] = None,
- has_not: typing.Optional["Locator"] = None,
- ) -> "Locator":
- """Locator.locator
- The method finds an element matching the specified selector in the locator's subtree. It also accepts filter
- options, similar to `locator.filter()` method.
- [Learn more about locators](https://playwright.dev/python/docs/locators).
- Parameters
- ----------
- selector_or_locator : Union[Locator, str]
- A selector or locator to use when resolving DOM element.
- has_text : Union[Pattern[str], str, None]
- Matches elements containing specified text somewhere inside, possibly in a child or a descendant element. When
- passed a [string], matching is case-insensitive and searches for a substring. For example, `"Playwright"` matches
- `<article><div>Playwright</div></article>`.
- has_not_text : Union[Pattern[str], str, None]
- Matches elements that do not contain specified text somewhere inside, possibly in a child or a descendant element.
- When passed a [string], matching is case-insensitive and searches for a substring.
- has : Union[Locator, None]
- Narrows down the results of the method to those which contain elements matching this relative locator. For example,
- `article` that has `text=Playwright` matches `<article><div>Playwright</div></article>`.
- Inner locator **must be relative** to the outer locator and is queried starting with the outer locator match, not
- the document root. For example, you can find `content` that has `div` in
- `<article><content><div>Playwright</div></content></article>`. However, looking for `content` that has `article
- div` will fail, because the inner locator must be relative and should not use any elements outside the `content`.
- Note that outer and inner locators must belong to the same frame. Inner locator must not contain `FrameLocator`s.
- has_not : Union[Locator, None]
- Matches elements that do not contain an element that matches an inner locator. Inner locator is queried against the
- outer one. For example, `article` that does not have `div` matches `<article><span>Playwright</span></article>`.
- Note that outer and inner locators must belong to the same frame. Inner locator must not contain `FrameLocator`s.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(
- self._impl_obj.locator(
- selectorOrLocator=selector_or_locator,
- hasText=has_text,
- hasNotText=has_not_text,
- has=has._impl_obj if has else None,
- hasNot=has_not._impl_obj if has_not else None,
- )
- )
- def get_by_alt_text(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """Locator.get_by_alt_text
- Allows locating elements by their alt text.
- **Usage**
- For example, this method will find the image by alt text \"Playwright logo\":
- ```html
- <img alt='Playwright logo'>
- ```
- ```py
- await page.get_by_alt_text(\"Playwright logo\").click()
- ```
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_alt_text(text=text, exact=exact))
- def get_by_label(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """Locator.get_by_label
- Allows locating input elements by the text of the associated `<label>` or `aria-labelledby` element, or by the
- `aria-label` attribute.
- **Usage**
- For example, this method will find inputs by label \"Username\" and \"Password\" in the following DOM:
- ```html
- <input aria-label=\"Username\">
- <label for=\"password-input\">Password:</label>
- <input id=\"password-input\">
- ```
- ```py
- await page.get_by_label(\"Username\").fill(\"john\")
- await page.get_by_label(\"Password\").fill(\"secret\")
- ```
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_label(text=text, exact=exact))
- def get_by_placeholder(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """Locator.get_by_placeholder
- Allows locating input elements by the placeholder text.
- **Usage**
- For example, consider the following DOM structure.
- ```html
- <input type=\"email\" placeholder=\"name@example.com\" />
- ```
- You can fill the input after locating it by the placeholder text:
- ```py
- await page.get_by_placeholder(\"name@example.com\").fill(\"playwright@microsoft.com\")
- ```
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(
- self._impl_obj.get_by_placeholder(text=text, exact=exact)
- )
- def get_by_role(
- self,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "blockquote",
- "button",
- "caption",
- "cell",
- "checkbox",
- "code",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "deletion",
- "dialog",
- "directory",
- "document",
- "emphasis",
- "feed",
- "figure",
- "form",
- "generic",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "insertion",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "meter",
- "navigation",
- "none",
- "note",
- "option",
- "paragraph",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "strong",
- "subscript",
- "superscript",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "time",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ],
- *,
- checked: typing.Optional[bool] = None,
- disabled: typing.Optional[bool] = None,
- expanded: typing.Optional[bool] = None,
- include_hidden: typing.Optional[bool] = None,
- level: typing.Optional[int] = None,
- name: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- pressed: typing.Optional[bool] = None,
- selected: typing.Optional[bool] = None,
- exact: typing.Optional[bool] = None,
- description: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- ) -> "Locator":
- """Locator.get_by_role
- Allows locating elements by their [ARIA role](https://www.w3.org/TR/wai-aria-1.2/#roles),
- [ARIA attributes](https://www.w3.org/TR/wai-aria-1.2/#aria-attributes) and
- [accessible name](https://w3c.github.io/accname/#dfn-accessible-name).
- **Usage**
- Consider the following DOM structure.
- ```html
- <h3>Sign up</h3>
- <label>
- <input type=\"checkbox\" /> Subscribe
- </label>
- <br/>
- <button>Submit</button>
- ```
- You can locate each element by its implicit role:
- ```py
- await expect(page.get_by_role(\"heading\", name=\"Sign up\")).to_be_visible()
- await page.get_by_role(\"checkbox\", name=\"Subscribe\").check()
- await page.get_by_role(\"button\", name=re.compile(\"submit\", re.IGNORECASE)).click()
- ```
- **Details**
- Role selector **does not replace** accessibility audits and conformance tests, but rather gives early feedback
- about the ARIA guidelines.
- Many html elements have an implicitly [defined role](https://w3c.github.io/html-aam/#html-element-role-mappings)
- that is recognized by the role selector. You can find all the
- [supported roles here](https://www.w3.org/TR/wai-aria-1.2/#role_definitions). ARIA guidelines **do not recommend**
- duplicating implicit roles and attributes by setting `role` and/or `aria-*` attributes to default values.
- Parameters
- ----------
- role : Union["alert", "alertdialog", "application", "article", "banner", "blockquote", "button", "caption", "cell", "checkbox", "code", "columnheader", "combobox", "complementary", "contentinfo", "definition", "deletion", "dialog", "directory", "document", "emphasis", "feed", "figure", "form", "generic", "grid", "gridcell", "group", "heading", "img", "insertion", "link", "list", "listbox", "listitem", "log", "main", "marquee", "math", "menu", "menubar", "menuitem", "menuitemcheckbox", "menuitemradio", "meter", "navigation", "none", "note", "option", "paragraph", "presentation", "progressbar", "radio", "radiogroup", "region", "row", "rowgroup", "rowheader", "scrollbar", "search", "searchbox", "separator", "slider", "spinbutton", "status", "strong", "subscript", "superscript", "switch", "tab", "table", "tablist", "tabpanel", "term", "textbox", "time", "timer", "toolbar", "tooltip", "tree", "treegrid", "treeitem"]
- Required aria role.
- checked : Union[bool, None]
- An attribute that is usually set by `aria-checked` or native `<input type=checkbox>` controls.
- Learn more about [`aria-checked`](https://www.w3.org/TR/wai-aria-1.2/#aria-checked).
- disabled : Union[bool, None]
- An attribute that is usually set by `aria-disabled` or `disabled`.
- **NOTE** Unlike most other attributes, `disabled` is inherited through the DOM hierarchy. Learn more about
- [`aria-disabled`](https://www.w3.org/TR/wai-aria-1.2/#aria-disabled).
- expanded : Union[bool, None]
- An attribute that is usually set by `aria-expanded`.
- Learn more about [`aria-expanded`](https://www.w3.org/TR/wai-aria-1.2/#aria-expanded).
- include_hidden : Union[bool, None]
- Option that controls whether hidden elements are matched. By default, only non-hidden elements, as
- [defined by ARIA](https://www.w3.org/TR/wai-aria-1.2/#tree_exclusion), are matched by role selector.
- Learn more about [`aria-hidden`](https://www.w3.org/TR/wai-aria-1.2/#aria-hidden).
- level : Union[int, None]
- A number attribute that is usually present for roles `heading`, `listitem`, `row`, `treeitem`, with default values
- for `<h1>-<h6>` elements.
- Learn more about [`aria-level`](https://www.w3.org/TR/wai-aria-1.2/#aria-level).
- name : Union[Pattern[str], str, None]
- Option to match the [accessible name](https://w3c.github.io/accname/#dfn-accessible-name). By default, matching is
- case-insensitive and searches for a substring, use `exact` to control this behavior.
- Learn more about [accessible name](https://w3c.github.io/accname/#dfn-accessible-name).
- pressed : Union[bool, None]
- An attribute that is usually set by `aria-pressed`.
- Learn more about [`aria-pressed`](https://www.w3.org/TR/wai-aria-1.2/#aria-pressed).
- selected : Union[bool, None]
- An attribute that is usually set by `aria-selected`.
- Learn more about [`aria-selected`](https://www.w3.org/TR/wai-aria-1.2/#aria-selected).
- exact : Union[bool, None]
- Whether `name` and `description` are matched exactly: case-sensitive and whole-string. Defaults to false. Ignored
- when the value is a regular expression. Note that exact match still trims whitespace.
- description : Union[Pattern[str], str, None]
- Option to match the [accessible description](https://w3c.github.io/accname/#dfn-accessible-description). By
- default, matching is case-insensitive and searches for a substring, use `exact` to control this behavior.
- Learn more about [accessible description](https://w3c.github.io/accname/#dfn-accessible-description).
- Returns
- -------
- Locator
- """
- return mapping.from_impl(
- self._impl_obj.get_by_role(
- role=role,
- checked=checked,
- disabled=disabled,
- expanded=expanded,
- includeHidden=include_hidden,
- level=level,
- name=name,
- pressed=pressed,
- selected=selected,
- exact=exact,
- description=description,
- )
- )
- def get_by_test_id(
- self, test_id: typing.Union[str, typing.Pattern[str]]
- ) -> "Locator":
- """Locator.get_by_test_id
- Locate element by the test id.
- **Usage**
- Consider the following DOM structure.
- ```html
- <button data-testid=\"directions\">Itinéraire</button>
- ```
- You can locate the element by its test id:
- ```py
- await page.get_by_test_id(\"directions\").click()
- ```
- **Details**
- By default, the `data-testid` attribute is used as a test id. Use `selectors.set_test_id_attribute()` to
- configure a different test id attribute if necessary.
- Parameters
- ----------
- test_id : Union[Pattern[str], str]
- Id to locate the element by.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_test_id(testId=test_id))
- def get_by_text(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """Locator.get_by_text
- Allows locating elements that contain given text.
- See also `locator.filter()` that allows to match by another criteria, like an accessible role, and then
- filter by the text content.
- **Usage**
- Consider the following DOM structure:
- ```html
- <div>Hello <span>world</span></div>
- <div>Hello</div>
- ```
- You can locate by text substring, exact string, or a regular expression:
- ```py
- # Matches <span>
- page.get_by_text(\"world\")
- # Matches first <div>
- page.get_by_text(\"Hello world\")
- # Matches second <div>
- page.get_by_text(\"Hello\", exact=True)
- # Matches both <div>s
- page.get_by_text(re.compile(\"Hello\"))
- # Matches second <div>
- page.get_by_text(re.compile(\"^hello$\", re.IGNORECASE))
- ```
- **Details**
- Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into
- one, turns line breaks into spaces and ignores leading and trailing whitespace.
- Input elements of the type `button` and `submit` are matched by their `value` instead of the text content. For
- example, locating by text `\"Log in\"` matches `<input type=button value=\"Log in\">`.
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_text(text=text, exact=exact))
- def get_by_title(
- self,
- text: typing.Union[str, typing.Pattern[str]],
- *,
- exact: typing.Optional[bool] = None,
- ) -> "Locator":
- """Locator.get_by_title
- Allows locating elements by their title attribute.
- **Usage**
- Consider the following DOM structure.
- ```html
- <span title='Issues count'>25 issues</span>
- ```
- You can check the issues count after locating it by the title text:
- ```py
- await expect(page.get_by_title(\"Issues count\")).to_have_text(\"25 issues\")
- ```
- Parameters
- ----------
- text : Union[Pattern[str], str]
- Text to locate the element for.
- exact : Union[bool, None]
- Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a
- regular expression. Note that exact match still trims whitespace.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.get_by_title(text=text, exact=exact))
- def frame_locator(self, selector: str) -> "FrameLocator":
- """Locator.frame_locator
- When working with iframes, you can create a frame locator that will enter the iframe and allow locating elements in
- that iframe:
- **Usage**
- ```py
- locator = page.frame_locator(\"iframe\").get_by_text(\"Submit\")
- await locator.click()
- ```
- Parameters
- ----------
- selector : str
- A selector to use when resolving DOM element.
- Returns
- -------
- FrameLocator
- """
- return mapping.from_impl(self._impl_obj.frame_locator(selector=selector))
- async def element_handle(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> "ElementHandle":
- """Locator.element_handle
- Resolves given locator to the first matching DOM element. If there are no matching elements, waits for one. If
- multiple elements match the locator, throws.
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- ElementHandle
- """
- return mapping.from_impl(
- await self._impl_obj.element_handle(timeout=to_milliseconds(timeout))
- )
- async def element_handles(self) -> typing.List["ElementHandle"]:
- """Locator.element_handles
- Resolves given locator to all matching DOM elements. If there are no matching elements, returns an empty list.
- Returns
- -------
- List[ElementHandle]
- """
- return mapping.from_impl_list(await self._impl_obj.element_handles())
- def nth(self, index: int) -> "Locator":
- """Locator.nth
- Returns locator to the n-th matching element. It's zero based, `nth(0)` selects the first element.
- **Usage**
- ```py
- banana = await page.get_by_role(\"listitem\").nth(2)
- ```
- Parameters
- ----------
- index : int
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.nth(index=index))
- def describe(self, description: str) -> "Locator":
- """Locator.describe
- Describes the locator, description is used in the trace viewer and reports. Returns the locator pointing to the
- same element.
- **Usage**
- ```py
- button = page.get_by_test_id(\"btn-sub\").describe(\"Subscribe button\")
- await button.click()
- ```
- Parameters
- ----------
- description : str
- Locator description.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.describe(description=description))
- def filter(
- self,
- *,
- has_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- has_not_text: typing.Optional[typing.Union[typing.Pattern[str], str]] = None,
- has: typing.Optional["Locator"] = None,
- has_not: typing.Optional["Locator"] = None,
- visible: typing.Optional[bool] = None,
- ) -> "Locator":
- """Locator.filter
- This method narrows existing locator according to the options, for example filters by text. It can be chained to
- filter multiple times.
- **Usage**
- ```py
- row_locator = page.locator(\"tr\")
- # ...
- await row_locator.filter(has_text=\"text in column 1\").filter(
- has=page.get_by_role(\"button\", name=\"column 2 button\")
- ).screenshot()
- ```
- Parameters
- ----------
- has_text : Union[Pattern[str], str, None]
- Matches elements containing specified text somewhere inside, possibly in a child or a descendant element. When
- passed a [string], matching is case-insensitive and searches for a substring. For example, `"Playwright"` matches
- `<article><div>Playwright</div></article>`.
- has_not_text : Union[Pattern[str], str, None]
- Matches elements that do not contain specified text somewhere inside, possibly in a child or a descendant element.
- When passed a [string], matching is case-insensitive and searches for a substring.
- has : Union[Locator, None]
- Narrows down the results of the method to those which contain elements matching this relative locator. For example,
- `article` that has `text=Playwright` matches `<article><div>Playwright</div></article>`.
- Inner locator **must be relative** to the outer locator and is queried starting with the outer locator match, not
- the document root. For example, you can find `content` that has `div` in
- `<article><content><div>Playwright</div></content></article>`. However, looking for `content` that has `article
- div` will fail, because the inner locator must be relative and should not use any elements outside the `content`.
- Note that outer and inner locators must belong to the same frame. Inner locator must not contain `FrameLocator`s.
- has_not : Union[Locator, None]
- Matches elements that do not contain an element that matches an inner locator. Inner locator is queried against the
- outer one. For example, `article` that does not have `div` matches `<article><span>Playwright</span></article>`.
- Note that outer and inner locators must belong to the same frame. Inner locator must not contain `FrameLocator`s.
- visible : Union[bool, None]
- Only matches visible or invisible elements.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(
- self._impl_obj.filter(
- hasText=has_text,
- hasNotText=has_not_text,
- has=has._impl_obj if has else None,
- hasNot=has_not._impl_obj if has_not else None,
- visible=visible,
- )
- )
- def or_(self, locator: "Locator") -> "Locator":
- """Locator.or_
- Creates a locator matching all elements that match one or both of the two locators.
- Note that when both locators match something, the resulting locator will have multiple matches, potentially causing
- a [locator strictness](https://playwright.dev/python/docs/locators#strictness) violation.
- **Usage**
- Consider a scenario where you'd like to click on a \"New email\" button, but sometimes a security settings dialog
- shows up instead. In this case, you can wait for either a \"New email\" button, or a dialog and act accordingly.
- **NOTE** If both \"New email\" button and security dialog appear on screen, the \"or\" locator will match both of them,
- possibly throwing the [\"strict mode violation\" error](https://playwright.dev/python/docs/locators#strictness). In this case, you can use
- `locator.first()` to only match one of them.
- ```py
- new_email = page.get_by_role(\"button\", name=\"New\")
- dialog = page.get_by_text(\"Confirm security settings\")
- await expect(new_email.or_(dialog).first).to_be_visible()
- if (await dialog.is_visible()):
- await page.get_by_role(\"button\", name=\"Dismiss\").click()
- await new_email.click()
- ```
- Parameters
- ----------
- locator : Locator
- Alternative locator to match.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.or_(locator=locator._impl_obj))
- def and_(self, locator: "Locator") -> "Locator":
- """Locator.and_
- Creates a locator that matches both this locator and the argument locator.
- **Usage**
- The following example finds a button with a specific title.
- ```py
- button = page.get_by_role(\"button\").and_(page.get_by_title(\"Subscribe\"))
- ```
- Parameters
- ----------
- locator : Locator
- Additional locator to match.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(self._impl_obj.and_(locator=locator._impl_obj))
- async def focus(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """Locator.focus
- Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the matching element.
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.focus(timeout=to_milliseconds(timeout))
- )
- async def blur(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """Locator.blur
- Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/blur) on the element.
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.blur(timeout=to_milliseconds(timeout))
- )
- async def all(self) -> typing.List["Locator"]:
- """Locator.all
- When the locator points to a list of elements, this returns an array of locators, pointing to their respective
- elements.
- **NOTE** `locator.all()` does not wait for elements to match the locator, and instead immediately returns
- whatever is present in the page.
- When the list of elements changes dynamically, `locator.all()` will produce unpredictable and flaky
- results.
- When the list of elements is stable, but loaded dynamically, wait for the full list to finish loading before
- calling `locator.all()`.
- **Usage**
- ```py
- for li in await page.get_by_role('listitem').all():
- await li.click();
- ```
- Returns
- -------
- List[Locator]
- """
- return mapping.from_impl_list(await self._impl_obj.all())
- async def count(self) -> int:
- """Locator.count
- Returns the number of elements matching the locator.
- **NOTE** If you need to assert the number of elements on the page, prefer `locator_assertions.to_have_count()`
- to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
- **Usage**
- ```py
- count = await page.get_by_role(\"listitem\").count()
- ```
- Returns
- -------
- int
- """
- return mapping.from_maybe_impl(await self._impl_obj.count())
- async def drag_to(
- self,
- target: "Locator",
- *,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- trial: typing.Optional[bool] = None,
- source_position: typing.Optional[Position] = None,
- target_position: typing.Optional[Position] = None,
- steps: typing.Optional[int] = None,
- ) -> None:
- """Locator.drag_to
- Drag the source element towards the target element and drop it.
- **Details**
- This method drags the locator to another target locator or target position. It will first move to the source
- element, perform a `mousedown`, then move to the target element or position and perform a `mouseup`.
- **Usage**
- ```py
- source = page.locator(\"#source\")
- target = page.locator(\"#target\")
- await source.drag_to(target)
- # or specify exact positions relative to the top-left corners of the elements:
- await source.drag_to(
- target,
- source_position={\"x\": 34, \"y\": 7},
- target_position={\"x\": 10, \"y\": 20}
- )
- ```
- Parameters
- ----------
- target : Locator
- Locator of the element to drag to.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it.
- source_position : Union[{x: float, y: float}, None]
- Clicks on the source element at this point relative to the top-left corner of the element's padding box. If not
- specified, some visible point of the element is used.
- target_position : Union[{x: float, y: float}, None]
- Drops on the target element at this point relative to the top-left corner of the element's padding box. If not
- specified, some visible point of the element is used.
- steps : Union[int, None]
- Defaults to 1. Sends `n` interpolated `mousemove` events to represent travel between the `mousedown` and `mouseup`
- of the drag. When set to 1, emits a single `mousemove` event at the destination location.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.drag_to(
- target=target._impl_obj,
- force=force,
- noWaitAfter=no_wait_after,
- timeout=to_milliseconds(timeout),
- trial=trial,
- sourcePosition=source_position,
- targetPosition=target_position,
- steps=steps,
- )
- )
- async def drop(
- self,
- payload: DropPayload,
- *,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """Locator.drop
- Simulate an external drag-and-drop of files or clipboard-like data onto this locator.
- **Details**
- Dispatches the native `dragenter`, `dragover`, and `drop` events at the center of the target element with a
- synthetic [DataTransfer] carrying the provided files and/or data entries. Works cross-browser by constructing the
- [DataTransfer] in the page context.
- If the target element's `dragover` listener does not call `preventDefault()`, the target is considered to have
- rejected the drop: Playwright dispatches `dragleave` and this method throws.
- **Usage**
- Drop a file buffer onto an upload area:
- Drop plain text and a URL together:
- Parameters
- ----------
- payload : {files: Union[Sequence[Union[pathlib.Path, str]], Sequence[{name: str, mimeType: str, buffer: bytes}], pathlib.Path, str, {name: str, mimeType: str, buffer: bytes}, None], data: Union[Dict[str, str], None]}
- Data to drop onto the target. Provide `files` (file paths or in-memory buffers), `data` (a mime-type → string map
- for clipboard-like content such as `text/plain`, `text/html`, `text/uri-list`), or both.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.drop(
- payload=payload, position=position, timeout=to_milliseconds(timeout)
- )
- )
- async def get_attribute(
- self,
- name: str,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> typing.Optional[str]:
- """Locator.get_attribute
- Returns the matching element's attribute value.
- **NOTE** If you need to assert an element's attribute, prefer `locator_assertions.to_have_attribute()` to
- avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
- Parameters
- ----------
- name : str
- Attribute name to get the value for.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- Union[str, None]
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.get_attribute(
- name=name, timeout=to_milliseconds(timeout)
- )
- )
- async def hover(
- self,
- *,
- modifiers: typing.Optional[
- typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]
- ] = None,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- force: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """Locator.hover
- Hover over the matching element.
- **Usage**
- ```py
- await page.get_by_role(\"link\").hover()
- ```
- **Details**
- This method hovers over the element by performing the following steps:
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the element, unless `force` option is set.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to hover over the center of the element, or the specified `position`.
- If the element is detached from the DOM at any moment during the action, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- Parameters
- ----------
- modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
- Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
- current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
- "Control" on Windows and Linux and to "Meta" on macOS.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard
- `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys
- are pressed.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.hover(
- modifiers=mapping.to_impl(modifiers),
- position=position,
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- force=force,
- trial=trial,
- )
- )
- async def inner_html(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> str:
- """Locator.inner_html
- Returns the [`element.innerHTML`](https://developer.mozilla.org/en-US/docs/Web/API/Element/innerHTML).
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.inner_html(timeout=to_milliseconds(timeout))
- )
- async def inner_text(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> str:
- """Locator.inner_text
- Returns the [`element.innerText`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/innerText).
- **NOTE** If you need to assert text on the page, prefer `locator_assertions.to_have_text()` with
- `useInnerText` option to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.inner_text(timeout=to_milliseconds(timeout))
- )
- async def input_value(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> str:
- """Locator.input_value
- Returns the value for the matching `<input>` or `<textarea>` or `<select>` element.
- **NOTE** If you need to assert input value, prefer `locator_assertions.to_have_value()` to avoid flakiness.
- See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
- **Usage**
- ```py
- value = await page.get_by_role(\"textbox\").input_value()
- ```
- **Details**
- Throws elements that are not an input, textarea or a select. However, if the element is inside the `<label>`
- element that has an associated
- [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the
- control.
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.input_value(timeout=to_milliseconds(timeout))
- )
- async def is_checked(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> bool:
- """Locator.is_checked
- Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
- **NOTE** If you need to assert that checkbox is checked, prefer `locator_assertions.to_be_checked()` to avoid
- flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
- **Usage**
- ```py
- checked = await page.get_by_role(\"checkbox\").is_checked()
- ```
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.is_checked(timeout=to_milliseconds(timeout))
- )
- async def is_disabled(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> bool:
- """Locator.is_disabled
- Returns whether the element is disabled, the opposite of [enabled](https://playwright.dev/python/docs/actionability#enabled).
- **NOTE** If you need to assert that an element is disabled, prefer `locator_assertions.to_be_disabled()` to
- avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
- **Usage**
- ```py
- disabled = await page.get_by_role(\"button\").is_disabled()
- ```
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.is_disabled(timeout=to_milliseconds(timeout))
- )
- async def is_editable(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> bool:
- """Locator.is_editable
- Returns whether the element is [editable](https://playwright.dev/python/docs/actionability#editable). If the target element is not an `<input>`,
- `<textarea>`, `<select>`, `[contenteditable]` and does not have a role allowing `[aria-readonly]`, this method
- throws an error.
- **NOTE** If you need to assert that an element is editable, prefer `locator_assertions.to_be_editable()` to
- avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
- **Usage**
- ```py
- editable = await page.get_by_role(\"textbox\").is_editable()
- ```
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.is_editable(timeout=to_milliseconds(timeout))
- )
- async def is_enabled(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> bool:
- """Locator.is_enabled
- Returns whether the element is [enabled](https://playwright.dev/python/docs/actionability#enabled).
- **NOTE** If you need to assert that an element is enabled, prefer `locator_assertions.to_be_enabled()` to
- avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
- **Usage**
- ```py
- enabled = await page.get_by_role(\"button\").is_enabled()
- ```
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.is_enabled(timeout=to_milliseconds(timeout))
- )
- async def is_hidden(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> bool:
- """Locator.is_hidden
- Returns whether the element is hidden, the opposite of [visible](https://playwright.dev/python/docs/actionability#visible).
- **NOTE** If you need to assert that element is hidden, prefer `locator_assertions.to_be_hidden()` to avoid
- flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
- **Usage**
- ```py
- hidden = await page.get_by_role(\"button\").is_hidden()
- ```
- Parameters
- ----------
- timeout : Union[float, None]
- Deprecated: This option is ignored. `locator.is_hidden()` does not wait for the element to become hidden and returns immediately.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.is_hidden(timeout=to_milliseconds(timeout))
- )
- async def is_visible(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> bool:
- """Locator.is_visible
- Returns whether the element is [visible](https://playwright.dev/python/docs/actionability#visible).
- **NOTE** If you need to assert that element is visible, prefer `locator_assertions.to_be_visible()` to avoid
- flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
- **Usage**
- ```py
- visible = await page.get_by_role(\"button\").is_visible()
- ```
- Parameters
- ----------
- timeout : Union[float, None]
- Deprecated: This option is ignored. `locator.is_visible()` does not wait for the element to become visible and returns immediately.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.is_visible(timeout=to_milliseconds(timeout))
- )
- async def press(
- self,
- key: str,
- *,
- delay: typing.Optional[float] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- ) -> None:
- """Locator.press
- Focuses the matching element and presses a combination of the keys.
- **Usage**
- ```py
- await page.get_by_role(\"textbox\").press(\"Backspace\")
- ```
- **Details**
- Focuses the element, and then uses `keyboard.down()` and `keyboard.up()`.
- `key` can specify the intended
- [keyboardEvent.key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) value or a single character
- to generate the text for. A superset of the `key` values can be found
- [here](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values). Examples of the keys are:
- `F1` - `F12`, `Digit0`- `Digit9`, `KeyA`- `KeyZ`, `Backquote`, `Minus`, `Equal`, `Backslash`, `Backspace`, `Tab`,
- `Delete`, `Escape`, `ArrowDown`, `End`, `Enter`, `Home`, `Insert`, `PageDown`, `PageUp`, `ArrowRight`, `ArrowUp`,
- etc.
- Following modification shortcuts are also supported: `Shift`, `Control`, `Alt`, `Meta`, `ShiftLeft`,
- `ControlOrMeta`. `ControlOrMeta` resolves to `Control` on Windows and Linux and to `Meta` on macOS.
- Holding down `Shift` will type the text that corresponds to the `key` in the upper case.
- If `key` is a single character, it is case-sensitive, so the values `a` and `A` will generate different respective
- texts.
- Shortcuts such as `key: \"Control+o\"`, `key: \"Control++` or `key: \"Control+Shift+T\"` are supported as well. When
- specified with the modifier, modifier is pressed and being held while the subsequent key is being pressed.
- Parameters
- ----------
- key : str
- Name of the key to press or a character to generate, such as `ArrowLeft` or `a`.
- delay : Union[float, None]
- Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
- can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
- navigating to inaccessible pages. Defaults to `false`.
- Deprecated: This option will default to `true` in the future.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.press(
- key=key,
- delay=delay,
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- )
- )
- async def screenshot(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- type: typing.Optional[Literal["jpeg", "png"]] = None,
- path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- quality: typing.Optional[int] = None,
- omit_background: typing.Optional[bool] = None,
- animations: typing.Optional[Literal["allow", "disabled"]] = None,
- caret: typing.Optional[Literal["hide", "initial"]] = None,
- scale: typing.Optional[Literal["css", "device"]] = None,
- mask: typing.Optional[typing.Sequence["Locator"]] = None,
- mask_color: typing.Optional[str] = None,
- style: typing.Optional[str] = None,
- ) -> bytes:
- """Locator.screenshot
- Take a screenshot of the element matching the locator.
- **Usage**
- ```py
- await page.get_by_role(\"link\").screenshot()
- ```
- Disable animations and save screenshot to a file:
- ```py
- await page.get_by_role(\"link\").screenshot(animations=\"disabled\", path=\"link.png\")
- ```
- **Details**
- This method captures a screenshot of the page, clipped to the size and position of a particular element matching
- the locator. If the element is covered by other elements, it will not be actually visible on the screenshot. If the
- element is a scrollable container, only the currently scrolled content will be visible on the screenshot.
- This method waits for the [actionability](https://playwright.dev/python/docs/actionability) checks, then scrolls element into view before taking
- a screenshot. If the element is detached from DOM, the method throws an error.
- Returns the buffer with the captured screenshot.
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- type : Union["jpeg", "png", None]
- Specify screenshot type, defaults to `png`.
- path : Union[pathlib.Path, str, None]
- The file path to save the image to. The screenshot type will be inferred from file extension. If `path` is a
- relative path, then it is resolved relative to the current working directory. If no path is provided, the image
- won't be saved to the disk.
- quality : Union[int, None]
- The quality of the image, between 0-100. Not applicable to `png` images.
- omit_background : Union[bool, None]
- Hides default white background and allows capturing screenshots with transparency. Not applicable to `jpeg` images.
- Defaults to `false`.
- animations : Union["allow", "disabled", None]
- When set to `"disabled"`, stops CSS animations, CSS transitions and Web Animations. Animations get different
- treatment depending on their duration:
- - finite animations are fast-forwarded to completion, so they'll fire `transitionend` event.
- - infinite animations are canceled to initial state, and then played over after the screenshot.
- Defaults to `"allow"` that leaves animations untouched.
- caret : Union["hide", "initial", None]
- When set to `"hide"`, screenshot will hide text caret. When set to `"initial"`, text caret behavior will not be
- changed. Defaults to `"hide"`.
- scale : Union["css", "device", None]
- When set to `"css"`, screenshot will have a single pixel per each css pixel on the page. For high-dpi devices, this
- will keep screenshots small. Using `"device"` option will produce a single pixel per each device pixel, so
- screenshots of high-dpi devices will be twice as large or even larger.
- Defaults to `"device"`.
- mask : Union[Sequence[Locator], None]
- Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink
- box `#FF00FF` (customized by `maskColor`) that completely covers its bounding box. The mask is also applied to
- invisible elements, see [Matching only visible elements](../locators.md#matching-only-visible-elements) to disable
- that.
- mask_color : Union[str, None]
- Specify the color of the overlay box for masked elements, in
- [CSS color format](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value). Default color is pink `#FF00FF`.
- style : Union[str, None]
- Text of the stylesheet to apply while making the screenshot. This is where you can hide dynamic elements, make
- elements invisible or change their properties to help you creating repeatable screenshots. This stylesheet pierces
- the Shadow DOM and applies to the inner frames.
- Returns
- -------
- bytes
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.screenshot(
- timeout=to_milliseconds(timeout),
- type=type,
- path=path,
- quality=quality,
- omitBackground=omit_background,
- animations=animations,
- caret=caret,
- scale=scale,
- mask=mapping.to_impl(mask),
- maskColor=mask_color,
- style=style,
- )
- )
- async def aria_snapshot(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- depth: typing.Optional[int] = None,
- mode: typing.Optional[Literal["ai", "default"]] = None,
- boxes: typing.Optional[bool] = None,
- ) -> str:
- """Locator.aria_snapshot
- Captures the aria snapshot of the given element. Read more about [aria snapshots](https://playwright.dev/python/docs/aria-snapshots) and
- `locator_assertions.to_match_aria_snapshot()` for the corresponding assertion.
- **Usage**
- ```py
- await page.get_by_role(\"link\").aria_snapshot()
- ```
- **Details**
- This method captures the aria snapshot of the given element. The snapshot is a string that represents the state of
- the element and its children. The snapshot can be used to assert the state of the element in the test, or to
- compare it to state in the future.
- The ARIA snapshot is represented using [YAML](https://yaml.org/spec/1.2.2/) markup language:
- - The keys of the objects are the roles and optional accessible names of the elements.
- - The values are either text content or an array of child elements.
- - Generic static text can be represented with the `text` key.
- Below is the HTML markup and the respective ARIA snapshot:
- ```html
- <ul aria-label=\"Links\">
- <li><a href=\"/\">Home</a></li>
- <li><a href=\"/about\">About</a></li>
- <ul>
- ```
- ```yml
- - list \"Links\":
- - listitem:
- - link \"Home\"
- - listitem:
- - link \"About\"
- ```
- An AI-optimized snapshot, controlled by `mode`, is different from a default snapshot:
- 1. Includes element references `[ref=e2]`. 2. Does not wait for an element matching the locator, and throws when
- no elements match. 3. Includes snapshots of `<iframe>`s inside the target.
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- depth : Union[int, None]
- When specified, limits the depth of the snapshot.
- mode : Union["ai", "default", None]
- When set to `"ai"`, returns a snapshot optimized for AI consumption. Defaults to `"default"`. See details for more
- information.
- boxes : Union[bool, None]
- When `true`, appends each element's bounding box as `[box=x,y,width,height]` to the snapshot. Coordinates are
- relative to the viewport, in CSS pixels, as returned by
- [`Element.getBoundingClientRect()`](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect).
- Defaults to `false`.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.aria_snapshot(
- timeout=to_milliseconds(timeout), depth=depth, mode=mode, boxes=boxes
- )
- )
- async def normalize(self) -> "Locator":
- """Locator.normalize
- Returns a new locator that uses best practices for referencing the matched element, prioritizing test ids, aria
- roles, and other user-facing attributes over CSS selectors. This is useful for converting implementation-detail
- selectors into more resilient, human-readable locators.
- Returns
- -------
- Locator
- """
- return mapping.from_impl(await self._impl_obj.normalize())
- async def scroll_into_view_if_needed(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """Locator.scroll_into_view_if_needed
- This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, then tries to scroll element into view, unless
- it is completely visible as defined by
- [IntersectionObserver](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API)'s `ratio`.
- See [scrolling](https://playwright.dev/python/docs/input#scrolling) for alternative ways to scroll.
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.scroll_into_view_if_needed(
- timeout=to_milliseconds(timeout)
- )
- )
- async def select_option(
- self,
- value: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
- *,
- index: typing.Optional[typing.Union[int, typing.Sequence[int]]] = None,
- label: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
- element: typing.Optional[
- typing.Union["ElementHandle", typing.Sequence["ElementHandle"]]
- ] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- force: typing.Optional[bool] = None,
- ) -> typing.List[str]:
- """Locator.select_option
- Selects option or options in `<select>`.
- **Details**
- This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, waits until all specified options are present in
- the `<select>` element and selects these options.
- If the target element is not a `<select>` element, this method throws an error. However, if the element is inside
- the `<label>` element that has an associated
- [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be used
- instead.
- Returns the array of option values that have been successfully selected.
- Triggers a `change` and `input` event once all the provided options have been selected.
- **Usage**
- ```html
- <select multiple>
- <option value=\"red\">Red</option>
- <option value=\"green\">Green</option>
- <option value=\"blue\">Blue</option>
- </select>
- ```
- ```py
- # single selection matching the value or label
- await element.select_option(\"blue\")
- # single selection matching the label
- await element.select_option(label=\"blue\")
- # multiple selection for blue, red and second option
- await element.select_option(value=[\"red\", \"green\", \"blue\"])
- ```
- Parameters
- ----------
- value : Union[Sequence[str], str, None]
- Options to select by value. If the `<select>` has the `multiple` attribute, all given options are selected,
- otherwise only the first option matching one of the passed options is selected. Optional.
- index : Union[Sequence[int], int, None]
- Options to select by index. Optional.
- label : Union[Sequence[str], str, None]
- Options to select by label. If the `<select>` has the `multiple` attribute, all given options are selected,
- otherwise only the first option matching one of the passed options is selected. Optional.
- element : Union[ElementHandle, Sequence[ElementHandle], None]
- Option elements to select. Optional.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- Returns
- -------
- List[str]
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.select_option(
- value=mapping.to_impl(value),
- index=mapping.to_impl(index),
- label=mapping.to_impl(label),
- element=mapping.to_impl(element),
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- force=force,
- )
- )
- async def select_text(
- self,
- *,
- force: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """Locator.select_text
- This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, then focuses the element and selects all its
- text content.
- If the element is inside the `<label>` element that has an associated
- [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), focuses and selects text in
- the control instead.
- Parameters
- ----------
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.select_text(
- force=force, timeout=to_milliseconds(timeout)
- )
- )
- async def set_input_files(
- self,
- files: typing.Union[
- str,
- pathlib.Path,
- FilePayload,
- typing.Sequence[typing.Union[str, pathlib.Path]],
- typing.Sequence[FilePayload],
- ],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- ) -> None:
- """Locator.set_input_files
- Upload file or multiple files into `<input type=file>`. For inputs with a `[webkitdirectory]` attribute, only a
- single directory path is supported.
- **Usage**
- ```py
- # Select one file
- await page.get_by_label(\"Upload file\").set_input_files('myfile.pdf')
- # Select multiple files
- await page.get_by_label(\"Upload files\").set_input_files(['file1.txt', 'file2.txt'])
- # Select a directory
- await page.get_by_label(\"Upload directory\").set_input_files('mydir')
- # Remove all the selected files
- await page.get_by_label(\"Upload file\").set_input_files([])
- # Upload buffer from memory
- await page.get_by_label(\"Upload file\").set_input_files(
- files=[
- {\"name\": \"test.txt\", \"mimeType\": \"text/plain\", \"buffer\": b\"this is a test\"}
- ],
- )
- ```
- **Details**
- Sets the value of the file input to these file paths or files. If some of the `filePaths` are relative paths, then
- they are resolved relative to the current working directory. For empty array, clears the selected files.
- This method expects `Locator` to point to an
- [input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside
- the `<label>` element that has an associated
- [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead.
- Parameters
- ----------
- files : Union[Sequence[Union[pathlib.Path, str]], Sequence[{name: str, mimeType: str, buffer: bytes}], pathlib.Path, str, {name: str, mimeType: str, buffer: bytes}]
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.set_input_files(
- files=mapping.to_impl(files),
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- )
- )
- async def tap(
- self,
- *,
- modifiers: typing.Optional[
- typing.Sequence[Literal["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]]
- ] = None,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """Locator.tap
- Perform a tap gesture on the element matching the locator. For examples of emulating other gestures by manually
- dispatching touch events, see the [emulating legacy touch events](https://playwright.dev/python/docs/touch-events) page.
- **Details**
- This method taps the element by performing the following steps:
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the element, unless `force` option is set.
- 1. Scroll the element into view if needed.
- 1. Use `page.touchscreen` to tap the center of the element, or the specified `position`.
- If the element is detached from the DOM at any moment during the action, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- **NOTE** `element.tap()` requires that the `hasTouch` option of the browser context be set to true.
- Parameters
- ----------
- modifiers : Union[Sequence[Union["Alt", "Control", "ControlOrMeta", "Meta", "Shift"]], None]
- Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores
- current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to
- "Control" on Windows and Linux and to "Meta" on macOS.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it. Note that keyboard
- `modifiers` will be pressed regardless of `trial` to allow testing elements which are only visible when those keys
- are pressed.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.tap(
- modifiers=mapping.to_impl(modifiers),
- position=position,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- trial=trial,
- )
- )
- async def text_content(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> typing.Optional[str]:
- """Locator.text_content
- Returns the [`node.textContent`](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent).
- **NOTE** If you need to assert text on the page, prefer `locator_assertions.to_have_text()` to avoid
- flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- Returns
- -------
- Union[str, None]
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.text_content(timeout=to_milliseconds(timeout))
- )
- async def type(
- self,
- text: str,
- *,
- delay: typing.Optional[float] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- ) -> None:
- """Locator.type
- Focuses the element, and then sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the
- text.
- To press a special key, like `Control` or `ArrowDown`, use `locator.press()`.
- **Usage**
- Parameters
- ----------
- text : str
- A text to type into a focused element.
- delay : Union[float, None]
- Time to wait between key presses in milliseconds. Defaults to 0.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.type(
- text=text,
- delay=delay,
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- )
- )
- async def press_sequentially(
- self,
- text: str,
- *,
- delay: typing.Optional[float] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- no_wait_after: typing.Optional[bool] = None,
- ) -> None:
- """Locator.press_sequentially
- **NOTE** In most cases, you should use `locator.fill()` instead. You only need to press keys one by one if
- there is special keyboard handling on the page.
- Focuses the element, and then sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the
- text.
- To press a special key, like `Control` or `ArrowDown`, use `locator.press()`.
- **Usage**
- ```py
- await locator.press_sequentially(\"hello\") # types instantly
- await locator.press_sequentially(\"world\", delay=100) # types slower, like a user
- ```
- An example of typing into a text field and then submitting the form:
- ```py
- locator = page.get_by_label(\"Password\")
- await locator.press_sequentially(\"my password\")
- await locator.press(\"Enter\")
- ```
- Parameters
- ----------
- text : str
- String of characters to sequentially press into a focused element.
- delay : Union[float, None]
- Time to wait between key presses in milliseconds. Defaults to 0.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.press_sequentially(
- text=text,
- delay=delay,
- timeout=to_milliseconds(timeout),
- noWaitAfter=no_wait_after,
- )
- )
- async def uncheck(
- self,
- *,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """Locator.uncheck
- Ensure that checkbox or radio element is unchecked.
- **Usage**
- ```py
- await page.get_by_role(\"checkbox\").uncheck()
- ```
- **Details**
- This method unchecks the element by performing the following steps:
- 1. Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already
- unchecked, this method returns immediately.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the element, unless `force` option is set.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to click in the center of the element.
- 1. Ensure that the element is now unchecked. If not, this method throws.
- If the element is detached from the DOM at any moment during the action, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- Parameters
- ----------
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.uncheck(
- position=position,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- trial=trial,
- )
- )
- async def all_inner_texts(self) -> typing.List[str]:
- """Locator.all_inner_texts
- Returns an array of `node.innerText` values for all matching nodes.
- **NOTE** If you need to assert text on the page, prefer `locator_assertions.to_have_text()` with
- `useInnerText` option to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
- **Usage**
- ```py
- texts = await page.get_by_role(\"link\").all_inner_texts()
- ```
- Returns
- -------
- List[str]
- """
- return mapping.from_maybe_impl(await self._impl_obj.all_inner_texts())
- async def all_text_contents(self) -> typing.List[str]:
- """Locator.all_text_contents
- Returns an array of `node.textContent` values for all matching nodes.
- **NOTE** If you need to assert text on the page, prefer `locator_assertions.to_have_text()` to avoid
- flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
- **Usage**
- ```py
- texts = await page.get_by_role(\"link\").all_text_contents()
- ```
- Returns
- -------
- List[str]
- """
- return mapping.from_maybe_impl(await self._impl_obj.all_text_contents())
- async def wait_for(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- state: typing.Optional[
- Literal["attached", "detached", "hidden", "visible"]
- ] = None,
- ) -> None:
- """Locator.wait_for
- Returns when element specified by locator satisfies the `state` option.
- If target element already satisfies the condition, the method returns immediately. Otherwise, waits for up to
- `timeout` milliseconds until the condition is met.
- **Usage**
- ```py
- order_sent = page.locator(\"#order-sent\")
- await order_sent.wait_for()
- ```
- Parameters
- ----------
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- state : Union["attached", "detached", "hidden", "visible", None]
- Defaults to `'visible'`. Can be either:
- - `'attached'` - wait for element to be present in DOM.
- - `'detached'` - wait for element to not be present in DOM.
- - `'visible'` - wait for element to have non-empty bounding box and no `visibility:hidden`. Note that element
- without any content or with `display:none` has an empty bounding box and is not considered visible.
- - `'hidden'` - wait for element to be either detached from DOM, or have an empty bounding box or
- `visibility:hidden`. This is opposite to the `'visible'` option.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.wait_for(timeout=to_milliseconds(timeout), state=state)
- )
- async def set_checked(
- self,
- checked: bool,
- *,
- position: typing.Optional[Position] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- force: typing.Optional[bool] = None,
- no_wait_after: typing.Optional[bool] = None,
- trial: typing.Optional[bool] = None,
- ) -> None:
- """Locator.set_checked
- Set the state of a checkbox or a radio element.
- **Usage**
- ```py
- await page.get_by_role(\"checkbox\").set_checked(True)
- ```
- **Details**
- This method checks or unchecks an element by performing the following steps:
- 1. Ensure that matched element is a checkbox or a radio input. If not, this method throws.
- 1. If the element already has the right checked state, this method returns immediately.
- 1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If
- the element is detached during the checks, the whole action is retried.
- 1. Scroll the element into view if needed.
- 1. Use `page.mouse` to click in the center of the element.
- 1. Ensure that the element is now checked or unchecked. If not, this method throws.
- When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`.
- Passing zero timeout disables this.
- Parameters
- ----------
- checked : bool
- Whether to check or uncheck the checkbox.
- position : Union[{x: float, y: float}, None]
- A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of
- the element.
- timeout : Union[float, None]
- Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can
- be changed by using the `browser_context.set_default_timeout()` or `page.set_default_timeout()` methods.
- force : Union[bool, None]
- Whether to bypass the [actionability](../actionability.md) checks. Defaults to `false`.
- no_wait_after : Union[bool, None]
- This option has no effect.
- Deprecated: This option has no effect.
- trial : Union[bool, None]
- When set, this method only performs the [actionability](../actionability.md) checks and skips the action. Defaults
- to `false`. Useful to wait until the element is ready for the action without performing it.
- """
- return mapping.from_maybe_impl(
- await self._impl_obj.set_checked(
- checked=checked,
- position=position,
- timeout=to_milliseconds(timeout),
- force=force,
- noWaitAfter=no_wait_after,
- trial=trial,
- )
- )
- async def highlight(self, *, style: typing.Optional[str] = None) -> None:
- """Locator.highlight
- Highlight the corresponding element(s) on the screen. Useful for debugging, don't commit the code that uses
- `locator.highlight()`.
- Parameters
- ----------
- style : Union[str, None]
- Additional inline CSS applied to the highlight overlay, e.g. `"outline: 2px dashed red"`.
- """
- return mapping.from_maybe_impl(await self._impl_obj.highlight(style=style))
- async def hide_highlight(self) -> None:
- """Locator.hide_highlight
- Hides the element highlight previously added by `locator.highlight()`.
- """
- return mapping.from_maybe_impl(await self._impl_obj.hide_highlight())
- mapping.register(LocatorImpl, Locator)
- class APIResponse(AsyncBase):
- @property
- def ok(self) -> bool:
- """APIResponse.ok
- Contains a boolean stating whether the response was successful (status in the range 200-299) or not.
- Returns
- -------
- bool
- """
- return mapping.from_maybe_impl(self._impl_obj.ok)
- @property
- def url(self) -> str:
- """APIResponse.url
- Contains the URL of the response.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.url)
- @property
- def status(self) -> int:
- """APIResponse.status
- Contains the status code of the response (e.g., 200 for a success).
- Returns
- -------
- int
- """
- return mapping.from_maybe_impl(self._impl_obj.status)
- @property
- def status_text(self) -> str:
- """APIResponse.status_text
- Contains the status text of the response (e.g. usually an \"OK\" for a success).
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(self._impl_obj.status_text)
- @property
- def headers(self) -> typing.Dict[str, str]:
- """APIResponse.headers
- An object with all the response HTTP headers associated with this response.
- Returns
- -------
- Dict[str, str]
- """
- return mapping.from_maybe_impl(self._impl_obj.headers)
- @property
- def headers_array(self) -> typing.List[NameValue]:
- """APIResponse.headers_array
- An array with all the response HTTP headers associated with this response. Header names are not lower-cased.
- Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
- Returns
- -------
- List[{name: str, value: str}]
- """
- return mapping.from_impl_list(self._impl_obj.headers_array)
- async def body(self) -> bytes:
- """APIResponse.body
- Returns the buffer with response body.
- Returns
- -------
- bytes
- """
- return mapping.from_maybe_impl(await self._impl_obj.body())
- async def text(self) -> str:
- """APIResponse.text
- Returns the text representation of response body.
- Returns
- -------
- str
- """
- return mapping.from_maybe_impl(await self._impl_obj.text())
- async def json(self) -> typing.Any:
- """APIResponse.json
- Returns the JSON representation of response body.
- This method will throw if the response body is not parsable via `JSON.parse`.
- Returns
- -------
- Any
- """
- return mapping.from_maybe_impl(await self._impl_obj.json())
- async def dispose(self) -> None:
- """APIResponse.dispose
- Disposes the body of this response. If not called then the body will stay in memory until the context closes.
- """
- return mapping.from_maybe_impl(await self._impl_obj.dispose())
- mapping.register(APIResponseImpl, APIResponse)
- class APIRequestContext(AsyncBase):
- @property
- def tracing(self) -> "Tracing":
- """APIRequestContext.tracing
- Returns
- -------
- Tracing
- """
- return mapping.from_impl(self._impl_obj.tracing)
- async def dispose(self, *, reason: typing.Optional[str] = None) -> None:
- """APIRequestContext.dispose
- All responses returned by `a_pi_request_context.get()` and similar methods are stored in the memory, so that
- you can later call `a_pi_response.body()`.This method discards all its resources, calling any method on
- disposed `APIRequestContext` will throw an exception.
- Parameters
- ----------
- reason : Union[str, None]
- The reason to be reported to the operations interrupted by the context disposal.
- """
- return mapping.from_maybe_impl(await self._impl_obj.dispose(reason=reason))
- async def delete(
- self,
- url: str,
- *,
- params: typing.Optional[
- typing.Union[typing.Dict[str, typing.Union[str, float, bool]], str]
- ] = None,
- headers: typing.Optional[typing.Dict[str, str]] = None,
- data: typing.Optional[typing.Union[typing.Any, bytes, str]] = None,
- form: typing.Optional[
- typing.Union[typing.Dict[str, typing.Union[str, float, bool]], "FormData"]
- ] = None,
- multipart: typing.Optional[
- typing.Union[
- typing.Dict[str, typing.Union[bytes, bool, float, str, FilePayload]],
- "FormData",
- ]
- ] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- fail_on_status_code: typing.Optional[bool] = None,
- ignore_https_errors: typing.Optional[bool] = None,
- max_redirects: typing.Optional[int] = None,
- max_retries: typing.Optional[int] = None,
- ) -> "APIResponse":
- """APIRequestContext.delete
- Sends HTTP(S) [DELETE](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE) request and returns its
- response. The method will populate request cookies from the context and update context cookies from the response.
- The method will automatically follow redirects.
- Parameters
- ----------
- url : str
- Target URL.
- params : Union[Dict[str, Union[bool, float, str]], str, None]
- Query parameters to be sent with the URL.
- headers : Union[Dict[str, str], None]
- Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by
- it.
- data : Union[Any, bytes, str, None]
- Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string
- and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type`
- header will be set to `application/octet-stream` if not explicitly set.
- form : Union[Dict[str, Union[bool, float, str]], FormData, None]
- Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent
- as this request body. If this parameter is specified `content-type` header will be set to
- `application/x-www-form-urlencoded` unless explicitly provided. Use `FormData` to send multiple values for the same
- field.
- multipart : Union[Dict[str, Union[bool, bytes, float, str, {name: str, mimeType: str, buffer: bytes}]], FormData, None]
- Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this
- request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless
- explicitly provided. File values can be passed as file-like object containing file name, mime-type and its content.
- Use `FormData` to send multiple files in the same field.
- timeout : Union[float, None]
- Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.
- fail_on_status_code : Union[bool, None]
- Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status
- codes.
- ignore_https_errors : Union[bool, None]
- Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
- max_redirects : Union[int, None]
- Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is
- exceeded. Defaults to `20`. Pass `0` to not follow redirects.
- max_retries : Union[int, None]
- Maximum number of times network errors should be retried. Currently only `ECONNRESET` error is retried. Does not
- retry based on HTTP response codes. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries.
- Returns
- -------
- APIResponse
- """
- return mapping.from_impl(
- await self._impl_obj.delete(
- url=url,
- params=mapping.to_impl(params),
- headers=mapping.to_impl(headers),
- data=mapping.to_impl(data),
- form=mapping.to_impl(form),
- multipart=mapping.to_impl(multipart),
- timeout=to_milliseconds(timeout),
- failOnStatusCode=fail_on_status_code,
- ignoreHTTPSErrors=ignore_https_errors,
- maxRedirects=max_redirects,
- maxRetries=max_retries,
- )
- )
- async def head(
- self,
- url: str,
- *,
- params: typing.Optional[
- typing.Union[typing.Dict[str, typing.Union[str, float, bool]], str]
- ] = None,
- headers: typing.Optional[typing.Dict[str, str]] = None,
- data: typing.Optional[typing.Union[typing.Any, bytes, str]] = None,
- form: typing.Optional[
- typing.Union[typing.Dict[str, typing.Union[str, float, bool]], "FormData"]
- ] = None,
- multipart: typing.Optional[
- typing.Union[
- typing.Dict[str, typing.Union[bytes, bool, float, str, FilePayload]],
- "FormData",
- ]
- ] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- fail_on_status_code: typing.Optional[bool] = None,
- ignore_https_errors: typing.Optional[bool] = None,
- max_redirects: typing.Optional[int] = None,
- max_retries: typing.Optional[int] = None,
- ) -> "APIResponse":
- """APIRequestContext.head
- Sends HTTP(S) [HEAD](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD) request and returns its
- response. The method will populate request cookies from the context and update context cookies from the response.
- The method will automatically follow redirects.
- Parameters
- ----------
- url : str
- Target URL.
- params : Union[Dict[str, Union[bool, float, str]], str, None]
- Query parameters to be sent with the URL.
- headers : Union[Dict[str, str], None]
- Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by
- it.
- data : Union[Any, bytes, str, None]
- Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string
- and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type`
- header will be set to `application/octet-stream` if not explicitly set.
- form : Union[Dict[str, Union[bool, float, str]], FormData, None]
- Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent
- as this request body. If this parameter is specified `content-type` header will be set to
- `application/x-www-form-urlencoded` unless explicitly provided. Use `FormData` to send multiple values for the same
- field.
- multipart : Union[Dict[str, Union[bool, bytes, float, str, {name: str, mimeType: str, buffer: bytes}]], FormData, None]
- Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this
- request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless
- explicitly provided. File values can be passed as file-like object containing file name, mime-type and its content.
- Use `FormData` to send multiple files in the same field.
- timeout : Union[float, None]
- Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.
- fail_on_status_code : Union[bool, None]
- Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status
- codes.
- ignore_https_errors : Union[bool, None]
- Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
- max_redirects : Union[int, None]
- Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is
- exceeded. Defaults to `20`. Pass `0` to not follow redirects.
- max_retries : Union[int, None]
- Maximum number of times network errors should be retried. Currently only `ECONNRESET` error is retried. Does not
- retry based on HTTP response codes. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries.
- Returns
- -------
- APIResponse
- """
- return mapping.from_impl(
- await self._impl_obj.head(
- url=url,
- params=mapping.to_impl(params),
- headers=mapping.to_impl(headers),
- data=mapping.to_impl(data),
- form=mapping.to_impl(form),
- multipart=mapping.to_impl(multipart),
- timeout=to_milliseconds(timeout),
- failOnStatusCode=fail_on_status_code,
- ignoreHTTPSErrors=ignore_https_errors,
- maxRedirects=max_redirects,
- maxRetries=max_retries,
- )
- )
- async def get(
- self,
- url: str,
- *,
- params: typing.Optional[
- typing.Union[typing.Dict[str, typing.Union[str, float, bool]], str]
- ] = None,
- headers: typing.Optional[typing.Dict[str, str]] = None,
- data: typing.Optional[typing.Union[typing.Any, bytes, str]] = None,
- form: typing.Optional[
- typing.Union[typing.Dict[str, typing.Union[str, float, bool]], "FormData"]
- ] = None,
- multipart: typing.Optional[
- typing.Union[
- typing.Dict[str, typing.Union[bytes, bool, float, str, FilePayload]],
- "FormData",
- ]
- ] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- fail_on_status_code: typing.Optional[bool] = None,
- ignore_https_errors: typing.Optional[bool] = None,
- max_redirects: typing.Optional[int] = None,
- max_retries: typing.Optional[int] = None,
- ) -> "APIResponse":
- """APIRequestContext.get
- Sends HTTP(S) [GET](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET) request and returns its
- response. The method will populate request cookies from the context and update context cookies from the response.
- The method will automatically follow redirects.
- **Usage**
- Request parameters can be configured with `params` option, they will be serialized into the URL search parameters:
- ```python
- query_params = {
- \"isbn\": \"1234\",
- \"page\": \"23\"
- }
- api_request_context.get(\"https://example.com/api/getText\", params=query_params)
- ```
- Parameters
- ----------
- url : str
- Target URL.
- params : Union[Dict[str, Union[bool, float, str]], str, None]
- Query parameters to be sent with the URL.
- headers : Union[Dict[str, str], None]
- Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by
- it.
- data : Union[Any, bytes, str, None]
- Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string
- and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type`
- header will be set to `application/octet-stream` if not explicitly set.
- form : Union[Dict[str, Union[bool, float, str]], FormData, None]
- Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent
- as this request body. If this parameter is specified `content-type` header will be set to
- `application/x-www-form-urlencoded` unless explicitly provided. Use `FormData` to send multiple values for the same
- field.
- multipart : Union[Dict[str, Union[bool, bytes, float, str, {name: str, mimeType: str, buffer: bytes}]], FormData, None]
- Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this
- request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless
- explicitly provided. File values can be passed as file-like object containing file name, mime-type and its content.
- Use `FormData` to send multiple files in the same field.
- timeout : Union[float, None]
- Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.
- fail_on_status_code : Union[bool, None]
- Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status
- codes.
- ignore_https_errors : Union[bool, None]
- Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
- max_redirects : Union[int, None]
- Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is
- exceeded. Defaults to `20`. Pass `0` to not follow redirects.
- max_retries : Union[int, None]
- Maximum number of times network errors should be retried. Currently only `ECONNRESET` error is retried. Does not
- retry based on HTTP response codes. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries.
- Returns
- -------
- APIResponse
- """
- return mapping.from_impl(
- await self._impl_obj.get(
- url=url,
- params=mapping.to_impl(params),
- headers=mapping.to_impl(headers),
- data=mapping.to_impl(data),
- form=mapping.to_impl(form),
- multipart=mapping.to_impl(multipart),
- timeout=to_milliseconds(timeout),
- failOnStatusCode=fail_on_status_code,
- ignoreHTTPSErrors=ignore_https_errors,
- maxRedirects=max_redirects,
- maxRetries=max_retries,
- )
- )
- async def patch(
- self,
- url: str,
- *,
- params: typing.Optional[
- typing.Union[typing.Dict[str, typing.Union[str, float, bool]], str]
- ] = None,
- headers: typing.Optional[typing.Dict[str, str]] = None,
- data: typing.Optional[typing.Union[typing.Any, bytes, str]] = None,
- form: typing.Optional[
- typing.Union[typing.Dict[str, typing.Union[str, float, bool]], "FormData"]
- ] = None,
- multipart: typing.Optional[
- typing.Union[
- typing.Dict[str, typing.Union[bytes, bool, float, str, FilePayload]],
- "FormData",
- ]
- ] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- fail_on_status_code: typing.Optional[bool] = None,
- ignore_https_errors: typing.Optional[bool] = None,
- max_redirects: typing.Optional[int] = None,
- max_retries: typing.Optional[int] = None,
- ) -> "APIResponse":
- """APIRequestContext.patch
- Sends HTTP(S) [PATCH](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH) request and returns its
- response. The method will populate request cookies from the context and update context cookies from the response.
- The method will automatically follow redirects.
- Parameters
- ----------
- url : str
- Target URL.
- params : Union[Dict[str, Union[bool, float, str]], str, None]
- Query parameters to be sent with the URL.
- headers : Union[Dict[str, str], None]
- Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by
- it.
- data : Union[Any, bytes, str, None]
- Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string
- and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type`
- header will be set to `application/octet-stream` if not explicitly set.
- form : Union[Dict[str, Union[bool, float, str]], FormData, None]
- Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent
- as this request body. If this parameter is specified `content-type` header will be set to
- `application/x-www-form-urlencoded` unless explicitly provided. Use `FormData` to send multiple values for the same
- field.
- multipart : Union[Dict[str, Union[bool, bytes, float, str, {name: str, mimeType: str, buffer: bytes}]], FormData, None]
- Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this
- request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless
- explicitly provided. File values can be passed as file-like object containing file name, mime-type and its content.
- Use `FormData` to send multiple files in the same field.
- timeout : Union[float, None]
- Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.
- fail_on_status_code : Union[bool, None]
- Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status
- codes.
- ignore_https_errors : Union[bool, None]
- Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
- max_redirects : Union[int, None]
- Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is
- exceeded. Defaults to `20`. Pass `0` to not follow redirects.
- max_retries : Union[int, None]
- Maximum number of times network errors should be retried. Currently only `ECONNRESET` error is retried. Does not
- retry based on HTTP response codes. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries.
- Returns
- -------
- APIResponse
- """
- return mapping.from_impl(
- await self._impl_obj.patch(
- url=url,
- params=mapping.to_impl(params),
- headers=mapping.to_impl(headers),
- data=mapping.to_impl(data),
- form=mapping.to_impl(form),
- multipart=mapping.to_impl(multipart),
- timeout=to_milliseconds(timeout),
- failOnStatusCode=fail_on_status_code,
- ignoreHTTPSErrors=ignore_https_errors,
- maxRedirects=max_redirects,
- maxRetries=max_retries,
- )
- )
- async def put(
- self,
- url: str,
- *,
- params: typing.Optional[
- typing.Union[typing.Dict[str, typing.Union[str, float, bool]], str]
- ] = None,
- headers: typing.Optional[typing.Dict[str, str]] = None,
- data: typing.Optional[typing.Union[typing.Any, bytes, str]] = None,
- form: typing.Optional[
- typing.Union[typing.Dict[str, typing.Union[str, float, bool]], "FormData"]
- ] = None,
- multipart: typing.Optional[
- typing.Union[
- typing.Dict[str, typing.Union[bytes, bool, float, str, FilePayload]],
- "FormData",
- ]
- ] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- fail_on_status_code: typing.Optional[bool] = None,
- ignore_https_errors: typing.Optional[bool] = None,
- max_redirects: typing.Optional[int] = None,
- max_retries: typing.Optional[int] = None,
- ) -> "APIResponse":
- """APIRequestContext.put
- Sends HTTP(S) [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) request and returns its
- response. The method will populate request cookies from the context and update context cookies from the response.
- The method will automatically follow redirects.
- Parameters
- ----------
- url : str
- Target URL.
- params : Union[Dict[str, Union[bool, float, str]], str, None]
- Query parameters to be sent with the URL.
- headers : Union[Dict[str, str], None]
- Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by
- it.
- data : Union[Any, bytes, str, None]
- Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string
- and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type`
- header will be set to `application/octet-stream` if not explicitly set.
- form : Union[Dict[str, Union[bool, float, str]], FormData, None]
- Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent
- as this request body. If this parameter is specified `content-type` header will be set to
- `application/x-www-form-urlencoded` unless explicitly provided. Use `FormData` to send multiple values for the same
- field.
- multipart : Union[Dict[str, Union[bool, bytes, float, str, {name: str, mimeType: str, buffer: bytes}]], FormData, None]
- Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this
- request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless
- explicitly provided. File values can be passed as file-like object containing file name, mime-type and its content.
- Use `FormData` to send multiple files in the same field.
- timeout : Union[float, None]
- Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.
- fail_on_status_code : Union[bool, None]
- Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status
- codes.
- ignore_https_errors : Union[bool, None]
- Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
- max_redirects : Union[int, None]
- Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is
- exceeded. Defaults to `20`. Pass `0` to not follow redirects.
- max_retries : Union[int, None]
- Maximum number of times network errors should be retried. Currently only `ECONNRESET` error is retried. Does not
- retry based on HTTP response codes. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries.
- Returns
- -------
- APIResponse
- """
- return mapping.from_impl(
- await self._impl_obj.put(
- url=url,
- params=mapping.to_impl(params),
- headers=mapping.to_impl(headers),
- data=mapping.to_impl(data),
- form=mapping.to_impl(form),
- multipart=mapping.to_impl(multipart),
- timeout=to_milliseconds(timeout),
- failOnStatusCode=fail_on_status_code,
- ignoreHTTPSErrors=ignore_https_errors,
- maxRedirects=max_redirects,
- maxRetries=max_retries,
- )
- )
- async def post(
- self,
- url: str,
- *,
- params: typing.Optional[
- typing.Union[typing.Dict[str, typing.Union[str, float, bool]], str]
- ] = None,
- headers: typing.Optional[typing.Dict[str, str]] = None,
- data: typing.Optional[typing.Union[typing.Any, bytes, str]] = None,
- form: typing.Optional[
- typing.Union[typing.Dict[str, typing.Union[str, float, bool]], "FormData"]
- ] = None,
- multipart: typing.Optional[
- typing.Union[
- typing.Dict[str, typing.Union[bytes, bool, float, str, FilePayload]],
- "FormData",
- ]
- ] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- fail_on_status_code: typing.Optional[bool] = None,
- ignore_https_errors: typing.Optional[bool] = None,
- max_redirects: typing.Optional[int] = None,
- max_retries: typing.Optional[int] = None,
- ) -> "APIResponse":
- """APIRequestContext.post
- Sends HTTP(S) [POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) request and returns its
- response. The method will populate request cookies from the context and update context cookies from the response.
- The method will automatically follow redirects.
- **Usage**
- JSON objects can be passed directly to the request:
- ```python
- data = {
- \"title\": \"Book Title\",
- \"body\": \"John Doe\",
- }
- api_request_context.post(\"https://example.com/api/createBook\", data=data)
- ```
- To send form data to the server use `form` option. Its value will be encoded into the request body with
- `application/x-www-form-urlencoded` encoding (see below how to use `multipart/form-data` form encoding to send
- files):
- The common way to send file(s) in the body of a request is to upload them as form fields with `multipart/form-data`
- encoding. Use `FormData` to construct request body and pass it to the request as `multipart` parameter:
- ```python
- api_request_context.post(
- \"https://example.com/api/uploadScript'\",
- multipart={
- \"fileField\": {
- \"name\": \"f.js\",
- \"mimeType\": \"text/javascript\",
- \"buffer\": b\"console.log(2022);\",
- },
- })
- ```
- Parameters
- ----------
- url : str
- Target URL.
- params : Union[Dict[str, Union[bool, float, str]], str, None]
- Query parameters to be sent with the URL.
- headers : Union[Dict[str, str], None]
- Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by
- it.
- data : Union[Any, bytes, str, None]
- Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string
- and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type`
- header will be set to `application/octet-stream` if not explicitly set.
- form : Union[Dict[str, Union[bool, float, str]], FormData, None]
- Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent
- as this request body. If this parameter is specified `content-type` header will be set to
- `application/x-www-form-urlencoded` unless explicitly provided. Use `FormData` to send multiple values for the same
- field.
- multipart : Union[Dict[str, Union[bool, bytes, float, str, {name: str, mimeType: str, buffer: bytes}]], FormData, None]
- Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this
- request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless
- explicitly provided. File values can be passed as file-like object containing file name, mime-type and its content.
- Use `FormData` to send multiple files in the same field.
- timeout : Union[float, None]
- Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.
- fail_on_status_code : Union[bool, None]
- Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status
- codes.
- ignore_https_errors : Union[bool, None]
- Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
- max_redirects : Union[int, None]
- Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is
- exceeded. Defaults to `20`. Pass `0` to not follow redirects.
- max_retries : Union[int, None]
- Maximum number of times network errors should be retried. Currently only `ECONNRESET` error is retried. Does not
- retry based on HTTP response codes. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries.
- Returns
- -------
- APIResponse
- """
- return mapping.from_impl(
- await self._impl_obj.post(
- url=url,
- params=mapping.to_impl(params),
- headers=mapping.to_impl(headers),
- data=mapping.to_impl(data),
- form=mapping.to_impl(form),
- multipart=mapping.to_impl(multipart),
- timeout=to_milliseconds(timeout),
- failOnStatusCode=fail_on_status_code,
- ignoreHTTPSErrors=ignore_https_errors,
- maxRedirects=max_redirects,
- maxRetries=max_retries,
- )
- )
- async def fetch(
- self,
- url_or_request: typing.Union[str, "Request"],
- *,
- params: typing.Optional[
- typing.Union[typing.Dict[str, typing.Union[str, float, bool]], str]
- ] = None,
- method: typing.Optional[str] = None,
- headers: typing.Optional[typing.Dict[str, str]] = None,
- data: typing.Optional[typing.Union[typing.Any, bytes, str]] = None,
- form: typing.Optional[
- typing.Union[typing.Dict[str, typing.Union[str, float, bool]], "FormData"]
- ] = None,
- multipart: typing.Optional[
- typing.Union[
- typing.Dict[str, typing.Union[bytes, bool, float, str, FilePayload]],
- "FormData",
- ]
- ] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- fail_on_status_code: typing.Optional[bool] = None,
- ignore_https_errors: typing.Optional[bool] = None,
- max_redirects: typing.Optional[int] = None,
- max_retries: typing.Optional[int] = None,
- ) -> "APIResponse":
- """APIRequestContext.fetch
- Sends HTTP(S) request and returns its response. The method will populate request cookies from the context and
- update context cookies from the response. The method will automatically follow redirects.
- **Usage**
- JSON objects can be passed directly to the request:
- ```python
- data = {
- \"title\": \"Book Title\",
- \"body\": \"John Doe\",
- }
- api_request_context.fetch(\"https://example.com/api/createBook\", method=\"post\", data=data)
- ```
- The common way to send file(s) in the body of a request is to upload them as form fields with `multipart/form-data`
- encoding, by specifiying the `multipart` parameter:
- Parameters
- ----------
- url_or_request : Union[Request, str]
- Target URL or Request to get all parameters from.
- params : Union[Dict[str, Union[bool, float, str]], str, None]
- Query parameters to be sent with the URL.
- method : Union[str, None]
- If set changes the fetch method (e.g. [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) or
- [POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST)). If not specified, GET method is used.
- headers : Union[Dict[str, str], None]
- Allows to set HTTP headers. These headers will apply to the fetched request as well as any redirects initiated by
- it.
- data : Union[Any, bytes, str, None]
- Allows to set post data of the request. If the data parameter is an object, it will be serialized to json string
- and `content-type` header will be set to `application/json` if not explicitly set. Otherwise the `content-type`
- header will be set to `application/octet-stream` if not explicitly set.
- form : Union[Dict[str, Union[bool, float, str]], FormData, None]
- Provides an object that will be serialized as html form using `application/x-www-form-urlencoded` encoding and sent
- as this request body. If this parameter is specified `content-type` header will be set to
- `application/x-www-form-urlencoded` unless explicitly provided. Use `FormData` to send multiple values for the same
- field.
- multipart : Union[Dict[str, Union[bool, bytes, float, str, {name: str, mimeType: str, buffer: bytes}]], FormData, None]
- Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this
- request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless
- explicitly provided. File values can be passed as file-like object containing file name, mime-type and its content.
- Use `FormData` to send multiple files in the same field.
- timeout : Union[float, None]
- Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.
- fail_on_status_code : Union[bool, None]
- Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status
- codes.
- ignore_https_errors : Union[bool, None]
- Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
- max_redirects : Union[int, None]
- Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is
- exceeded. Defaults to `20`. Pass `0` to not follow redirects.
- max_retries : Union[int, None]
- Maximum number of times network errors should be retried. Currently only `ECONNRESET` error is retried. Does not
- retry based on HTTP response codes. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries.
- Returns
- -------
- APIResponse
- """
- return mapping.from_impl(
- await self._impl_obj.fetch(
- urlOrRequest=url_or_request,
- params=mapping.to_impl(params),
- method=method,
- headers=mapping.to_impl(headers),
- data=mapping.to_impl(data),
- form=mapping.to_impl(form),
- multipart=mapping.to_impl(multipart),
- timeout=to_milliseconds(timeout),
- failOnStatusCode=fail_on_status_code,
- ignoreHTTPSErrors=ignore_https_errors,
- maxRedirects=max_redirects,
- maxRetries=max_retries,
- )
- )
- async def storage_state(
- self,
- *,
- path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
- indexed_db: typing.Optional[bool] = None,
- ) -> StorageState:
- """APIRequestContext.storage_state
- Returns storage state for this request context, contains current cookies and local storage snapshot if it was
- passed to the constructor.
- Parameters
- ----------
- path : Union[pathlib.Path, str, None]
- The file path to save the storage state to. If `path` is a relative path, then it is resolved relative to current
- working directory. If no path is provided, storage state is still returned, but won't be saved to the disk.
- indexed_db : Union[bool, None]
- Set to `true` to include IndexedDB in the storage state snapshot.
- Returns
- -------
- {cookies: List[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"]}], origins: List[{origin: str, localStorage: List[{name: str, value: str}]}]}
- """
- return mapping.from_impl(
- await self._impl_obj.storage_state(path=path, indexedDB=indexed_db)
- )
- mapping.register(APIRequestContextImpl, APIRequestContext)
- class APIRequest(AsyncBase):
- async def new_context(
- self,
- *,
- base_url: typing.Optional[str] = None,
- extra_http_headers: typing.Optional[typing.Dict[str, str]] = None,
- http_credentials: typing.Optional[HttpCredentials] = None,
- ignore_https_errors: typing.Optional[bool] = None,
- proxy: typing.Optional[ProxySettings] = None,
- user_agent: typing.Optional[str] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- storage_state: typing.Optional[
- typing.Union[StorageState, str, pathlib.Path]
- ] = None,
- client_certificates: typing.Optional[typing.List[ClientCertificate]] = None,
- fail_on_status_code: typing.Optional[bool] = None,
- max_redirects: typing.Optional[int] = None,
- ) -> "APIRequestContext":
- """APIRequest.new_context
- Creates new instances of `APIRequestContext`.
- Parameters
- ----------
- base_url : Union[str, None]
- Methods like `a_pi_request_context.get()` take the base URL into consideration by using the
- [`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the corresponding URL.
- Examples:
- - baseURL: `http://localhost:3000` and sending request to `/bar.html` results in `http://localhost:3000/bar.html`
- - baseURL: `http://localhost:3000/foo/` and sending request to `./bar.html` results in
- `http://localhost:3000/foo/bar.html`
- - baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in
- `http://localhost:3000/bar.html`
- extra_http_headers : Union[Dict[str, str], None]
- An object containing additional HTTP headers to be sent with every request. Defaults to none.
- http_credentials : Union[{username: str, password: str, origin: Union[str, None], send: Union["always", "unauthorized", None]}, None]
- Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication). If no
- origin is specified, the username and password are sent to any servers upon unauthorized responses.
- ignore_https_errors : Union[bool, None]
- Whether to ignore HTTPS errors when sending network requests. Defaults to `false`.
- proxy : Union[{server: str, bypass: Union[str, None], username: Union[str, None], password: Union[str, None]}, None]
- Network proxy settings.
- user_agent : Union[str, None]
- Specific user agent to use in this context.
- timeout : Union[float, None]
- Maximum time in milliseconds to wait for the response. Defaults to `30000` (30 seconds). Pass `0` to disable
- timeout.
- storage_state : Union[pathlib.Path, str, {cookies: Sequence[{name: str, value: str, domain: str, path: str, expires: float, httpOnly: bool, secure: bool, sameSite: Union["Lax", "None", "Strict"]}], origins: Sequence[{origin: str, localStorage: Sequence[{name: str, value: str}]}]}, None]
- Populates context with given storage state. This option can be used to initialize context with logged-in
- information obtained via `browser_context.storage_state()` or `a_pi_request_context.storage_state()`.
- Either a path to the file with saved storage, or the value returned by one of
- `browser_context.storage_state()` or `a_pi_request_context.storage_state()` methods.
- client_certificates : Union[Sequence[{origin: str, certPath: Union[pathlib.Path, str, None], cert: Union[bytes, None], keyPath: Union[pathlib.Path, str, None], key: Union[bytes, None], pfxPath: Union[pathlib.Path, str, None], pfx: Union[bytes, None], passphrase: Union[str, None]}], None]
- TLS Client Authentication allows the server to request a client certificate and verify it.
- **Details**
- An array of client certificates to be used. Each certificate object must have either both `certPath` and `keyPath`,
- a single `pfxPath`, or their corresponding direct value equivalents (`cert` and `key`, or `pfx`). Optionally,
- `passphrase` property should be provided if the certificate is encrypted. The `origin` property should be provided
- with an exact match to the request origin that the certificate is valid for.
- Client certificate authentication is only active when at least one client certificate is provided. If you want to
- reject all client certificates sent by the server, you need to provide a client certificate with an `origin` that
- does not match any of the domains you plan to visit.
- **NOTE** When using WebKit on macOS, accessing `localhost` will not pick up client certificates. You can make it
- work by replacing `localhost` with `local.playwright`.
- fail_on_status_code : Union[bool, None]
- Whether to throw on response codes other than 2xx and 3xx. By default response object is returned for all status
- codes.
- max_redirects : Union[int, None]
- Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is
- exceeded. Defaults to `20`. Pass `0` to not follow redirects. This can be overwritten for each request
- individually.
- Returns
- -------
- APIRequestContext
- """
- return mapping.from_impl(
- await self._impl_obj.new_context(
- baseURL=base_url,
- extraHTTPHeaders=mapping.to_impl(extra_http_headers),
- httpCredentials=http_credentials,
- ignoreHTTPSErrors=ignore_https_errors,
- proxy=proxy,
- userAgent=user_agent,
- timeout=to_milliseconds(timeout),
- storageState=storage_state,
- clientCertificates=client_certificates,
- failOnStatusCode=fail_on_status_code,
- maxRedirects=max_redirects,
- )
- )
- mapping.register(APIRequestImpl, APIRequest)
- class PageAssertions(AsyncBase):
- async def to_have_title(
- self,
- title_or_reg_exp: typing.Union[typing.Pattern[str], str],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """PageAssertions.to_have_title
- Ensures the page has the given title.
- **Usage**
- ```py
- import re
- from playwright.async_api import expect
- # ...
- await expect(page).to_have_title(re.compile(r\".*checkout\"))
- ```
- Parameters
- ----------
- title_or_reg_exp : Union[Pattern[str], str]
- Expected title or RegExp.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_have_title(
- titleOrRegExp=title_or_reg_exp, timeout=to_milliseconds(timeout)
- )
- )
- async def not_to_have_title(
- self,
- title_or_reg_exp: typing.Union[typing.Pattern[str], str],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """PageAssertions.not_to_have_title
- The opposite of `page_assertions.to_have_title()`.
- Parameters
- ----------
- title_or_reg_exp : Union[Pattern[str], str]
- Expected title or RegExp.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_have_title(
- titleOrRegExp=title_or_reg_exp, timeout=to_milliseconds(timeout)
- )
- )
- async def to_have_url(
- self,
- url_or_reg_exp: typing.Union[str, typing.Pattern[str]],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ignore_case: typing.Optional[bool] = None,
- ) -> None:
- """PageAssertions.to_have_url
- Ensures the page is navigated to the given URL.
- **Usage**
- ```py
- import re
- from playwright.async_api import expect
- # ...
- await expect(page).to_have_url(re.compile(\".*checkout\"))
- ```
- Parameters
- ----------
- url_or_reg_exp : Union[Pattern[str], str]
- Expected URL string or RegExp.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- ignore_case : Union[bool, None]
- Whether to perform case-insensitive match. `ignoreCase` option takes precedence over the corresponding regular
- expression parameter if specified. A provided predicate ignores this flag.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_have_url(
- urlOrRegExp=url_or_reg_exp,
- timeout=to_milliseconds(timeout),
- ignoreCase=ignore_case,
- )
- )
- async def not_to_have_url(
- self,
- url_or_reg_exp: typing.Union[typing.Pattern[str], str],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ignore_case: typing.Optional[bool] = None,
- ) -> None:
- """PageAssertions.not_to_have_url
- The opposite of `page_assertions.to_have_url()`.
- Parameters
- ----------
- url_or_reg_exp : Union[Pattern[str], str]
- Expected URL string or RegExp.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- ignore_case : Union[bool, None]
- Whether to perform case-insensitive match. `ignoreCase` option takes precedence over the corresponding regular
- expression flag if specified.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_have_url(
- urlOrRegExp=url_or_reg_exp,
- timeout=to_milliseconds(timeout),
- ignoreCase=ignore_case,
- )
- )
- async def to_match_aria_snapshot(
- self,
- expected: str,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """PageAssertions.to_match_aria_snapshot
- Asserts that the page body matches the given [accessibility snapshot](https://playwright.dev/python/docs/aria-snapshots).
- **Usage**
- ```py
- await page.goto(\"https://demo.playwright.dev/todomvc/\")
- await expect(page).to_match_aria_snapshot('''
- - heading \"todos\"
- - textbox \"What needs to be done?\"
- ''')
- ```
- Parameters
- ----------
- expected : str
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_match_aria_snapshot(
- expected=expected, timeout=to_milliseconds(timeout)
- )
- )
- async def not_to_match_aria_snapshot(
- self,
- expected: str,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """PageAssertions.not_to_match_aria_snapshot
- The opposite of `page_assertions.to_match_aria_snapshot()`.
- Parameters
- ----------
- expected : str
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_match_aria_snapshot(
- expected=expected, timeout=to_milliseconds(timeout)
- )
- )
- mapping.register(PageAssertionsImpl, PageAssertions)
- class LocatorAssertions(AsyncBase):
- async def to_contain_text(
- self,
- expected: typing.Union[
- typing.Sequence[str],
- typing.Sequence[typing.Pattern[str]],
- typing.Sequence[typing.Union[typing.Pattern[str], str]],
- typing.Pattern[str],
- str,
- ],
- *,
- use_inner_text: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ignore_case: typing.Optional[bool] = None,
- ) -> None:
- """LocatorAssertions.to_contain_text
- Ensures the `Locator` points to an element that contains the given text. All nested elements will be considered
- when computing the text content of the element. You can use regular expressions for the value as well.
- **Details**
- When `expected` parameter is a string, Playwright will normalize whitespaces and line breaks both in the actual
- text and in the expected string before matching. When regular expression is used, the actual text is matched as is.
- **Usage**
- ```py
- import re
- from playwright.async_api import expect
- locator = page.locator('.title')
- await expect(locator).to_contain_text(\"substring\")
- await expect(locator).to_contain_text(re.compile(r\"\\d messages\"))
- ```
- If you pass an array as an expected value, the expectations are:
- 1. Locator resolves to a list of elements.
- 1. Elements from a **subset** of this list contain text from the expected array, respectively.
- 1. The matching subset of elements has the same order as the expected array.
- 1. Each text value from the expected array is matched by some element from the list.
- For example, consider the following list:
- ```html
- <ul>
- <li>Item Text 1</li>
- <li>Item Text 2</li>
- <li>Item Text 3</li>
- </ul>
- ```
- Let's see how we can use the assertion:
- ```py
- from playwright.async_api import expect
- # ✓ Contains the right items in the right order
- await expect(page.locator(\"ul > li\")).to_contain_text([\"Text 1\", \"Text 3\"])
- # ✖ Wrong order
- await expect(page.locator(\"ul > li\")).to_contain_text([\"Text 3\", \"Text 2\"])
- # ✖ No item contains this text
- await expect(page.locator(\"ul > li\")).to_contain_text([\"Some 33\"])
- # ✖ Locator points to the outer list element, not to the list items
- await expect(page.locator(\"ul\")).to_contain_text([\"Text 3\"])
- ```
- Parameters
- ----------
- expected : Union[Pattern[str], Sequence[Pattern[str]], Sequence[Union[Pattern[str], str]], Sequence[str], str]
- Expected substring or RegExp or a list of those.
- use_inner_text : Union[bool, None]
- Whether to use `element.innerText` instead of `element.textContent` when retrieving DOM node text.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- ignore_case : Union[bool, None]
- Whether to perform case-insensitive match. `ignoreCase` option takes precedence over the corresponding regular
- expression flag if specified.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_contain_text(
- expected=mapping.to_impl(expected),
- useInnerText=use_inner_text,
- timeout=to_milliseconds(timeout),
- ignoreCase=ignore_case,
- )
- )
- async def not_to_contain_text(
- self,
- expected: typing.Union[
- typing.Sequence[str],
- typing.Sequence[typing.Pattern[str]],
- typing.Sequence[typing.Union[typing.Pattern[str], str]],
- typing.Pattern[str],
- str,
- ],
- *,
- use_inner_text: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ignore_case: typing.Optional[bool] = None,
- ) -> None:
- """LocatorAssertions.not_to_contain_text
- The opposite of `locator_assertions.to_contain_text()`.
- Parameters
- ----------
- expected : Union[Pattern[str], Sequence[Pattern[str]], Sequence[Union[Pattern[str], str]], Sequence[str], str]
- Expected substring or RegExp or a list of those.
- use_inner_text : Union[bool, None]
- Whether to use `element.innerText` instead of `element.textContent` when retrieving DOM node text.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- ignore_case : Union[bool, None]
- Whether to perform case-insensitive match. `ignoreCase` option takes precedence over the corresponding regular
- expression flag if specified.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_contain_text(
- expected=mapping.to_impl(expected),
- useInnerText=use_inner_text,
- timeout=to_milliseconds(timeout),
- ignoreCase=ignore_case,
- )
- )
- async def to_have_attribute(
- self,
- name: str,
- value: typing.Union[str, typing.Pattern[str]],
- *,
- ignore_case: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_have_attribute
- Ensures the `Locator` points to an element with given attribute.
- **Usage**
- ```py
- from playwright.async_api import expect
- locator = page.locator(\"input\")
- await expect(locator).to_have_attribute(\"type\", \"text\")
- ```
- Parameters
- ----------
- name : str
- Attribute name.
- value : Union[Pattern[str], str]
- Expected attribute value.
- ignore_case : Union[bool, None]
- Whether to perform case-insensitive match. `ignoreCase` option takes precedence over the corresponding regular
- expression flag if specified.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_have_attribute(
- name=name,
- value=value,
- ignoreCase=ignore_case,
- timeout=to_milliseconds(timeout),
- )
- )
- async def not_to_have_attribute(
- self,
- name: str,
- value: typing.Union[str, typing.Pattern[str]],
- *,
- ignore_case: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_have_attribute
- The opposite of `locator_assertions.to_have_attribute()`.
- Parameters
- ----------
- name : str
- Attribute name.
- value : Union[Pattern[str], str]
- Expected attribute value.
- ignore_case : Union[bool, None]
- Whether to perform case-insensitive match. `ignoreCase` option takes precedence over the corresponding regular
- expression flag if specified.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_have_attribute(
- name=name,
- value=value,
- ignoreCase=ignore_case,
- timeout=to_milliseconds(timeout),
- )
- )
- async def to_have_class(
- self,
- expected: typing.Union[
- typing.Sequence[str],
- typing.Sequence[typing.Pattern[str]],
- typing.Sequence[typing.Union[typing.Pattern[str], str]],
- typing.Pattern[str],
- str,
- ],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_have_class
- Ensures the `Locator` points to an element with given CSS classes. When a string is provided, it must fully match
- the element's `class` attribute. To match individual classes use `locator_assertions.to_contain_class()`.
- **Usage**
- ```html
- <div class='middle selected row' id='component'></div>
- ```
- ```py
- from playwright.async_api import expect
- locator = page.locator(\"#component\")
- await expect(locator).to_have_class(\"middle selected row\")
- await expect(locator).to_have_class(re.compile(r\"(^|\\\\s)selected(\\\\s|$)\"))
- ```
- When an array is passed, the method asserts that the list of elements located matches the corresponding list of
- expected class values. Each element's class attribute is matched against the corresponding string or regular
- expression in the array:
- ```py
- from playwright.async_api import expect
- locator = page.locator(\".list > .component\")
- await expect(locator).to_have_class([\"component\", \"component selected\", \"component\"])
- ```
- Parameters
- ----------
- expected : Union[Pattern[str], Sequence[Pattern[str]], Sequence[Union[Pattern[str], str]], Sequence[str], str]
- Expected class or RegExp or a list of those.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_have_class(
- expected=mapping.to_impl(expected), timeout=to_milliseconds(timeout)
- )
- )
- async def not_to_have_class(
- self,
- expected: typing.Union[
- typing.Sequence[str],
- typing.Sequence[typing.Pattern[str]],
- typing.Sequence[typing.Union[typing.Pattern[str], str]],
- typing.Pattern[str],
- str,
- ],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_have_class
- The opposite of `locator_assertions.to_have_class()`.
- Parameters
- ----------
- expected : Union[Pattern[str], Sequence[Pattern[str]], Sequence[Union[Pattern[str], str]], Sequence[str], str]
- Expected class or RegExp or a list of those.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_have_class(
- expected=mapping.to_impl(expected), timeout=to_milliseconds(timeout)
- )
- )
- async def to_contain_class(
- self,
- expected: typing.Union[typing.Sequence[str], str],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_contain_class
- Ensures the `Locator` points to an element with given CSS classes. All classes from the asserted value, separated
- by spaces, must be present in the
- [Element.classList](https://developer.mozilla.org/en-US/docs/Web/API/Element/classList) in any order.
- **Usage**
- ```html
- <div class='middle selected row' id='component'></div>
- ```
- ```py
- from playwright.async_api import expect
- locator = page.locator(\"#component\")
- await expect(locator).to_contain_class(\"middle selected row\")
- await expect(locator).to_contain_class(\"selected\")
- await expect(locator).to_contain_class(\"row middle\")
- ```
- When an array is passed, the method asserts that the list of elements located matches the corresponding list of
- expected class lists. Each element's class attribute is matched against the corresponding class in the array:
- ```html
- <div class='list'>
- <div class='component inactive'></div>
- <div class='component active'></div>
- <div class='component inactive'></div>
- </div>
- ```
- ```py
- from playwright.async_api import expect
- locator = page.locator(\".list > .component\")
- await expect(locator).to_contain_class([\"inactive\", \"active\", \"inactive\"])
- ```
- Parameters
- ----------
- expected : Union[Sequence[str], str]
- A string containing expected class names, separated by spaces, or a list of such strings to assert multiple
- elements.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_contain_class(
- expected=mapping.to_impl(expected), timeout=to_milliseconds(timeout)
- )
- )
- async def not_to_contain_class(
- self,
- expected: typing.Union[typing.Sequence[str], str],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_contain_class
- The opposite of `locator_assertions.to_contain_class()`.
- Parameters
- ----------
- expected : Union[Sequence[str], str]
- Expected class or RegExp or a list of those.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_contain_class(
- expected=mapping.to_impl(expected), timeout=to_milliseconds(timeout)
- )
- )
- async def to_have_count(
- self,
- count: int,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_have_count
- Ensures the `Locator` resolves to an exact number of DOM nodes.
- **Usage**
- ```py
- from playwright.async_api import expect
- locator = page.locator(\"list > .component\")
- await expect(locator).to_have_count(3)
- ```
- Parameters
- ----------
- count : int
- Expected count.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_have_count(
- count=count, timeout=to_milliseconds(timeout)
- )
- )
- async def not_to_have_count(
- self,
- count: int,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_have_count
- The opposite of `locator_assertions.to_have_count()`.
- Parameters
- ----------
- count : int
- Expected count.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_have_count(
- count=count, timeout=to_milliseconds(timeout)
- )
- )
- async def to_have_css(
- self,
- name: str,
- value: typing.Union[str, typing.Pattern[str]],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- pseudo: typing.Optional[Literal["after", "before"]] = None,
- ) -> None:
- """LocatorAssertions.to_have_css
- Ensures the `Locator` resolves to an element with the given computed CSS style.
- **Usage**
- ```py
- from playwright.async_api import expect
- locator = page.get_by_role(\"button\")
- await expect(locator).to_have_css(\"display\", \"flex\")
- ```
- Parameters
- ----------
- name : str
- CSS property name.
- value : Union[Pattern[str], str]
- CSS property value.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- pseudo : Union["after", "before", None]
- Pseudo-element to read computed styles from.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_have_css(
- name=name, value=value, timeout=to_milliseconds(timeout), pseudo=pseudo
- )
- )
- async def not_to_have_css(
- self,
- name: str,
- value: typing.Union[str, typing.Pattern[str]],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_have_css
- The opposite of `locator_assertions.to_have_css()`.
- Parameters
- ----------
- name : str
- CSS property name.
- value : Union[Pattern[str], str]
- CSS property value.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_have_css(
- name=name, value=value, timeout=to_milliseconds(timeout)
- )
- )
- async def to_have_id(
- self,
- id: typing.Union[str, typing.Pattern[str]],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_have_id
- Ensures the `Locator` points to an element with the given DOM Node ID.
- **Usage**
- ```py
- from playwright.async_api import expect
- locator = page.get_by_role(\"textbox\")
- await expect(locator).to_have_id(\"lastname\")
- ```
- Parameters
- ----------
- id : Union[Pattern[str], str]
- Element id.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_have_id(id=id, timeout=to_milliseconds(timeout))
- )
- async def not_to_have_id(
- self,
- id: typing.Union[str, typing.Pattern[str]],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_have_id
- The opposite of `locator_assertions.to_have_id()`.
- Parameters
- ----------
- id : Union[Pattern[str], str]
- Element id.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_have_id(id=id, timeout=to_milliseconds(timeout))
- )
- async def to_have_js_property(
- self,
- name: str,
- value: typing.Any,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_have_js_property
- Ensures the `Locator` points to an element with given JavaScript property. Note that this property can be of a
- primitive type as well as a plain serializable JavaScript object.
- **Usage**
- ```py
- from playwright.async_api import expect
- locator = page.locator(\".component\")
- await expect(locator).to_have_js_property(\"loaded\", True)
- ```
- Parameters
- ----------
- name : str
- Property name.
- value : Any
- Property value.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_have_js_property(
- name=name,
- value=mapping.to_impl(value),
- timeout=to_milliseconds(timeout),
- )
- )
- async def not_to_have_js_property(
- self,
- name: str,
- value: typing.Any,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_have_js_property
- The opposite of `locator_assertions.to_have_js_property()`.
- Parameters
- ----------
- name : str
- Property name.
- value : Any
- Property value.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_have_js_property(
- name=name,
- value=mapping.to_impl(value),
- timeout=to_milliseconds(timeout),
- )
- )
- async def to_have_value(
- self,
- value: typing.Union[str, typing.Pattern[str]],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_have_value
- Ensures the `Locator` points to an element with the given input value. You can use regular expressions for the
- value as well.
- **Usage**
- ```py
- import re
- from playwright.async_api import expect
- locator = page.locator(\"input[type=number]\")
- await expect(locator).to_have_value(re.compile(r\"[0-9]\"))
- ```
- Parameters
- ----------
- value : Union[Pattern[str], str]
- Expected value.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_have_value(
- value=value, timeout=to_milliseconds(timeout)
- )
- )
- async def not_to_have_value(
- self,
- value: typing.Union[str, typing.Pattern[str]],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_have_value
- The opposite of `locator_assertions.to_have_value()`.
- Parameters
- ----------
- value : Union[Pattern[str], str]
- Expected value.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_have_value(
- value=value, timeout=to_milliseconds(timeout)
- )
- )
- async def to_have_values(
- self,
- values: typing.Union[
- typing.Sequence[str],
- typing.Sequence[typing.Pattern[str]],
- typing.Sequence[typing.Union[typing.Pattern[str], str]],
- ],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_have_values
- Ensures the `Locator` points to multi-select/combobox (i.e. a `select` with the `multiple` attribute) and the
- specified values are selected.
- **Usage**
- For example, given the following element:
- ```html
- <select id=\"favorite-colors\" multiple>
- <option value=\"R\">Red</option>
- <option value=\"G\">Green</option>
- <option value=\"B\">Blue</option>
- </select>
- ```
- ```py
- import re
- from playwright.async_api import expect
- locator = page.locator(\"id=favorite-colors\")
- await locator.select_option([\"R\", \"G\"])
- await expect(locator).to_have_values([re.compile(r\"R\"), re.compile(r\"G\")])
- ```
- Parameters
- ----------
- values : Union[Sequence[Pattern[str]], Sequence[Union[Pattern[str], str]], Sequence[str]]
- Expected options currently selected.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_have_values(
- values=mapping.to_impl(values), timeout=to_milliseconds(timeout)
- )
- )
- async def not_to_have_values(
- self,
- values: typing.Union[
- typing.Sequence[str],
- typing.Sequence[typing.Pattern[str]],
- typing.Sequence[typing.Union[typing.Pattern[str], str]],
- ],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_have_values
- The opposite of `locator_assertions.to_have_values()`.
- Parameters
- ----------
- values : Union[Sequence[Pattern[str]], Sequence[Union[Pattern[str], str]], Sequence[str]]
- Expected options currently selected.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_have_values(
- values=mapping.to_impl(values), timeout=to_milliseconds(timeout)
- )
- )
- async def to_have_text(
- self,
- expected: typing.Union[
- typing.Sequence[str],
- typing.Sequence[typing.Pattern[str]],
- typing.Sequence[typing.Union[typing.Pattern[str], str]],
- typing.Pattern[str],
- str,
- ],
- *,
- use_inner_text: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ignore_case: typing.Optional[bool] = None,
- ) -> None:
- """LocatorAssertions.to_have_text
- Ensures the `Locator` points to an element with the given text. All nested elements will be considered when
- computing the text content of the element. You can use regular expressions for the value as well.
- **Details**
- When `expected` parameter is a string, Playwright will normalize whitespaces and line breaks both in the actual
- text and in the expected string before matching. When regular expression is used, the actual text is matched as is.
- **Usage**
- ```py
- import re
- from playwright.async_api import expect
- locator = page.locator(\".title\")
- await expect(locator).to_have_text(re.compile(r\"Welcome, Test User\"))
- await expect(locator).to_have_text(re.compile(r\"Welcome, .*\"))
- ```
- If you pass an array as an expected value, the expectations are:
- 1. Locator resolves to a list of elements.
- 1. The number of elements equals the number of expected values in the array.
- 1. Elements from the list have text matching expected array values, one by one, in order.
- For example, consider the following list:
- ```html
- <ul>
- <li>Text 1</li>
- <li>Text 2</li>
- <li>Text 3</li>
- </ul>
- ```
- Let's see how we can use the assertion:
- ```py
- from playwright.async_api import expect
- # ✓ Has the right items in the right order
- await expect(page.locator(\"ul > li\")).to_have_text([\"Text 1\", \"Text 2\", \"Text 3\"])
- # ✖ Wrong order
- await expect(page.locator(\"ul > li\")).to_have_text([\"Text 3\", \"Text 2\", \"Text 1\"])
- # ✖ Last item does not match
- await expect(page.locator(\"ul > li\")).to_have_text([\"Text 1\", \"Text 2\", \"Text\"])
- # ✖ Locator points to the outer list element, not to the list items
- await expect(page.locator(\"ul\")).to_have_text([\"Text 1\", \"Text 2\", \"Text 3\"])
- ```
- Parameters
- ----------
- expected : Union[Pattern[str], Sequence[Pattern[str]], Sequence[Union[Pattern[str], str]], Sequence[str], str]
- Expected string or RegExp or a list of those.
- use_inner_text : Union[bool, None]
- Whether to use `element.innerText` instead of `element.textContent` when retrieving DOM node text.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- ignore_case : Union[bool, None]
- Whether to perform case-insensitive match. `ignoreCase` option takes precedence over the corresponding regular
- expression flag if specified.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_have_text(
- expected=mapping.to_impl(expected),
- useInnerText=use_inner_text,
- timeout=to_milliseconds(timeout),
- ignoreCase=ignore_case,
- )
- )
- async def not_to_have_text(
- self,
- expected: typing.Union[
- typing.Sequence[str],
- typing.Sequence[typing.Pattern[str]],
- typing.Sequence[typing.Union[typing.Pattern[str], str]],
- typing.Pattern[str],
- str,
- ],
- *,
- use_inner_text: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ignore_case: typing.Optional[bool] = None,
- ) -> None:
- """LocatorAssertions.not_to_have_text
- The opposite of `locator_assertions.to_have_text()`.
- Parameters
- ----------
- expected : Union[Pattern[str], Sequence[Pattern[str]], Sequence[Union[Pattern[str], str]], Sequence[str], str]
- Expected string or RegExp or a list of those.
- use_inner_text : Union[bool, None]
- Whether to use `element.innerText` instead of `element.textContent` when retrieving DOM node text.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- ignore_case : Union[bool, None]
- Whether to perform case-insensitive match. `ignoreCase` option takes precedence over the corresponding regular
- expression flag if specified.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_have_text(
- expected=mapping.to_impl(expected),
- useInnerText=use_inner_text,
- timeout=to_milliseconds(timeout),
- ignoreCase=ignore_case,
- )
- )
- async def to_be_attached(
- self,
- *,
- attached: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_be_attached
- Ensures that `Locator` points to an element that is
- [connected](https://developer.mozilla.org/en-US/docs/Web/API/Node/isConnected) to a Document or a ShadowRoot.
- **Usage**
- ```py
- await expect(page.get_by_text(\"Hidden text\")).to_be_attached()
- ```
- Parameters
- ----------
- attached : Union[bool, None]
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_be_attached(
- attached=attached, timeout=to_milliseconds(timeout)
- )
- )
- async def to_be_checked(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- checked: typing.Optional[bool] = None,
- indeterminate: typing.Optional[bool] = None,
- ) -> None:
- """LocatorAssertions.to_be_checked
- Ensures the `Locator` points to a checked input.
- **Usage**
- ```py
- from playwright.async_api import expect
- locator = page.get_by_label(\"Subscribe to newsletter\")
- await expect(locator).to_be_checked()
- ```
- Parameters
- ----------
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- checked : Union[bool, None]
- Provides state to assert for. Asserts for input to be checked by default. This option can't be used when
- `indeterminate` is set to true.
- indeterminate : Union[bool, None]
- Asserts that the element is in the indeterminate (mixed) state. Only supported for checkboxes and radio buttons.
- This option can't be true when `checked` is provided.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_be_checked(
- timeout=to_milliseconds(timeout),
- checked=checked,
- indeterminate=indeterminate,
- )
- )
- async def not_to_be_attached(
- self,
- *,
- attached: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_be_attached
- The opposite of `locator_assertions.to_be_attached()`.
- Parameters
- ----------
- attached : Union[bool, None]
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_be_attached(
- attached=attached, timeout=to_milliseconds(timeout)
- )
- )
- async def not_to_be_checked(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_be_checked
- The opposite of `locator_assertions.to_be_checked()`.
- Parameters
- ----------
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_be_checked(timeout=to_milliseconds(timeout))
- )
- async def to_be_disabled(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_be_disabled
- Ensures the `Locator` points to a disabled element. Element is disabled if it has \"disabled\" attribute or is
- disabled via
- ['aria-disabled'](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-disabled). Note
- that only native control elements such as HTML `button`, `input`, `select`, `textarea`, `option`, `optgroup` can be
- disabled by setting \"disabled\" attribute. \"disabled\" attribute on other elements is ignored by the browser.
- **Usage**
- ```py
- from playwright.async_api import expect
- locator = page.locator(\"button.submit\")
- await expect(locator).to_be_disabled()
- ```
- Parameters
- ----------
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_be_disabled(timeout=to_milliseconds(timeout))
- )
- async def not_to_be_disabled(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_be_disabled
- The opposite of `locator_assertions.to_be_disabled()`.
- Parameters
- ----------
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_be_disabled(timeout=to_milliseconds(timeout))
- )
- async def to_be_editable(
- self,
- *,
- editable: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_be_editable
- Ensures the `Locator` points to an editable element.
- **Usage**
- ```py
- from playwright.async_api import expect
- locator = page.get_by_role(\"textbox\")
- await expect(locator).to_be_editable()
- ```
- Parameters
- ----------
- editable : Union[bool, None]
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_be_editable(
- editable=editable, timeout=to_milliseconds(timeout)
- )
- )
- async def not_to_be_editable(
- self,
- *,
- editable: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_be_editable
- The opposite of `locator_assertions.to_be_editable()`.
- Parameters
- ----------
- editable : Union[bool, None]
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_be_editable(
- editable=editable, timeout=to_milliseconds(timeout)
- )
- )
- async def to_be_empty(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_be_empty
- Ensures the `Locator` points to an empty editable element or to a DOM node that has no text.
- **Usage**
- ```py
- from playwright.async_api import expect
- locator = page.locator(\"div.warning\")
- await expect(locator).to_be_empty()
- ```
- Parameters
- ----------
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_be_empty(timeout=to_milliseconds(timeout))
- )
- async def not_to_be_empty(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_be_empty
- The opposite of `locator_assertions.to_be_empty()`.
- Parameters
- ----------
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_be_empty(timeout=to_milliseconds(timeout))
- )
- async def to_be_enabled(
- self,
- *,
- enabled: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_be_enabled
- Ensures the `Locator` points to an enabled element.
- **Usage**
- ```py
- from playwright.async_api import expect
- locator = page.locator(\"button.submit\")
- await expect(locator).to_be_enabled()
- ```
- Parameters
- ----------
- enabled : Union[bool, None]
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_be_enabled(
- enabled=enabled, timeout=to_milliseconds(timeout)
- )
- )
- async def not_to_be_enabled(
- self,
- *,
- enabled: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_be_enabled
- The opposite of `locator_assertions.to_be_enabled()`.
- Parameters
- ----------
- enabled : Union[bool, None]
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_be_enabled(
- enabled=enabled, timeout=to_milliseconds(timeout)
- )
- )
- async def to_be_hidden(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_be_hidden
- Ensures that `Locator` either does not resolve to any DOM node, or resolves to a
- [non-visible](https://playwright.dev/python/docs/actionability#visible) one.
- **Usage**
- ```py
- from playwright.async_api import expect
- locator = page.locator('.my-element')
- await expect(locator).to_be_hidden()
- ```
- Parameters
- ----------
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_be_hidden(timeout=to_milliseconds(timeout))
- )
- async def not_to_be_hidden(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_be_hidden
- The opposite of `locator_assertions.to_be_hidden()`.
- Parameters
- ----------
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_be_hidden(timeout=to_milliseconds(timeout))
- )
- async def to_be_visible(
- self,
- *,
- visible: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_be_visible
- Ensures that `Locator` points to an attached and [visible](https://playwright.dev/python/docs/actionability#visible) DOM node.
- To check that at least one element from the list is visible, use `locator.first()`.
- **Usage**
- ```py
- # A specific element is visible.
- await expect(page.get_by_text(\"Welcome\")).to_be_visible()
- # At least one item in the list is visible.
- await expect(page.get_by_test_id(\"todo-item\").first).to_be_visible()
- # At least one of the two elements is visible, possibly both.
- await expect(
- page.get_by_role(\"button\", name=\"Sign in\")
- .or_(page.get_by_role(\"button\", name=\"Sign up\"))
- .first
- ).to_be_visible()
- ```
- Parameters
- ----------
- visible : Union[bool, None]
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_be_visible(
- visible=visible, timeout=to_milliseconds(timeout)
- )
- )
- async def not_to_be_visible(
- self,
- *,
- visible: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_be_visible
- The opposite of `locator_assertions.to_be_visible()`.
- Parameters
- ----------
- visible : Union[bool, None]
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_be_visible(
- visible=visible, timeout=to_milliseconds(timeout)
- )
- )
- async def to_be_focused(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_be_focused
- Ensures the `Locator` points to a focused DOM node.
- **Usage**
- ```py
- from playwright.async_api import expect
- locator = page.get_by_role(\"textbox\")
- await expect(locator).to_be_focused()
- ```
- Parameters
- ----------
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_be_focused(timeout=to_milliseconds(timeout))
- )
- async def not_to_be_focused(
- self,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_be_focused
- The opposite of `locator_assertions.to_be_focused()`.
- Parameters
- ----------
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_be_focused(timeout=to_milliseconds(timeout))
- )
- async def to_be_in_viewport(
- self,
- *,
- ratio: typing.Optional[float] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_be_in_viewport
- Ensures the `Locator` points to an element that intersects viewport, according to the
- [intersection observer API](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API).
- **Usage**
- ```py
- from playwright.async_api import expect
- locator = page.get_by_role(\"button\")
- # Make sure at least some part of element intersects viewport.
- await expect(locator).to_be_in_viewport()
- # Make sure element is fully outside of viewport.
- await expect(locator).not_to_be_in_viewport()
- # Make sure that at least half of the element intersects viewport.
- await expect(locator).to_be_in_viewport(ratio=0.5)
- ```
- Parameters
- ----------
- ratio : Union[float, None]
- The minimal ratio of the element to intersect viewport. If equals to `0`, then element should intersect viewport at
- any positive ratio. Defaults to `0`.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_be_in_viewport(
- ratio=ratio, timeout=to_milliseconds(timeout)
- )
- )
- async def not_to_be_in_viewport(
- self,
- *,
- ratio: typing.Optional[float] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_be_in_viewport
- The opposite of `locator_assertions.to_be_in_viewport()`.
- Parameters
- ----------
- ratio : Union[float, None]
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_be_in_viewport(
- ratio=ratio, timeout=to_milliseconds(timeout)
- )
- )
- async def to_have_accessible_description(
- self,
- description: typing.Union[str, typing.Pattern[str]],
- *,
- ignore_case: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_have_accessible_description
- Ensures the `Locator` points to an element with a given
- [accessible description](https://w3c.github.io/accname/#dfn-accessible-description).
- **Usage**
- ```py
- locator = page.get_by_test_id(\"save-button\")
- await expect(locator).to_have_accessible_description(\"Save results to disk\")
- ```
- Parameters
- ----------
- description : Union[Pattern[str], str]
- Expected accessible description.
- ignore_case : Union[bool, None]
- Whether to perform case-insensitive match. `ignoreCase` option takes precedence over the corresponding regular
- expression flag if specified.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_have_accessible_description(
- description=description,
- ignoreCase=ignore_case,
- timeout=to_milliseconds(timeout),
- )
- )
- async def not_to_have_accessible_description(
- self,
- name: typing.Union[str, typing.Pattern[str]],
- *,
- ignore_case: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_have_accessible_description
- The opposite of `locator_assertions.to_have_accessible_description()`.
- Parameters
- ----------
- name : Union[Pattern[str], str]
- Expected accessible description.
- ignore_case : Union[bool, None]
- Whether to perform case-insensitive match. `ignoreCase` option takes precedence over the corresponding regular
- expression flag if specified.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_have_accessible_description(
- name=name, ignoreCase=ignore_case, timeout=to_milliseconds(timeout)
- )
- )
- async def to_have_accessible_name(
- self,
- name: typing.Union[str, typing.Pattern[str]],
- *,
- ignore_case: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_have_accessible_name
- Ensures the `Locator` points to an element with a given
- [accessible name](https://w3c.github.io/accname/#dfn-accessible-name).
- **Usage**
- ```py
- locator = page.get_by_test_id(\"save-button\")
- await expect(locator).to_have_accessible_name(\"Save to disk\")
- ```
- Parameters
- ----------
- name : Union[Pattern[str], str]
- Expected accessible name.
- ignore_case : Union[bool, None]
- Whether to perform case-insensitive match. `ignoreCase` option takes precedence over the corresponding regular
- expression flag if specified.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_have_accessible_name(
- name=name, ignoreCase=ignore_case, timeout=to_milliseconds(timeout)
- )
- )
- async def not_to_have_accessible_name(
- self,
- name: typing.Union[str, typing.Pattern[str]],
- *,
- ignore_case: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_have_accessible_name
- The opposite of `locator_assertions.to_have_accessible_name()`.
- Parameters
- ----------
- name : Union[Pattern[str], str]
- Expected accessible name.
- ignore_case : Union[bool, None]
- Whether to perform case-insensitive match. `ignoreCase` option takes precedence over the corresponding regular
- expression flag if specified.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_have_accessible_name(
- name=name, ignoreCase=ignore_case, timeout=to_milliseconds(timeout)
- )
- )
- async def to_have_role(
- self,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "blockquote",
- "button",
- "caption",
- "cell",
- "checkbox",
- "code",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "deletion",
- "dialog",
- "directory",
- "document",
- "emphasis",
- "feed",
- "figure",
- "form",
- "generic",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "insertion",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "meter",
- "navigation",
- "none",
- "note",
- "option",
- "paragraph",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "strong",
- "subscript",
- "superscript",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "time",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_have_role
- Ensures the `Locator` points to an element with a given [ARIA role](https://www.w3.org/TR/wai-aria-1.2/#roles).
- Note that role is matched as a string, disregarding the ARIA role hierarchy. For example, asserting a superclass
- role `\"checkbox\"` on an element with a subclass role `\"switch\"` will fail.
- **Usage**
- ```py
- locator = page.get_by_test_id(\"save-button\")
- await expect(locator).to_have_role(\"button\")
- ```
- Parameters
- ----------
- role : Union["alert", "alertdialog", "application", "article", "banner", "blockquote", "button", "caption", "cell", "checkbox", "code", "columnheader", "combobox", "complementary", "contentinfo", "definition", "deletion", "dialog", "directory", "document", "emphasis", "feed", "figure", "form", "generic", "grid", "gridcell", "group", "heading", "img", "insertion", "link", "list", "listbox", "listitem", "log", "main", "marquee", "math", "menu", "menubar", "menuitem", "menuitemcheckbox", "menuitemradio", "meter", "navigation", "none", "note", "option", "paragraph", "presentation", "progressbar", "radio", "radiogroup", "region", "row", "rowgroup", "rowheader", "scrollbar", "search", "searchbox", "separator", "slider", "spinbutton", "status", "strong", "subscript", "superscript", "switch", "tab", "table", "tablist", "tabpanel", "term", "textbox", "time", "timer", "toolbar", "tooltip", "tree", "treegrid", "treeitem"]
- Required aria role.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_have_role(
- role=role, timeout=to_milliseconds(timeout)
- )
- )
- async def to_have_accessible_error_message(
- self,
- error_message: typing.Union[str, typing.Pattern[str]],
- *,
- ignore_case: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_have_accessible_error_message
- Ensures the `Locator` points to an element with a given
- [aria errormessage](https://w3c.github.io/aria/#aria-errormessage).
- **Usage**
- ```py
- locator = page.get_by_test_id(\"username-input\")
- await expect(locator).to_have_accessible_error_message(\"Username is required.\")
- ```
- Parameters
- ----------
- error_message : Union[Pattern[str], str]
- Expected accessible error message.
- ignore_case : Union[bool, None]
- Whether to perform case-insensitive match. `ignoreCase` option takes precedence over the corresponding regular
- expression flag if specified.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_have_accessible_error_message(
- errorMessage=error_message,
- ignoreCase=ignore_case,
- timeout=to_milliseconds(timeout),
- )
- )
- async def not_to_have_accessible_error_message(
- self,
- error_message: typing.Union[str, typing.Pattern[str]],
- *,
- ignore_case: typing.Optional[bool] = None,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_have_accessible_error_message
- The opposite of `locator_assertions.to_have_accessible_error_message()`.
- Parameters
- ----------
- error_message : Union[Pattern[str], str]
- Expected accessible error message.
- ignore_case : Union[bool, None]
- Whether to perform case-insensitive match. `ignoreCase` option takes precedence over the corresponding regular
- expression flag if specified.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_have_accessible_error_message(
- errorMessage=error_message,
- ignoreCase=ignore_case,
- timeout=to_milliseconds(timeout),
- )
- )
- async def not_to_have_role(
- self,
- role: Literal[
- "alert",
- "alertdialog",
- "application",
- "article",
- "banner",
- "blockquote",
- "button",
- "caption",
- "cell",
- "checkbox",
- "code",
- "columnheader",
- "combobox",
- "complementary",
- "contentinfo",
- "definition",
- "deletion",
- "dialog",
- "directory",
- "document",
- "emphasis",
- "feed",
- "figure",
- "form",
- "generic",
- "grid",
- "gridcell",
- "group",
- "heading",
- "img",
- "insertion",
- "link",
- "list",
- "listbox",
- "listitem",
- "log",
- "main",
- "marquee",
- "math",
- "menu",
- "menubar",
- "menuitem",
- "menuitemcheckbox",
- "menuitemradio",
- "meter",
- "navigation",
- "none",
- "note",
- "option",
- "paragraph",
- "presentation",
- "progressbar",
- "radio",
- "radiogroup",
- "region",
- "row",
- "rowgroup",
- "rowheader",
- "scrollbar",
- "search",
- "searchbox",
- "separator",
- "slider",
- "spinbutton",
- "status",
- "strong",
- "subscript",
- "superscript",
- "switch",
- "tab",
- "table",
- "tablist",
- "tabpanel",
- "term",
- "textbox",
- "time",
- "timer",
- "toolbar",
- "tooltip",
- "tree",
- "treegrid",
- "treeitem",
- ],
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_have_role
- The opposite of `locator_assertions.to_have_role()`.
- Parameters
- ----------
- role : Union["alert", "alertdialog", "application", "article", "banner", "blockquote", "button", "caption", "cell", "checkbox", "code", "columnheader", "combobox", "complementary", "contentinfo", "definition", "deletion", "dialog", "directory", "document", "emphasis", "feed", "figure", "form", "generic", "grid", "gridcell", "group", "heading", "img", "insertion", "link", "list", "listbox", "listitem", "log", "main", "marquee", "math", "menu", "menubar", "menuitem", "menuitemcheckbox", "menuitemradio", "meter", "navigation", "none", "note", "option", "paragraph", "presentation", "progressbar", "radio", "radiogroup", "region", "row", "rowgroup", "rowheader", "scrollbar", "search", "searchbox", "separator", "slider", "spinbutton", "status", "strong", "subscript", "superscript", "switch", "tab", "table", "tablist", "tabpanel", "term", "textbox", "time", "timer", "toolbar", "tooltip", "tree", "treegrid", "treeitem"]
- Required aria role.
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_have_role(
- role=role, timeout=to_milliseconds(timeout)
- )
- )
- async def to_match_aria_snapshot(
- self,
- expected: str,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.to_match_aria_snapshot
- Asserts that the target element matches the given [accessibility snapshot](https://playwright.dev/python/docs/aria-snapshots).
- **Usage**
- ```py
- await page.goto(\"https://demo.playwright.dev/todomvc/\")
- await expect(page.locator('body')).to_match_aria_snapshot('''
- - heading \"todos\"
- - textbox \"What needs to be done?\"
- ''')
- ```
- Parameters
- ----------
- expected : str
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.to_match_aria_snapshot(
- expected=expected, timeout=to_milliseconds(timeout)
- )
- )
- async def not_to_match_aria_snapshot(
- self,
- expected: str,
- *,
- timeout: typing.Optional[typing.Union[float, datetime.timedelta]] = None,
- ) -> None:
- """LocatorAssertions.not_to_match_aria_snapshot
- The opposite of `locator_assertions.to_match_aria_snapshot()`.
- Parameters
- ----------
- expected : str
- timeout : Union[float, None]
- Time to retry the assertion for in milliseconds. Defaults to `5000`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(
- await self._impl_obj.not_to_match_aria_snapshot(
- expected=expected, timeout=to_milliseconds(timeout)
- )
- )
- mapping.register(LocatorAssertionsImpl, LocatorAssertions)
- class APIResponseAssertions(AsyncBase):
- async def to_be_ok(self) -> None:
- """APIResponseAssertions.to_be_ok
- Ensures the response status code is within `200..299` range.
- **Usage**
- ```py
- from playwright.async_api import expect
- # ...
- await expect(response).to_be_ok()
- ```
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(await self._impl_obj.to_be_ok())
- async def not_to_be_ok(self) -> None:
- """APIResponseAssertions.not_to_be_ok
- The opposite of `a_pi_response_assertions.to_be_ok()`.
- """
- __tracebackhide__ = True
- return mapping.from_maybe_impl(await self._impl_obj.not_to_be_ok())
- mapping.register(APIResponseAssertionsImpl, APIResponseAssertions)
- class Disposable(AsyncContextManager):
- async def dispose(self) -> None:
- """Disposable.dispose
- Removes the associated resource. For example, removes the init script installed via `page.add_init_script()`
- or `browser_context.add_init_script()`.
- """
- return mapping.from_maybe_impl(await self._impl_obj.dispose())
- async def close(self) -> None:
- return mapping.from_maybe_impl(await self._impl_obj.close())
- mapping.register(DisposableImpl, Disposable)
|