<p align="center">
<img src="https://raw.githubusercontent.com/VirtusLab/pandas-stubs/master/logo.png"
alt="Logo"
width="60%"/>
</p>
# Pandas Stubs
Collection of pandas [stub files](https://www.python.org/dev/peps/pep-0484/#stub-files>) initially generated using [stubgen](https://github.com/python/mypy/blob/master/mypy/stubgen.py), fixed when necessary and then partially completed.
|CI|PyPi version | PyPI Downloads | Conda Downloads | Python support | License
|--|--|--|--|--|--|
| [![VirtusLab](https://circleci.com/gh/VirtusLab/pandas-stubs.svg?style=svg)]() | [![PyPI package](https://img.shields.io/pypi/v/pandas-stubs.svg)](https://pypi.org/project/pandas-stubs) | [![PyPI download month](https://img.shields.io/pypi/dm/pandas-stubs.svg)](https://pypi.python.org/pypi/pandas-stubs/) | [![PyPI download month](https://anaconda.org/conda-forge/pandas-stubs/badges/downloads.svg)](https://anaconda.org/conda-forge/pandas-stubs) | [![PyPI pyversions](https://img.shields.io/pypi/pyversions/pandas-stubs.svg)](https://pypi.python.org/pypi/pandas-stubs/)|[![GitHub license](https://img.shields.io/github/license/VirtusLab/pandas-stubs.svg)](https://github.com/VirtusLab/pandas-stubs/blob/master/LICENSE)
# Announcement - pandas_stubs is moving!
**Starting from July 2022 `pandas_stubs` package will no longer be sourced from here
but instead from a repository owned and maintained by the core pandas team:**
https://github.com/pandas-dev/pandas-stubs
This is result of a strategic effort lead by the core pandas team to integrate [Microsoft type stub repository](https://github.com/microsoft/python-type-stubs)
together with the [current pandas_stubs repository](https://github.com/VirtusLab/pandas-stubs).
All future development will take place in the new repository and both the PyPI and CondaForge distributions will be sourced from there.
If you're having any problems with the current package please try switching over, and report any issues on the new Github page. Direct pip install and conda are still unsupported but try the following command:
```
pip install git+https://github.com/pandas-dev/pandas-stubs
```
or just clone the repository manually and specify it in `mypy.ini`.
Related issue: [172](https://github.com/VirtusLab/pandas-stubs/issues/172)
## Motivation
Provide rudimentary coverage of pandas code by static type checking, to alleviate problems mentioned in the following issues [14468](https://github.com/pandas-dev/pandas/issues/14468), [26766](https://github.com/pandas-dev/pandas/issues/26766). This approach was taken to achieve accelerated development - compared to refactoring existing Pandas codebase creating stub files is relatively uninhibited.
Due to extensive pandas API, quality of the proposed annotations is, for the most part, not suitable for integration into original codebase, but they can be very useful as a way of achieving some type safety during development.
## Installation
The easiest way is using PyPI. This will add `.pyi` files to `pandas` package location, which will be removed when uninstalling:
```
pip install pandas-stubs
```
Another way to install is using Conda:
```
conda install -c conda-forge pandas-stubs
```
Alternatively, if you want a cleaner `PYTHONPATH` or wish to modify the annotations, manual options are:
* cloning the repository along with the files, or
* including it as a submodule to your project repository,
and then configuring a type checker with the correct paths.
## Usage
Let’s take this example piece of code in file `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)
```
Mypy won't see any issues with that, but after installing pandas-stubs and running it again:
```
mypy round.py
```
we get the following error message:
```
round.py:6: error: Argument "decimals" to "round" of "DataFrame" has incompatible type "DataFrame"; expected "Union[int, Dict[Union[int, str], int], Series]"
```
And after confirming with the [docs](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.round.html)
we can fix the code:
```
decimals = pd.Series({'TSLA': 2, 'AMZN': 1})
```
## Version Compatibility
The aim of the current release is to cover the most common parts of the 1.2.0 API, however it can provide partial functionality for other version as well. Future versions will cover new Pandas releases.
### Versioning
The versions follow a pattern `MAJOR.MINOR.PATCH.STUB_VERSION` where the first three parts correspond to a specific pandas API version, while `STUB_VERSION` is used to distinguish between the versions of the stubs themselves.
## Type checkers
As of now mypy is the only type checker the stubs were tested with.
## Development
### Testing using tox
Tox will automatically run all types of tests mentioned further.
It will create isolated temporary environments for each declared version of Python and install `pandas-stubs`
like it would normally be installed when using pip or conda.
Usage is as simple as:
```
tox
```
Last few lines of the output should look like this (assuming all Python versions are available):
```
pep8: commands succeeded
py36: commands succeeded
py37: commands succeeded
py38: commands succeeded
py39: commands succeeded
```
### Partial testing
Test the stub files internal consistency:
```
mypy --config-file mypy.ini third_party/3/pandas
```
Test the stub files against actual code examples (this will use the stubs from the `third_party/3/pandas` dir):
```
mypy --config-file mypy.ini tests/snippets
```
Test the **installed** stub files against actual code examples.
You'll need to install the library beforehand - the .pyi files from your env will be used:
```
mypy --config-file mypy_env.ini tests/snippets
```
Test if the code examples work, when actually ran with pandas:
```
pytests tests/snippets
```
# Disclaimer
This project provides additional functionality for [pandas](https://pandas.pydata.org/docs/index.html) library. Pandas is available under it's own [license](https://github.com/pandas-dev/pandas/blob/master/LICENSE).
This project is not owned, endorsed, or sponsored by any of AQR Capital Management, NumFOCUS, LLC, Lambda Foundry, Inc. and PyData Development Team.
没有合适的资源?快使用搜索试试~ 我知道了~
pandas-stubs-1.2.0.61.tar.gz
需积分: 5 0 下载量 123 浏览量
2024-03-08
15:37:44
上传
评论
收藏 94KB GZ 举报
温馨提示
共252个文件
pyi:240个
txt:4个
pkg-info:2个
pandas-stubs-1.2.0.61.tar.gz
资源推荐
资源详情
资源评论
收起资源包目录
pandas-stubs-1.2.0.61.tar.gz (252个子文件)
setup.cfg 312B
MANIFEST.in 16B
LICENSE 1KB
README.md 6KB
PKG-INFO 8KB
PKG-INFO 8KB
setup.py 1KB
frame.pyi 25KB
pytables.pyi 20KB
series.pyi 18KB
generic.pyi 16KB
blocks.pyi 13KB
__init__.pyi 9KB
format.pyi 8KB
offsets.pyi 8KB
base.pyi 7KB
multi.pyi 7KB
categorical.pyi 7KB
managers.pyi 6KB
groupby.pyi 6KB
strings.pyi 6KB
rolling.pyi 5KB
_typing.pyi 5KB
sql.pyi 5KB
readers.pyi 5KB
timestamps.pyi 5KB
stata.pyi 5KB
_base.pyi 5KB
numpy_.pyi 5KB
datetimelike.pyi 4KB
ops.pyi 4KB
_json.pyi 4KB
interval.pyi 4KB
resample.pyi 4KB
dtypes.pyi 4KB
__init__.pyi 4KB
pytables.pyi 4KB
base.pyi 4KB
cast.pyi 4KB
merge.pyi 4KB
algorithms.pyi 4KB
core.pyi 4KB
array.pyi 4KB
common.pyi 4KB
style.pyi 3KB
interval.pyi 3KB
generic.pyi 3KB
datetimelike.pyi 3KB
timedeltas.pyi 3KB
period.pyi 3KB
datetimes.pyi 3KB
datetimes.pyi 3KB
converter.pyi 3KB
expr.pyi 3KB
_core.pyi 3KB
ops.pyi 3KB
conftest.pyi 3KB
range.pyi 3KB
sas_constants.pyi 3KB
apply.pyi 3KB
category.pyi 3KB
base.pyi 3KB
grouper.pyi 2KB
timedeltas.pyi 2KB
holiday.pyi 2KB
nanops.pyi 2KB
excel.pyi 2KB
api.pyi 2KB
period.pyi 2KB
concat.pyi 2KB
common.pyi 2KB
numeric.pyi 2KB
timedeltas.pyi 2KB
__init__.pyi 2KB
construction.pyi 2KB
html.pyi 2KB
indexing.pyi 2KB
integer.pyi 2KB
python_parser.pyi 2KB
_misc.pyi 2KB
array_ops.pyi 2KB
csvs.pyi 2KB
common.pyi 2KB
interval.pyi 2KB
construction.pyi 2KB
config.pyi 2KB
config_init.pyi 2KB
boolean.pyi 2KB
extension.pyi 2KB
missing.pyi 2KB
parquet.pyi 2KB
expanding.pyi 1KB
string_.pyi 1KB
html.pyi 1KB
misc.pyi 1KB
missing.pyi 1KB
hist.pyi 1KB
boxplot.pyi 1KB
ewm.pyi 1KB
pivot.pyi 1KB
共 252 条
- 1
- 2
- 3
资源评论
程序员Chino的日记
- 粉丝: 2861
- 资源: 4万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功