Use get_package_share_path just as python by Timple · Pull Request #112 · ament/ament_index

Timple · 2026-02-19T21:07:34Z

cpp and python were going out of sync.

Besides

  auto dbc = ament_index_cpp::get_package_share_path("can_dbc_pkg") / "test" / "motohawk.dbc";

Looks much better than

  std::filesystem::path package_path;
  ament_index_cpp::get_package_share_directory("can_dbc_pkg", package_path);
  auto dbc = package_path / "test" / "motohawk.dbc";

Due to the short-livedness of the get_package_share_directory(..., std::filesystem::path) syntax, I didn't deprecated it.

I can finish this PR including the tests etc if that's appreciated. For now I wanted feedback first. 🙂

Signed-off-by: Tim Clephas <tim.clephas@nobleo.nl>

jmachowinski · 2026-02-20T13:54:36Z

I like the change. It's way cleaner than the previous version.

ahcorde · 2026-02-20T14:09:47Z

ament_index_cpp/include/ament_index_cpp/get_package_share_directory.hpp

- */
-AMENT_INDEX_CPP_PUBLIC
-void
-get_package_share_directory(const std::string & package_name, std::filesystem::path & path);


we need to update downstream packages

How? Or to what?
Or do we (shortly) keep this function around for depreciation?

I think the API in question was added after kilted and therefore we can directly remove/replace it before the next release.
Removing this API will break all the tests etc that were already moved to the new API and need to be fixed.
E.g. if you check out the full rolling stack and remove the old API fix all compile failures resulting from this and do PRs for it.

And then merge simultaneously?

Then we would need someone with merge access to all these repos I guess?

Edit: or we can let everyone merge at their own pace I guess

I have permission to merge PRs across all the ROS 2 core.

We should deprecate the method instead of removing it

I deprecated the previous implementation. So this can be merged and the other repositories will get a deprecation warning.

Signed-off-by: Tim Clephas <tim.clephas@nobleo.nl>

ahcorde · 2026-02-24T09:56:03Z

Related PRs

ahcorde · 2026-02-24T10:01:03Z

Pulls: #112, ros2/rmw_zenoh#913, ros2/rviz#1671, ros/resource_retriever#119, ros/ros_tutorials#193, ros-perception/image_common#391
Gist: https://gist.githubusercontent.com/ahcorde/4443a34cc7425a61b630b0ea7761d778/raw/ee918bf6abee19d2c84b4f3502bc35f27436183a/ros2.repos
BUILD args: --packages-above-and-dependencies ament_index_cpp
TEST args: --packages-above ament_index_cpp
ROS Distro: rolling
Job: ci_launcher
ci_launcher ran: https://ci.ros2.org/job/ci_launcher/18300

Linux
Linux-aarch64
Linux-rhel
Windows

ahcorde

Windows is not compiling

  utest.cpp

utest.obj : error LNK2019: unresolved external symbol "__declspec(dllimport) class std::filesystem::path __cdecl ament_index_cpp::get_package_share_path(class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > const &)" (__imp_?get_package_share_path@ament_index_cpp@@YA?AVpath@filesystem@std@@AEBV?$basic_string@DU?$char_traits@D@std@@V?$allocator@D@2@@4@@Z) referenced in function "private: virtual void __cdecl AmentIndexCpp_get_package_share_path_Test::TestBody(void)" (?TestBody@AmentIndexCpp_get_package_share_path_Test@@EEAAXXZ) [C:\ci\ws\build\ament_index_cpp\ament_index_cpp_utest.vcxproj]

C:\ci\ws\build\ament_index_cpp\Release\ament_index_cpp_utest.exe : fatal error LNK1120: 1 unresolved externals [C:\ci\ws\build\ament_index_cpp\ament_index_cpp_utest.vcxproj]

ament_index_cpp/src/get_package_share_path.cpp

Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com> Signed-off-by: Tim Clephas <tim.clephas@nobleo.nl>

Signed-off-by: Tim Clephas <tim.clephas@nobleo.nl>

Timple · 2026-02-24T12:54:23Z

Windows is not compiling

  utest.cpp

utest.obj : error LNK2019: unresolved external symbol "__declspec(dllimport) class std::filesystem::path __cdecl ament_index_cpp::get_package_share_path(class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > const &)" (__imp_?get_package_share_path@ament_index_cpp@@YA?AVpath@filesystem@std@@AEBV?$basic_string@DU?$char_traits@D@std@@V?$allocator@D@2@@4@@Z) referenced in function "private: virtual void __cdecl AmentIndexCpp_get_package_share_path_Test::TestBody(void)" (?TestBody@AmentIndexCpp_get_package_share_path_Test@@EEAAXXZ) [C:\ci\ws\build\ament_index_cpp\ament_index_cpp_utest.vcxproj]

C:\ci\ws\build\ament_index_cpp\Release\ament_index_cpp_utest.exe : fatal error LNK1120: 1 unresolved externals [C:\ci\ws\build\ament_index_cpp\ament_index_cpp_utest.vcxproj]

