Configuration class

Platform: ImagesLanguage: Python SDK:
This class is used to create a configuration object that is used to configure an Eyes object by passing it to the Eyes.set_configuration method.
You can use this configuration object instead of using the various Eyes methods and properties that set the same attributes. Typically you set up a Configuration object by calling its setXXXX methods chained with a '.' in a Fluent coding style.

Import statement

from applitools.images import Configuration
	

Constructor

Configuration()
The constructor for the Configuration class. This object is setup and then passed to the Eyes.set_configuration method before the call to Eyes.open.

Properties

ignore_caretType:bool
Use this method to set whether or not Eyes eliminates mismatches due to blinking cursor artifacts.
accessibility_validationType:AccessibilitySettings
This property can be used to set and retrieve the accessibility testing level to use.
agent_idType:Text
This property can be used to set and retrieve the name and version of the SDK.
api_keyType:Text
This property can be used to set and retrieve your Eyes license key.
app_nameType:Text
This property can be used to set and retrieve the value of the application name property. The application name is one of the 5 properties that define the baseline.
baseline_branch_nameType:Text
This property can be used to set and retrieve the name of the branch the baseline reference will be taken from and where new and accepted steps will be saved to.
baseline_env_nameType:Text
This property can be used to set and retrieve the name of the environment that will be used to determine the baseline.
batchType:BatchInfo
This property can be used to set and retrieve the batch information for this test.
branch_nameType:Text
This property can be used to set and retrieve the branch used for the baseline of this run.
host_appType:Text
This property can be used to set and retrieve the name of the hosting application property.
host_osType:Text
This property can be used to set and retrieve the name of the hosting operating system property.
ignore_displacementsType:bool
This property can be used to set and retrieve whether Test Manager should initially display mismatches for image features that have only been displaced, as opposed to real mismatches.
is_disabledType:bool
This property can be used to set and retrieve whether or not interactions with Eyes will be silently ignored.
match_levelType:MatchLevel
This property can be used to set and retrieve the default match level to be used for subsequent checkpoints in the test.
parent_branch_nameType:Text
This property can be used to set and retrieve the parent branch from which newly created branches get their initial baseline.
save_diffsType:bool
This property can be used to set and retrieve if steps that have mismatches should be automatically saved to the baseline or not.
save_new_testsType:bool
This property can be used to set and retrieve whether or not 'new' tests are saved to the baseline by default.
server_urlType:Text
This property can be used to set and retrieve the URL of the Eyes server used to process the captured images.
test_nameType:Text
This property can be used to set and retrieve the name of the test.
viewport_sizeType:RectangleSize
This property can be used to set and retrieve the viewport size to be used by the browser for the test.

Methods

add_property()
Adds a custom key name/value property that will be associated with tests. You can view these properties and filter and group by these properties in the Test Manager.
clear_properties()
Clears any custom key name/value properties.
clone()
Returns a clone of the configuration object.
set_accessibility_validation()
Use this method to set the accessibility testing level to use.
set_agent_id()
Use this method to set the name and version of the SDK.
set_api_key()
Use this method to set your Eyes license key.
set_app_name()
Use this method to set the value of the application name property. The application name is one of the 5 properties that define the baseline.
set_baseline_branch_name()
Use this method to set the name of the branch the baseline reference will be taken from and where new and accepted steps will be saved to.
set_baseline_env_name()
Use this method to set the name of the environment that will be used to determine the baseline.
set_batch()
Use this method to set the batch information for this test.
set_branch_name()
Use this method to set the branch used for the baseline of this run.
set_host_app()
Use this method to set the name of the hosting application property.
set_host_os()
Use this method to set the name of the hosting operating system property.
set_ignore_caret()
Use this method to set whether or not Eyes eliminates mismatches due to blinking cursor artifacts.
set_ignore_displacements()
Use this method to set whether Test Manager should initially display mismatches for image features that have only been displaced, as opposed to real mismatches.
set_match_level()
Use this method to set the default match level to be used for subsequent checkpoints in the test.
set_parent_branch_name()
Use this method to set the parent branch from which newly created branches get their initial baseline.
set_save_diffs()
Use this method to set if steps that have mismatches should be automatically saved to the baseline or not.
set_save_new_tests()
Use this method to set whether or not 'new' tests are saved to the baseline by default.
set_server_url()
Use this method to set the URL of the Eyes server used to process the captured images.
set_test_name()
Use this method to set the name of the test.
set_viewport_size()
Set the viewport size to be used by the browser for the test.