File size: 4,630 Bytes
8334cee |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
// 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.
#pragma once
#include <memory>
#include <vector>
#include "arrow/ipc/options.h"
#include "arrow/python/visibility.h"
#include "arrow/sparse_tensor.h"
#include "arrow/status.h"
#include "arrow/util/macros.h"
// Forward declaring PyObject, see
// https://mail.python.org/pipermail/python-dev/2003-August/037601.html
#ifndef PyObject_HEAD
struct _object;
typedef _object PyObject;
#endif
namespace arrow {
class Buffer;
class DataType;
class MemoryPool;
class RecordBatch;
class Tensor;
namespace io {
class OutputStream;
} // namespace io
namespace py {
struct ARROW_PYTHON_EXPORT SerializedPyObject {
std::shared_ptr<RecordBatch> batch;
std::vector<std::shared_ptr<Tensor>> tensors;
std::vector<std::shared_ptr<SparseTensor>> sparse_tensors;
std::vector<std::shared_ptr<Tensor>> ndarrays;
std::vector<std::shared_ptr<Buffer>> buffers;
ipc::IpcWriteOptions ipc_options;
SerializedPyObject();
/// \brief Write serialized Python object to OutputStream
/// \param[in,out] dst an OutputStream
/// \return Status
Status WriteTo(io::OutputStream* dst);
/// \brief Convert SerializedPyObject to a dict containing the message
/// components as Buffer instances with minimal memory allocation
///
/// {
/// 'num_tensors': M,
/// 'num_sparse_tensors': N,
/// 'num_buffers': K,
/// 'data': [Buffer]
/// }
///
/// Each tensor is written as two buffers, one for the metadata and one for
/// the body. Therefore, the number of buffers in 'data' is 2 * M + 2 * N + K + 1,
/// with the first buffer containing the serialized record batch containing
/// the UnionArray that describes the whole object
Status GetComponents(MemoryPool* pool, PyObject** out);
};
/// \brief Serialize Python sequence as a SerializedPyObject.
/// \param[in] context Serialization context which contains custom serialization
/// and deserialization callbacks. Can be any Python object with a
/// _serialize_callback method for serialization and a _deserialize_callback
/// method for deserialization. If context is None, no custom serialization
/// will be attempted.
/// \param[in] sequence A Python sequence object to serialize to Arrow data
/// structures
/// \param[out] out The serialized representation
/// \return Status
///
/// Release GIL before calling
ARROW_DEPRECATED("Deprecated in 18.0.0. Will be removed in 20.0.0")
ARROW_PYTHON_EXPORT
Status SerializeObject(PyObject* context, PyObject* sequence, SerializedPyObject* out);
/// \brief Serialize an Arrow Tensor as a SerializedPyObject.
/// \param[in] tensor Tensor to be serialized
/// \param[out] out The serialized representation
/// \return Status
ARROW_DEPRECATED("Deprecated in 18.0.0. Will be removed in 20.0.0")
ARROW_PYTHON_EXPORT
Status SerializeTensor(std::shared_ptr<Tensor> tensor, py::SerializedPyObject* out);
/// \brief Write the Tensor metadata header to an OutputStream.
/// \param[in] dtype DataType of the Tensor
/// \param[in] shape The shape of the tensor
/// \param[in] tensor_num_bytes The length of the Tensor data in bytes
/// \param[in] dst The OutputStream to write the Tensor header to
/// \return Status
ARROW_DEPRECATED("Deprecated in 18.0.0. Will be removed in 20.0.0")
ARROW_PYTHON_EXPORT
Status WriteNdarrayHeader(std::shared_ptr<DataType> dtype,
const std::vector<int64_t>& shape, int64_t tensor_num_bytes,
io::OutputStream* dst);
struct PythonType {
enum type {
NONE,
BOOL,
INT,
PY2INT, // Kept for compatibility
BYTES,
STRING,
HALF_FLOAT,
FLOAT,
DOUBLE,
DATE64,
LIST,
DICT,
TUPLE,
SET,
TENSOR,
NDARRAY,
BUFFER,
SPARSECOOTENSOR,
SPARSECSRMATRIX,
SPARSECSCMATRIX,
SPARSECSFTENSOR,
NUM_PYTHON_TYPES
};
};
} // namespace py
} // namespace arrow
|