ARROW-17160: [C++] Create a base directory for PyArrow CPP header files (apache#14275)

This PR is a follow-up of apache#13311 where it was decided to change the base directory for PyArrow C++ headers to avoid top level inclusions. See apache#13311 (comment)

Authored-by: Alenka Frim <[email protected]>
Signed-off-by: Joris Van den Bossche <[email protected]>

Author: AlenkaF

python/pyarrow/src/CMakeLists.txt

@@ -73,31 +73,31 @@ set(Python3_FIND_REGISTRY "LAST")
 set(Python3_FIND_FRAMEWORK "LAST")
 
 find_package(Python3Alt 3.7 REQUIRED)
-include_directories(SYSTEM ${NUMPY_INCLUDE_DIRS} ${PYTHON_INCLUDE_DIRS} ${ARROW_INCLUDE_DIR} src)
+include_directories(SYSTEM ${NUMPY_INCLUDE_DIRS} ${PYTHON_INCLUDE_DIRS} ${ARROW_INCLUDE_DIR} ${CMAKE_SOURCE_DIR} src)
 
 add_custom_target(arrow_python)
 
 set(ARROW_PYTHON_SRCS
-    arrow_to_pandas.cc
-    benchmark.cc
-    common.cc
-    datetime.cc
-    decimal.cc
-    deserialize.cc
-    extension_type.cc
-    gdb.cc
-    helpers.cc
-    inference.cc
-    init.cc
-    io.cc
-    ipc.cc
-    numpy_convert.cc
-    numpy_to_arrow.cc
-    python_test.cc
-    python_to_arrow.cc
-    pyarrow.cc
-    serialize.cc
-    udf.cc)
+    arrow/python/arrow_to_pandas.cc
+    arrow/python/benchmark.cc
+    arrow/python/common.cc
+    arrow/python/datetime.cc
+    arrow/python/decimal.cc
+    arrow/python/deserialize.cc
+    arrow/python/extension_type.cc
+    arrow/python/gdb.cc
+    arrow/python/helpers.cc
+    arrow/python/inference.cc
+    arrow/python/init.cc
+    arrow/python/io.cc
+    arrow/python/ipc.cc
+    arrow/python/numpy_convert.cc
+    arrow/python/numpy_to_arrow.cc
+    arrow/python/python_test.cc
+    arrow/python/python_to_arrow.cc
+    arrow/python/pyarrow.cc
+    arrow/python/serialize.cc
+    arrow/python/udf.cc)
 
 set_source_files_properties(init.cc PROPERTIES SKIP_PRECOMPILE_HEADERS ON
                                                SKIP_UNITY_BUILD_INCLUSION ON)
@@ -127,7 +127,7 @@ endif()
 
 if(PYARROW_WITH_PARQUET_ENCRYPTION)
   if(PARQUET_REQUIRE_ENCRYPTION)
-    list(APPEND ARROW_PYTHON_SRCS parquet_encryption.cc)
+    list(APPEND ARROW_PYTHON_SRCS arrow/python/parquet_encryption.cc)
     find_package(Parquet REQUIRED)
     list(APPEND ARROW_PYTHON_SHARED_LINK_LIBS Parquet::parquet_shared)
     list(APPEND ARROW_PYTHON_SHARED_INSTALL_INTERFACE_LIBS Parquet::parquet_shared)
@@ -146,11 +146,11 @@ endif()
 
 # Check for only Arrow C++ options
 if(ARROW_CSV)
-  list(APPEND ARROW_PYTHON_SRCS csv.cc)
+  list(APPEND ARROW_PYTHON_SRCS arrow/python/csv.cc)
 endif()
 
 if(ARROW_FILESYSTEM)
