Skip to content

Parameter

Bases: Component

Defining Class Parameters

Parameter NAME as Type [ Keywords ] = value;

keywords = field(default_factory=dict, kw_only=True)

Parameter Keywords

Optional dict used to specify keywords for this component.

Use {"Keyword": None} for keywords that do not have a value

Valid Parameter keywords
  • Abstract – Specifies whether this is an abstract parameter.
  • Constraint – Specifies a user interface constraint in IDEs for this parameter.
  • Deprecated – Specifies that this parameter is deprecated. This keyword is ignored by the class compiler and merely provides a human-readable indicator that the parameter is deprecated.
  • Final – Specifies whether this parameter is final (cannot be overridden in subclasses)
  • Flags – Modifies the user interface type (in IDEs) for this parameter.
  • Internal – Specifies whether this parameter definition is internal (not displayed in the class documentation).

type = None

Optional type of the Parameter

Allowed Types for Parameters

value = None

Optional default value or expression of the Parameter