checks.py

Set of utilities for detecting and reporting connection errors.

exception openmdao.core.checks.ConnectError[source]

Bases: exceptions.Exception

Custom error that is raised when a connection is invalid.

classmethod invalid_target_error(src, target)[source]

Formats an error message for invalid target in a connection.

Args:

src : str

Name of source

target : str

Name of target

Returns:

str : error message

classmethod nonexistent_src_error(src, target)[source]

Formats an error message for non-existant source in a connection.

Args:

src : str

Name of source

target : str

Name of target

Returns:

str : error message

classmethod nonexistent_target_error(src, target)[source]

Formats an error message for non-existant target in a connection.

Args:

src : str

Name of source

target : str

Name of target

Returns:

str : error message

openmdao.core.checks.check_connections(connections, params, unknowns)[source]

Checks the specified connections to make sure they are valid in OpenMDAO.

Args:

params : list of strings

Connection source names. Each param has a corresponding unknown.

unknowns : list of strings

Connection target names. Each unknown has a corresponding param.

Raises:

ConnectError

Any invalidity in the connection raises an error.