Selenium - O que você deveria saber - Parte 4

Esse é o quarto post da série sobre Selenium, hoje você irá aprender a fazer algumas coisas mais interessantes!

Veja a primeira parte.

Veja a segunda parte.

Veja a terceira parte.

Esse post será o mais longo, então prepare-se!

Parte 4

Expected conditions

ActionsChains - Operações avançadas

EventListener - Ouvindo seu código

Expected conditions

Em alguns casos você precisa esperar para manipular o elemento até que uma condição se satisfaça, para isso o Selenium possui um conjunto de funções para facilitar na maioria das situações.

Essas condições são chamadas expected conditions, abaixo a lista das principais condições:

title_is: Checa se o título (title) da página corresponde ao informado (comparação exata). Retorna True ou False.
title_contains: Checa se o título contém a string informada (case-sensitive). Retorna True ou False.
presence_of_element_located: Checa se o elemento está presente no DOM (ele não precisa estar visível). Retorna o elemento se ele estiver presente ou False.
visibility_of_element_located: Checa se o elemento está presente no DOM e visível (ele precisa ter width e height maior que 0). Retorna o elemento se ele estiver visível ou False.
text_to_be_present_in_element: Checa se o texto está presente no elemento. Retorna True ou False.
text_to_be_present_in_element_value: Checa se o texto está presente no atributo "value" do elemento. Retorna True ou False.
element_to_be_clickable: Checa se o elemento está visível e disponível para ser clicado. Retorna o elemento ou False.
alert_is_present: Checa se existe algum alerta na página. Retorna o alerta ou False.

Todas as funções estão no arquivo: selenium/webdriver/support/expected_conditions.py

Você pode utilizar essas funções em conjunto com o que foi aprendido na Parte 2

Exemplos de uso:

# Importar classe para inicializar o browser
from selenium import webdriver
# Importar a classe WebDriverWait
from selenium.webdriver.support.ui import WebDriverWait
# Importar a classe que contém as funções e aplicar um alias
from selenium.webdriver.support import expected_conditions as EC
# Importar classe para ajudar a localizar os elementos
from selenium.webdriver.common.by import By

firefox = webdriver.Firefox()
# Instanciar a classe que irá esperar até 5 segundos
wait = WebDriverWait(firefox, 5)

# Aguardar até que a página tenha o título "PythonClub"
wait.until(EC.title_is("PythonClub"))

# Aguardar página contenha o título "PythonClub"
wait.until(EC.title_contains("PythonClub"))

# Aguardar até que o elemento "id_elemento" esteja presente no DOM
elemento = wait.until(EC.presence_of_element_located((By.ID, 'id_elemento')))

# Aguardar até que o elemento "id_elemento" esteja visível
elemento = wait.until(EC.visibility_of_element_located((By.ID, 'id_elemento'))))

# Aguardar até que o elemento "id_elemento" contenha o texto "Python"
wait.until(EC.text_to_be_present_in_element((By.ID, 'id_elemento'), 'Python'))

# Aguardar até que o elemento "id_elemento" contenha o valor "Python"
wait.until(EC.text_to_be_present_in_element_value((By.ID, 'id_elemento'), 'Python')))

# Aguardar até que o elemento "id_elemento" possa ser clicado
elemento = wait.until(EC.element_to_be_clickable((By.ID, 'id_elemento')))

# Aguardar até que um alerta esteja presente na página
wait.until(EC.alert_is_present)

Após os 5 segundos, se a condição retornar False será gerado uma exception TimeoutException.

Use a abuse das conditions!

ActionsChains - Operações avançadas

