使用cython编译python项目（cython编译python教程）

off999 2024-09-23 11:34 72 浏览 0 评论

前言

python拥有语法简单、开发效率高等优点，但也存在运行速度慢、代码无法加密容易被反编译等问题。绝大多数情况下，python开发者并不希望用户拿到项目源代码，因此需要对python代码加入一些保密措施。本文主要介绍采用cython编译加密python源码，并实现cython批量编译加密整个python项目，后续会详细介绍cython加速的用法。

python源码加密方式

1.用pyc或pyo文件代替

#转化后的.pyc文件将在当前目录的__pycache__文件夹下.
python -m compileall <dir>
#或者使用下面的方式
import py_compile
py_compile.compile('/path/to/foo.py')
#生成pyo文件
python -O source.py

pyc和pyo格式文件在一定程度上避免了源码被直接查看的风险，但是存在很多在线网址或者工具能够反编译pyc和pyo文件得到源码，因此只能隐藏源码。

2.混淆源代码

一些在线网站和工具提供了python代码混淆功能，但这只能在一定程度上增加了破解者阅读代码的成本，不能起到保密的作用。·

3.使用Cython编译

cython是属于python的超集，用于编写python的c扩展语言。pyx文件由 Cython 编译为.c文件，包含 python 扩展模块的代码。.c文件由 C 编译器编译为.so文件（或 Windows 上的.pyd）。生成的.so文件或pyd文件是D语言(C/C++综合进化版本)生成的二进制文件，理论上很难反编译。

cython简单使用

1.安装cython

pip install cython

2.安装c编译器

编译过程中还需要c编译器，否则报错无法找到编译器。例如

unable to find vcvarsall.bat

windows下可安装mingw或者vs，网上说vs版本和python版本需保持一致，但实测安装vs2022即可。Linux下需安装gcc和devel。

yum install gcc
yum install python-devel

3.使用cython编译py文件

from distutils.core import setup
from Cython.Build import cythonize
 #source.py为需要加密的文件
setup(
    ext_modules = cythonize("source.py")
)
#在命令行执行
python setup.py build_ext --inplace

我们来看看cythonize的参数介绍

module_list 作为模块列表，传递全局模式，全局模式列表或扩展对象列表。后者允许您通过常规distutils选项分别配置扩展。您还可以传递具有glob模式作为其源的Extension对象。然后，cythonize将解析该模式并为每个匹配文件创建扩展的副本。
exclude 当将glob模式传递作为module_list时，可以通过将某些模块名称传递到exclude选项中来显式排除某些模块名称。
nthreads 并行编译的并发构建数（需要multiprocessing模块）。
aliases 你可以使用别名并传递字典，调用 cythonize 时将这些别名映射到 Python 字符串。
quiet 如果为True，则Cython在编译过程中不会打印错误，警告或状态消息。
force 强制重新编译Cython模块，即使时间戳不表明需要重新编译也是如此。
language 要全局启用C ++模式，可以通过language='c++'。否则，这将基于编译器指令在每个文件级别确定。这仅影响基于文件名找到的模块。传入的扩展实例cythonize()将不会更改。建议使用编译器指令而不是此选项。# distutils: language = c++
exclude_failures 对于广泛的“尝试编译”模式，该模式将忽略编译失败并仅排除失败的扩展，请通过exclude_failures=True。请注意，这仅对编译.py文件有意义，这些文件也可以不经编译而使用。
show_all_warnings 默认情况下，并非所有Cython警告都会被打印。设置为true以显示所有警告。
annotate 如果设置为“True”，将为每个“.pyx”或“.py”生成一个HTML文件，显示cython加速python代码效果。

cython编译整个python项目

module_list可以传入单个py文件路径，也可以传入多个py文件list，还可以一个通配符，例如 ./util/*.py 表示util下面所有的py文件。

根据下面代码即可将整个python项目编译成pyd文件

import sys

if 'build_ext' not in sys.argv:
    sys.argv.append('build_ext')
import os
from distutils.core import setup
from Cython.Build import cythonize
import shutil
import multiprocessing

# 需要编译的项目地址
resource_directory = r'/your/python/file/path'
# 编译后存放so/pyd文件的项目地址
build_directory = r'/output/path'

# 不编译的文件，例如程序入口
exclude_build = ['__init__.py', 'main.py']
# 不需要复制的文件，例如缓存
exclude_copy = ('.git', '.svn', ".idea", ".vscode", '__pycache__', 'setup.py')

# 需要加载的资源文件，一般为py和pyx
resource_suffix = ('.py', '.pyx')
# 存放编译文件路径
temp_directory = "./build"

# 防止路径正反斜杠问题导致输出路径取相对路径
resource_directory = os.path.abspath(resource_directory)
build_directory = os.path.abspath(build_directory)


def copy_project():
    """
    将当前项目复制到目标编译文件夹
    """
    if os.path.exists(build_directory):
        # 如果目标路径存在就先删除
        if input("目标文件夹已存在，是否删除?:（y删除/orther退出）\n").lower() == 'y':
            shutil.rmtree(build_directory)
        else:
            sys.exit(0)
    shutil.copytree(resource_directory, build_directory, ignore=shutil.ignore_patterns(*exclude_copy))


def build_project(dir_path):
    """
    按文件夹编译文件
    """
    # 存放加载的路径
    extensions = []
    dir_path = os.path.abspath(dir_path)
    for file_name in os.listdir(dir_path):
        new_path = os.path.join(dir_path, file_name)
        if os.path.isdir(new_path):
            build_project(new_path)
        elif file_name.endswith(resource_suffix) and file_name not in exclude_build:
            # 加载所有需要编译的资源文件
            extensions.append(new_path)
    build(dir_path, extensions)


def remove_resource(dir_path):
    """
    编译完毕后，删除py和c文件
    :param dir_path:
    :return:
    """
    for file_name in os.listdir(dir_path):
        new_path = os.path.join(dir_path, file_name)
        if os.path.isdir(new_path):
            remove_resource(new_path)
        elif file_name.endswith(('.py', '.c', '.html')) and \
                os.path.abspath(resource_directory) != os.path.abspath(build_directory) and \
                file_name not in exclude_build:
            os.remove(new_path)


def build(dir_path, extensions):
    """
    开始编译文件，为了保证输出文件夹需要单个文件夹循环编译
    """
    # for file_path in extensions:
    out_dir = dir_path
    # 如果当前目录有init.py文件，编译过程中会多建一层文件夹
    if '__init__.py' in os.listdir(out_dir):
        out_dir = os.path.split(out_dir)[0]

    setup(
        ext_modules=cythonize(
            extensions,  # 直接是list对象，可以用多核加速
            # annotate=True,  # 生成html，用来观察代码是否加速
            language_level=3,  # Python 3
            nthreads=multiprocessing.cpu_count(),  # 多核编译
            build_dir=temp_directory,  # 编译的文件夹
        ),
        options={
            "build": {
                "build_lib": out_dir,  # 将编译好的pyd文件放在python文件目录下
            }
        },
    )


if __name__ == '__main__':
    assert resource_directory != build_directory, '为了防止出错，项目文件夹不能和编译文件夹一致'
    # 复制项目到编译文件夹
    copy_project()
    # 加载所有可以编译的资源文件
    build_project(build_directory)
    # 删除编译的文件夹
    shutil.rmtree(temp_directory)
    # 删除py文件和pyx文件
    remove_resource(build_directory)

注意事项