py_binding_tools package from py_binding_tools repo


Package Summary

Tags No category tags.
Version 1.0.0
License BSD
Build type CATKIN

Repository Summary

Checkout URI
VCS Type git
VCS Version main
Last Updated 2024-03-05
CI status No Continuous Integration
Tags No category tags.
Contributing Help Wanted (0)
Good First Issues (0)
Pull Requests to Review (0)

Package Description

Python binding tools for C++

Additional Links


  • Robert Haschke


  • Robert Haschke

Python binding tools for C++

This package provides some tools to facilitate the generation of python bindings for C++ code, based on pybind11.

Automatic type conversion for ROS message types

Conversion between native C++ and python types is performed via ROS message serialization and deserialization, which is implemented via C++ templates. It suffices to include:

#include <py_binding_tools/ros_msg_typecasters.h>

The PoseStamped message from the geometry_msgs package also accepts a single string as an argument. In this case, the string is interpreted as the header.frame_id field of the message and the pose becomes the identity transform. To use this extension, include the following header instead:

#include <py_binding_tools/geometry_msg_typecasters.h>

C++ ROS initialization

C++ and Python use their own ROS implementations (rospy and roscpp). Thus, it is necessary to initialize ROS in the C++ domain additionally to the Python domain before calling any ROS-related functions from wrapped C++ functions or classes. To this end, the package provides the python function roscpp_init() and the C++ class ROScppInitializer. The latter is intended to be used as a base class for your python wrapper classes:

class FooWrapper : protected ROScppInitializer, public Foo {
    // ...

to ensure that the ROS infrastructure is initialized before usage in the wrapped C++ class. Ensure to list ROScppInitializer as the first base class, if ROS functionality is required in the constructor already!

ROScppInitializer registers an anonymous C++ ROS node named python_wrapper_xxx. If you need a specific node name or if you want to pass remappings, use the manual initialization function roscpp_init(name="", remappings={}, options=0) instead, which effectively calls ros::init with the given arguments. Note, that an empty name will map to the above-mentioned node name python_wrapper_xxx.


Changelog for package py_binding_tools

1.0.0 (2024-03-05)

Wiki Tutorials

See ROS Wiki Tutorials for more details.

Source Tutorials

Not currently indexed.

Package Dependencies

System Dependencies

No direct system dependencies.

Dependant Packages

No known dependants.

Launch files

No launch files found


No message files found.


No service files found


No plugins found.

Recent questions tagged py_binding_tools at Robotics Stack Exchange