Unable to use cv_bridge with ROS Kinetic and Python3

Question

I had a computer vision project on Ubuntu 14.04 with ROS indigo and python3, then I had to move on Ubuntu 16.04 with ROS kinetic. Here I ran into multiple issues:

1) I installed opencv, but couldn't import it in python3, the error message was:

Traceback (most recent call last):
  File "test.py", line 2, in <module>
    import cv2
ImportError: /opt/ros/kinetic/lib/python2.7/dist-packages/cv2.so: 
undefined symbol: PyCObject_Type

What I figured out is just rename cv2.so

cd /opt/ros/kinetic/lib/python2.7/dist-packages/
sudo mv cv2.so cv2_ros.so

Then I was able to import cv2 and use it

2) Then I couldn't import rospy, but installation of python3-catkin-pkg-modules and python3-rospkg-modules fixed that problem

3) Finally I ran into an issue with cv_bridge it says:

[ERROR] [1520780674.845066]: bad callback: <bound method ViewsBuffer.update of <__main__.ViewsBuffer object at 0x7f5f45a07f28>>
Traceback (most recent call last):
  File "/opt/ros/kinetic/lib/python2.7/dist-packages/rospy/topics.py", line 750, in _invoke_callback
    cb(msg)
  File "test.py", line 48, in update
    im = self.bridge.imgmsg_to_cv2(im, "bgr8")
  File "/opt/ros/kinetic/lib/python2.7/dist-packages/cv_bridge/core.py", line 163, in imgmsg_to_cv2
    dtype, n_channels = self.encoding_to_dtype_with_channels(img_msg.encoding)
  File "/opt/ros/kinetic/lib/python2.7/dist-packages/cv_bridge/core.py", line 99, in encoding_to_dtype_with_channels
    return self.cvtype2_to_dtype_with_channels(self.encoding_to_cvtype2(encoding))
  File "/opt/ros/kinetic/lib/python2.7/dist-packages/cv_bridge/core.py", line 91, in encoding_to_cvtype2
    from cv_bridge.boost.cv_bridge_boost import getCvType
ImportError: dynamic module does not define module export function (PyInit_cv_bridge_boost)

I believe the problem is in the cv_bridge_boost.so file. I also tried to build cv_bridge from https://github.com/ros-perception/vision_opencv, but it automatically builds for python2.7, I was trying to modify CMakeLists.txt a little bit to specify python3 there, but I don't have much experience with CMakeLists, so it didn't work. I also tried to copy cv_bridge module to my project folder, but it didn't change much and it still points on that cv_bridge_boost.so file. Another thing to mention is that cv_bridge works fine with python2.7, but my project requires python3.5.

Volcano

Answer 1

You are right, you should build cv_bridge with python3.

You can do it with passing

-DPYTHON_EXECUTABLE=/usr/bin/python3 -DPYTHON_INCLUDE_DIR=/usr/include/python3.5m -DPYTHON_LIBRARY=/usr/lib/x86_64-linux-gnu/libpython3.5m.so

args to cmake. Or, if you are using catkin to build packages, you can do next steps:

# `python-catkin-tools` is needed for catkin tool
# `python3-dev` and `python3-catkin-pkg-modules` is needed to build cv_bridge
# `python3-numpy` and `python3-yaml` is cv_bridge dependencies
# `ros-kinetic-cv-bridge` is needed to install a lot of cv_bridge deps. Probaply you already have it installed.
sudo apt-get install python-catkin-tools python3-dev python3-catkin-pkg-modules python3-numpy python3-yaml ros-kinetic-cv-bridge
# Create catkin workspace
mkdir catkin_workspace
cd catkin_workspace
catkin init
# Instruct catkin to set cmake variables
catkin config -DPYTHON_EXECUTABLE=/usr/bin/python3 -DPYTHON_INCLUDE_DIR=/usr/include/python3.5m -DPYTHON_LIBRARY=/usr/lib/x86_64-linux-gnu/libpython3.5m.so
# Instruct catkin to install built packages into install place. It is $CATKIN_WORKSPACE/install folder
catkin config --install
# Clone cv_bridge src
git clone https://github.com/ros-perception/vision_opencv.git src/vision_opencv
# Find version of cv_bridge in your repository
apt-cache show ros-kinetic-cv-bridge | grep Version
    Version: 1.12.8-0xenial-20180416-143935-0800
# Checkout right version in git repo. In our case it is 1.12.8
cd src/vision_opencv/
git checkout 1.12.8
cd ../../
# Build
catkin build cv_bridge
# Extend environment with new package
source install/setup.bash --extend

And

$ python3

Python 3.5.2 (default, Nov 23 2017, 16:37:01) 
[GCC 5.4.0 20160609] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from cv_bridge.boost.cv_bridge_boost import getCvType
>>> 

If you encountered an next error

CMake Error at /usr/share/cmake-3.5/Modules/FindBoost.cmake:1677 (message):
  Unable to find the requested Boost libraries.

  Boost version: 1.58.0

  Boost include path: /usr/include

  Could not find the following Boost libraries:

          boost_python3

  No Boost libraries were found.  You may need to set BOOST_LIBRARYDIR to the
  directory containing Boost libraries or BOOST_ROOT to the location of
  Boost.
Call Stack (most recent call first):
  CMakeLists.txt:11 (find_package)

It is because CMake tries to find libboost_python3.so library, but in ubuntu it is libboost_python-py35.so(/usr/lib/x86_64-linux-gnu/libboost_python-py35.so), so you should change line

find_package(Boost REQUIRED python3)

to

find_package(Boost REQUIRED python-py35)

in file src/vision_opencv/cv_bridge/CMakeLists.txt and rebuild package.

Deafen

Worked like a charm! – Aftershock

Thank you so much, this worked with Python 3.6, under virtualenv – Sparing

Failing with Python 3.8. I get 1 packages succeeded and 3 packages skipped/blacklisted when I try. Looking at the log its targeting 3.6m somewhere, not sure where. I used your setup replacing all Python instance mentions with the paths to my Python3.8. – Position

Answer 2

I have anaconda3 installed in my system and I face a similar issue while using cv_bridge. When I try to build using catkin build cv_bridge it throws up an error. I use python3.7 from conda. My catkin cofig command is:

catkin config -DPYTHON_EXECUTABLE=/home/akashbaskaran/anaconda3/bin/python3 -DPYTHON_INCLUDE_DIR=/home/akashbaskaran/anaconda3/include/python3.7m -DPYTHON_LIBRARY=/home/akashbaskaran/anaconda3/lib/libpython3.7m.so

Solution: There are a couple of things which I did and the issue got resolved.

• since anaconda is being used, the executables and include directorires should be the one inside your current virtual enviroment. -DPYTHON_EXECUTABLE=/home/akashbaskaran/anaconda3/envs/tf/bin/python3.6 -DPYTHON_INCLUDE_DIR=/home/akashbaskaran/anaconda3/envs/tf/include/python3.6m -DPYTHON_LIBRARY=/home/akashbaskaran/anaconda3/envs/tf/lib/libpython3.6m.so e
• I was having build issues when I tried catkin build cv_bridge. If you face a similar issue, delete all folders except src. Then run catkin_make from the terminal (make sure you are present inside catkin_workspace).
• source the current workspace source devel/setup.bash

Now import cv2 from cv_bridge.boost.cv_bridge_boost import getCvType

should work without an error.

Lasandralasater

Answer 3

My basic environment:Ubuntu 18.04 and ROS melodic.

I am compiling cv_bridge in conda's virtual environment(python3.7), and I have the same problem as @Jibril. When I catkin build cv_bridge, I get 1 package successful and 3 packages skipped / blacklisted.

The command I use is

# 1
catkin init

# 2
catkin config \
-DPYTHON_EXECUTABLE=/home/zed/anaconda3/envs/yolov5/bin/python3.7 \
-DPYTHON_INCLUDE_DIR=/home/zed/anaconda3/envs/yolov5/include/python3.7m \
-DPYTHON_LIBRARY=/home/zed/anaconda3/envs/yolov5/lib/libpython3.7m.so

# 3
catkin config --install

# 4
catkin build cv_bridge

Then I found the error message about the --install-layout parameter by looking at the log file in the {ws}/log folder. Referring to the solution in the issue, I added -DSETUPTOOLS_DEB_LAYOUT=OFF to the original command and finally finished compiling.

The command I modified is

# 1
catkin init

# 2
catkin config \
-DPYTHON_EXECUTABLE=/home/zed/anaconda3/envs/yolov5/bin/python3.7 \
-DPYTHON_INCLUDE_DIR=/home/zed/anaconda3/envs/yolov5/include/python3.7m \
-DPYTHON_LIBRARY=/home/zed/anaconda3/envs/yolov5/lib/libpython3.7m.so \
-DSETUPTOOLS_DEB_LAYOUT=OFF

# 3
catkin config --install

# 4
catkin build cv_bridge

When you need to use the compiled cv_bridge in another ROS workspace, you only need to execute source {PATH_cv_bridge_ws}/install/setup.bash --extend, then source {PATH_current_ws}/devel/setup.bash.

If the above solution doesn't work for you, you can also try some of the alternatives to cv_bridge proposed in this issue!!

Iives