PackageParameters¶

class PackageParameters¶

AppendReferencedFile(filename)¶

Appends a package parameters definition file at the end of the list of referenced package parameters definition files.

Parameters:

filename : str¶

Path to the package parameters definition file. Absolute or relative to the current workspace directory.

ClearReferencedFiles()¶

Removes all referenced package parameters definition files from the list.

Clone()¶

Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.

Returns:

A copy of this object

Return type:

PackageParameters

GetPackageParametersDefinition()¶

Returns the container for defining package parameters statically.

Returns:

Container for package parameters

Return type:

PackageParametersDefinition

GetReferencedFiles()¶

Returns a list of all referenced package parameters definition files. The list is ordered by priority, i.e. package parameters from files in the beginning of the list overwrite parameters from later files.

Returns:

List of all referenced package parameters definition files (*.ppd)

Return type:

list[str]

GetStaticParametersPriority()¶

Returns the priority of statically defined parameters with regard to the parameters from referenced files.

Returns:

Priority value

Return type:

int

RemoveReferencedFile(filename)¶

Removes a package parameters definition file from the list of referenced package parameters definition files.

Parameters:

filename : str¶

Path to the package parameters definition file to be removed. Absolute or relative to the current workspace directory.

Raises:

ApiError – When the given file is not referenced in this parameter set

SetStaticParametersPriority(priority)¶

Specifies the priority of the statically defined parameters with regard to the parameters from referenced files.

Note:

If the given value is out of the valid range, it will be coerced to the closest reasonable value.

Parameters:

priority : int¶

Priority of the statically defined parameters. Should be between

• 0: highest priority and

• length of referenced files list: lowest priority