Skip to content

Commit

Permalink
MINOR: [Docs][Python] Add more text around PyArrow build types (#38522)
Browse files Browse the repository at this point in the history
### Rationale for this change

It's not very clear that PyArrow will get built in release mode even if the linked Arrow C++ is built in debug mode. I added some text to the docs to make it more clear. An example of a user running into this is #38519.

### Are these changes tested?

No as they're just minor docs changes.

### Are there any user-facing changes?

This adds text to the Python docs.

Authored-by: Bryce Mecum <petridish@gmail.com>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
  • Loading branch information
amoeba authored Oct 31, 2023
1 parent cb11e44 commit efd945d
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/source/developers/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,12 @@ set the ``PYARROW_PARALLEL`` environment variable.
If you wish to delete stale PyArrow build artifacts before rebuilding, navigate
to the ``arrow/python`` folder and run ``git clean -Xfd .``.

By default, PyArrow will be built in release mode even if Arrow C++ has been
built in debug mode. To create a debug build of PyArrow, run
``export PYARROW_BUILD_TYPE=debug`` prior to running ``python setup.py
build_ext --inplace`` above. A ``relwithdebinfo`` build can be created
similarly.

Now you are ready to install test dependencies and run `Unit Testing`_, as
described above.

Expand Down Expand Up @@ -434,6 +440,9 @@ Debugging

Since pyarrow depends on the Arrow C++ libraries, debugging can
frequently involve crossing between Python and C++ shared libraries.
For the best experience, make sure you've built both Arrow C++
(``-DCMAKE_BUILD_TYPE=Debug``) and PyArrow (``export PYARROW_BUILD_TYPE=debug``)
in debug mode.

Using gdb on Linux
~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit efd945d

Please sign in to comment.