commit | 39ac8f80d82ca10df5c719b3520985352f578ad4 | [log] [tgz] |
---|---|---|
author | Yunze Xu <xyzinfernity@163.com> | Fri May 26 08:02:36 2023 +0800 |
committer | GitHub <noreply@github.com> | Thu May 25 17:02:36 2023 -0700 |
tree | 5a29713558af1f188a7af13138316475393e0cfd | |
parent | d2fac8fb8bbaaaa7d134abc35e7f1f8f89f615be [diff] |
Include the C extension when generating API docs (#126) ### Motivation https://github.com/apache/pulsar-client-python/issues/85#issuecomment-1531069608 Some targets in the API docs are referenced from the `_pulsar` module, while the `pydoctor` command does not generate API docs for it. It's not friendly to users, e.g. they cannot find which values could `_pulsar.ConsumerType` be. ``` pulsar/__init__.py:695: Cannot find link target for "_pulsar.ConsumerType" ``` ### Modifications Fix the documents to describe how to include the API docs for the `_pulsar` module when generating API docs. It also fixes some other warnings when running the `pydoctor` command.
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.