Skip to content

Rclpy named capsules fixups #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sloretz merged 2 commits into from
Oct 25, 2017
Merged

Rclpy named capsules fixups #133

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25d2b03
homogenize docblock for ValueError + few typos
mikaelarguedas Oct 25, 2017
d12a127
homogenize error strings and quote strings
mikaelarguedas Oct 25, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 30 additions & 30 deletions rclpy/src/rclpy/_rclpy.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,10 @@ rclpy_create_guard_condition(PyObject * Py_UNUSED(self), PyObject * Py_UNUSED(ar

/// Trigger a general purpose guard condition
/**
* Raises ValueError if the guard condition is not a capsule of the correcttype
* Raises ValueError if pygc is not a guard condition capsule
* Raises RuntimeError if the guard condition could not be triggered
*
* \param[in] guard_condition Capsule pointing to guard condtition
* \param[in] pygc Capsule pointing to guard condtition
*/
static PyObject *
rclpy_trigger_guard_condition(PyObject * Py_UNUSED(self), PyObject * args)
Expand Down Expand Up @@ -248,7 +248,7 @@ rclpy_get_node_name(PyObject * Py_UNUSED(self), PyObject * args)

/// Get the namespace of a node.
/**
* Raises ValueError if not passed a node capsule
* Raises ValueError if pynode is not a node capsule
*
* \param[in] pynode Capsule pointing to the node to get the namespace from
* \return namespace, or
Expand Down Expand Up @@ -713,7 +713,7 @@ rclpy_create_publisher(PyObject * Py_UNUSED(self), PyObject * args)

/// Publish a message
/**
* Raises ValueError if the capsule is not a publisher pointer
* Raises ValueError if pypublisher is not a publisher capsule
* Raises RuntimeError if the message cannot be published
*
* \param[in] pypublisher Capsule pointing to the publisher
Expand Down Expand Up @@ -824,7 +824,7 @@ rclpy_create_timer(PyObject * Py_UNUSED(self), PyObject * args)

/// Returns the period of the timer in nanoseconds
/**
* Raises ValueError if capsule is not a timer capsule
* Raises ValueError if pytimer is not a timer capsule
* Raises RuntimeError if the timer period cannot be retrieved
*
* \param[in] pytimer Capsule pointing to the timer
Expand Down Expand Up @@ -856,8 +856,8 @@ rclpy_get_timer_period(PyObject * Py_UNUSED(self), PyObject * args)

/// Cancel the timer
/**
* Raises ValueError if capsule is not a timer
* Raises RuntimeError if the timmer cannot be cancelled
* Raises ValueError if pytimer is not a timer capsule
* Raises RuntimeError if the timmer cannot be canceled
*
* \param[in] pytimer Capsule pointing to the timer
* \return NULL on failure:
Expand Down Expand Up @@ -888,7 +888,7 @@ rclpy_cancel_timer(PyObject * Py_UNUSED(self), PyObject * args)

/// Checks if timer is cancelled
/**
* Raises ValueError if capsule is not a timer
* Raises ValueError if pytimer is not a timer capsule
* Raises Runtime error if there is an rcl error
*
* \param[in] pytimer Capsule pointing to the timer
Expand Down Expand Up @@ -955,7 +955,7 @@ rclpy_reset_timer(PyObject * Py_UNUSED(self), PyObject * args)

/// Checks if timer reached its timeout
/**
* Raises ValueError if capsule is not a timer
* Raises ValueError if pytimer is not a timer capsule
* Raises RuntimeError if there is an rcl error
*
* \param[in] pytimer Capsule pointing to the timer
Expand Down Expand Up @@ -990,7 +990,7 @@ rclpy_is_timer_ready(PyObject * Py_UNUSED(self), PyObject * args)

/// Set the last call time and start counting again
/**
* Raises ValueError if capsule is not a timer
* Raises ValueError if pytimer is not a timer capsule
* Raises RuntimeError if there is an rcl error
*
* \param[in] pytimer Capsule pointing to the timer
Expand Down Expand Up @@ -1024,7 +1024,7 @@ rclpy_call_timer(PyObject * Py_UNUSED(self), PyObject * args)
/**
* The change in period will take effect after the next timer call
*
* Raises ValueError if the capsule is not a timer
* Raises ValueError if pytimer is not a timer capsule
* Raises RuntimeError if the timer perioud could not be changed
*
* \param[in] pytimer Capsule pointing to the timer
Expand Down Expand Up @@ -1060,7 +1060,7 @@ rclpy_change_timer_period(PyObject * Py_UNUSED(self), PyObject * args)
/**
* the returned time can be negative, this means that the timer is ready and hasn't been called yet
*
* Raises ValueError if the capsule is not a timer
* Raises ValueError if pytimer is not a timer capsule
* Raises RuntimeError there is an rcl error
*
* \param[in] pytimer Capsule pointing to the timer
Expand Down Expand Up @@ -1129,7 +1129,7 @@ rclpy_time_since_last_call(PyObject * Py_UNUSED(self), PyObject * args)
* - a Capsule pointing to the pointer of the created rcl_subscription_t * structure
* - an integer representing the memory address of the created rcl_subscription_t
*
* Raises ValueError if the capsule is not a node
* Raises ValueError if the capsules are not the correct types
* Raises RuntimeError if the subscription could not be created
*
* \param[in] pynode Capsule pointing to the node to add the subscriber to
Expand Down Expand Up @@ -1195,7 +1195,7 @@ rclpy_create_subscription(PyObject * Py_UNUSED(self), PyObject * args)
topic, rcl_get_error_string_safe());
} else {
PyErr_Format(PyExc_RuntimeError,
"Failed to create subscriptions: %s", rcl_get_error_string_safe());
"Failed to create subscription: %s", rcl_get_error_string_safe());
}
Py_DECREF(pysubscription);
rcl_reset_error();
Expand All @@ -1219,7 +1219,7 @@ rclpy_create_subscription(PyObject * Py_UNUSED(self), PyObject * args)
* - a Capsule pointing to the pointer of the created rcl_client_t * structure
* - an integer representing the memory address of the created rcl_client_t
*
* Raises ValueError if the capsule is not a node
* Raises ValueError if the capsules are not the correct types
* Raises RuntimeError if the client could not be created
*
* \param[in] pynode Capsule pointing to the node to add the client to
Expand Down Expand Up @@ -1300,7 +1300,7 @@ rclpy_create_client(PyObject * Py_UNUSED(self), PyObject * args)

/// Publish a request message
/**
* Raises ValueError if the capsule is not a client
* Raises ValueError if pyclient is not a client capsule
* Raises RuntimeError if the request could not be sent
*
* \param[in] pyclient Capsule pointing to the client
Expand Down Expand Up @@ -1376,7 +1376,7 @@ rclpy_send_request(PyObject * Py_UNUSED(self), PyObject * args)
* - a Capsule pointing to the pointer of the created rcl_service_t * structure
* - an integer representing the memory address of the created rcl_service_t
*
* Raises ValueError if the capsule is not a node
* Raises ValueError if the capsules are not the correct types
* Raises RuntimeError if the service could not be created
*
* \param[in] pynode Capsule pointing to the node to add the service to
Expand Down Expand Up @@ -1454,7 +1454,7 @@ rclpy_create_service(PyObject * Py_UNUSED(self), PyObject * args)

/// Publish a response message
/**
* Raises ValueError if the capsule is not a service
* Raises ValueError if pyservice is not a service capsule
* Raises RuntimeError if the response could not be sent
*
* \param[in] pyservice Capsule pointing to the service
Expand Down Expand Up @@ -1575,7 +1575,7 @@ rclpy_destroy_node_entity(PyObject * Py_UNUSED(self), PyObject * args)
PyMem_Free(service);
} else {
ret = RCL_RET_ERROR; // to avoid a linter warning
PyErr_Format(PyExc_RuntimeError, "%s is not a known node entity", PyCapsule_GetName(pyentity));
PyErr_Format(PyExc_RuntimeError, "'%s' is not a known node entity", PyCapsule_GetName(pyentity));
return NULL;
}
if (ret != RCL_RET_OK) {
Expand Down Expand Up @@ -1629,7 +1629,7 @@ rclpy_destroy_entity(PyObject * Py_UNUSED(self), PyObject * args)
PyMem_Free(guard_condition);
} else {
ret = RCL_RET_ERROR; // to avoid a linter warning
PyErr_Format(PyExc_RuntimeError, "unknown entity type (%s)", PyCapsule_GetName(pyentity));
PyErr_Format(PyExc_RuntimeError, "'%s' is not a known entity", PyCapsule_GetName(pyentity));
return NULL;
}
if (ret != RCL_RET_OK) {
Expand Down Expand Up @@ -1722,7 +1722,7 @@ rclpy_wait_set_init(PyObject * Py_UNUSED(self), PyObject * args)

/// Clear all the pointers of a given wait_set field
/**
* Raises RuntimeError if the entity type is unknown or any rcl error occurrs
* Raises RuntimeError if the entity type is unknown or any rcl error occurs
*
* \param[in] entity_type string defining the entity ["subscription, client, service"]
* \param[in] pywait_set Capsule pointing to the waitset structure
Expand Down Expand Up @@ -1756,7 +1756,7 @@ rclpy_wait_set_clear_entities(PyObject * Py_UNUSED(self), PyObject * args)
} else {
ret = RCL_RET_ERROR; // to avoid a linter warning
PyErr_Format(PyExc_RuntimeError,
"%s is not a known entity", entity_type);
"'%s' is not a known entity", entity_type);
return NULL;
}
if (ret != RCL_RET_OK) {
Expand Down Expand Up @@ -1815,7 +1815,7 @@ rclpy_wait_set_add_entity(PyObject * Py_UNUSED(self), PyObject * args)
} else {
ret = RCL_RET_ERROR; // to avoid a linter warning
PyErr_Format(PyExc_RuntimeError,
"%s is not a known entity", entity_type);
"'%s' is not a known entity", entity_type);
return NULL;
}
if (ret != RCL_RET_OK) {
Expand Down Expand Up @@ -1880,7 +1880,7 @@ rclpy_destroy_wait_set(PyObject * Py_UNUSED(self), PyObject * args)
return entity_ready_list;
/// Get list of non-null entities in waitset
/**
* Raises ValueError if the capsule is invalid or of the wrong type
* Raises ValueError if pywait_set is not a wait_set capsule
* Raises RuntimeError if the entity type is not known
*
* \param[in] entity_type string defining the entity ["subscription, client, service"]
Expand Down Expand Up @@ -1914,7 +1914,7 @@ rclpy_get_ready_entities(PyObject * Py_UNUSED(self), PyObject * args)
GET_LIST_READY_ENTITIES(guard_condition)
} else {
PyErr_Format(PyExc_RuntimeError,
"%s is not a known entity", entity_type);
"'%s' is not a known entity", entity_type);
return NULL;
}

Expand All @@ -1923,7 +1923,7 @@ rclpy_get_ready_entities(PyObject * Py_UNUSED(self), PyObject * args)

/// Wait until timeout is reached or event happened
/**
* Raises ValueError if the wait set is not a capsule or is of the wrong type
* Raises ValueError if pywait_set is not a wait_set capsule
* Raises RuntimeError if there was an error while waiting
*
* This function will wait for an event to happen or for the timeout to expire.
Expand Down Expand Up @@ -2048,7 +2048,7 @@ rclpy_take(PyObject * Py_UNUSED(self), PyObject * args)

/// Take a request from a given service
/**
* Raises ValueError if the service is not a capsule or is of the wrong type
* Raises ValueError if pyservice is not a service capsule
*
* \param[in] pyservice Capsule pointing to the service to process the request
* \param[in] pyrequest_type Instance of the message type to take
Expand Down Expand Up @@ -2138,7 +2138,7 @@ rclpy_take_request(PyObject * Py_UNUSED(self), PyObject * args)

/// Take a response from a given client
/**
* Raises ValueError if the client is not a capsule or is of the wrong type
* Raises ValueError if pyclient is not a client capsule
*
* \param[in] pyclient Capsule pointing to the client to process the response
* \param[in] pyresponse_type Instance of the message type to take
Expand Down Expand Up @@ -2247,7 +2247,7 @@ rclpy_shutdown(PyObject * Py_UNUSED(self), PyObject * Py_UNUSED(args))

/// Get the list of nodes discovered by the provided node
/**
* Raises ValueError if the capsule is not a node or is the wrong type
* Raises ValueError if pynode is not a node capsule
* Raises RuntimeError if there is an rcl error
*
* \param[in] pynode Capsule pointing to the node
Expand Down Expand Up @@ -2536,7 +2536,7 @@ rclpy_get_rmw_qos_profile(PyObject * Py_UNUSED(self), PyObject * args)
pyqos_profile = rclpy_convert_to_py_qos_policy((void *)&rmw_qos_profile_parameter_events);
} else {
PyErr_Format(PyExc_RuntimeError,
"Requested unknown rmw_qos_profile: %s", pyrmw_profile);
"Requested unknown rmw_qos_profile: '%s'", pyrmw_profile);
return NULL;
}
return pyqos_profile;
Expand Down