module documentation

Undocumented

Function is_legal_resource_base_name Validates that name is a legal resource base name. A base name has no package context, e.g. "String".
Function is_legal_resource_name Check if name is a legal ROS name for filesystem resources (alphabetical character followed by alphanumeric, underscore, or forward slashes). This constraint is currently not being enforced, but may start getting enforced in later versions of ROS.
Function normalize_package_context Undocumented
Function package_resource_name Split a name into its package and resource name parts, e.g. 'std_msgs/String -> std_msgs, String'
Function resource_name Convert package name + resource into a fully qualified resource name
Function resource_name_base pkg/typeName -> typeName, typeName -> typeName
Function resource_name_package pkg/typeName -> pkg, typeName -> None
Constant BASE_RESOURCE_NAME_LEGAL_CHARS_P Undocumented
Constant PRN_SEPARATOR Undocumented
Constant RESOURCE_NAME_LEGAL_CHARS_P Undocumented
def is_legal_resource_base_name(name):

Validates that name is a legal resource base name. A base name has no package context, e.g. "String".

def is_legal_resource_name(name):

Check if name is a legal ROS name for filesystem resources (alphabetical character followed by alphanumeric, underscore, or forward slashes). This constraint is currently not being enforced, but may start getting enforced in later versions of ROS.

@param name: Name @type name: str

def normalize_package_context(package_context):

Undocumented

def package_resource_name(name):

Split a name into its package and resource name parts, e.g. 'std_msgs/String -> std_msgs, String'

@param name: package resource name, e.g. 'std_msgs/String' @type name: str @return: package name, resource name @rtype: str @raise ValueError: if name is invalid

def resource_name(res_pkg_name, name, my_pkg=None):

Convert package name + resource into a fully qualified resource name

@param res_pkg_name: name of package resource is located in @type res_pkg_name: str @param name: resource base name @type name: str @param my_pkg: name of package resource is being referred to

in. If specified, name will be returned in local form if res_pkg_name is my_pkg

@type my_pkg: str @return: name for resource @rtype: str

def resource_name_base(name):

pkg/typeName -> typeName, typeName -> typeName

Convert fully qualified resource name into the package-less resource name @param name: package resource name, e.g. 'std_msgs/String' @type name: str @return: resource name sans package-name scope @rtype: str

def resource_name_package(name):

pkg/typeName -> pkg, typeName -> None

@param name: package resource name, e.g. 'std_msgs/String' @type name: str @return: package name of resource @rtype: str

BASE_RESOURCE_NAME_LEGAL_CHARS_P =

Undocumented

Value
re.compile(r'^[A-Za-z][\w_]*$')
PRN_SEPARATOR: str =

Undocumented

Value
'/'
RESOURCE_NAME_LEGAL_CHARS_P =

Undocumented

Value
re.compile(r'^[A-Za-z][\w_/]*$')