The information in this topic may be out of date. The current SDK reference guide has moved here.
BatchInfo class
Platform: ImagesLanguage: Python SDK:
Call the
Configuration.set_batch method with an object of this class to configure the batch for one or more tests.
See How to group tests into batches using the SDK
for details and an example.
Import statement
from applitools.images import BatchInfo
Constructor
- BatchInfo()
- The constructor for the BatchInfo class.
Properties
- idType:Text
- Use this property to set and retrieve the unique id of the batch.
- nameType:Text
- Use this property to set and retrieve the name of the batch.
- notify_on_completionType:bool
- Enable informing the Eyes server that the batch has completed.
- propertiesType:List[Dict[Text,Text]]
- Set one or more user-defined properties to be associated with the batch.
- sequence_nameType:Text
- Use this property to set and retrieve the batch sequence name for a batch.
- started_atType:datetime
- Use this property to set and retrieve the date and time that will be displayed in the Test Manager as the start time of the batch.
Methods
- add_property()
- Associate a user-defined property with the batch.
- with_batch_id()
- Use this method to set the unique id of the batch using a Fluent interface.