Skip to content
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.

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

Permit building python bindings separately from libsdformat library (backport #1491) #1497

Merged
merged 4 commits into from
Nov 7, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Nov 6, 2024

🎉 New feature

Part of osrf/homebrew-simulation#2834, related to gazebosim/gz-math#636

Summary

This allows the python/CMakeLists.txt file to be built as a top-level cmake project against an external libsdformat library. The first commit (1985c90) is a patch from @traversaro used in conda, and the second commit (4644d3b) replaces the GZ_LIB_INSTALL_DIR cmake variable with CMAKE_INSTALL_LIBDIR (see GzPackaging.cmake:111) since GZ_LIB_INSTALL_DIR is not defined with the minimal cmake project added in 1985c90.

Test it

  1. Follow the instructions from Permit building python bindings separately from gz-math library gz-math#636 to build gz-math python bindings
  2. Invoke cmake on the root CMakeLists.txt with using -DSKIP_PYBIND11=ON to build and install the libsdformat library without python bindings.
  3. Invoke cmake on python/CMakeLists.txt with -DPython_EXECUTABLE=/path/to/python to build and install python bindings for a given python version
  4. Repeat 2 with for each desired version of python

I have a draft of an updated homebrew formula using this branch in osrf/homebrew-simulation#2836

Checklist

  • Signed all commits for DCO
  • Added tests
  • Added example and/or tutorial
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.


This is an automatic backport of pull request #1491 done by [Mergify](https://mergify.com).

…1491)

This allows the src/python_pybind11/CMakeLists.txt file to be
built as a top-level cmake project against an external sdformat
library, with documentation added to the README.

The logic for finding pybind11 is also moved from the root
CMakeLists.txt to python/CMakeLists.txt to reduce code
duplication. When invoked through the root CMakeLists.txt,
pybind11 is treated as an optional dependency, but when
invoked from the python folder, pybind11 is treated as
required by setting the variable
CMAKE_REQUIRE_FIND_PACKAGE_pybind11 to TRUE.

Signed-off-by: Steve Peters <[email protected]>
Signed-off-by: Silvio Traversaro <[email protected]>
Co-authored-by: Silvio Traversaro <[email protected]>
(cherry picked from commit 3dcdd55)

# Conflicts:
#	python/CMakeLists.txt
@mergify mergify bot requested review from azeey and scpeters as code owners November 6, 2024 02:51
@mergify mergify bot added the conflicts label Nov 6, 2024
Copy link
Contributor Author

mergify bot commented Nov 6, 2024

Cherry-pick of 3dcdd55 has failed:

On branch mergify/bp/sdf14/pr-1491
Your branch is up to date with 'origin/sdf14'.

You are currently cherry-picking commit 3dcdd55e.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   CMakeLists.txt
	modified:   README.md

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   python/CMakeLists.txt

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

Signed-off-by: Steve Peters <[email protected]>
python/CMakeLists.txt Outdated Show resolved Hide resolved
set(PYTHON_LIBRARIES "${PYTHON_DEBUG_LIBRARIES}")
# Detect if we are doing a standalone build of the bindings, using an external sdformat
if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
cmake_minimum_required(VERSION 3.22.1)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you document this CMake version requirement?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ea6256a

thanks for catching these!

@scpeters scpeters merged commit 91d9029 into sdf14 Nov 7, 2024
12 checks passed
@scpeters scpeters deleted the mergify/bp/sdf14/pr-1491 branch November 7, 2024 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants