ROS报错：“ImportError: dynamic module does not define module export function (PyInit__tf2)”的原因及解决办法

问题描述

作者目前正在使用Python3.8编写一个ROS代码，代码需要使用到tf包。当我们import tf并运行代码时，控制台给出了如下报错：

>>> import tf
Traceback (most recent call last):
  File "", line 1, in <module>
  File "/opt/ros/kinetic/lib/python2.7/dist-packages/tf/__init__.py", line 28, in <module>
    from tf2_ros import TransformException as Exception, ConnectivityException, LookupException, ExtrapolationException
  File "/opt/ros/kinetic/lib/python2.7/dist-packages/tf2_ros/__init__.py", line 38, in <module>
    from tf2_py import *
  File "/opt/ros/kinetic/lib/python2.7/dist-packages/tf2_py/__init__.py", line 38, in <module>
    from ._tf2 import *
ImportError: dynamic module does not define module export function (PyInit__tf2)

问题原因

从上文的报错信息不难看出，报错信息皆指向了python2.7文件夹，这是因为tf2是面向python2.7进行编写的，而作者使用的解释器版本为python3.8，因此由于版本不对应所以产生了上述问题

解决问题

软件与硬件

以下为作者解决问题所基于的各种软件与硬件信息：
操作系统：Ubuntu16.04
ROS版本：Kinetic
Python版本：3.8
环境管理：Anaconda
CPU：i7-12700f
GPU：RTX 4060Ti

解决思路

ROS自带的tf2使用python2.7对源码进行编译，而我们需要的是使用python3进行编译的tf2，因此可以从github上下载tf2对应的源码，并通过指定编译器的方式来make出一个适用于python3的tf包。

解决方法

1. Anaconda创建虚拟环境

conda create --name py36 python=3.6
# 这里的python版本原则上不影响后续操作

2. 为Anaconda环境安装指定的包，这些包在catkin_make时将会被使用

pip install numpy
pip install empy
pip install pyyaml

3. 新建一个工作空间（推荐位置在主目录下，名字随便起）

mkdir -p tf/src
cd tf/src

4. 在src文件夹内克隆编译tf2所需的源码（geometry，geometry2）

git clone https://github.com/ros/geometry
git clone https://github.com/ros/geometry2

如果克隆报错的话，直接去网站下载压缩包并解压到src目录下亦可

5. 返回tf目录下，并进行自定义catkin_make

catkin_make --cmake-args \
            -DCMAKE_BUILD_TYPE=Release \
            -DPYTHON_EXECUTABLE=/usr/bin/python3 \
            -DPYTHON_INCLUDE_DIR=/usr/include/python3.5m \
            -DPYTHON_LIBRARY=/usr/lib/x86_64-linux-gnu/libpython3.5m.so

需要注意的是，上面三个链接一定要仔细核对，大家可以根据链接的指引去文件夹内查看，网上有些教程使用的是python3.6m，而作者电脑中只有python3.5m，因此链接内容的填写一定要根据电脑的实际情况。
在确保链接无误后，上面的指令可以全部复制并执行。
若编译未产生报错，则说明python3可用的tf2包创建成功

可行性验证

当我们需要在python3环境中使用tf2包时，在程序运行前还需要在终端source一下新建立tf包的位置

source /home/xxx/tf/devel/setup.bash

具体链接根据自己安装的位置而定，如果想一劳永逸，也可以将指令添加到.bashrc文件下。

此后，我们可以在控制台临时启动一个python3并import tf，看是否有报错：

>>> import tf
>>>