python bdist_wheel

2021-07-14

利用cython进行编译成库.

1. setup.py

# coding: utf-8
import os
import sysconfig


from setuptools import setup, find_packages

# https://stackoverflow.com/questions/21594925/error-each-element-of-ext-modules-option-must-be-an-extension-instance-or-2-t
# 注意，这个顺序必须在这里，要比setup低.
from Cython.Build import cythonize

from setuptools.command.build_py import build_py as _build_py


def read():
    with open("./requirements.txt", "r") as f:
        return f.readlines()


# Notice1: your modules.
packages = set(find_packages()) | {'your modules.'}

# Notice2: exclude files.
EXCLUDE_FILES = [
    # 'your package/ignore python files.'
    'package/file1.py'

]


def get_ext_paths(root_dir, exclude_files):
    """get filepaths for compilation"""
    paths = []

    for root, dirs, files in os.walk(root_dir):
        for filename in files:
            if os.path.splitext(filename)[1] != '.py':
                continue

            file_path = os.path.join(root, filename)
            if file_path in exclude_files:
                continue

            paths.append(file_path)
    return paths


# noinspection PyPep8Naming
class build_py(_build_py):

    def find_package_modules(self, package, package_dir):
        ext_suffix = sysconfig.get_config_var('EXT_SUFFIX')
        modules = super().find_package_modules(package, package_dir)
        filtered_modules = []
        for (pkg, mod, filepath) in modules:
            if os.path.exists(filepath.replace('.py', ext_suffix)):
                continue
            filtered_modules.append((pkg, mod, filepath,))
        return filtered_modules


setup(
    name='package name', # Notice3
    version='0.3.0',

    ext_modules=cythonize(
        get_ext_paths('project root path', EXCLUDE_FILES), # Notice4
        compiler_directives={'language_level': 3.6}
    ),
    cmdclass={
        'build_py': build_py
    },
    packages=packages,
    include_package_data=True,
    install_requires=read(),
)

2. build

1
2
3

python setup.py build_ext --inplace
python setup.py bdist_wheel

3. 结论

通过这种方式编译成一个库，正常情况下无法查看源码。
在开发过程中，IDE无法自动导入，就正常打包方便开发同学调试、使用，而在生产环境使用2方式进行编译成一个安装包，开发替换一下安装包路径即可。