Element locators in page class in Selenium Python - Framework Patterns

Framework Mode - Element locators in page class

Folder Structure

project_root/
├── src/
│   └── pages/
│       └── login_page.py
├── tests/
│   └── test_login.py
├── utils/
│   └── helpers.py
├── config/
│   └── config.yaml
├── conftest.py
└── requirements.txt
    

Test Framework Layers

• Driver Layer: Manages browser setup and teardown (e.g., in conftest.py using pytest fixtures).
• Page Objects: Classes representing pages, containing element locators and methods to interact with them (e.g., login_page.py).
• Tests: Test scripts that use page objects to perform actions and assertions (e.g., test_login.py).
• Utilities: Helper functions or classes for common tasks like waits or data handling (e.g., helpers.py).
• Configuration: Files and code to manage environment variables, URLs, credentials (e.g., config.yaml).

Configuration Patterns

Use a config.yaml file to store environment URLs, browser types, and credentials securely.

Load configuration in conftest.py or utility modules to initialize tests dynamically.

Example snippet to load config:

import yaml

with open('config/config.yaml') as f:
    config = yaml.safe_load(f)

browser = config['browser']
base_url = config['base_url']
credentials = config['credentials']

Test Reporting and CI/CD Integration

• Use pytest's built-in reporting with --junitxml=report.xml for CI tools.
• Integrate with CI/CD pipelines (GitHub Actions, Jenkins) to run tests on each commit.
• Generate HTML reports using plugins like pytest-html for readable test results.
• Fail tests clearly when element locators are not found, aiding quick debugging.

Best Practices for Element Locators in Page Classes

1. Use descriptive variable names for locators to make code readable (e.g., username_input).
2. Keep locators private (prefix with underscore) and expose interaction methods instead.
3. Use stable locator strategies like By.ID or By.CSS_SELECTOR over brittle XPaths.
4. Centralize locators in page classes to ease maintenance when UI changes.
5. Use explicit waits in page methods to handle dynamic elements reliably.

Self Check

Where in this folder structure would you add a new locator for the "Remember Me" checkbox on the login page?

Key Result

Organize element locators inside page classes to keep tests clean, maintainable, and reliable.

Practice

1. What is the main purpose of using element locators in a page class in Selenium Python?

easy

A. To find web elements clearly and reuse them easily

B. To write complex test logic inside the page class

C. To store test data separately from the test scripts

D. To execute browser commands directly

Solution

1. Step 1: Understand the role of element locators

   Element locators help identify web elements on a page so tests can interact with them.

2. Step 2: Recognize the benefit of using a page class

   Storing locators in a page class allows easy reuse and keeps code clean.

3. Final Answer:

   To find web elements clearly and reuse them easily -> Option A

4. Quick Check:

   Element locators = reuse and clarity [OK]

Hint: Locators in page class = find elements + reuse [OK]

Common Mistakes:

• Confusing locators with test data storage
• Thinking page class runs browser commands
• Assuming locators hold test logic

2. Which of the following is the correct way to define a locator for a button with id 'submit' in a Selenium page class?

easy

A. submit_button = By('id', 'submit')

B. submit_button = By.ID('submit')

C. submit_button = ('id', submit)

D. submit_button = (By.ID, 'submit')

Solution

1. Step 1: Recall the correct locator tuple format

   Locators are tuples with By strategy and string value, e.g., (By.ID, 'value').

2. Step 2: Check each option's syntax

   submit_button = (By.ID, 'submit') uses (By.ID, 'submit'), which is correct. Others use wrong syntax or missing quotes.

3. Final Answer:

   submit_button = (By.ID, 'submit') -> Option D

4. Quick Check:

   Locator tuple = (By.ID, 'value') [OK]

Hint: Locator = (By.<STRATEGY>, 'value') tuple [OK]

Common Mistakes:

• Using By.ID('submit') instead of tuple
• Missing quotes around 'submit'
• Using wrong tuple structure

3. Given the locator login_button = (By.CSS_SELECTOR, 'button.login') in a page class, what will driver.find_element(*login_button) do?

medium

A. Cause a syntax error because of unpacking

B. Find the first button element with class 'login' on the page

C. Find all button elements with class 'login' on the page

D. Find an element by tag name 'button.login'

Solution

1. Step 1: Understand the locator tuple and unpacking

   The locator is a tuple (By.CSS_SELECTOR, 'button.login'). Using * unpacks it into two arguments.

2. Step 2: Know what find_element does

   find_element returns the first matching element, not all elements.

3. Final Answer:

   Find the first button element with class 'login' on the page -> Option B

4. Quick Check:

   find_element + CSS selector = first match [OK]

Hint: find_element finds first match, unpack locator tuple [OK]

Common Mistakes:

• Confusing find_element with find_elements
• Thinking unpacking causes syntax error
• Misunderstanding CSS selector as tag name

4. You have this locator in your page class: search_box = (By.NAME, 'q'). Your test code uses driver.find_element(search_box) and fails. What is the error and how to fix it?

medium

A. Error: Missing unpacking operator '*'. Fix: Use driver.find_element(*search_box)

B. Error: Wrong locator type. Fix: Change By.NAME to By.ID

C. Error: Locator value is incorrect. Fix: Change 'q' to 'search'

D. Error: find_element cannot use tuples. Fix: Use string locator only

Solution

1. Step 1: Identify the cause of failure

   driver.find_element expects two arguments, but passing a tuple without unpacking sends one argument.

2. Step 2: Apply the correct fix

   Use the unpacking operator * to pass locator as separate arguments: driver.find_element(*search_box).

3. Final Answer:

   Error: Missing unpacking operator '*'. Fix: Use driver.find_element(*search_box) -> Option A

4. Quick Check:

   Unpack locator tuple with * [OK]

Hint: Always unpack locator tuple with * in find_element [OK]

Common Mistakes:

• Not using * causes TypeError
• Changing locator type unnecessarily
• Assuming locator value is wrong

5. You want to create a page class locator for a link with text 'Home' that may appear as either an <a> tag or a <button> tag. Which locator is best to find it reliably?

hard

A. home_link = (By.LINK_TEXT, 'Home')

B. home_link = (By.CSS_SELECTOR, 'a.home, button.home')

C. home_link = (By.XPATH, "//a[text()='Home'] | //button[text()='Home']")

D. home_link = (By.ID, 'home')

Solution

1. Step 1: Understand the locator requirements

   The element can be either an <a> or <button> with text 'Home', so locator must cover both tags.

2. Step 2: Evaluate locator options

   home_link = (By.XPATH, "//a[text()='Home'] | //button[text()='Home']") uses XPath with OR (|) to match either tag by exact text, which is reliable. home_link = (By.LINK_TEXT, 'Home') only works for <a> tags. home_link = (By.CSS_SELECTOR, 'a.home, button.home') uses classes which may not exist. home_link = (By.ID, 'home') uses ID which is not given.

3. Final Answer:

   home_link = (By.XPATH, "//a[text()='Home'] | //button[text()='Home']") -> Option C

4. Quick Check:

   XPath OR matches multiple tags [OK]

Hint: Use XPath OR (|) to match multiple tag types [OK]

Common Mistakes:

• Using LINK_TEXT misses button tags
• Using CSS selectors without classes
• Assuming ID exists without confirmation