click_and_hold(on_element=None): Clica no elemento e mantém o botão esquerdo do mouse pressionado. Se o parâmetro on_element não for informado, será realizado na posição atual do mouse.
release(on_element=None): Despressiona o botão do mouse. Se o parâmetro on_element for informado, será realizado no elemento.
context_click(on_element=None): Clica no elemento com o botão direito do mouse. Se o parâmetro on_element não for informado, será realizado na posição atual do mouse.
double_click(on_element=None): Realiza o clique duplo. Se o parâmetro on_element não for informado, será realizado na posição atual do mouse.
key_down(value, element=None): Simula uma tecla sendo pressionada e mantida assim. (Deve ser utilizada somente com as teclas de modificação Control, Alt e Shift). Se o parâmetro element não for informado, será realizado no elemento atual.
key_up(value, element=None): Simula uma tecla sendo despressionada. (Deve ser utilizada somente com as teclas de modificação Control, Alt e Shift). Se o parâmetro element não for informado, será realizado no elemento atual.

As ações são armazenadas na ordem em que foram invocadas e para que sejam realizadas é preciso chamar o metódo perform da instância.

Exemplos de uso:

# Importar classe para inicializar o browser
from selenium import webdriver
# Importar a classe ActionChains responsável pelas manipulações
from selenium.webdriver.common.action_chains import ActionChains
# Importar a classe Keys que podem ser utilizadas no key_up e key_down
from selenium.webdriver.common.keys import Keys

firefox = webdriver.Firefox()
actions = ActionChains(firefox)


# Clicar e manter na posição atual do mouse
actions.click_and_hold()
# Voltar o mouse para o estado inicial
actions.release()
# Disparar metódo para que as ações sejam executadas
actions.perform()


botao = firefox.find_element_by_id("#botaoqualquer")
# Clicar e manter em um botão
actions.click_and_hold(on_element=botao)
actions.perform()


# Clicar com o botão direito na posição atual do mouse
actions.context_click()
actions.perform()

# Clique duplo
actions.double_click(on_element=botao)
actions.perform()

# Exemplo com key_down e key_up. Simular um CTRL + C
actions.key_down(Keys.CONTROL) # Pressionar o CTRL
actions.send_keys('c') # Pressionar o C
actions.key_up(Keys.CONTROL) # Liberar o CTRL
actions.perform()

Tem algumas outras ações bem interessantes, vale dar uma olhada no arquivo.

Você pode visualizar as outras funções em: selenium/webdriver/common/action_chains.py

EventListener - Ouvindo seu código

Introdução

O Selenium provê uma forma bem simples para que possa monitorar tudo que está sendo feito pelo navegador. Para cada ação pode ser disparado um evento e esse evento pode ser "ouvido" por seu EventListener.

É necessário que a instância do navegador seja passada para uma classe que irá disparar todos os eventos e então construir seu EventListener para ouvi-lá.

Listener

A classe AbstractEventListener foi construída para ser herdada e alterada. Cada metódo da classe será executado quando determinado evento for disparado.

class AbstractEventListener(object):

  # Será invocado antes de uma url ser acessada pelo metódo "get" do webdriver
  def before_navigate_to(self, url, driver):  pass

  # Será invocado após uma url ser acessada pelo metódo "get" do webdriver
  def after_navigate_to(self, url, driver):   pass

  # Será invocado antes que o metódo "back" do webdriver seja executado
  def before_navigate_back(self, driver): pass

  # Será invocado depois que o metódo "back" do webdriver seja executado
  def after_navigate_back(self, driver):  pass

  # Será invocado antes que o metódo "forward" do webdriver seja executado
  def before_navigate_forward(self, driver):  pass

  # Será invocado depois que o metódo "forward" do webdriver seja executado
  def after_navigate_forward(self, driver):   pass

  # Será invocado antes que o metódo "find(s)_element(s)_by_*" seja executado
  def before_find(self, by, value, driver):   pass

  # Será invocado após que o metódo "find(s)_element(s)_by_*" seja executado
  def after_find(self, by, value, driver):    pass

  # Será invocado antes que o metódo "click" seja executado
  def before_click(self, element, driver):    pass

  # Será invocado após que o metódo "click" seja executado
  def after_click(self, element, driver): pass

  # Será invocado antes que o metódo "clear" ou "send_keys" seja executado
  def before_change_value_of(self, element, driver):  pass

  # Será invocado após que o metódo "clear" ou "send_keys" seja executado
  def after_change_value_of(self, element, driver):   pass

  # Será invocado antes que o metódo "execute_script" ou "execute_async_script" seja executado
  def before_execute_script(self, script, driver):    pass

  # Será invocado após que o metódo "execute_script" ou "execute_async_script" seja executado
  def after_execute_script(self, script, driver): pass

  # Será invocado antes que uma página seja fechada com o metódo "close"
  def before_close(self, driver): pass

  # Será invocado após que uma página seja fechada com o metódo "close"
  def after_close(self, driver):  pass

  # Será invocado antes que o metódo "quit" seja executado
  def before_quit(self, driver):  pass

  # Será invocado depois que o metódo "quit" seja executado
  def after_quit(self, driver):   pass

  # Será executado sempre que houver uma exeception
  def on_exception(self, exception, driver):  pass

