Type annotations for Pandas

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Dr-Irv from gravatar.com Dr-Irv Avatar for simonjayhawkins from gravatar.com simonjayhawkins Avatar for twoertwein from gravatar.com twoertwein Avatar for ZKroliko from gravatar.com ZKroliko

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Project description

Pandas Stubs

Collection of pandas stub files initially generated using stubgen, fixed when necessary and then partially completed.

CI PyPi version PyPI Downloads Conda Downloads Python support License
VirtusLab PyPI package PyPI download month PyPI download month PyPI pyversions GitHub license

Motivation

Provide rudimentary coverage of pandas code by static type checking, to alleviate problems mentioned in the following issues 14468, 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 and usage

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.

Version Compatibility

The aim of the current release is to cover the most common parts of the 1.1.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.

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 (this will use pandas .pyi files from your env):

mypy --config-file mypy_env.ini tests/snippets

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Dr-Irv from gravatar.com Dr-Irv Avatar for simonjayhawkins from gravatar.com simonjayhawkins Avatar for twoertwein from gravatar.com twoertwein Avatar for ZKroliko from gravatar.com ZKroliko

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

2.2.3.241009

2.2.2.240909

2.2.2.240807

2.2.2.240805 yanked

Reason this release was yanked:

Incorrect dependencies for numpy and python < 3.12

2.2.2.240603

2.2.2.240514

2.2.1.240316

2.2.0.240218

2.1.4.231227

2.1.4.231218

2.1.1.230928

2.0.3.230814

2.0.2.230605

2.0.1.230501

2.0.0.230412

1.5.3.230321

1.5.3.230320 yanked

Reason this release was yanked:

Found error due to pyxlsb after pushing

1.5.3.230304

1.5.3.230227

1.5.3.230214

1.5.3.230203

1.5.2.230105

1.5.2.221213

1.5.2.221124

1.5.1.221024

1.5.0.221012

1.5.0.221010

1.5.0.221003

1.5.0.220926

1.4.4.220919

1.4.4.220912

1.4.4.220906

1.4.3.220829

1.4.3.220822

1.4.3.220815

1.4.3.220807

1.4.3.220801

1.4.3.220724

1.4.3.220718

1.4.3.220710

1.4.3.220704

1.4.3.220703

1.4.3.220702

1.4.2.220626

1.4.2.220622

1.2.0.62

1.2.0.61

1.2.0.60

1.2.0.59

1.2.0.58

1.2.0.57

1.2.0.56

1.2.0.55

1.2.0.54

1.2.0.53

1.2.0.52

1.2.0.51

1.2.0.50

1.2.0.49

1.2.0.48

1.2.0.47

1.2.0.46

1.2.0.45

1.2.0.44

1.2.0.43

1.2.0.42

1.2.0.41

1.2.0.40

1.2.0.39

1.2.0.38

1.2.0.37

1.2.0.36

1.2.0.35

1.2.0.34

1.2.0.33

1.2.0.32

1.2.0.31

1.2.0.30

1.2.0.29

1.2.0.28

1.2.0.27

1.2.0.26

1.2.0.25

1.2.0.24

1.2.0.23

1.2.0.22

1.2.0.21

1.2.0.20

1.2.0.19

1.2.0.18

1.2.0.17

1.2.0.16

1.2.0.15

1.2.0.14

1.2.0.13

1.2.0.12

1.2.0.11

1.2.0.10

1.2.0.9

1.2.0.8

1.2.0.7

1.2.0.6

1.2.0.5

1.2.0.4

1.2.0.3

1.2.0.2

1.2.0.1

1.1.0.14

1.1.0.13

1.1.0.12

1.1.0.11

1.1.0.10

1.1.0.9

1.1.0.8

1.1.0.7

1.1.0.6

1.1.0.5

1.1.0.4

1.1.0.3

This version

1.1.0.2

1.1.0.1

1.0.4.7

1.0.4.6

1.0.4.5

1.0.4.4

1.0.4.3

1.0.4.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pandas-stubs-1.1.0.2.tar.gz (89.0 kB view hashes)

Uploaded Source

Built Distribution

pandas_stubs-1.1.0.2-py3-none-any.whl (156.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page