Skip to content

Input Utils

Overview

InputUtils provides reliable text input interactions using visible label text. Inputs can be located by exact label match, partial label match, HTML id attributes, or placeholder text.

All input operations handle timing issues automatically and clear existing values before entering new text.

Methods

setValueByLabelText

Set value in an input field by its exact label text.

Use this when you know the complete, exact label text associated with the input field. This is the most precise way to interact with inputs and works best when label text is stable and consistent across your application.

Args:

  • wait (WebDriverWait): WebDriverWait instance
  • label (str): Exact visible label text to match
  • value (str): Text to enter into the input field

Raises:

  • ValueError: If label element has no 'for' attribute linking to input
  • TimeoutException: If label or input not found within timeout

Examples:

HTML: 

<div>
  <label for="username_input">Username</label>
  <input id="username_input" type="text" />
</div>

Python: 

from robo_appian.components.InputUtils import InputUtils

InputUtils.setValueByLabelText(wait, "Username", "john_doe")

setValueByPartialLabelText

Set value in an input field by partial label text match.

Use this when you only know part of the label text, or when labels include dynamic content like suffixes or prefixes (e.g., "Username (Production)" vs "Username (Test)"). Perfect for environment-agnostic tests where labels have variable portions.

Args:

  • wait (WebDriverWait): WebDriverWait instance
  • label (str): Partial label text to match (e.g., "Username" matches "Username (Production)")
  • value (str): Text to enter into the input field

Raises:

  • ValueError: If label element is missing the 'for' attribute that links it to an input field. Verify the HTML structure of the form component.
  • TimeoutException: If label or input not found within timeout

Examples:

HTML: 

<div>
  <label for="user_name_input">Full User Name</label>
  <input id="user_name_input" type="text" />
</div>
<div>
  <label for="first_input">Employee First Name</label>
  <input id="first_input" type="text" />
</div>

Python: 

from robo_appian.components.InputUtils import InputUtils

# Matches "Full User Name" (contains "User")
InputUtils.setValueByPartialLabelText(wait, "User", "John")

# Matches "Employee First Name" (contains "First")
InputUtils.setValueByPartialLabelText(wait, "First", "Jane")

setValueById

Set value in an input field by its HTML id attribute.

Use this when the input has a specific HTML id and label-based selection isn't suitable. This is useful for inputs without visible labels or when you need to target a specific field among several with similar labels.

Args:

  • wait (WebDriverWait): WebDriverWait instance
  • id (str): The HTML id attribute of the input element
  • value (str): Text to enter into the input field

Raises:

  • TimeoutException: If input not found within timeout

Examples:

HTML: 

<input id="email_input" type="email" />

Python: 

from robo_appian.components.InputUtils import InputUtils

InputUtils.setValueById(wait, "email_input", "user@example.com")

setValueByPlaceholderText

Set value in an input field by its placeholder text.

Use this when the input field has placeholder text but no visible label. Placeholder text is the hint text that appears inside an empty input field (e.g., "Enter your email").

Args:

  • wait (WebDriverWait): WebDriverWait instance
  • text (str): The placeholder text of the input field
  • value (str): Text to enter into the input field

Raises:

  • TimeoutException: If input not found within timeout

Examples:

HTML: 

<input type="email" placeholder="Enter your email" />

Python: 

from robo_appian.components.InputUtils import InputUtils

InputUtils.setValueByPlaceholderText(wait, "Enter your email", "user@example.com")