ceph/src/arrow/cpp/src/arrow/python/inference.h

   1 // Licensed to the Apache Software Foundation (ASF) under one
   2 // or more contributor license agreements.  See the NOTICE file
   3 // distributed with this work for additional information
   4 // regarding copyright ownership.  The ASF licenses this file
   5 // to you under the Apache License, Version 2.0 (the
   6 // "License"); you may not use this file except in compliance
   7 // with the License.  You may obtain a copy of the License at
   8 //
   9 //   http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing,
  12 // software distributed under the License is distributed on an
  13 // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  14 // KIND, either express or implied.  See the License for the
  15 // specific language governing permissions and limitations
  16 // under the License.
  17
  18 // Functions for converting between CPython built-in data structures and Arrow
  19 // data structures
  20
  21 #pragma once
  22
  23 #include "arrow/python/platform.h"
  24
  25 #include <memory>
  26
  27 #include "arrow/python/visibility.h"
  28 #include "arrow/type.h"
  29 #include "arrow/util/macros.h"
  30
  31 #include "arrow/python/common.h"
  32
  33 namespace arrow {
  34
  35 class Array;
  36 class Status;
  37
  38 namespace py {
  39
  40 // These functions take a sequence input, not arbitrary iterables
  41
  42 /// \brief Infer Arrow type from a Python sequence
  43 /// \param[in] obj the sequence of values
  44 /// \param[in] mask an optional mask where True values are null. May
  45 /// be nullptr
  46 /// \param[in] pandas_null_sentinels use pandas's null value markers
  47 ARROW_PYTHON_EXPORT
  48 Result<std::shared_ptr<arrow::DataType>> InferArrowType(PyObject* obj, PyObject* mask,
  49                                                         bool pandas_null_sentinels);
  50
  51 /// Checks whether the passed Python object is a boolean scalar
  52 ARROW_PYTHON_EXPORT
  53 bool IsPyBool(PyObject* obj);
  54
  55 /// Checks whether the passed Python object is an integer scalar
  56 ARROW_PYTHON_EXPORT
  57 bool IsPyInt(PyObject* obj);
  58
  59 /// Checks whether the passed Python object is a float scalar
  60 ARROW_PYTHON_EXPORT
  61 bool IsPyFloat(PyObject* obj);
  62
  63 }  // namespace py
  64 }  // namespace arrow