Found a wrong include, I hope windows works now?

ahcorde · 2026-02-24T12:57:28Z

Pulls: #112, ros2/rmw_zenoh#913, ros2/rviz#1671, ros/resource_retriever#119, ros/ros_tutorials#193, ros-perception/image_common#391
Gist: https://gist.githubusercontent.com/ahcorde/fbb27b2127b62cdf0c2dea03ea0b3fec/raw/ee918bf6abee19d2c84b4f3502bc35f27436183a/ros2.repos
BUILD args: --packages-above-and-dependencies ament_index_cpp
TEST args: --packages-above ament_index_cpp
ROS Distro: rolling
Job: ci_launcher
ci_launcher ran: https://ci.ros2.org/job/ci_launcher/18301

Linux
Linux-aarch64
Linux-rhel
Windows

nbbrooks · 2026-03-15T15:37:52Z

Is there a source of truth somewhere for deprecations and deletions and their associated PRs? A docs.ros.org page? A ROS discourse post? When moveit2 rolling starts failing CI jobs around deprecations, it takes me a frustrating amount of time for me to find the particular GH organization and repo associated with that breakage to understand and fix it, whether that is something in rclcpp, ament, tf, etc.

I imagine if this existed/was more widely known, more package maintainers would mention the deprecation/deletion PR in their issue, which would make it easier for other package maintainers to do their migration.

…and ament_index_cpp::get_package_share_directory(*, *) to ament_index_cpp::get_package_share_path(package_name) addressing ament/ament_index#112 Revert QT support changes which will be addressed in a separate PR Temporarily add '-Wno-error=deprecated-declarations' to suppress other upstream deprecatios from short circuiting CI

Timple · 2026-03-15T18:29:24Z

Can this be backported to active distro's? Minus the deprecation message of course.

To prevent these kind of constructions for packages that use a single branch for all active distros: https://github.com/moveit/moveit2/pull/3705/changes#diff-c5eab2d24cfc0cc52d9d0fadc0596533f00ca45e3f8ea45a31bcd8c72b34fafaR40

Timple mentioned this pull request Feb 19, 2026

Extend API to use std::filesystem #104

Merged

Timple force-pushed the get_package_share_path branch from 9df7db4 to 9781967 Compare February 20, 2026 08:22

Timple added 3 commits February 20, 2026 09:23

Use get_package_share_path just as python

b41171e

Signed-off-by: Tim Clephas <tim.clephas@nobleo.nl>

fixup! Use get_package_share_path just as python

1d36ecd

Signed-off-by: Tim Clephas <tim.clephas@nobleo.nl>

fixup! Use get_package_share_path just as python

a3b1568

Signed-off-by: Tim Clephas <tim.clephas@nobleo.nl>

Timple force-pushed the get_package_share_path branch from 9781967 to a3b1568 Compare February 20, 2026 08:23

jmachowinski approved these changes Feb 20, 2026

View reviewed changes

ahcorde requested changes Feb 20, 2026

View reviewed changes

Put back, but deprecate, the intermediate solution

df3df5f

Signed-off-by: Tim Clephas <tim.clephas@nobleo.nl>

ahcorde requested changes Feb 24, 2026

View reviewed changes

ament_index_cpp/src/get_package_share_path.cpp Outdated Show resolved Hide resolved

Timple and others added 2 commits February 24, 2026 13:51

Fix copyright

efba7e0

Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com> Signed-off-by: Tim Clephas <tim.clephas@nobleo.nl>

Fix include

c9186fd

Signed-off-by: Tim Clephas <tim.clephas@nobleo.nl>

ahcorde merged commit acfcac6 into ament:rolling Feb 25, 2026
3 checks passed

christophfroehlich mentioned this pull request Mar 14, 2026

Fix deprecations in ament_index_cpp ros-controls/mujoco_ros2_control#145

Draft

nbbrooks mentioned this pull request Mar 15, 2026

Update deprecated usage of get_package_share without std::filesystem::path moveit/moveit2#3703

Merged

6 tasks

nbbrooks mentioned this pull request Mar 16, 2026

DUPLICATE Update deprecated usage of get_package_share moveit/moveit2#3705

Draft

6 tasks

Conversation

Timple commented Feb 19, 2026

Uh oh!

jmachowinski commented Feb 20, 2026

Uh oh!

ahcorde Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Timple Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

jmachowinski Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Timple Feb 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ahcorde Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

Timple Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

ahcorde commented Feb 24, 2026

Uh oh!

ahcorde commented Feb 24, 2026

Uh oh!

ahcorde left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Timple commented Feb 24, 2026

Uh oh!

ahcorde commented Feb 24, 2026

Uh oh!

Uh oh!

nbbrooks commented Mar 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Timple commented Mar 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Timple Feb 20, 2026 •

edited

Loading

nbbrooks commented Mar 15, 2026 •

edited

Loading