The information in this topic may be out of date. The current SDK reference guide has moved here.

Configuration class

Platform: Selenium 3Language: 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. In this class, some attributes can be set by both a property and a set command. The properties allow you simple direct access to assign to and retrieve the attribute. The corresponding set method allows you to set multiple attributes using a Fluent style.

Import statement

from applitools.selenium import Configuration

Constructor

Configuration(): The constructor for the Configuration class. This object isset upand then passed to the Eyes.set_configuration method before the call to the Eyes.open method.

Properties

ignore_caretType:bool: Use this property to set and retrieve whether or not Eyes eliminates mismatches due to blinking cursor artifacts.

ignore_caretType:bool: Use this property to retrieve and set whether or not Eyes eliminates mismatches due to blinking cursor artifacts.

is_send_domType:bool: Returns whether the DOM is being sent to the server or not.

accessibility_validationType:AccessibilitySettings: Use this property to set and retrieve the accessibility testing level to use.

agent_idType:Text: Use this property to set and retrieve the name and version of the SDK.

api_keyType:Text: Use this property to set and retrieve your Eyes license key.

app_nameType:Text: Use this property 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: Use this property 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: Use this property to set and retrieve the name of the environment that will be used to determine the baseline.

batchType:BatchInfo: Use this property to set and retrieve the batch information for this test.

branch_nameType:Text: Use this property to set and retrieve the branch used for the baseline of this run.

featuresType:Set[Feature]: Use this method to enable various Eyes features.

force_full_page_screenshotType:bool: Use this property to set and retrieve whether or not Eyes does scrolling and stitching on pages whose size is greater than the viewport.

hide_caretType:bool: Use this property to set and retrieve whether Eyes should hide the cursor before the screenshot is captured.

hide_scrollbarsType:bool: Use this property to set and retrieve whether Eyes hides the scrollbars before capturing screenshots or not.

host_appType:Text: Use this property to set and retrieve the name of the hosting application property.

host_osType:Text: Use this property to set and retrieve the name of the hosting operating system property.

ignore_displacementsType:bool: Use this property 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: Use this property to set and retrieve whether or not interactions with Eyes will be silently ignored.

match_levelType:MatchLevel: Use this property to set and retrieve the default match level to be used for subsequent checkpoints in the test.

match_timeoutType:int: Use this property to set and retrieve the maximum time Eyes will try to perform a match on the fully captured image.

parent_branch_nameType:Text: Use this property to set and retrieve the parent branch from which newly created branches get their initial baseline.

propertiesType:List[Dict[Text,Text]]: Set a list of user-defined properties each of which is a key/value pair.

propertiesType:List[Dict[Text,Text]]: Set a list of user-defined properties each of which is a key/value pair.

save_diffsType:bool: Use this property to set and retrieve if steps that have mismatches should be automatically saved to the baseline or not.

save_new_testsType:bool: Use this property to set and retrieve whether or not 'new' tests are saved to the baseline by default.

send_domType:bool: Use this property to set and retrieve if DOM information should be sent for checkpoints.

server_urlType:Text: Use this property to set and retrieve the URL of the Eyes server used to process the captured images.

stitch_modeType:StitchMode: Use this property to set and retrieve the type of stitching used for full page screenshots.

stitch_overlapType:int: Use this property to set and retrieve the overlap between sub-images when a scrolled window is stitched.

test_nameType:Text: Use this property to set and retrieve the name of the test.

viewport_sizeType:RectangleSize: Use this property to set and retrieve the viewport size to be used by the browser for the test.

visual_grid_optionsType:Tuple[VisualGridOption]: Use this property to set and retrieve configuration values for the Ultrafast Grid.

wait_before_screenshotsType:int: Use this property to set and retrieve the amount of time in milliseconds that Eyes will wait before capturing a screenshot.

Methods

add_browser(): Request that the checkpoint be rendered by the Ultrafast Grid using a particular target desktop or mobile device browser.

add_browsers(): Request that the checkpoint be rendered by the Ultrafast Grid using the specified desktop browsers and viewport sizes.

add_device_emulation(): Request that the checkpoint be rendered by the Ultrafast Grid using Chrome mobile emulation.

add_property(): Adds a user-defined key name/value property that will be associated with tests.

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_features(): Use this method to enable various Eyes features.

set_force_full_page_screenshot(): Use this method to set whether or not Eyes does scrolling and stitching on pages whose size is greater than the viewport.

set_hide_caret(): Use this method to set whether Eyes should hide the cursor before the screenshot is captured.

set_hide_scrollbars(): Use this method to set whether Eyes hides the scrollbars before capturing screenshots or not.

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_match_timeout(): Use this method to set the maximum time Eyes will try to perform a match on the fully captured image.

set_parent_branch_name(): Use this method to set the parent branch from which newly created branches get their initial baseline.

set_proxy(): Use this method to configure Eyes so that it will interact with the Eyes server via a proxy.

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_send_dom(): Use this method to set if DOM information should be sent for checkpoints.

set_server_url(): Use this method to set the URL of the Eyes server used to process the captured images.

set_stitch_mode(): Use this method to set the type of stitching used for full page screenshots.

set_stitch_overlap(): Use this method to set the overlap between sub-images when a scrolled window is stitched.

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.

set_visual_grid_options(): Use this method to set configuration values for the Ultrafast Grid.

set_wait_before_screenshots(): Use this method to set the amount of time in milliseconds that Eyes will wait before capturing a screenshot.