rosbag2_py

Regenerating Python stub files (.pyi)

Python stub files allow to supply type-hinting information for binary Python modules (e.g. pybind-based).

In rosbag2_py stub files are generated with utility called stubgen.

To regenerate stub files

cd <workspace>
colcon build --packages-up-to rosbag2_py
source install/setup.sh
# Make sure rosbag2_py can be imported
python3 -c 'import rosbag2_py'

# Ubuntu 24.04
sudo apt update && sudo apt install mypy

# Older Ubuntu
# pip3 install -U mypy==1.9

cd <rosbag2 git repo>
stubgen -p rosbag2_py -o rosbag2_py

Changelog for package rosbag2_py

0.26.5 (2024-09-06)

• Added method to introspect QoS in Python (#1648) (#1790) (cherry picked from commit f0f3cc5f57ba9142b763247a68acc571d2500bb5) Co-authored-by: Alejandro Hernández Cordero <<ahcorde@gmail.com>>
• Add cli option compression-threads-priority (#1768) (#1778) Co-authored-by: Michael Orlov <<michael.orlov@apex.ai>> (cherry picked from commit 25c3e1c2effdaea3b880c39ff7580b2f38a44b1c) Co-authored-by: Roman <<rsokolkov@gmail.com>>
• [jazzy] Update CI scripts to use Ubuntu Noble distros and bump action scripts to latest versions (backport #1709) (#1779) Co-authored-by: Roman <<rsokolkov@gmail.com>> (cherry picked from commit 27a6b600c2a813ec1f2154145fe77392c88b314b) Co-authored-by: Michael Orlov <<michael.orlov@apex.ai>>
• Bugfix for wrong timestamps in ros2 bag info (#1745) (#1752) (cherry picked from commit da28c9da82824b8ce5f6fc18935d1a954e52b636) Co-authored-by: Michael Orlov <<michael.orlov@apex.ai>>
• Contributors: mergify[bot]

0.26.4 (2024-06-27)

• Add bindings for LocalMessageDefinitionSource (#1697) (#1701) Co-authored-by: Michael Orlov <<michael.orlov@apex.ai>> Co-authored-by: methylDragon <<methylDragon@gmail.com>>
• Add --log-level to ros2 bag play and record (#1625) (#1674) Co-authored-by: Roman Sokolkov <<rsokolkov@gmail.com>>
• Contributors: mergify[bot]

0.26.3 (2024-05-15)

• Included to_rclcpp_qos_vector to Python wrappers (#1642) (#1650) Co-authored-by: Alejandro Hernández Cordero <<ahcorde@gmail.com>>
• Contributors: mergify[bot]

0.26.2 (2024-04-24)

0.26.1 (2024-04-17)

0.26.0 (2024-04-16)

• Add option to disable recorder keyboard controls (#1607)
• Support service 2/2 --- rosbag2 service play (#1481)
• Use middleware send and receive timestamps from message_info during recording (#1531)
• Switch rclpy to be an exec_depend here. (#1606)
• Gracefully handle SIGINT and SIGTERM signals for play and burst CLI (#1557)
• Added exclude-topic-types to record (#1582)
• Contributors: Alejandro Hernández Cordero, Barry Xu, Bernd Pfrommer, Chris Lalancette, Michael Orlov, jmachowinski

0.25.0 (2024-03-27)

• Fix for false negative tests in rosbag2_py (#1592)
• Update rosbag2_py stubs (#1593)
• Add Python stubs for rosbag2_py (#1459) (#1569)
• Filter topic by type (#1577)
• Add topic_id returned by storage to the TopicMetadata (#1538)
• Install signal handlers in recorder only inside record method (#1464)
• add missing import otherwise it doesnt compile (#1524)
• Implement service recording and display info about recorded services (#1480)
• Make [rosbag2_transport::Player::play()]{.title-ref} run in a separate thread (#1503)
• Switch to target_link_libraries everywhere. (#1504)
• Use enum values for offered_qos_profiles in code and string names in serialized metadata (#1476)
• ros2 bag convert now excludes messages not in [start_time;end_time] (#1455)
• Add support for compression to python API (#1425)
• Contributors: Alejandro Hernández Cordero, Andrew Symington, Barry Xu, Chris Lalancette, Michael Orlov, Mikael Arguedas, Patrick Roncagliolo, Peter Favrholdt, Roman Sokolkov

0.24.0 (2023-07-11)

• Gracefully handle SIGINT and SIGTERM in rosbag2 recorder (#1301)
• Implement storing and loading ROS_DISTRO from metadata.yaml and mcap files (#1241)
• Add binding to close the writer (#1339)
• Contributors: Emerson Knapp, Michael Orlov, Yadu

0.23.0 (2023-04-28)

0.22.0 (2023-04-18)

• Add type_hash in MessageDefinition struct (#1296)
• Store message definitions in SQLite3 storage plugin (#1293)
• Add message definition read API (#1292)
• rosbag2_storage: add type description hash to topic metadata (#1272)
• Contributors: Michael Orlov, james-rms

0.21.0 (2023-04-12)

• rosbag2_cpp: move local message definition source out of MCAP plugin (#1265)
• Update rosbag2 to C++17. (#1238)
• Use target_link_libraries instead of ament_target_dependencies (#1202)
• Contributors: Chris Lalancette, Daisuke Nishimatsu, Michael Orlov, james-rms

0.20.0 (2023-02-14)

0.19.0 (2023-01-13)

• Expose more Writer methods in python interface (#1220)
• rosbag2_storage: set MCAP as default plugin (#1160)
• Add Michael Orlov as maintainer in rosbag2 packages (#1215)
• rosbag2_py: parametrize tests across storage plugins (#1203)
• Added option to change node name for the recorder from the Python API (#1180)
• Replace language for "db3"/"db"/"database" (#1194)
• Remove explicit sqlite3 from code (#1166)
• Move python get_default_storage_id to storage module instead of writer (#1165)
• Contributors: Emerson Knapp, Michael Orlov, james-rms, ricardo-manriquez

0.18.0 (2022-11-15)

• rosbag2_storage: expose default storage ID as method (#1146)
• rosbag2_py: set defaults for config when bag rewriting (#1121)
• Reverse read order API and sqlite storage implementation (#1083)
• expose py Reader metadata, improve [rosbag2_py.BagMetadata]{.title-ref} usability (#1082)
• Added support for excluding topics via regular expressions (#1046)
• Contributors: Emerson Knapp, Esteve Fernandez, james-rms

0.17.0 (2022-07-30)

• Use a single variable for evaluating the filter regex (#1053)
• Add additional mode of publishing sim time updates triggered by replayed messages (#1050)
• Renamed --topics-regex to --regex and -e in Player class to be consistent with Recorder (#1045)
• Add the ability to record any key/value pair in 'custom' field in metadata.yaml (#1038)
• Added support for filtering topics via regular expressions on Playback (#1034)
• Adds play until timestamp functionality (#1005)
• Add CLI verb for burst mode of playback (#980)
• Add play-for specified number of seconds functionality (#960)
• Contributors: Agustin Alba Chicar, Esteve Fernandez, Geoffrey Biggs, Hunter L. Allen, kylemarcey, Michael Orlov, Tony Peng

0.16.0 (2022-05-11)

• Make unpublished topics unrecorded by default (#968)
• Fix test rosbag2_py test compatibility with Python < 3.8 (#987)
• Contributors: Michael Orlov, Scott K Logan, Sean Kelly

0.15.1 (2022-04-06)

• support to publish as loaned message (#981)
• Revert "Add the ability to record any key/value pair in the 'custom' field in metadata.yaml (#976)" (#984)
• Add the ability to record any key/value pair in the 'custom' field in metadata.yaml (#976)
• Contributors: Audrow Nash, Barry Xu, Jorge Perez, Tony Peng

0.15.0 (2022-04-05)

• support to publish as loaned message (#981)
• Revert "Add the ability to record any key/value pair in the 'custom' field in metadata.yaml (#976)" (#984)
• Add the ability to record any key/value pair in the 'custom' field in metadata.yaml (#976)
• Contributors: Barry Xu, Jorge Perez, Tony Peng

0.14.1 (2022-03-29)

• Bump version number to avoid conflict
• Contributors: Chris Lalancette

0.14.0 (2022-03-29)

• Make sure published messages are acknowledged for play mode (#951)
• Contributors: Barry Xu

0.13.0 (2022-01-13)

• Fix relative path syntax for cpplint (#947)
• Update to pybind11 2.7.1 (#945)
• Contributors: Chris Lalancette, Jacob Perron

0.12.0 (2021-12-17)

• Add start-offset play option (#931)
• Expose bag_rewrite as [ros2 bag convert]{.title-ref} (#921)
• Add "ignore leaf topics" option to recorder (#925)
• Add a ReaderWriterFactory utility to share logic for reuse (#923)
• Add pause/resume options to the bag recorder (#905)
• Contributors: Abrar Rahman Protyasha, Emerson Knapp, Ivan Santiago Paunovic

0.11.0 (2021-11-08)

• Add --start-paused option to [ros2 bag play]{.title-ref} (#904)
• Update package maintainers (#899)
• Fix converter plugin choices for record (#897)
• Contributors: Emerson Knapp, Ivan Santiago Paunovic, Michel Hidalgo

0.10.1 (2021-10-22)

0.10.0 (2021-10-19)

• Metadata per file info (#870)
• keyboard controls for pause/resume toggle and play-next: (#847)
• Add --snapshot-mode argument to the "record" verb (#851)
• Add stopRecording into rosbag2_py (#854)
• added seek interface (#836)
• Refactor plugin query mechanism and standardize trait management (#833)
• Update [PlayOptions::delay]{.title-ref} to [rclcpp::Duration]{.title-ref} to get nanosecond resolution (#843)
• Load compression and serialization choices via plugin query (#827)
• Add delay option (#789)
• Handle SIGTERM gracefully in recording (#792)
• Contributors: Afonso da Fonseca Braga, Cameron Miller, Emerson Knapp, Kosuke Takeuchi, Wojciech Jaworski, sonia

0.9.0 (2021-05-17)

• remove rosbag2_transport header (#742)
• Include utility to quiet cpplint. (#744)
• player owns the reader (#725)
• Contributors: Chris Lalancette, Karsten Knese

0.8.0 (2021-04-19)

• Remove -Werror from builds, enable it in Action CI (#722)
• Split Rosbag2Transport into Player and Recorder classes - first pass to enable further progress (#721)
• /clock publisher in Player (#695)
• Introducing Reindexer CLI (#699)
• Fix rosbag2_py transport test for py capsule (#707)
• rosbag2_py pybind wrapper for "record" - remove rosbag2_transport_py (#702)
• Add rosbag2_py::Player::play to replace rosbag2_transport_python version (#693)
• Explicitly add emersonknapp as maintainer (#692)
• Contributors: Emerson Knapp, jhdcs

0.7.0 (2021-03-18)

• RMW-implementation-searcher converter in rosbag2_cpp (#670)
• use rosbag2_py for ros2 bag info (#673)
• CLI query rosbag2_py for available storage implementations (#659)
• Contributors: Emerson Knapp, Karsten Knese

0.6.0 (2021-02-01)

• Fix build issues when rosbag2_storage is binary installed (#585)
• Fix the tests on cyclonedds by translating qos duration values (#606)
• Contributors: Emerson Knapp, P. J. Reed

0.5.0 (2020-12-02)

0.4.0 (2020-11-19)

• add storage_config_uri (#493)
• Workaround pybind11 bug on Windows when CMAKE_BUILD_TYPE=RelWithDebInfo (#538)
• Update the package.xml files with the latest Open Robotics maintainers (#535)
• Fix rosbag2_py on Windows debug and stop ignoring the package (#531)
• Fix rosbag2_py bug when using libc++ (#529)
• AMENT_IGNORE rosbag2_py for now (#509)
• rosbag2_py reader and writer (#308)
• Contributors: Ivan Santiago Paunovic, Karsten Knese, Mabel Zhang, Michael Jeronimo

0.3.2 (2020-06-03)

0.3.1 (2020-06-01)

0.3.0 (2020-05-26)

0.2.8 (2020-05-18)

0.2.7 (2020-05-12)

0.2.6 (2020-05-07)

0.2.5 (2020-04-30)

0.2.4 (2019-11-18 17:51)

0.2.3 (2019-11-18 13:55)

0.2.2 (2019-11-13)

0.2.1 (2019-10-23)

0.2.0 (2019-09-26)

0.1.2 (2019-05-20)

0.1.1 (2019-05-09)

0.1.0 (2019-05-08)

0.0.5 (2018-12-27)

0.0.4 (2018-12-19)

0.0.3 (2018-12-14)

0.0.2 (2018-12-12)

0.0.1 (2018-12-11)