Pandas-Stubs 项目教程

最新推荐文章于 2024-09-15 08:16:33 发布

秋玥多

最新推荐文章于 2024-09-15 08:16:33 发布

阅读量359

点赞数 5

本文链接：https://blog.csdn.net/gitblog_00015/article/details/139914811

版权

Pandas-Stubs 项目教程

pandas-stubs Pandas type stubs. Helps you type-check your code. 项目地址: https://gitcode.com/gh_mirrors/pan/pandas-stubs

1. 项目介绍

Pandas-Stubs 是一个为 Pandas 库提供类型注解的项目。它通过生成和维护 Pandas 的类型存根（stub files），帮助开发者在使用 Pandas 时进行静态类型检查。这些类型存根可以显著提高代码的类型安全性，减少运行时错误。

Pandas-Stubs 最初由 VirtusLab 开发，但自2022年7月起，该项目已被 Pandas 核心团队接管，并迁移到新的仓库中。目前，Pandas-Stubs 的维护和开发工作主要在 Pandas 官方仓库中进行。

2. 项目快速启动

安装

Pandas-Stubs 可以通过 PyPI 或 Conda 进行安装。以下是两种安装方式的示例：

通过 PyPI 安装

pip install pandas-stubs==1.2.0.62

通过 Conda 安装

conda install -c conda-forge pandas-stubs=1.2.0.62

使用示例

安装完成后，你可以使用 mypy 等类型检查工具来验证你的 Pandas 代码。以下是一个简单的示例：

# round.py
import pandas as pd

decimals = pd.DataFrame({'TSLA': 2, 'AMZN': 1})
prices = pd.DataFrame(data={
    'date': ['2021-08-13', '2021-08-07', '2021-08-21'],
    'TSLA': [720.13, 716.22, 731.22],
    'AMZN': [3316.50, 3200.50, 3100.23]
})

rounded_prices = prices.round(decimals=decimals)

在没有安装 Pandas-Stubs 的情况下，mypy 不会发现任何问题。但安装 Pandas-Stubs 后，运行 mypy round.py 会得到以下错误信息：

round.py:6: error: Argument "decimals" to "round" of "DataFrame" has incompatible type "DataFrame"; expected "Union[int, Dict[Union[int, str], int], Series]"

根据错误提示，我们可以修正代码：

decimals = pd.Series({'TSLA': 2, 'AMZN': 1})

3. 应用案例和最佳实践

应用案例

Pandas-Stubs 主要用于以下场景：

静态类型检查：通过类型存根，开发者可以在编写代码时进行静态类型检查，减少运行时错误。
代码重构：在进行大规模代码重构时，类型存根可以帮助开发者快速发现潜在的类型错误。

最佳实践

定期更新：由于 Pandas-Stubs 会随着 Pandas 版本的更新而更新，建议开发者定期更新 Pandas-Stubs 以保持与最新 Pandas 版本的兼容性。
结合其他工具：除了 mypy，还可以结合其他类型检查工具（如 pyright）来进一步提高代码的类型安全性。