ARROW-9283: [Python] Expose build info

pitrou · wesm · wesm · commit 6ada1728a33c · 2020-07-11T17:28:16.000-05:00
Closes apache#7605 from pitrou/ARROW-9283-py-build-info Lead-authored-by: Antoine Pitrou <antoine@python.org> Co-authored-by: Wes McKinney <wesm@apache.org> Signed-off-by: Wes McKinney <wesm@apache.org>
diff --git a/cpp/src/arrow/util/config.h.cmake b/cpp/src/arrow/util/config.h.cmake
@@ -20,7 +20,7 @@
 #define ARROW_VERSION_PATCH @ARROW_VERSION_PATCH@
 #define ARROW_VERSION ((ARROW_VERSION_MAJOR * 1000) + ARROW_VERSION_MINOR) * 1000 + ARROW_VERSION_PATCH
 
-#define ARROW_VERSION_STRING "@ARROW_VERSION_MAJOR@.@ARROW_VERSION_MINOR@.@ARROW_VERSION_PATCH@"
+#define ARROW_VERSION_STRING "@ARROW_VERSION@"
 
 #define ARROW_SO_VERSION "@ARROW_SO_VERSION@"
 #define ARROW_FULL_SO_VERSION "@ARROW_FULL_SO_VERSION@"
diff --git a/python/pyarrow/__init__.py b/python/pyarrow/__init__.py
@@ -63,7 +63,26 @@ def parse_git(root, **kwargs):
 if _gc_enabled:
     _gc.enable()
 
-from pyarrow.lib import cpu_count, set_cpu_count
+from pyarrow.lib import (BuildInfo, VersionInfo,
+                         cpp_build_info, cpp_version, cpp_version_info,
+                         cpu_count, set_cpu_count)
+
+
+def show_versions():
+    """
+    Print various version information, to help with error reporting.
+    """
+    # TODO: CPU information and flags
+    print("pyarrow version info\n--------------------")
+    print("Package kind: {}".format(cpp_build_info.package_kind
+                                    if len(cpp_build_info.package_kind) > 0
+                                    else "not indicated"))
+    print("Arrow C++ library version: {}".format(cpp_build_info.version))
+    print("Arrow C++ git revision: {}".format(cpp_build_info.git_id))
+    print("Arrow C++ git description: {}"
+          .format(cpp_build_info.git_description))
+
+
 from pyarrow.lib import (null, bool_,
                          int8, int16, int32, int64,
                          uint8, uint16, uint32, uint64,
diff --git a/python/pyarrow/config.pxi b/python/pyarrow/config.pxi
@@ -0,0 +1,49 @@
+# 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.
+
+from pyarrow.includes.libarrow cimport GetBuildInfo
+
+from collections import namedtuple
+
+
+VersionInfo = namedtuple('VersionInfo', ('major', 'minor', 'patch'))
+
+BuildInfo = namedtuple(
+    'BuildInfo',
+    ('version', 'version_info', 'so_version', 'full_so_version',
+     'git_id', 'git_description', 'package_kind'))
+
+cdef _build_info():
+    cdef:
+        const CBuildInfo* c_info
+
+    c_info = &GetBuildInfo()
+
+    return BuildInfo(version=frombytes(c_info.version_string),
+                     version_info=VersionInfo(c_info.version_major,
+                                              c_info.version_minor,
+                                              c_info.version_patch),
+                     so_version=frombytes(c_info.so_version),
+                     full_so_version=frombytes(c_info.full_so_version),
+                     git_id=frombytes(c_info.git_id),
+                     git_description=frombytes(c_info.git_description),
+                     package_kind=frombytes(c_info.package_kind))
+
+
+cpp_build_info = _build_info()
+cpp_version = cpp_build_info.version
+cpp_version_info = cpp_build_info.version_info
diff --git a/python/pyarrow/includes/libarrow.pxd b/python/pyarrow/includes/libarrow.pxd
@@ -51,6 +51,20 @@ cdef extern from "arrow/util/decimal.h" namespace "arrow" nogil:
 
 cdef extern from "arrow/api.h" namespace "arrow" nogil:
 
+    cdef cppclass CBuildInfo "arrow::BuildInfo":
+        int version
+        int version_major
+        int version_minor
+        int version_patch
+        c_string version_string
+        c_string so_version
+        c_string full_so_version
+        c_string git_id
+        c_string git_description
+        c_string package_kind
+
+    const CBuildInfo& GetBuildInfo()
+
     enum Type" arrow::Type::type":
         _Type_NA" arrow::Type::NA"
 
diff --git a/python/pyarrow/lib.pyx b/python/pyarrow/lib.pyx
@@ -109,6 +109,9 @@ include "compat.pxi"
 # Exception types and Status handling
 include "error.pxi"
 
+# Configuration information
+include "config.pxi"
+
 # pandas API shim
 include "pandas-shim.pxi"
 
diff --git a/python/pyarrow/tests/test_misc.py b/python/pyarrow/tests/test_misc.py
@@ -42,6 +42,16 @@ def test_cpu_count():
         pa.set_cpu_count(n)
 
 
+def test_build_info():
+    assert isinstance(pa.cpp_build_info, pa.BuildInfo)
+    assert isinstance(pa.cpp_version_info, pa.VersionInfo)
+    assert isinstance(pa.cpp_version, str)
+    assert isinstance(pa.__version__, str)
+    assert pa.cpp_build_info.version_info == pa.cpp_version_info
+
+    # assert pa.version == pa.__version__  # XXX currently false
+
+
 @pytest.mark.parametrize('klass', [
     pa.Field,
     pa.Schema,
diff --git a/python/setup.py b/python/setup.py
@@ -546,6 +546,15 @@ def parse_git(root, **kwargs):
     return parse(root, **kwargs)
 
 
+def guess_next_dev_version(version):
+    if version.exact:
+        return version.format_with('{tag}')
+    else:
+        def guess_next_version(tag_version):
+            return default_version.replace('-SNAPSHOT', '')
+        return version.format_next_version(guess_next_version)
+
+
 with open('README.md') as f:
     long_description = f.read()
 
@@ -595,7 +604,8 @@ def has_ext_modules(foo):
         'root': os.path.dirname(setup_dir),
         'parse': parse_git,
         'write_to': os.path.join(scm_version_write_to_prefix,
-                                 'pyarrow/_generated_version.py')
+                                 'pyarrow/_generated_version.py'),
+        'version_scheme': guess_next_dev_version
     },
     setup_requires=['setuptools_scm', 'cython >= 0.29'] + setup_requires,
     install_requires=install_requires,
