Test pragmas#

Test information is stored as test pragmas in the Swan source. This section describes the test pragma classes.

class ansys.scadeone.core.swan.TestPragma(kind: TestPragmaKind | str)#

Bases: Pragma

Pragma used to mark an instance operator as being under test in a test harness.

static filter(pragmas: List[Pragma], key: str, with_key: bool = True) → List[Pragma]#

Filters a list of pragmas with/without a given key.

Parameters:

pragmasList[Pragma]: List of pragmas.
keystr: Key to filter.
with_keybool, optional: If True, return pragmas with the given key, otherwise without the key, by default True.

Returns:

List[Pragma]: List of pragmas with the given key.

get_full_path() → str#

Full path of the Swan construct.

This method is implemented by derived classes that correspond to a declaration at the module level (such as sensor, type, group, const, operator), or a module itself.

Returns:

str: Path within the owner and name of the Swan construct.

Raises:

ScadeOneException: If the method is not implemented for the current SwanItem type.

static set_owner(owner: SwanItem | IModel | None, children: SwanItem | Iterable[SwanItem] | None) → None#

Helper to set owner as the owner of each item in the Iterable items.

Parameters:

ownerSwanItem: Owner of the items.
childrenUnion[SwanItem, Iterable[SwanItem], None]: Items to set owner.

property data: str | None#: Return the pragma data.

property is_protected: bool#: Tell if a construct item is syntactically protected with some markup and is stored as a string (without the markup).

property key: PragmaKey | str#: Return the pragma key.

property kind: TestPragmaKind | str#

Return the pragma kind.

According to the kind call the appropriate method to get the value if any.

property model: IModel#: Return model containing the Swan item.

property module: ModuleBase | None#

Module containing the item.

Returns:: ModuleBase: module container, see ModuleBody and ModuleInterface or None if the object is itself a module.

property owner: SwanItem | IModel | None#: Owner of current Swan construct.