tag | 46386df2304ac1e5d10e36b076dd05bf1ae153be | |
---|---|---|
tagger | Zike Yang <zike@apache.org> | Tue Dec 26 04:20:14 2023 +0000 |
object | 5e5ba62fffe5f6a8e2ee7f941fae2065adaed6dd |
Release v3.4.0 candidate 1
commit | 5e5ba62fffe5f6a8e2ee7f941fae2065adaed6dd | [log] [tgz] |
---|---|---|
author | Yunze Xu <xyzinfernity@163.com> | Tue Dec 26 12:08:01 2023 +0800 |
committer | Zike Yang <zike@apache.org> | Tue Dec 26 12:12:06 2023 +0800 |
tree | 6b9cbca8a1cd98f43cb81c3aa9a78c78fadf6a4a | |
parent | cfe55b457b0a4cf66d4e0e8bf200993ff4337bf3 [diff] |
Fix the incompatibility with Python 3.12 and drop the support for 3.7 (#181) ### Motivation The `avro` component cannot be installed with Python 3.12 because the depended `fastavro` dependency is 1.7.3, which is not compatible with Python 3.12. However, the newer fastavro dependencies all do not support Python 3.7, which has already reached the EOL (2023-06-27). ### Modifications - Upgrade the fastavro dependency to 1.9.2 - Add the workflows to run tests for the lowest and highest supported Python versions (3.8 and 3.12). - Fix the documents (cherry picked from commit daabc677e06e867f84beaeb3912d1d450cddf54d)
Pulsar Python clients support a variety of Pulsar features to enable building applications connecting to your Pulsar cluster. For the supported Pulsar features, see Client Feature Matrix.
PyBind11 is a header-only library and a submodule, so you can simply download the submodule so that CMake can find this dependency.
git submodule update --init
You can also download the pybind11 directly like:
pip3 install pyyaml export PYBIND11_VERSION=$(./build-support/dep-version.py pybind11) curl -L -O https://github.com/pybind/pybind11/archive/refs/tags/v${PYBIND11_VERSION}.tar.gz tar zxf v${PYBIND11_VERSION}.tar.gz mv pybind11-${PYBIND11_VERSION} pybind11
After that, you only need to install the Pulsar C++ client dependency into the system path. You can install the pre-built binaries or build from source.
Make sure the PyBind11 submodule has been downloaded and the Pulsar C++ client has been installed. Then run the following commands:
cmake -B build cmake --build build cmake --install build python3 ./setup.py bdist_wheel python3 -m pip install dist/pulsar_client-*.whl --force-reinstall
NOTE
- The separate
build
directory is created to store all CMake temporary files. However, thesetup.py
requires the_pulsar.so
to be under the project directory.- Add the
--force-reinstall
option to overwrite the existing Python wheel in case your system has already installed a wheel before.- On Windows, the Python command is
py
instead ofpython3
.
You can run python3 -c 'import pulsar'
to see whether the wheel has been installed successfully. If it fails, check whether dependencies (e.g., libpulsar.so
) are in the system path. If not, make sure the dependencies are in LD_LIBRARY_PATH
(on Linux) or DYLD_LIBRARY_PATH
(on macOS).
Then you can run examples as a simple end-to-end test.
# In terminal 1 python3 ./examples/consumer.py
# In terminal 2 python3 ./examples/producer.py
Before executing the commands above, you must ensure the Pulsar service is running. See here for quick start.
Before running the unit tests, you must run a Pulsar service with all things set up:
./build-support/pulsar-test-service-start.sh
The command above runs a Pulsar standalone in a Docker container. You can run ./build-support/pulsar-test-service-stop.sh
to stop it.
Run all unit tests:
./tests/run-unit-tests.sh
Run a single unit test (e.g., PulsarTest.test_tls_auth
):
python3 ./tests/pulsar_test.py 'PulsarTest.test_tls_auth'
Pulsar Python Client uses pydoctor to generate API docs. To generate by yourself, you need to install the Python library first. Then run the following command in the root path of this repository:
sudo python3 -m pip install pydoctor cp $(python3 -c 'import _pulsar, os; print(_pulsar.__file__)') ./_pulsar.so pydoctor --make-html \ --docformat=numpy --theme=readthedocs \ --intersphinx=https://docs.python.org/3/objects.inv \ --html-output=<path-to-apidocs> \ --introspect-c-modules \ ./_pulsar.so \ pulsar
Then the index page will be generated in <path-to-apidocs>/index.html
.
We welcome contributions from the open source community!
If your contribution adds Pulsar features for Python clients, you need to update both the Pulsar docs and the Client Feature Matrix. See Contribution Guide for more details.