ament_index_python.resources module
- exception ament_index_python.resources.InvalidResourceNameError
Bases:
ValueErrorRaised when a resource name is invalid.
- exception ament_index_python.resources.InvalidResourceTypeNameError
Bases:
ValueErrorRaised when a resource type name is invalid.
- ament_index_python.resources.get_resource(resource_type, resource_name)
Get the content of a specific resource and its prefix path.
- Parameters:
resource_type (str) – the type of the resource
resource_names – the name of the resource
- Returns:
a tuple of the content (bytes) of the resource and its prefix path
- Raises:
EnvironmentError- Raises:
OSError- Raises:
LookupError- Raises:
- Raises:
- ament_index_python.resources.get_resource_types()
Get the resource types.
- Returns:
set of resource types within the search paths
- Raises:
EnvironmentError
- ament_index_python.resources.get_resources(resource_type)
Get the resource names of all resources of the specified type.
- Parameters:
resource_type (str) – the type of the resource
- Returns:
dict of resource names to the prefix path they are in
- Raises:
EnvironmentError- Raises:
- ament_index_python.resources.has_resource(resource_type, resource_name)
Check if a specific resource exists.
- Parameters:
resource_type (str) – the type of the resource
resource_names – the name of the resource
- Returns:
The prefix path if the resource exists, False otherwise
- Raises:
EnvironmentError- Raises:
- Raises: