Skip to main content

Type annotations for Pandas

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


Release history Release notifications | RSS feed

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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file pandas-stubs-1.1.0.2.tar.gz.

File metadata

  • Download URL: pandas-stubs-1.1.0.2.tar.gz
  • Upload date:
  • Size: 89.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.5

File hashes

Hashes for pandas-stubs-1.1.0.2.tar.gz
Algorithm Hash digest
SHA256 5c1c921bc01b266ae34c88c523dfb495f716e376dd35f2f23575d0ce797d457a
MD5 f0c220a6c74aefd5134ad21a5d73cd2b
BLAKE2b-256 f098d082db4025d87ec682f945e023010a61cb76fdf9a13567f9237e13d5fac5

See more details on using hashes here.

Provenance

File details

Details for the file pandas_stubs-1.1.0.2-py3-none-any.whl.

File metadata

  • Download URL: pandas_stubs-1.1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 156.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.5

File hashes

Hashes for pandas_stubs-1.1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c9c7aca3bfc0333888e98c35482f59000d68094bb256b51b0f28537ac815d879
MD5 aa42f3a66d8826e2af1706e4567ab2d2
BLAKE2b-256 9952fd9a9d151659d9169c32f35f53057bd0d444658ea3030264d1fc62dfd9a4

See more details on using hashes here.

Provenance

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