-  list(APPEND ARROW_PYTHON_SRCS filesystem.cc)
+  list(APPEND ARROW_PYTHON_SRCS arrow/python/filesystem.cc)
 endif()
 
 if(CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang" OR CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
@@ -225,7 +225,7 @@ add_arrow_lib(arrow_python
               SOURCES
               ${ARROW_PYTHON_SRCS}
               PRECOMPILED_HEADERS
-              "$<$<COMPILE_LANGUAGE:CXX>:pch.h>"
+              "$<$<COMPILE_LANGUAGE:CXX>:arrow/python/pch.h>"
               OUTPUTS
               ARROW_PYTHON_LIBRARIES
               SHARED_LINK_FLAGS
@@ -269,7 +269,7 @@ if(ARROW_FLIGHT AND ARROW_BUILD_SHARED)
                 PKG_CONFIG_NAME
                 arrow-python-flight
                 SOURCES
-                flight.cc
+                arrow/python/flight.cc
                 OUTPUTS
                 ARROW_PYFLIGHT_LIBRARIES
                 SHARED_LINK_FLAGS
@@ -309,4 +309,4 @@ if(CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang" OR CMAKE_CXX_COMPILER_ID STREQUAL
                PROPERTY COMPILE_FLAGS -Wno-parentheses-equality)
 endif()
 
-arrow_install_all_headers("arrow/python")
+add_subdirectory(arrow/python)

python/pyarrow/src/arrow/python/CMakeLists.txt

@@ -0,0 +1,18 @@
+# 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.
+
+arrow_install_all_headers("arrow/python")

python/pyarrow/src/api.h python/pyarrow/src/arrow/python/api.h

@@ -17,14 +17,14 @@
 
 #pragma once
 
-#include "arrow_to_pandas.h"
-#include "common.h"
-#include "datetime.h"
-#include "deserialize.h"
-#include "helpers.h"
-#include "inference.h"
-#include "io.h"
-#include "numpy_convert.h"
-#include "numpy_to_arrow.h"
-#include "python_to_arrow.h"
-#include "serialize.h"
+#include "arrow/python/arrow_to_pandas.h"
+#include "arrow/python/common.h"
+#include "arrow/python/datetime.h"
+#include "arrow/python/deserialize.h"
+#include "arrow/python/helpers.h"
+#include "arrow/python/inference.h"
+#include "arrow/python/io.h"
+#include "arrow/python/numpy_convert.h"
+#include "arrow/python/numpy_to_arrow.h"
+#include "arrow/python/python_to_arrow.h"
+#include "arrow/python/serialize.h"

python/pyarrow/src/arrow_to_pandas.cc python/pyarrow/src/arrow/python/arrow_to_pandas.cc

@@ -17,8 +17,8 @@
 
 // Functions for pandas conversion via NumPy
 
-#include "arrow_to_pandas.h"
-#include "numpy_interop.h"  // IWYU pragma: expand
+#include "arrow/python/arrow_to_pandas.h"
+#include "arrow/python/numpy_interop.h"  // IWYU pragma: expand
 
 #include <cmath>
 #include <cstdint>
@@ -48,16 +48,16 @@
 
 #include "arrow/compute/api.h"
 
-#include "arrow_to_python_internal.h"
-#include "common.h"
-#include "datetime.h"
-#include "decimal.h"
-#include "helpers.h"
-#include "numpy_convert.h"
-#include "numpy_internal.h"
-#include "pyarrow.h"
-#include "python_to_arrow.h"
-#include "type_traits.h"
+#include "arrow/python/arrow_to_python_internal.h"
+#include "arrow/python/common.h"
+#include "arrow/python/datetime.h"
+#include "arrow/python/decimal.h"
+#include "arrow/python/helpers.h"
+#include "arrow/python/numpy_convert.h"
+#include "arrow/python/numpy_internal.h"
+#include "arrow/python/pyarrow.h"
+#include "arrow/python/python_to_arrow.h"
+#include "arrow/python/type_traits.h"
 
 namespace arrow {
 

python/pyarrow/src/arrow_to_pandas.h python/pyarrow/src/arrow/python/arrow_to_pandas.h

@@ -20,14 +20,14 @@
 
 #pragma once
 
-#include "platform.h"
+#include "arrow/python/platform.h"
 
 #include <memory>
 #include <string>
 #include <unordered_set>
 
 #include "arrow/memory_pool.h"
-#include "visibility.h"
+#include "arrow/python/visibility.h"
 
 namespace arrow {
 

python/pyarrow/src/arrow_to_python_internal.h python/pyarrow/src/arrow/python/arrow_to_python_internal.h

@@ -18,7 +18,7 @@
 #pragma once
 
 #include "arrow/array.h"
-#include "platform.h"
+#include "arrow/python/platform.h"
 
 namespace arrow {
 namespace py {

python/pyarrow/src/benchmark.cc python/pyarrow/src/arrow/python/benchmark.cc

@@ -15,8 +15,8 @@
 // specific language governing permissions and limitations
 // under the License.
 
-#include "benchmark.h"
-#include "helpers.h"
+#include "arrow/python/benchmark.h"
+#include "arrow/python/helpers.h"
 
 namespace arrow {
 namespace py {

python/pyarrow/src/benchmark.h python/pyarrow/src/arrow/python/benchmark.h

@@ -17,9 +17,9 @@
 
 #pragma once
 
-#include "platform.h"
+#include "arrow/python/platform.h"
 
-#include "visibility.h"
+#include "arrow/python/visibility.h"
 
 namespace arrow {
 namespace py {

python/pyarrow/src/common.cc python/pyarrow/src/arrow/python/common.cc

@@ -15,7 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-#include "common.h"
+#include "arrow/python/common.h"
 
 #include <cstdlib>
 #include <mutex>
@@ -26,7 +26,7 @@
 #include "arrow/util/checked_cast.h"
 #include "arrow/util/logging.h"
 
-#include "helpers.h"
+#include "arrow/python/helpers.h"
 
 namespace arrow {
 

python/pyarrow/src/common.h python/pyarrow/src/arrow/python/common.h

@@ -24,8 +24,8 @@
 #include "arrow/buffer.h"
 #include "arrow/result.h"
 #include "arrow/util/macros.h"
-#include "pyarrow.h"
-#include "visibility.h"
+#include "arrow/python/pyarrow.h"
+#include "arrow/python/visibility.h"
 
 namespace arrow {
 

python/pyarrow/src/csv.cc python/pyarrow/src/arrow/python/csv.cc

@@ -19,7 +19,7 @@
 
 #include <memory>
 
-#include "common.h"
+#include "arrow/python/common.h"
 
 namespace arrow {
 

python/pyarrow/src/csv.h python/pyarrow/src/arrow/python/csv.h

@@ -24,7 +24,7 @@
 
 #include "arrow/csv/options.h"
 #include "arrow/util/macros.h"
-#include "common.h"
+#include "arrow/python/common.h"
 
 namespace arrow {
 namespace py {

python/pyarrow/src/datetime.cc python/pyarrow/src/arrow/python/datetime.cc

@@ -27,10 +27,10 @@
 #include "arrow/type.h"
 #include "arrow/util/logging.h"
 #include "arrow/util/value_parsing.h"
-#include "arrow_to_python_internal.h"
-#include "common.h"
-#include "helpers.h"
-#include "platform.h"
+#include "arrow/python/arrow_to_python_internal.h"
+#include "arrow/python/common.h"
+#include "arrow/python/helpers.h"
+#include "arrow/python/platform.h"
 
 namespace arrow {
 namespace py {

python/pyarrow/src/datetime.h python/pyarrow/src/arrow/python/datetime.h

@@ -20,12 +20,12 @@
 #include <algorithm>
 #include <chrono>
 
-#include "platform.h"
-#include "visibility.h"
 #include "arrow/status.h"
 #include "arrow/type.h"
 #include "arrow/type_fwd.h"
 #include "arrow/util/logging.h"
+#include "arrow/python/platform.h"
+#include "arrow/python/visibility.h"
 
 // By default, PyDateTimeAPI is a *static* variable.  This forces
 // PyDateTime_IMPORT to be called in every C/C++ module using the

python/pyarrow/src/decimal.cc python/pyarrow/src/arrow/python/decimal.cc

@@ -18,12 +18,12 @@
 #include <algorithm>
 #include <limits>
 
-#include "common.h"
-#include "decimal.h"
-#include "helpers.h"
 #include "arrow/type_fwd.h"
 #include "arrow/util/decimal.h"
 #include "arrow/util/logging.h"
+#include "arrow/python/common.h"
+#include "arrow/python/decimal.h"
+#include "arrow/python/helpers.h"
 
 namespace arrow {
 namespace py {

python/pyarrow/src/decimal.h python/pyarrow/src/arrow/python/decimal.h

@@ -19,7 +19,7 @@
 
 #include <string>
 
-#include "visibility.h"
+#include "arrow/python/visibility.h"
 #include "arrow/type.h"
 
 namespace arrow {

python/pyarrow/src/deserialize.cc python/pyarrow/src/arrow/python/deserialize.cc

@@ -15,9 +15,9 @@
 // specific language governing permissions and limitations
 // under the License.
 
-#include "deserialize.h"
+#include "arrow/python/deserialize.h"
 
-#include "numpy_interop.h"
+#include "arrow/python/numpy_interop.h"
 
 #include <cstdint>
 #include <memory>
@@ -40,12 +40,12 @@
 #include "arrow/util/logging.h"
 #include "arrow/util/value_parsing.h"
 
-#include "common.h"
-#include "datetime.h"
-#include "helpers.h"
-#include "numpy_convert.h"
-#include "pyarrow.h"
-#include "serialize.h"
+#include "arrow/python/common.h"
+#include "arrow/python/datetime.h"
+#include "arrow/python/helpers.h"
+#include "arrow/python/numpy_convert.h"
+#include "arrow/python/pyarrow.h"
+#include "arrow/python/serialize.h"
 
 namespace arrow {
 

python/pyarrow/src/deserialize.h python/pyarrow/src/arrow/python/deserialize.h

@@ -21,9 +21,9 @@
 #include <memory>
 #include <vector>
 
-#include "serialize.h"
-#include "visibility.h"
 #include "arrow/status.h"
+#include "arrow/python/serialize.h"
+#include "arrow/python/visibility.h"
 
 namespace arrow {
 

python/pyarrow/src/extension_type.cc python/pyarrow/src/arrow/python/extension_type.cc

@@ -19,11 +19,11 @@
 #include <sstream>
 #include <utility>
 
-#include "extension_type.h"
-#include "helpers.h"
-#include "pyarrow.h"
 #include "arrow/util/checked_cast.h"
 #include "arrow/util/logging.h"
+#include "arrow/python/extension_type.h"
+#include "arrow/python/helpers.h"
+#include "arrow/python/pyarrow.h"
 
 namespace arrow {