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.

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

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.

Pandas Version Compatibility

The aim of the current release is to cover the most common parts of the 1.0.4 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.0.4.3.tar.gz (86.0 kB view details)

Uploaded Source

Built Distribution

pandas_stubs-1.0.4.3-py3-none-any.whl (153.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pandas-stubs-1.0.4.3.tar.gz
  • Upload date:
  • Size: 86.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.5

File hashes

Hashes for pandas-stubs-1.0.4.3.tar.gz
Algorithm Hash digest
SHA256 97f7ac6621aa280a8225615750f83e06c612436a1bc1c8961ff740b0bb61b3d6
MD5 35dc2f12bd0109273f3acb439d111bb2
BLAKE2b-256 8974dacd1fadd00150582428cb050512bece3f6079d32c05d25d4446c67f6511

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pandas_stubs-1.0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 153.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.5

File hashes

Hashes for pandas_stubs-1.0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8a4698634dee0c996ccf810267f329195344c8e9ff619d220f639ba1ba7d6374
MD5 23eae93a1822b1a1caad72f9ac1f5f70
BLAKE2b-256 9b5c5c0067c69440b2d2c820d693fd3e8aae75e9c206081a4ac4ef1d0025d40d

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