Skip to content

Variable

Variable

Bases: OpenTerm

Base class for variables.

Parameters:

  • name (str | None, default: None ) –

    Name or None (fresh name).

  • term_class (type[Term] | None, default: None ) –

    Term class.

name property

The name of variable.

coerce(variable_class=None)

Coerces variable into variable_class.

If variable cannot be coerced, raises an error.

Parameters:

  • variable_class (TVariableClass | None, default: None ) –

    Variable class.

Returns:

  • Self –

    Variable.

get_name()

Gets the name of variable.

Returns:

  • str –

    Name.

Variables(name, *names)

Constructs one or more variables.

Parameters:

  • name (str | None) –

    Name or None (fresh name).

  • names (str | TVariableClass | None, default: () ) –

    Names or None values (fresh names) or variable classes.

Returns:

  • Iterator[Variable] –

    The resulting variables.