PyO3 Asyncio 项目教程

PyO3 Asyncio 项目教程

pyo3-asyncio 项目地址: https://gitcode.com/gh_mirrors/py/pyo3-asyncio

1. 项目目录结构及介绍

PyO3 Asyncio 项目的目录结构如下：

pyo3-asyncio/
├── devcontainer/
├── githooks/
├── github/
├── examples/
├── pyo3-asyncio-macros/
├── pytestspytests/
├── src/
├── .gitignore
├── Cargo.toml
├── Code-of-Conduct.md
├── Contributing.md
├── LICENSE
├── Makefile
├── README.md
└── codecov.yml

目录介绍

• devcontainer/: 包含开发容器的配置文件。
• githooks/: 包含 Git 钩子脚本。
• github/: 包含 GitHub 相关的配置文件和脚本。
• examples/: 包含项目的示例代码。
• pyo3-asyncio-macros/: 包含宏定义文件。
• pytestspytests/: 包含测试脚本。
• src/: 包含项目的源代码。
• .gitignore: Git 忽略文件配置。
• Cargo.toml: Rust 项目的依赖和配置文件。
• Code-of-Conduct.md: 行为准则文件。
• Contributing.md: 贡献指南文件。
• LICENSE: 项目许可证文件。
• Makefile: 项目构建文件。
• README.md: 项目介绍和使用说明文件。
• codecov.yml: 代码覆盖率配置文件。

2. 项目启动文件介绍

项目的启动文件通常是 src/ 目录下的 main.rs 文件。以下是一个典型的启动文件示例：

// src/main.rs
use pyo3::prelude::*;

#[pyo3_asyncio::async_std::main]
async fn main() -> PyResult<()> {
    let fut = Python::with_gil(|py| {
        let asyncio = py.import("asyncio")?;
        // 将 asyncio.sleep 转换为 Rust Future
        pyo3_asyncio::async_std::into_future(asyncio.call_method1("sleep", (1.into_py(py),))?)
    })?;

    fut.await?;
    Ok(())
}

启动文件介绍

• main.rs: 这是 Rust 项目的入口文件。它使用 pyo3_asyncio 库来与 Python 的 asyncio 库进行交互。
• #[pyo3_asyncio::async_std::main]: 这是一个属性宏，用于指定异步主函数使用 async-std 运行时。
• Python::with_gil: 获取 Python 的全局解释器锁（GIL），以便在 Rust 中调用 Python 代码。
• pyo3_asyncio::async_std::into_future: 将 Python 的异步函数转换为 Rust 的 Future。

3. 项目配置文件介绍

Cargo.toml

Cargo.toml 是 Rust 项目的依赖和配置文件。以下是一个典型的 Cargo.toml 文件示例：

[package]
name = "pyo3-asyncio"
version = "0.1.0"
edition = "2018"

[dependencies]
pyo3 = { version = "0.20", features = ["extension-module"] }
pyo3-asyncio = { version = "0.20", features = ["async-std-runtime"] }
async-std = "1.9"

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

配置文件介绍

• [package]: 定义项目的名称、版本和 Rust 版本。
• [dependencies]: 定义项目的依赖项。pyo3 和 pyo3-asyncio 是与 Python 交互的主要依赖项。
• [lib]: 定义库的名称和类型。crate-type = ["cdylib"] 表示这是一个动态链接库，可以被 Python 导入。

通过以上配置，项目可以顺利编译并生成一个可被 Python 导入的动态链接库。

pyo3-asyncio 项目地址: https://gitcode.com/gh_mirrors/py/pyo3-asyncio