Arquivo: selenium/webdriver/support/abstract_event_listener.py

Dispatch

A classe EventFiringWebDriver é responsável por disparar os eventos do navegador. Para que ela funcione é necessário passar uma instância do navegador e um EventListener.

Arquivo: selenium/webdriver/support/event_firing_webdriver.py

Seu próprio Listener

Vamos criar um EventListener simples para utilizarmos no nosso exemplo.

from selenium.webdriver.support.events import AbstractEventListener

class MyListener(AbstractEventListener):
    def before_navigate_to(self, url, driver):
        print "Antes de abrir a url %s" % url

    def after_navigate_to(self, url, driver):
        print "Depois de abrir a url %s" % url

    def before_click(self, element, driver):
        print "Antes de clicar no elemento"

    def after_click(self, element, driver):
        print "Depois de clicar no elemento"

    def before_close(self, driver):
        print "Antes de fechar a pagina"

    def after_close(self, driver):
        print "Depois de fechar a pagina"

    def on_exception(self, exeception, driver):
        print "Ocorreu um erro"

Para criar um EventListener é preciso criar uma classe que herde da AbstractEventListener e implementar os metódos que serão invocados a cada evento ou criar uma classe com os mesmos metódos.

Salve o código em um arquivo chamado "mylistener.py" para testes.

Juntando tudo

Para que tudo funcione corretamente, você precisa primeiro importar as bibliotecas necessárias.

# para instanciar o navegador
from selenium import webdriver

# EventFiringWebdriver para disparar os eventos
from selenium.webdriver.support.events import EventFiringWebDriver

# Importe o seu Listener
from mylistener import MyListener

Depois criar as instâncias:

firefox = webdriver.Firefox()
listener = MyListener()

# Firefox com os eventos sendo disparados
ef_firefox = EventFiringWebDriver(firefox, listener)

Agora é só executar algumas ações e você verá as informações sendo "printadas" na tela.

# abrir página da python club
ef_firefox.get('http://pythonclub.com.br/')

try:
    """
        Propositalmente irá gerar uma exception pois a classe não existe.
        O evento "on_exception" deve ser chamado
    """
    post = ef_firefox.find_element_by_class_name('post-tile')
except:
    pass

# localizamos o primeiro post
post = ef_firefox.find_element_by_class_name('post-title')

# clicar no elemento
post.click()

# fechar a página
ef_firefox.close()

Resultado:

>> python mylistener.py

Antes de abrir a url http://pythonclub.com.br/
Depois de abrir a url http://pythonclub.com.br/
Ocorreu um erro
Antes de clicar no elemento
Depois de clicar no elemento
Antes de fechar a pagina
Depois de fechar a pagina

Código completo: mylistener.py.

Agora você pode explorar o AbstractEventListener e o EventFiringWebdriver e construir seu próprio EventListener de acordo com suas necessidades.

The End

Acredito que esse seja o último post sobre Selenium, espero que tenham gostado!

"Selenium - O que você deveria saber - Parte 4" de "Lucas Magnum" está licenciado com uma Licença Creative Commons - Atribuição-NãoComercial-SemDerivações 4.0 Internacional.

Topo