Milksnake

Milksnake是setuptools的一个扩展，允许您以最便携的方式在Python wheel中分发动态链接库。

它提供了一个钩子来调用您的构建过程，然后获取生成的动态链接库。

为什么？

已经存在其他项目可以让Python和本地库协同工作，但这个项目是不同的。与其他构建Python扩展模块的项目不同，此项目的目标是构建常规的本地库，然后在运行时通过CFFI加载。为什么不直接使用CFFI？因为CFFI的setuptools支持本身无法正确处理此类wheel（它不提供构建和正确标记共享库wheel的方式），并且它不提供调用外部构建过程（如makefile、cargo构建rust二进制文件等）的好方法。

特别是，您可能只需要两个Linux wheel，一个mac wheel，很快还将有一个Windows wheel，无论您想要针对多少个Python解释器。

支持什么？

• 平台：Linux、Mac、Windows
• setuptools命令：bdist_wheel、build、build_ext、develop
• pip install --editable .
• 通用wheel（PACKAGE-py2.py3-none-PLATFORM.whl）；如果包还包含一些链接到libpython的东西，可以在setup()中使用milksnake_universal=False来禁用它。

如何？

此示例展示了如何使用它构建一个rust项目

这是一个setup.py文件的样子

from setuptools import setup

def build_native(spec):
    # build an example rust library
    build = spec.add_external_build(
        cmd=['cargo', 'build', '--release'],
        path='./rust'
    )

    spec.add_cffi_module(
        module_path='example._native',
        dylib=lambda: build.find_dylib('example', in_path='target/release'),
        header_filename=lambda: build.find_header('example.h', in_path='target'),
        rtld_flags=['NOW', 'NODELETE']
    )

setup(
    name='example',
    version='0.0.1',
    packages=['example'],
    zip_safe=False,
    platforms='any',
    setup_requires=['milksnake'],
    install_requires=['milksnake'],
    milksnake_tasks=[
        build_native
    ]
)

然后您需要一个包含Rust库（crate类型为cdylib）和example/ python包的rust/文件夹。

示例example/__init__.py文件

from example._native import ffi, lib


def test():
    return lib.a_function_from_rust()

以及rust/src/lib.rs

#[no_mangle]
pub unsafe extern "C" fn a_function_from_rust() -> i32 {
    42
}

以及rust/Cargo.toml

[package]
name = "example"
version = "0.1.0"
build = "build.rs"

[lib]
name = "example"
crate-type = ["cdylib"]

[build-dependencies]
cbindgen = "0.4"

最后是build.rs文件

extern crate cbindgen;

use std::env;

fn main() {
    let crate_dir = env::var("CARGO_MANIFEST_DIR").unwrap();
    let mut config: cbindgen::Config = Default::default();
    config.language = cbindgen::Language::C;
    cbindgen::generate_with_config(&crate_dir, config)
      .unwrap()
      .write_to_file("target/example.h");
}