Action methods in page class in Selenium Python - Framework Patterns

Framework Mode - Action methods in page class

Folder Structure

project_root/
├── src/
│   └── pages/
│       ├── base_page.py
│       ├── login_page.py
│       └── dashboard_page.py
├── tests/
│   ├── test_login.py
│   └── test_dashboard.py
├── utils/
│   ├── driver_factory.py
│   └── helpers.py
├── config/
│   └── config.yaml
└── requirements.txt
    

Test Framework Layers

• Driver Layer: Manages browser setup and teardown (e.g., driver_factory.py).
• Page Objects Layer: Contains page classes with locators and action methods that perform user interactions (e.g., login_page.py).
• Test Layer: Contains test scripts that call page object methods to perform tests (e.g., test_login.py).
• Utilities Layer: Helper functions and reusable utilities (e.g., waits, data handling).
• Configuration Layer: Holds environment settings, credentials, and browser options.

Configuration Patterns

Use a config.yaml file to store environment URLs, browser types, and user credentials. Load this config in your driver_factory.py and tests to keep settings centralized and easy to change.

Example snippet from config.yaml:

environment:
  url: "https://example.com"
  browser: "chrome"
credentials:
  username: "testuser"
  password: "password123"
    

Test Reporting and CI/CD Integration

Use pytest with plugins like pytest-html to generate readable HTML reports after test runs.

Integrate tests into CI/CD pipelines (e.g., GitHub Actions, Jenkins) to run tests automatically on code changes and publish reports.

Best Practices for Action Methods in Page Classes

• Encapsulate Actions: Each method should perform a clear user action (e.g., login(username, password)), hiding low-level details.
• Use Descriptive Method Names: Names like click_login_button() or enter_username() make tests easy to read.
• Return Page Objects: After actions that navigate, return the new page object to allow fluent test code.
• Keep Locators Private: Define locators as private variables inside the page class to avoid external access.
• Use Explicit Waits: Inside action methods, wait for elements to be ready before interacting to avoid flaky tests.

Self Check

Where in this framework structure would you add a new action method for clicking the "Submit" button on the login page?

Key Result

Action methods in page classes encapsulate user interactions, improving test readability and maintainability.

Practice

1. What is the main purpose of action methods in a page class in Selenium Python?

easy

A. To perform tasks like clicking or typing on web page elements

B. To store test data separately from test scripts

C. To generate reports after test execution

D. To configure browser settings before tests

Solution

1. Step 1: Understand what action methods do

   Action methods are designed to perform user-like actions such as clicking buttons or typing text on web elements.

2. Step 2: Identify the role of action methods in page classes

   They help keep test code clean by encapsulating these actions inside the page class, making tests easier to read and reuse.

3. Final Answer:

   To perform tasks like clicking or typing on web page elements -> Option A

4. Quick Check:

   Action methods = perform tasks on elements [OK]

Hint: Action methods do things on page elements, like clicks or typing [OK]

Common Mistakes:

• Confusing action methods with data storage
• Thinking action methods generate reports
• Believing action methods configure browsers

2. Which of the following is the correct way to define an action method that clicks a button using Selenium Python inside a page class?

easy

A. def click_button(): driver.find_element(By.ID, 'btn').click()

B. def click_button(self): self.driver.find_element('btn').click()

C. def click_button(self): find_element(By.ID, 'btn').click()

D. def click_button(self): self.driver.find_element(By.ID, 'btn').click()

Solution

1. Step 1: Check method signature and usage of self

   Inside a class, methods must have self as the first parameter to access instance variables like driver.

2. Step 2: Verify correct locator usage

   Using By.ID with the driver.find_element method is the correct way to locate elements in Selenium Python.

3. Final Answer:

   def click_button(self): self.driver.find_element(By.ID, 'btn').click() -> Option D

4. Quick Check:

   Method with self and correct locator = def click_button(self): self.driver.find_element(By.ID, 'btn').click() [OK]

Hint: Always include self and use By.ID for locators [OK]

Common Mistakes:

• Omitting self parameter in method
• Using find_element without driver or self
• Passing locator as string without By.ID

