^j.KddlmZmZmZmZmZmZmZmZm Z m Z ddl m Z m Z mZmZddlmZddlmZddlmZddlmZddlmZddlmZd d lmZd d l m!Z!d d l"m#Z#d d l$m%Z%d dl&m'Z'd dl(m)Z)d dl*m+Z+d dl,m-Z-d dl.m/Z/d dl0m1Z1d dl2m3Z3d dl4m5Z5d dl6m7Z7d dl8m9Z9d dl:m;Z;d dlm?Z?d dl@mAZAd dlBmCZCd dlDmEZEd dlFmGZGd dlHmIZId d lJmKZKd d!lLmMZMd d"lNmOZOd d#lPmQZQd d$lRmSZSd d%lTmUZUd d&lVmWZWd d'lXmYZYd d(lZm[Zd d)l\m]Z]d d*l^m_Z`Gd+d,Za d4d.e ebefd/ee!d0eceee!ffd1ZdGd2d3ee%e'e9e;e=e)e?e+eAeCe-eEeGeIeKeMeOe/e1e3eQeSeUeWe5e7Zy-)5) TYPE_CHECKINGAnyCallableDictListOptionalSetTupleTypeUnion)InvalidArgumentExceptionSessionNotCreatedExceptionUnknownMethodExceptionWebDriverException)Command)RemoteConnection) WebDriver)Self)logger) AppiumOptions)AppiumConnection)AppiumClientConfig)MobileErrorHandler) ActionHelpers) Activities)Common)Display)Gsm)Network) Performance)Power)Sms) SystemBars) Applications) Clipboard)Context) DeviceTime) ExecuteDriver)ExecuteMobileCommand)HardwareActions)ImagesComparison)Keyboard)Location)LogEvent)Logs)RemoteFS) ScreenRecord)Session)Settings)AppiumLocatorConverter) MobileCommandMobileSwitchTo) WebElementc|eZdZdZdeeegeeefffdZd de eeefdfdefdZ defdZ de eeffd Z y) ExtensionBasea Used to define an extension command as driver's methods. Example: When you want to add `example_command` which calls a get request to `session/$sessionId/path/to/your/custom/url`. #. Defines an extension as a subclass of `ExtensionBase` .. code-block:: python class YourCustomCommand(ExtensionBase): def method_name(self): return 'custom_method_name' # Define a method with the name of `method_name` def custom_method_name(self): # Generally the response of Appium follows `{ 'value': { data } }` # format. return self.execute()['value'] # Used to register the command pair as "Appium command" in this driver. def add_command(self): return ('GET', 'session/$sessionId/path/to/your/custom/url') #. Creates a session with the extension. .. code-block:: python # Appium capabilities options = AppiumOptions() driver = webdriver.Remote('http://localhost:4723/wd/hub', options=options, extensions=[YourCustomCommand]) #. Calls the custom command .. code-block:: python # Then, the driver calls a get request against # `session/$sessionId/path/to/your/custom/url`. `$sessionId` will be # replaced properly in the driver. Then, the method returns # the `value` part of the response. driver.custom_method_name() #. Remove added commands (if needed) .. code-block:: python # New commands are added by `setattr`. They remain in the module, # so you should explicitly delete them to define the same name method # with different arguments or process in the method. driver.delete_extensions() You can give arbitrary arguments for the command like the below. .. code-block:: python class YourCustomCommand(ExtensionBase): def method_name(self): return 'custom_method_name' def test_command(self, argument): return self.execute(argument)['value'] def add_command(self): return ('post', 'session/$sessionId/path/to/your/custom/url') driver = webdriver.Remote('http://localhost:4723/wd/hub', options=options, extensions=[YourCustomCommand]) # Then, the driver sends a post request to `session/$sessionId/path/to/your/custom/url` # with `{'dummy_arg': 'as a value'}` JSON body. driver.custom_method_name({'dummy_arg': 'as a value'}) When you customize the URL dynamically with element id. .. code-block:: python class CustomURLCommand(ExtensionBase): def method_name(self): return 'custom_method_name' def custom_method_name(self, element_id): return self.execute({'id': element_id})['value'] def add_command(self): return ('GET', 'session/$sessionId/path/to/your/custom/$id/url') driver = webdriver.Remote('http://localhost:4723/wd/hub', options=options, extensions=[YourCustomCommand]) element = driver.find_element(by=AppiumBy.ACCESSIBILITY_ID, value='id') # Then, the driver calls a get request to `session/$sessionId/path/to/your/custom/$id/url` # with replacing the `$id` with the given `element.id` driver.custom_method_name(element.id) executec||_yN)_execute)selfr<s N/home/ubuntu/.local/lib/python3.12/site-packages/appium/webdriver/webdriver.py__init__zExtensionBase.__init__s  N parametersreturncNi}|r|}|j|j|Sr>)r? method_name)r@rDparams rAr<zExtensionBase.executes) E}}T--/77rCct)z Expected to return a method name. This name will be available as a driver method. Returns: 'str' The method name. NotImplementedErrorr@s rArGzExtensionBase.method_names "##rCct)zI Expected to define the pair of HTTP method and its URL. rJrLs rA add_commandzExtensionBase.add_commands "##rCr>)__name__ __module__ __qualname____doc__rstrrrrBr r<rGr rNrCrAr;r;Dsp^@ #td38n)D E 8%S#X(<"=88 $S$$U38_$rCr;Ncommand_executor client_configrEcft|ts|dfS| t|n|}t||fS)a-Return the pair of command executor and client config. If the given command executor is a custom one, returned client config will be None since the custom command executor has its own client config already. The custom command executor's one will be prior than the given client config. N)remote_server_addr)rV) isinstancerSrr)rUrVnew_client_configs rA(_get_remote_connection_and_client_configr[sG & ,!$'' TaSh*>NOn{ +< =?P QQrCc eZdZ ddeeefdeeeddee ee dfdee ffd Z e r%dded eee dfd d fd Zdded eee dfd ed fd Zd dZded dfdZddee e fdeed dfdZd e fdZdeeefd efdZed efdZed efdZej8d ed dfdZded efdZded efdZd dZ xZ!S)!rNrU extensionsr;optionsrVc t||\}}t | ||tt|||j t |_|r(|jr|j|jt|_ |xsg|_ |jD]}||j}|j}t!t"|rt%j&d|dt)t"|t+|||j-\}} |j.j-||j1| y)N)rUrV)rUr^locator_converterweb_element_clsrV keep_alivezOverriding the method '')r[superrBr5MobileWebElement _add_commandsr error_handlerdirect_connection_update_command_executorrcset_absent_extensions _extensionsr<rGhasattrrrdebugsetattrgetattrrNrUupper) r@rUr]r^rV extensioninstancerGmethodurl_cmd __class__s rArBzWebDriver.__init__s.+S-]+ '- -46,'    /1 ]<<  ) )]5M5M ) N,/E%+)) TI .H"..0Ky+. 6{m1EF I{GHk,J K&224OFG  ! ! - -k6<<>7 S TrCbyvaluerErfcyr>rTr@rxrys rA find_elementzWebDriver.find_element rCcyr>rTr{s rA find_elementszWebDriver.find_elements r}rCc|jD]E}||j}|j}tt|s6t t|Gy)z3Delete extensions added in the class with 'setattr'N)rmr<rGrnrdelattr)r@rsrtrGs rAdelete_extensionszWebDriver.delete_extensions#sG)) 0I .H"..0Ky+. ;/  0rCrcc|d}d}d}d}|js td||||hjt|jsHd}||||fD]'}||d|jj |dd z })t j |y |j|}|j|} |j|} |j|} |d | d | | } t j d | t|jtrt| ||_nt| ||_|jy )z7Update command executor following directConnect featuredirectConnectProtocoldirectConnectHostdirectConnectPortdirectConnectPathz#Driver capabilities must be definedz.Direct connect capabilities from server were: z: 'z' Nz://:zUpdated request endpoint to %srb) caps ValueErrorissubsetrkgetrrorYrUrrrg) r@rcdirect_protocol direct_host direct_port direct_pathmessagekeyprotocolhostnameportpathexecutors rArjz"WebDriver._update_command_executor+s>1) ) ) yyBC Ck;GPPQTUYU^U^Q_`GG'k;O AcU#diimmC&<%=R@@ A LL ! 99_-99[)yy%yy%Zs8*AdVD6: 5x@ d++-= >$4X*$UD !$4X*$UD ! rC capabilitiesbrowser_profilect|ttfs tdt|trtj|n|j }|j tj|ttstddfd}|d}|stdd||_ |dxsi|_ y) a(Creates a new session with the desired capabilities. Override for Appium Args: capabilities: Read https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/caps.md for more details. browser_profile: Browser profile z;Capabilities must be a dictionary or AppiumOptions instancezAA valid W3C session creation response must be a dictionary. Got "z " insteadcj|xs5tjdtrdj|SdS)Nry)rrYdict)rresponses rAz)WebDriver.start_session..bsE LL  r 8<*+hi i9CLRV9W='' 5]i]p]p]r<< 9 98D(D),ST\S]]fg  > ( 4 ,ijriss|} %&~6<" rCcF|jtjdS)z Get the Appium server status Usage: driver.get_status() Returns: dict: The status information ry)r<r GET_STATUSrLs rA get_statuszWebDriver.get_statusms||G../88rC element_idct||S)a#Creates a web element with the specified element_id. Overrides method in Selenium WebDriver in order to always give them Appium WebElement Args: element_id: The element id to create a web element Returns: `MobileWebElement` )rf)r@rs rAcreate_web_elementzWebDriver.create_web_elementzs j11rCct|S)zReturns an object containing all options to switch focus into Override for appium Returns: `appium.webdriver.switch_to.MobileSwitchTo` r7rLs rA switch_tozWebDriver.switch_tosd##rCcF|jtjdS)z Gets the current orientation of the device Example: .. code-block:: python orientation = driver.orientation ry)r<rGET_SCREEN_ORIENTATIONrLs rA orientationzWebDriver.orientations||G::;GDDrCcddg}|j|vr#|jtjd|iyt d)z Sets the current orientation of the device Args: - value: orientation to set it to. Example: .. code-block:: python driver.orientation = 'landscape' LANDSCAPEPORTRAITrz>You can only set the orientation to 'LANDSCAPE' and 'PORTRAIT'N)rrr<rSET_SCREEN_ORIENTATIONr)r@ryallowed_valuess rArzWebDriver.orientationsA&z2 ;;=N * LL77-9O P$%ef frCext_namec6||jvr t|S)a Verifies if the given extension is not present in the list of absent extensions for the given driver instance. This API is designed for private usage. Args: ext_name: extension name Returns: self instance for chaining Raises: UnknownMethodException: If the extension has been marked as absent once )rlrr@rs rAassert_extension_existsz!WebDriver.assert_extension_existss  t.. .(* * rCcntjd|d|jj||S)z Marks the given extension as absent for the given driver instance. This API is designed for private usage. Args: ext_name: extension name Returns: self instance for chaining zMarking driver extension "z$" as absent for the current instance)rrorladdrs rAmark_extension_absencez WebDriver.mark_extension_absences4  1(;_`a ##H- rCcDtd|jjD]O}t||jj s$t ||jj d}|sH||Q|jjtjdd|jjtjdd|jjtjdd|jjtjdd|jjtjdd|jjtjdd |jjtj dd y) Nc$t|t Sr>) issubclassr)xs rArz)WebDriver._add_commands..s 1i0H,HrCGETz/statusPOSTz%/session/$sessionId/element/$id/clearz0/session/$sessionId/element/$id/location_in_viewz)/session/$sessionId/element/$id/displayedz/session/$sessionIdz/session/$sessionId/orientation)filterrw__mro__rnrgrOrqrUrNrrCLEARLOCATION_IN_VIEWIS_ELEMENT_DISPLAYEDGET_CAPABILITIESrr)r@ mixin_class get_atters rArgzWebDriver._add_commandss?""H$..J`J`a $K{D$6$6$?$?@#K1C1C1L1LdS dO  $ ))'*<*  ))'*F*FOz{ ))'*B*BEK`a ))'*H*H%Qrs ))'*H*H&RstrC)zhttp://127.0.0.1:4723NNNr>)rEN)"rOrPrQr rSrrrr rrrBrrr|rrboolrjrrintrfrpropertyr8rrsetterrrrrg __classcell__)rws@rArrs>:Q<@CG6: (T%5 56(TT$"789(T}d=&94?@ (T  23 (TT 3 uS$_/E Qc  C c4o0F RVWiRj 04D@ =%m0C*D =W_`cWd =pt =D 9D 9 2U38_ 2AQ 2 $> $ $ ES E Egggg$& s t urCrr>)etypingrrrrrrr r r r selenium.common.exceptionsr rrr!selenium.webdriver.remote.commandrr+selenium.webdriver.remote.remote_connectionr#selenium.webdriver.remote.webdriverrRemotetyping_extensionsrappium.common.loggerrappium.options.common.baserappium_connectionrrVr errorhandlerrextensions.action_helpersrextensions.android.activitiesrextensions.android.commonrextensions.android.displayrextensions.android.gsmrextensions.android.networkr extensions.android.performancer!extensions.android.powerr"extensions.android.smsr#extensions.android.system_barsr$extensions.applicationsr%extensions.clipboardr&extensions.contextr'extensions.device_timer(extensions.execute_driverr)!extensions.execute_mobile_commandr*extensions.hw_actionsr+extensions.images_comparisonr,extensions.keyboardr-extensions.locationr.extensions.log_eventr/extensions.logsr0extensions.remote_fsr1extensions.screen_recordr2extensions.sessionr3extensions.settingsr4r`r5 mobilecommandr6rr8 webelementr9rfr;rStupler[rTrCrArsL_^^ GHD"'4/-,45-/'/7+'61+'.4C2:))*!*2')53%6x$x$xcgRC!112RCKL^C_R X&89 9:R*^u             7^urC