Skip to content

Commit 3cc982e

Browse files
AlenkaFpitroujorisvandenbossche
authored
ARROW-18341: [Doc][Python] Update note about bundling Arrow C++ on Windows (apache#14660)
Lead-authored-by: Alenka Frim <frim.alenka@gmail.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Antoine Pitrou <pitrou@free.fr> Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
1 parent 57b81ca commit 3cc982e

1 file changed

Lines changed: 13 additions & 9 deletions

File tree

docs/source/developers/python.rst

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -563,19 +563,23 @@ Then run the unit tests with:
563563
the Python extension. This is recommended for development as it allows the
564564
C++ libraries to be re-built separately.
565565

566-
If you want to bundle the Arrow C++ libraries with ``pyarrow``, add
567-
the ``--bundle-arrow-cpp`` option when building:
566+
If you are using the conda package manager then conda will ensure the Arrow C++
567+
libraries are found. In case you are *not* using conda then you have to:
568+
569+
* add the path of installed DLL libraries to ``PATH`` every time before
570+
importing ``pyarrow``, or
571+
* bundle the Arrow C++ libraries with ``pyarrow``.
572+
573+
If you want to bundle the Arrow C++ libraries with ``pyarrow``, set the
574+
``PYARROW_BUNDLE_ARROW_CPP`` environment variable before building ``pyarrow``:
568575

569576
.. code-block::
570577
571-
$ python setup.py build_ext --bundle-arrow-cpp
578+
$ set PYARROW_BUNDLE_ARROW_CPP=1
579+
$ python setup.py build_ext --inplace
572580
573-
Important: If you combine ``--bundle-arrow-cpp`` with ``--inplace`` the
574-
Arrow C++ libraries get copied to the source tree and are not cleared
575-
by ``python setup.py clean``. They remain in place and will take precedence
576-
over any later Arrow C++ libraries contained in ``CONDA_PREFIX``. This can lead to
577-
incompatibilities when ``pyarrow`` is later built without
578-
``--bundle-arrow-cpp``.
581+
Note that bundled Arrow C++ libraries will not be automatically
582+
updated when rebuilding Arrow C++.
579583

580584
Caveats
581585
-------

0 commit comments

Comments
 (0)