PyCharm 2025.3 Help

Cython 支持

先决条件

PyCharm 开箱即用地提供对 Cython 的基本支持。 PyCharm 可以识别 .pyx .pxd .pxi 文件,并允许您编辑它们。 您还可以在 Unix 和 macOS 上使用 Cython 包将这些文件编译为 .so 文件,或在 Windows 上编译为 .pyd 文件。

Cython 支持

Cython 文件使用 cython 图标标记。

Cython 支持包括:

  • 编码辅助功能:

  • 代码检查。 几乎所有 Python 代码检查都适用于 Cython。

  • 重构

  • 在源代码中进行智能搜索,尤其是 查找用法

  • 编译 Cython 模块:

    • 使用 外部工具 完成编译。 建议的构建系统( Makefile setup.py 等)应 配置为外部工具

    • 应在您的计算机上下载并安装 C 编译器

在 PyCharm 中开始使用 Cython

按照以下步骤在 PyCharm 中创建一个 .pyx 文件,对其进行编辑,并使用 setup.py 将其构建为 .so 文件(在 Windows 上为 .pyd )。

  1. 按照 创建 Python 项目 中的说明创建一个新项目。

  2. 确保已随 Python 解释器(设置 | Python | 解释器 )安装 Cython 包。 有关安装包的更多信息,请参阅 安装、卸载和升级软件包

  3. 现在创建一个 .pyx 文件。 从主菜单中选择 新建 | 文件 ,然后选择 文件。 键入文件名,例如 example.pyx ,并保存更改。 文件将在编辑器中打开。

  4. 您可以复制并粘贴以下代码:

    def function (a: int, b: int) -> str: return str(a + b) function(2, 4)
  5. 现在创建该 setup.py 文件。 从主菜单中选择 工具 | 创建 setup.py。 PyCharm 会创建一个模板 setup.py 文件并在编辑器中将其打开。 您可以复制并粘贴以下设置选项:

    from setuptools import setup, Extension module = Extension ('example', sources=['example.pyx']) setup( name='cythonTest', version='1.0', author='jetbrains', ext_modules=[module] )
  6. 要编译 example.pyx 文件,请从主菜单中选择 工具 | 运行 setup.py 任务 命令。 在 输入 setup.py 任务名称 中键入 build ,然后选择 build_ext 任务。 有关详细信息,请参阅 创建并运行 setup.py

    选择构建任务

    运行 setup.py 任务 build_ext 对话框中,添加 --inplace 命令行参数

    添加命令行参数

    构建任务成功完成后,将创建 .so 文件(在 Windows 上为 .pyd 文件)。

    使用构建任务进行编译

此时,您可以使用已编译的文件来导入 function

from example import function

有关完整说明,请参阅 Cython 文档

最后修改日期: 2025年 12月 2日