3. Given the following page class method, what will be the output if the button with ID 'submit' is not present on the page?

def click_submit(self):
    self.driver.find_element(By.ID, 'submit').click()
    return 'Clicked'

medium

A. 'Clicked' will be returned

B. selenium.common.exceptions.NoSuchElementException will be raised

C. No output, test will silently pass

D. 'submit' string will be printed

Solution

1. Step 1: Understand what happens when element is missing

   If the element with ID 'submit' is not found, Selenium raises NoSuchElementException immediately.

2. Step 2: Check method return behavior

   The return 'Clicked' only happens after the click succeeds, so it won't be reached if exception occurs.

3. Final Answer:

   selenium.common.exceptions.NoSuchElementException will be raised -> Option B

4. Quick Check:

   Missing element causes NoSuchElementException [OK]

Hint: Missing element causes exception, no return happens [OK]

Common Mistakes:

• Assuming method returns 'Clicked' even if element missing
• Thinking test passes silently without error
• Confusing exception with printed output

4. Identify the error in this action method and choose the correct fix:

def enter_text(self, text):
    input_box = self.driver.find_element(By.NAME, 'username')
    input_box.sendkeys(text)

medium

A. Change 'sendkeys' to 'send_keys' to fix the method call

B. Replace 'By.NAME' with 'By.ID' to locate the element correctly

C. Add 'self' parameter to the method definition

D. Use 'find_elements' instead of 'find_element' to get multiple elements

Solution

1. Step 1: Check method call spelling

   The correct Selenium method to send text is 'send_keys', not 'sendkeys'. This typo causes an AttributeError.

2. Step 2: Verify other parts of the method

   The method has self parameter and uses By.NAME correctly, so no changes needed there.

3. Final Answer:

   Change 'sendkeys' to 'send_keys' to fix the method call -> Option A

4. Quick Check:

   Correct method name is send_keys [OK]

Hint: Selenium method is send_keys, not sendkeys [OK]

Common Mistakes:

• Misspelling send_keys method
• Changing locator type unnecessarily
• Removing self parameter incorrectly

5. You want to create an action method in your page class that selects an option from a dropdown by visible text. Which of the following is the best implementation?

hard

A. def select_option(self, text):
self.driver.find_element(By.ID, 'menu').click()
self.driver.find_element(By.XPATH, f'//option[text()="{text}"]').click()

B. def select_option(self, text):
dropdown = self.driver.find_element(By.ID, 'menu')
dropdown.select_by_visible_text(text)

C. def select_option(self, text):
dropdown = Select(self.driver.find_element(By.ID, 'menu'))
dropdown.select_by_visible_text(text)

D. def select_option(self, text):
self.driver.find_element(By.ID, 'menu').send_keys(text)

Solution

1. Step 1: Understand how to handle dropdowns in Selenium Python

   Selenium provides a Select class to handle dropdowns, which must be initialized with the dropdown element.

2. Step 2: Check each option for correct usage

   def select_option(self, text): dropdown = Select(self.driver.find_element(By.ID, 'menu')) dropdown.select_by_visible_text(text) correctly creates a Select object and calls select_by_visible_text. def select_option(self, text): dropdown = self.driver.find_element(By.ID, 'menu') dropdown.select_by_visible_text(text) tries to call select_by_visible_text directly on a WebElement, which is invalid. def select_option(self, text): self.driver.find_element(By.ID, 'menu').click() self.driver.find_element(By.XPATH, f'//option[text()="{text}"]').click() manually clicks options but is less clean. def select_option(self, text): self.driver.find_element(By.ID, 'menu').send_keys(text) uses send_keys which may not work reliably.

3. Final Answer:

   def select_option(self, text): dropdown = Select(self.driver.find_element(By.ID, 'menu')) dropdown.select_by_visible_text(text) -> Option C

4. Quick Check:

   Use Select class for dropdowns [OK]

Hint: Use Select class to pick dropdown options by visible text [OK]

Common Mistakes:

• Calling select_by_visible_text on WebElement directly
• Not importing or using Select class
• Using send_keys instead of Select for dropdowns