From 8a42f30f51a3d3b0e1fa5b013156042d546fc01b Mon Sep 17 00:00:00 2001 From: Wes McKinney Date: Sat, 19 Aug 2017 14:07:57 -0400 Subject: [PATCH] Add doxygen comment to set_serialization_callbacks Change-Id: If9ac54f494495186743b0a6929ea193ca5048ed0 --- cpp/src/arrow/python/python_to_arrow.h | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/cpp/src/arrow/python/python_to_arrow.h b/cpp/src/arrow/python/python_to_arrow.h index f07de56538e35..8ac03965a1c44 100644 --- a/cpp/src/arrow/python/python_to_arrow.h +++ b/cpp/src/arrow/python/python_to_arrow.h @@ -39,15 +39,22 @@ class OutputStream; namespace py { -ARROW_EXPORT -void set_serialization_callbacks(PyObject* serialize_callback, - PyObject* deserialize_callback); - struct ARROW_EXPORT SerializedPyObject { std::shared_ptr batch; std::vector> tensors; }; +/// \brief Register callback functions to perform conversions to or from other +/// Python representations en route to/from deserialization +/// +/// \param[in] serialize_callback a Python callable +/// \param[in] deserialize_callback a Python callable +/// +/// Analogous to Python custom picklers / unpicklers +ARROW_EXPORT +void set_serialization_callbacks(PyObject* serialize_callback, + PyObject* deserialize_callback); + /// \brief Serialize Python sequence as a RecordBatch plus /// \param[in] sequence a Python sequence object to serialize to Arrow data /// structures