# pandas-stubs: Public type stubs for pandas
[![PyPI Latest Release](https://img.shields.io/pypi/v/pandas-stubs.svg)](https://pypi.org/project/pandas-stubs/)
[![Conda Latest Release](https://anaconda.org/conda-forge/pandas-stubs/badges/version.svg)](https://anaconda.org/conda-forge/pandas-stubs)
[![Package Status](https://img.shields.io/pypi/status/pandas-stubs.svg)](https://pypi.org/project/pandas-stubs/)
[![License](https://img.shields.io/pypi/l/pandas-stubs.svg)](https://github.com/pandas-dev/pandas-stubs/blob/main/LICENSE)
[![Downloads](https://static.pepy.tech/personalized-badge/pandas-stubs?period=month&units=international_system&left_color=black&right_color=orange&left_text=PyPI%20downloads%20per%20month)](https://pepy.tech/project/pandas-stubs)
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/pydata/pandas)
[![Powered by NumFOCUS](https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](https://numfocus.org)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
## What is it?
These are public type stubs for [**pandas**](http://pandas.pydata.org/), following the
convention of providing stubs in a separate package, as specified in [PEP 561](https://peps.python.org/pep-0561/#stub-only-packages). The stubs cover the most typical use cases of
pandas. In general, these stubs are narrower than what is possibly allowed by pandas,
but follow a convention of suggesting best recommended practices for using pandas.
The stubs are likely incomplete in terms of covering the published API of pandas. NOTE: The current 2.0.x releases of pandas-stubs do not support all of the new features of pandas 2.0. See this [tracker](https://github.com/pandas-dev/pandas-stubs/issues/624) to understand the current compatibility with version 2.0.
The stubs are tested with [mypy](http://mypy-lang.org/) and [pyright](https://github.com/microsoft/pyright#readme) and are currently shipped with the Visual Studio Code extension
[pylance](https://github.com/microsoft/pylance-release#readme).
## Usage
Let’s take this example piece of code in file `round.py`
```python
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:
```sh
mypy round.py
```
we get the following error message:
```text
round.py:6: error: Argument "decimals" to "round" of "DataFrame" has incompatible type "DataFrame"; expected "Union[int, Dict[Any, Any], Series[Any]]" [arg-type]
Found 1 error in 1 file (checked 1 source file)
```
And, if you use pyright:
```sh
pyright round.py
```
you get the following error message:
```text
round.py:6:40 - error: Argument of type "DataFrame" cannot be assigned to parameter "decimals" of type "int | Dict[Unknown, Unknown] | Series[Unknown]" in function "round"
Type "DataFrame" cannot be assigned to type "int | Dict[Unknown, Unknown] | Series[Unknown]"
"DataFrame" is incompatible with "int"
"DataFrame" is incompatible with "Dict[Unknown, Unknown]"
"DataFrame" is incompatible with "Series[Unknown]" (reportGeneralTypeIssues)
```
And after confirming with the [docs](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.round.html)
we can fix the code:
```python
decimals = pd.Series({'TSLA': 2, 'AMZN': 1})
```
## Version Numbering Convention
The version number x.y.z.yymmdd corresponds to a test done with pandas version x.y.z, with the stubs released on the date mm/yy/dd.
It is anticipated that the stubs will be released more frequently than pandas as the stubs are expected to evolve due to more
public visibility.
## Where to get it
The source code is currently hosted on GitHub at: <https://github.com/pandas-dev/pandas-stubs>
Binary installers for the latest released version are available at the [Python
Package Index (PyPI)](https://pypi.org/project/pandas-stubs) and on [conda-forge](https://conda-forge.org/).
```sh
# conda
conda install pandas-stubs
```
```sh
# or PyPI
pip install pandas-stubs
```
## Dependencies
- [pandas: powerful Python data analysis toolkit](https://pandas.pydata.org/)
- [typing-extensions >= 4.2.0 - supporting the latest typing extensions](https://github.com/python/typing_extensions#readme)
## Installation from sources
- Make sure you have `python >= 3.9` installed.
- Install poetry
```sh
# conda
conda install poetry
```
```sh
# or PyPI
pip install 'poetry>=1.2'
```
- Install the project dependencies
```sh
poetry update -vvv
```
- Build and install the distribution
```sh
poetry run poe build_dist
poetry run poe install_dist
```
## License
[BSD 3](LICENSE)
## Documentation
Documentation is a work-in-progress.
## Background
These stubs are the result of a strategic effort led by the core pandas team to integrate [Microsoft type stub repository](https://github.com/microsoft/python-type-stubs) with the [VirtusLabs pandas_stubs repository](https://github.com/VirtusLab/pandas-stubs).
These stubs were initially forked from the Microsoft project at <https://github.com/microsoft/python-type-stubs> as of [this commit](https://github.com/microsoft/python-type-stubs/tree/6b800063bde687cd1846122431e2a729a9de625a).
We are indebted to Microsoft and that project for providing the initial set of public type stubs. We are also grateful for the original pandas-stubs project at <https://github.com/VirtusLab/pandas-stubs>, which created the framework for testing the stubs.
## Differences between type declarations in pandas and pandas-stubs
The <https://github.com/pandas-dev/pandas/> project has type declarations for some parts of pandas, both for the internal and public API's. Those type declarations are used to make sure that the pandas code is _internally_ consistent.
The <https://github.com/pandas-dev/pandas-stubs/> project provides type declarations for the pandas _public_ API. The philosophy of these stubs can be found at <https://github.com/pandas-dev/pandas-stubs/blob/main/docs/philosophy.md/>. While it would be ideal if the `pyi` files in this project would be part of the `pandas` distribution, this would require consistency between the internal type declarations and the public declarations, and the scope of a project to create that consistency is quite large. That is a long term goal. Finally, another goal is to do more frequent releases of the pandas-stubs than is done for pandas, in order to make the stubs more useful.
If issues are found with the public stubs, pull requests to correct those issues are welcome. In addition, pull requests on the pandas repository to fix the same issue are welcome there as well. However, since the goals of typing in the two projects are different (internal consistency vs. public usage), it may be a challenge to create consistent type declarations across both projects. See <https://pandas.pydata.org/docs/development/contributing_codebase.html#type-hints> for a discussion of typing standards used within the pandas code.
## Getting help
Ask questions and report issues on the [pandas-stubs repository](https://github.com/pandas-dev/pandas-stubs/issues).
## Discussion and Development
Most development discussions take place on GitHub in the [pandas-stubs repository](https://github.com/pandas-dev/pandas-stubs/). Further, the [pandas-dev mailing list](https://mail.python.org/mailman/listi
没有合适的资源?快使用搜索试试~ 我知道了~
pandas_stubs-2.1.4.231218.tar.gz
需积分: 1 0 下载量 199 浏览量
2024-03-17
13:29:17
上传
评论
收藏 98KB GZ 举报
温馨提示
共205个文件
pyi:199个
typed:1个
toml:1个
Python库是一组预先编写的代码模块,旨在帮助开发者实现特定的编程任务,无需从零开始编写代码。这些库可以包括各种功能,如数学运算、文件操作、数据分析和网络编程等。Python社区提供了大量的第三方库,如NumPy、Pandas和Requests,极大地丰富了Python的应用领域,从数据科学到Web开发。Python库的丰富性是Python成为最受欢迎的编程语言之一的关键原因之一。这些库不仅为初学者提供了快速入门的途径,而且为经验丰富的开发者提供了强大的工具,以高效率、高质量地完成复杂任务。例如,Matplotlib和Seaborn库在数据可视化领域内非常受欢迎,它们提供了广泛的工具和技术,可以创建高度定制化的图表和图形,帮助数据科学家和分析师在数据探索和结果展示中更有效地传达信息。
资源推荐
资源详情
资源评论
收起资源包目录
pandas_stubs-2.1.4.231218.tar.gz (205个子文件)
LICENSE 1KB
README.md 8KB
PKG-INFO 9KB
setup.py 10KB
frame.pyi 68KB
series.pyi 67KB
_typing.pyi 23KB
readers.pyi 16KB
base.pyi 15KB
generic.pyi 14KB
timedeltas.pyi 14KB
interval.pyi 13KB
_core.pyi 12KB
accessors.pyi 12KB
generic.pyi 12KB
style.pyi 11KB
timestamps.pyi 11KB
_base.pyi 10KB
offsets.pyi 8KB
interval.pyi 8KB
tile.pyi 8KB
categorical.pyi 7KB
clipboards.pyi 7KB
pytables.pyi 7KB
period.pyi 7KB
strings.pyi 7KB
resample.pyi 6KB
multi.pyi 5KB
sql.pyi 5KB
rolling.pyi 5KB
_json.pyi 4KB
stata.pyi 4KB
config.pyi 4KB
holiday.pyi 4KB
pivot.pyi 4KB
__init__.pyi 4KB
groupby.pyi 4KB
datetimes.pyi 4KB
__init__.pyi 4KB
nattype.pyi 3KB
timedeltas.pyi 3KB
expanding.pyi 3KB
dataframe_protocol.pyi 3KB
merge.pyi 3KB
pytables.pyi 3KB
sasreader.pyi 3KB
period.pyi 3KB
concat.pyi 3KB
range.pyi 3KB
datetimes.pyi 3KB
ops.pyi 3KB
interval.pyi 3KB
datetimelike.pyi 3KB
api.pyi 3KB
base.pyi 3KB
_misc.pyi 2KB
expr.pyi 2KB
algorithms.pyi 2KB
style_render.pyi 2KB
ops.pyi 2KB
datetimes.pyi 2KB
base.pyi 2KB
arraylike.pyi 2KB
common.pyi 2KB
timedeltas.pyi 2KB
__init__.pyi 2KB
missing.pyi 2KB
array.pyi 2KB
dtypes.pyi 2KB
indexing.pyi 2KB
__init__.pyi 2KB
ewm.pyi 2KB
__init__.pyi 2KB
config_init.pyi 2KB
period.pyi 2KB
indexers.pyi 2KB
category.pyi 2KB
grouper.pyi 2KB
html.pyi 2KB
api.pyi 1KB
offsets.pyi 1KB
dtypes.pyi 1KB
numeric.pyi 1KB
api.pyi 1KB
xml.pyi 1KB
timedeltas.pyi 1KB
integer.pyi 1KB
missing.pyi 1KB
boolean.pyi 961B
common.pyi 955B
datetimelike.pyi 945B
construction.pyi 926B
__init__.pyi 924B
lib.pyi 866B
base.pyi 834B
masked.pyi 824B
api.pyi 748B
melt.pyi 741B
_decorators.pyi 720B
encoding.pyi 716B
共 205 条
- 1
- 2
- 3
资源评论
程序员Chino的日记
- 粉丝: 2830
- 资源: 3万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功