[GitHub] [arrow] pitrou commented on a diff in pull request #14660: ARROW-18341: [Doc][Python] Update note about bundling Arrow C++ on Windows

[GitBox <gi...@apache.org>]

pitrou commented on code in PR #14660:
URL: https://github.com/apache/arrow/pull/14660#discussion_r1028365605


##########
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 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``, use
+   ``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 the Arrow C++.

Review Comment:
   ```suggestion
      updated when rebuilding Arrow C++.
   ```



##########
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 Arrow C++
+   libraries are found. In case you are *not* using conda then you have to

Review Comment:
   Style nits :-)
   ```suggestion
      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:
   ```



##########
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 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``, use
+   ``PYARROW_BUNDLE_ARROW_CPP`` environment variable before building pyarrow:

Review Comment:
   Style nits again
   ```suggestion
      If you want to bundle the Arrow C++ libraries with ``pyarrow``, set the
      ``PYARROW_BUNDLE_ARROW_CPP`` environment variable before building ``pyarrow``:
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org