jorisvandenbossche commented on a change in pull request #12624: URL: https://github.com/apache/arrow/pull/12624#discussion_r828831453
########## File path: docs/source/python/env_vars.rst ########## @@ -0,0 +1,63 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + +.. currentmodule:: pyarrow + +===================== +Environment Variables +===================== + +The following environment variables can be used to affect the behavior of +PyArrow. + +.. envvar:: ARROW_HOME + + The base path to the PyArrow installation. This variable overrides the + default computation of library paths in introspection functions such + as :func:`get_library_dirs`. + +.. envvar:: ARROW_PRE_0_15_IPC_FORMAT + + If this environment variable is set to a non-zero integer value, the PyArrow + IPC writer will default to the pre-0.15 Arrow IPC format. + This behavior can also be enabled using :attr:`IpcWriteOptions.use_legacy_format`. + +.. envvar:: ARROW_PRE_1_0_METADATA_VERSION + + If this environment variable is set to a non-zero integer value, the PyArrow + IPC writer will write V4 Arrow metadata (corresponding to pre-1.0 Arrow + with an incompatible Union data layout). + This behavior can also be enabled using :attr:`IpcWriteOptions.metadata_version`. + +.. envvar:: PKG_CONFIG + + The path to the ``pkg-config`` executable. This may be required for + proper functioning of introspection functions such as + :func:`get_library_dirs` if ``pkg-config`` is not available on the system + ``PATH``. + +.. envvar:: PYARROW_IGNORE_TIMEZONE + + By default, PyArrow propagates the timezone value when converting + Arrow data to/from Python datetime objects. If this environment variable + is set to a non-empty value, the timezone is not propagated. Review comment: That sounds correct, yes. Now, checking the code, I see this note: https://github.com/apache/arrow/blob/ecf8c753c0e9552fbf54fd79c48e58d382efcba8/cpp/src/arrow/python/python_to_arrow.h#L56-L59 Although I see that spark is still using the env variable (cc @BryanCutler). In the spark code (https://github.com/apache/spark/pull/30111) it points to https://issues.apache.org/jira/browse/SPARK-32285, which is not yet resolved. -- 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-unsubscr...@arrow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
