BatchInfo method
The constructor for the BatchInfo class.
Create the object, set it up and assign it to the batch before the test starts using the Configuration.set_batch method or Eyes.batch property. See How to group tests into batches using the SDK for more details and an example.
Syntax
batch_info = BatchInfo(name, started_at)
batch_info = BatchInfo(name)
batch_info = BatchInfo()
Parameters
- name
- Type:Text [Optional : default = None ]
The name of the batch. If a
is passed then the name will be taken from the environment variable APPLITOOLS_BATCH_NAME. If the environment variable is not defined then the name of the first test is used as the batch name.
- started_at
- Type:datetime [Optional : default = None ]
The date and time that will be displayed in the Test Manager as the batch start time. If the parameter is not passed, or a value of
is passed, then the run time will be the time at which the constructor was called.
Return value
- Type: None