This is an automated email from the ASF dual-hosted git repository.
jorisvandenbossche pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/master by this push:
new 3cc982e519 ARROW-18341: [Doc][Python] Update note about bundling Arrow
C++ on Windows (#14660)
3cc982e519 is described below
commit 3cc982e519dc573ebe1bebd72d37c60afb787ed0
Author: Alenka Frim <[email protected]>
AuthorDate: Tue Nov 22 08:49:02 2022 +0100
ARROW-18341: [Doc][Python] Update note about bundling Arrow C++ on Windows
(#14660)
Lead-authored-by: Alenka Frim <[email protected]>
Co-authored-by: Alenka Frim <[email protected]>
Co-authored-by: Antoine Pitrou <[email protected]>
Co-authored-by: Joris Van den Bossche <[email protected]>
Signed-off-by: Joris Van den Bossche <[email protected]>
---
docs/source/developers/python.rst | 22 +++++++++++++---------
1 file changed, 13 insertions(+), 9 deletions(-)
diff --git a/docs/source/developers/python.rst
b/docs/source/developers/python.rst
index 27a685551c..b32b77fa6c 100644
--- a/docs/source/developers/python.rst
+++ b/docs/source/developers/python.rst
@@ -563,19 +563,23 @@ Then run the unit tests with:
the Python extension. This is recommended for development as it allows the
C++ libraries to be re-built separately.
- If you want to bundle the Arrow C++ libraries with ``pyarrow``, add
- the ``--bundle-arrow-cpp`` option when building:
+ If you are using the conda package manager then conda will ensure the Arrow
C++
+ libraries are found. In case you are *not* using conda then you have to:
+
+ * add the path of installed DLL libraries to ``PATH`` every time before
+ importing ``pyarrow``, or
+ * bundle the Arrow C++ libraries with ``pyarrow``.
+
+ If you want to bundle the Arrow C++ libraries with ``pyarrow``, set the
+ ``PYARROW_BUNDLE_ARROW_CPP`` environment variable before building
``pyarrow``:
.. code-block::
- $ python setup.py build_ext --bundle-arrow-cpp
+ $ set PYARROW_BUNDLE_ARROW_CPP=1
+ $ python setup.py build_ext --inplace
- Important: If you combine ``--bundle-arrow-cpp`` with ``--inplace`` the
- Arrow C++ libraries get copied to the source tree and are not cleared
- by ``python setup.py clean``. They remain in place and will take precedence
- over any later Arrow C++ libraries contained in ``CONDA_PREFIX``. This can
lead to
- incompatibilities when ``pyarrow`` is later built without
- ``--bundle-arrow-cpp``.
+ Note that bundled Arrow C++ libraries will not be automatically
+ updated when rebuilding Arrow C++.
Caveats
-------
