rclpy.validate_node_name module

rclpy.validate_node_name.validate_node_name(node_name: str) → Literal[True]

Validate a given node_name, and raise an exception if it is invalid.

If the node_name is invalid then rclpy.exceptions.InvalidNodeNameException will be raised.

Parameters:

node_name – node_name to be validated

Returns:

True when it is valid

Raises:

InvalidNodeNameException: when the node_name is invalid