package documentation
The Pulsar Python client library is based on the existing C++ client library. All the same features are exposed through the Python interface.
Currently, the supported Python versions are 3.7, 3.8, 3.9 and 3.10.
Install from PyPI
Download Python wheel binary files for macOS and Linux directly from the PyPI archive:
sudo pip install pulsar-client
Install from source code
Read the instructions on source code repository.
Module | __about__ |
Undocumented |
Module | asyncio |
The Pulsar Python client APIs that work with the asyncio module. |
Module | exceptions |
Undocumented |
Package | functions |
No package docstring; 3/3 modules documented |
Package | schema |
Undocumented |
From __init__.py
:
Class |
|
Authentication provider object. Used to load authentication from an external shared library. |
Class |
|
Athenz Authentication implementation |
Class |
|
Basic Authentication implementation |
Class |
|
Oauth2 Authentication implementation |
Class |
|
TLS Authentication implementation |
Class |
|
Token based authentication implementation |
Class |
|
The Pulsar client. A single client instance can be used to create producers and consumers on multiple topics. |
Class |
|
Logger that writes on standard output |
Class |
|
Pulsar consumer. |
Class |
|
Batch receive policy can limit the number and bytes of messages in a single batch, and can specify a timeout for waiting for enough messages for this batch. |
Class |
|
Configuration for the "dead letter queue" feature in consumer. |
Class |
|
Consumer key shared policy is used to configure the consumer behaviour when the ConsumerType is KeyShared. |
Class |
|
Default crypto key reader implementation |
Class |
|
Logger that writes into a file |
Class |
|
Message objects are returned by a consumer, either by calling receive or through a listener. |
Class |
|
Undocumented |
Class |
|
Represents a message id. |
Class |
|
The Pulsar message producer, used to publish messages on a topic. |
Class |
|
Pulsar topic reader. |
Function | _check |
Undocumented |
Function | _check |
Undocumented |
Function | _listener |
Undocumented |
Variable | _retype |
Undocumented |