forked from apache/arrow
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpython_to_arrow.h
More file actions
89 lines (73 loc) · 2.86 KB
/
Copy pathpython_to_arrow.h
File metadata and controls
89 lines (73 loc) · 2.86 KB
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
// 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.
#ifndef ARROW_PYTHON_PYTHON_TO_ARROW_H
#define ARROW_PYTHON_PYTHON_TO_ARROW_H
#include "arrow/python/platform.h"
#include <memory>
#include <vector>
#include "arrow/python/common.h"
#include "arrow/python/pyarrow.h"
#include "arrow/status.h"
#include "arrow/util/visibility.h"
namespace arrow {
class MemoryPool;
class RecordBatch;
class Tensor;
namespace io {
class OutputStream;
} // namespace io
namespace py {
struct ARROW_EXPORT SerializedPyObject {
std::shared_ptr<RecordBatch> batch;
std::vector<std::shared_ptr<Tensor>> tensors;
std::vector<std::shared_ptr<Buffer>> buffers;
/// \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': 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 * 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 RecordBatch plus
/// \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_EXPORT
Status SerializeObject(PyObject* context, PyObject* sequence, SerializedPyObject* out);
} // namespace py
} // namespace arrow
#endif // ARROW_PYTHON_PYTHON_TO_ARROW_H