如何正确引入自建共享库：解决PyCharm识别与C扩展配置问题

问题背景 #

我有一个自建的Python C扩展共享库，程序能正常运行，但PyCharm提示无法找到该模块。以下是最简示例代码：

C扩展代码（test.c） #

#include <Python.h>
#include <stdio.h>

static PyObject * print(PyObject *self, PyObject *noargs) {
   // printf() displays the string inside quotation
   printf("Hello, World!");

   return Py_None;
}

static PyMethodDef myLibMethods[] = {
    {"print",  print, METH_NOARGS,
     "Execute a shell command."},
    {NULL, NULL, 0, NULL}        /* Sentinel */
};

static struct PyModuleDef myLibmodule = {
    PyModuleDef_HEAD_INIT,
    "cmcts",   /* name of module */
    NULL, /* module documentation, may be NULL */
    -1,       /* size of per-interpreter state of the module, or -1 if the module keeps state in global variables. */
    myLibMethods
};

PyMODINIT_FUNC PyInit_myLib(void) {
    return PyModule_Create(&myLibmodule);
}

setup.py代码 #

from distutils.core import setup, Extension

module1 = Extension('myLib', sources=['test.c'])

setup(name='PackageName',
      version='1.0',
      description='This is a demo package',
      ext_modules=[module1])

已执行python setup.py build并成功，但PyCharm无法识别模块，临时将.so文件复制到项目目录可消除提示，但并非正确做法，现需解决两个问题：

1. 如何让PyCharm识别我的模块？
2. 如何正确配置我的C扩展项目？

问题1：让PyCharm识别C扩展模块 #

• 全局安装扩展：执行python setup.py install，将模块安装到Python的site-packages目录，PyCharm会自动扫描该目录，消除找不到模块的提示。
• 手动添加build路径到解释器：
  1. 打开PyCharm的File → Settings → Project: [你的项目名] → Python Interpreter
  2. 点击右上角齿轮图标，选择Show All
  3. 选中当前解释器，点击Show paths for the selected interpreter
  4. 点击+，添加setup.py build生成的目录（通常为build/lib.[平台]-[Python版本]）
  5. 重启PyCharm后模块即可被识别
• 开发模式安装：执行pip install -e .（需依赖setuptools），在site-packages创建项目链接，既不用复制文件，PyCharm也能识别，且修改代码后重新执行python setup.py build即可更新模块，适合开发阶段。

问题2：正确配置C扩展项目 #

1. 统一模块命名 #

当前C代码中PyModuleDef的模块名是"cmcts"，但setup.py的Extension名称是"myLib"，PyInit_后缀是myLib，命名不一致会导致导入混乱。需统一名称，比如全部改为myLib：
修改C代码中的PyModuleDef：

static struct PyModuleDef myLibmodule = {
    PyModuleDef_HEAD_INIT,
    "myLib",   /* 改为和Extension一致的名称 */
    NULL,
    -1,
    myLibMethods
};

2. 替换弃用的构建工具 #

distutils已被弃用，推荐使用setuptools，修改setup.py：

from setuptools import setup, Extension

module1 = Extension('myLib', sources=['test.c'])

setup(name='PackageName',
      version='1.0',
      description='This is a demo package',
      ext_modules=[module1])

3. 规范项目结构 #

采用标准包结构便于管理：

my_lib_project/
├── setup.py
├── src/
│   └── test.c
└── tests/
    └── test_my_lib.py

同步修改setup.py中的源码路径：

module1 = Extension('myLib', sources=['src/test.c'])

4. 标准化构建流程 #

• 开发阶段：用pip install -e .实现开发模式安装，修改C代码后重新执行python setup.py build即可更新模块，无需重新安装
• 发布阶段：执行python setup.py sdist bdist_wheel生成分发包，通过pip install安装到目标环境

5. 忽略平台差异 #

不同系统生成的扩展文件后缀不同（Linux: .so，Windows: .pyd，macOS: .so/.dylib），无需手动复制，通过安装或添加路径的方式让Python和PyCharm自动识别即可。

内容的提问来源于stack exchange，提问作者Nima Mousavi