properties property

Class: BatchInfoPlatform: ImagesLanguage: Python SDK:

Set one or more user-defined properties to be associated with the batch.

A batch property is a user-defined name/value pair that you can associate with a batch. Use the Test Manger to view the properties and their values for a particular batch and you can filter for batches with specific property values. See Hide displacement diffs tool for more information.

Syntax

batch_info.properties  = value # type is List[Dict[Text,Text]]
value = batch_info.properties

Type:List[Dict[Text,Text]]

Remarks

Set batch properties using the BatchInfo.add_property method or Configuration.properties property:
  • Call this method after creating the BatchInfo object and before using the Eyes.batch or Configuration.set_batch method to associate the batch with the test (before the test is started).
  • Set multiple properties by calling BatchInfo.add_property multiple times with the same property name and different values. Alternatively, set them together using the properties property.
  • You should not assign a given value to a property more than once in a given batch run.
  • You can also associate properties with a specific test using Configuration.add_property.