title
Pulsar Stubs

A collection of the Apache Spark stub files. These files were generated by stubgen and manually edited to include accurate type hints.

Tests and configuration files have been originally contributed to the Typeshed project. Please refer to its contributors list and license for details.

Motivation

• Improved autocompletion.

Installation and usage

Please note that the guidelines for distribution of type information is still work in progress (PEP 561 - Distributing and Packaging Type Information). Currently installation script overlays existing Spark installations (pyi stub files are copied next to their py counterparts in the Pulsar installation directory). If this approach is not acceptable you can add stub files to the search path manually.

According to PEP 484:

Third-party stub packages can use any location for stub storage. Type checkers should search for them using PYTHONPATH.

Moreover:

Third-party stub packages can use any location for stub storage. Type checkers should search for them using PYTHONPATH. A default fallback directory that is always checked is shared/typehints/python3.5/ (or 3.6, etc.)

Please check usage before proceeding.

The package is available on PYPI:

pip install pulsar-stubs

and conda-forge:

conda install -c conda-forge pulsar-stubs

Depending on your environment you might also need a type checker, like Mypy or Pytype¹, and autocompletion tool, like Jedi.

This package is tested against MyPy development branch and in rare cases (primarily important upstream bugfixes), is not compatible with the preceding MyPy release.

Pulsar Version Compatibility

Package versions follow Pulsar versions with exception to maintenance releases - i.e. [pulsar-stubs==2.0.2] should be compatible with [Pulsar>=2.0.2,<2.1.0]. Maintenance releases ([post1], [post2], ..., [postN]) are reserved for internal annotations updates.

API Coverage:

The package is generated from the Pulsar codebase and is not guaranteed to be complete. The goal is to provide type hints for the most commonly used classes and methods. The package is not intended to be a complete replacement for the original codebase.

Disclaimer

Apache Pulsar, Pulsar, Apache, and the Pulsar logo are trademarks of The Apache Software Foundation. This project is not owned, endorsed, or sponsored by The Apache Software Foundation.

Footnotes

Footnotes

1. Not supported or tested. ↩