pyats.aereport.tsinitinfo.params package¶
params
– Params¶
This module implements Params element.
- class pyats.aereport.tsinitinfo.params.Params¶
Bases:
AEReportElement
Internally calculated “final” values of various parameters based on CLI, control and CONFIG files (_easySetKey / _easyGetKey)
Class based on this schema definition
<xs:element name="params"> <xs:annotation> <xs:documentation>internally calculated "final" values of various parameters based on CLI, control and CONFIG files (_easySetKey / _easyGetKey)</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="cli" type="xs:string"></xs:element> <xs:element name="mailto"></xs:element> <xs:element name="report"></xs:element> <xs:element name="rerun" type="xs:boolean"></xs:element> <xs:element name="cleantype" type="xs:string"></xs:element> <xs:element name="uniquetid" type="xs:boolean"></xs:element> <xs:element name="max"></xs:element> <xs:element name="reason" /> <xs:choice minOccurs="0"> <xs:annotation> <xs:documentation>List of tasks or suite lines requested for run </xs:documentation> </xs:annotation> <xs:element name="tidRange"/> <xs:element name="runLines"/> </xs:choice> <xs:element name="pause" type="xs:string" minOccurs="0"></xs:element> <xs:element name="controlfile" type="xs:string" minOccurs="0"></xs:element> <xs:element name="rerunfile" minOccurs="0"></xs:element> </xs:sequence> </xs:complexType> </xs:element>
- tag¶
Constant value = ‘report’ to be used as xml tag.
- Type
str
- cli¶
CLI paramerters passed to easypy
- Type
str
- mailto¶
List of users and mailing lists for e-mail notification
- Type
str
- rerun¶
Enable/disable rerun mode
- Type
bool
- cleantype¶
Default value should be easyclean
- Type
str
- uniquetid¶
Enable/disable use of md5id for tid uniqueness
- Type
bool
- max = MaxLimit
Upper limit on the number of errors or forked jobs
- reason¶
- Type
str
- runchoice¶
List of tasks or suite lines requested for run. Value should be tidRange or runLines
- Type
str
- runchoicevalue¶
The value to be used for runchoice
- Type
str
- pause¶
The trigger value for pause: pass/fail - Optional
- Type
str
- controlfile¶
Path and file name of queue file or control file - Optional
- Type
str
- rerunfile¶
Name of rerun file if it exists - Optional
- Type
str
- generate_dom(parent)¶
Override the default behavior of AEReportElement.generate_dom
- Parameters
parent (AEReportElement) – The xml element that should be used as a parent for this userdef
- set_args(**kwargs)¶
Set params and children attributes (Report, SEM, MaxLimit)
- Parameters
cli (str) – CLI paramerters passed to easypy
mailto (str) – List of users and mailing lists for e-mail notification
report (dict) – Report for testsuite
rerun (bool) – Enable/disable rerun mode
cleantype (str) – Default value should be easyclean
uniquetid (str) – Enable/disable use of md5id for tid uniqueness
max (dict) – Max errors and max jobs
reason (str) – List of tasks or suite lines requested for run
runchoice (str) – Choice between tidRange/runLines
runchoicevalue (str) – Value of the above
pause (str) – The trigger value for pause: pass/fail
controlfile (str) – Path and file name of queue file or control file
rerunfile (str) – Name of rerun file if it exists
type (str) – one of autotest, ats_easy, easypy, detail, or summary. In future we may add “html” type.
sort (bool) – Enable/disable reporting of results in sorted order
outofrange (bool) – Enable/disable reporting of out of range tasks
uniquesuites (bool) – Enable/disable reporting of test suites as consolidated or as unique when same suite is run multiple times with different parameters
sem (dict) –
alignment (bool) – Enable/disable reporting of SEM alignment errors
traceback (bool) – Enable/disable reporting of SEM traceback errors
errors (str) – max errors (default is 10)
jobs (str) – max jobs to fork per easypy harness (default is -1 no limit)
Subpackages¶
Submodules¶
maxlimit
– MaxLimit Class¶
This module contains the MaxLimit class.
- class pyats.aereport.tsinitinfo.params.maxlimit.MaxLimit(**kwargs)¶
Bases:
AEReportElement
Class based on the following schema definition
<xs:element name="max"> <xs:complexType> <xs:sequence> <xs:element name="errors" type="xs:integer"></xs:element> <xs:element name="jobs" type="xs:integer"></xs:element> </xs:sequence> </xs:complexType> </xs:element>
- tag¶
Constant value = ‘max’ to be used as xml tag.
- Type
str
- errors¶
max errors (default is 10)
- Type
int
- jobs¶
max jobs to fork per easypy harness (default is -1 no limit)
- Type
int
- set_args(**kwargs)¶
Set maxLimit attributes
- Parameters
errors (int) – max errors (default is 10)
jobs (int) – max jobs to fork per easypy harness (default is -1 no limit)