Repository: arrow-site Updated Branches: refs/heads/asf-site d3e1b42c6 -> f508ee596
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/cpp/arrow_2python_2common_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/arrow_2python_2common_8h_source.html b/docs/cpp/arrow_2python_2common_8h_source.html index fd3d708..ddac49c 100644 --- a/docs/cpp/arrow_2python_2common_8h_source.html +++ b/docs/cpp/arrow_2python_2common_8h_source.html @@ -5,7 +5,7 @@ <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> -<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/python/common.h Source File</title> +<title>Apache Arrow (C++): /arrow/cpp/src/arrow/python/common.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> @@ -70,38 +70,39 @@ $(function() { <div class="title">common.h</div> </div> </div><!--header--> <div class="contents"> -<a href="arrow_2python_2common_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006">< /a><span class="lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software distributed under the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef ARROW_PYTHON_COMMON_H</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define ARROW_PYTHON_COMMON_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <sstream></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <utility></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="arrow_2python_2con fig_8h.html">arrow/python/config.h</a>"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="buffer_8h.html">arrow/buffer.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="macros_8h.html">arrow/util/macros.h</a>"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span>MemoryPool;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span>py {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> ARROW_EXPORT Status <a class="code" href="namespacearrow_1_1py.html#a3e3b2a009ad096bb408386d7f36c679f">ConvertPyError</a>(<a class="code" href="namespacearrow.html#a331ad1dbd1c157c8be168cb6548d188f">StatusCode</a> code = <a class="code" href="namespacearrow.html#a331ad1dbd1c157c8be168cb6548d188fabfaef30f1c8011c5cefa38ae470fb7aa">StatusCode::UnknownError</a>);</div><div class="line"><a name="l00039"> </a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// Catch a pending Python exception and return the corresponding Status.</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// If no exception is pending, Status::OK() is returned.</span></div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="namespacearrow_1_1py.html#a37da12f47177606bf2725384804bef19"> 42</a></span> <span class="keyword">inline</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1py.html#a37da12f47177606bf2725384804bef19">CheckPyError</a>(<a class="code" href="namespacearrow.html#a331ad1dbd1c157c8be168cb6548d188f">StatusCode</a> code = <a class="code" href="namespacearrow.html#a331ad1dbd1c157c8be168cb6548d188fabfaef30f1c8011c5cefa38ae470fb7aa">StatusCode::UnknownErro r</a>) {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">if</span> (<a class="code" href="macros_8h.html#a1f418a9edc46d53e62732e7ccd06f329">ARROW_PREDICT_TRUE</a>(!PyErr_Occurred())) {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#a5c0b0031db6eeec3dcc70485d24cfe03">Status::OK</a>();</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">return</span> <a class="code" href="namespacearrow_1_1py.html#a3e3b2a009ad096bb408386d7f36c679f">ConvertPyError</a>(code);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  }</div><div class="line"><a name="l00048"></a><span class="lineno"> 48 </span> }</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> ARROW_EXPORT <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1py.html#a420f8c193475027edf8f2fb07cb6274f">PassPyError</a>();</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// TODO(wesm): We can just let errors pass through. To be explored later</span></div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="arrow_2python_2common_8h.html#ad99052ac0ced9d8a858bd49d5bfd2ebd"> 53</a></span> <span class="preprocessor">#define RETURN_IF_PYERROR() RETURN_NOT_OK(CheckPyError());</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="li ne"><a name="l00055"></a><span class="lineno"><a class="line" href="arrow_2python_2common_8h.html#acae7d13f31abc214abe5d1e7c901b72f"> 55</a></span> <span class="preprocessor">#define PY_RETURN_IF_ERROR(CODE) RETURN_NOT_OK(CheckPyError(CODE));</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html"> 57</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html">PyAcquireGIL</a> {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html#a176ad0a1d753c1e1297a8c8c8e24edfc"> 59</a></span>  <a class="code" href="classarrow_1_1py_1_1_py_acquire_g_i_l. html#a176ad0a1d753c1e1297a8c8c8e24edfc">PyAcquireGIL</a>() : acquired_gil_(false) { acquire(); }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html#aa07961f7d96ca5dd17319aa4fb65facc"> 61</a></span>  <a class="code" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html#aa07961f7d96ca5dd17319aa4fb65facc">~PyAcquireGIL</a>() { release(); }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html#a705f95bb8ae5f01b9c6615ef3694aef4"> 63</a></span>  <span class="keywordtype">void</span> <a class="code" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html#a705f95bb8ae5f01b9c6615ef3694aef4">acquire</a>() {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">if</span> (!acquired_gil_) {</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  state_ = PyGILState_Ensure();</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  acquired_gil_ = <span class="keyword">true</span>;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  }</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  }</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// idempotent</span></div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html#a9b0f2a430dac36520aeedd344d21fb3f"> 71</a></span>  <span class="keywordtype">void</span> <a class="code" href="classarrow_1_1py_1_1_py_ acquire_g_i_l.html#a9b0f2a430dac36520aeedd344d21fb3f">release</a>() {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">if</span> (acquired_gil_) {</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  PyGILState_Release(state_);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  acquired_gil_ = <span class="keyword">false</span>;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  }</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  }</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">bool</span> acquired_gil_;</div><di v class="line"><a name="l00080"></a><span class="lineno"> 80</span>  PyGILState_STATE state_;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="macros_8h.html#a40d72e185b1488b5659b761f0b6115bb">ARROW_DISALLOW_COPY_AND_ASSIGN</a>(<a class="code" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html">PyAcquireGIL</a>);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> };</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="arrow_2python_2common_8h.html#a3736d68f2c04b7b41de8a06fb198b577"> 84</a></span> <span class="preprocessor">#define PYARROW_IS_PY2 PY_MAJOR_VERSION <= 2</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">// A RAII primitive that DECREFs the underlying PyObject* when it</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">// goes out of scope.</span></div><div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html"> 88</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a> {</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#a23c568f39cefb24111a5b126342907fb"> 90</a></span>  <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#a23c568f39cefb24111a5b126342907fb">OwnedRef</a>() : obj_(<a class="code" href="macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a>) {}</div><div class="li ne"><a name="l00091"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#abbf808f76a630e08324908ff8f0164a1"> 91</a></span>  <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#abbf808f76a630e08324908ff8f0164a1">OwnedRef</a>(<a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a>&& other) : <a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a>(other.detach()) {}</div><div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#a4fa414445a0d45fc6876e22a48323818"> 92</a></span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#a4fa414445a0d45fc6876e22a48323818">OwnedRef</a>(<a class="code" href="python__to__arrow_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj) : obj_(obj) {}</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="li ne"><a name="l00094"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#ac532ea6b2a2ef8f021f1bd195830df69"> 94</a></span>  <a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a>& <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#ac532ea6b2a2ef8f021f1bd195830df69">operator=</a>(<a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a>&& other) {</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  obj_ = other.<a class="code" href="classarrow_1_1py_1_1_owned_ref.html#acec5dc3d562adf45d8df3a5d74cc105b">detach</a>();</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  }</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="l ine"><a name="l00099"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#a8dbf530a3d56e9cc8be52ee72de0a2f8"> 99</a></span>  <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#a8dbf530a3d56e9cc8be52ee72de0a2f8">~OwnedRef</a>() { reset(); }</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#ad99c47163961c1b346c3ea9836783eda"> 101</a></span>  <span class="keywordtype">void</span> <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#ad99c47163961c1b346c3ea9836783eda">reset</a>(<a class="code" href="python__to__arrow_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj) {</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  Py_XDECREF(obj_);</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  obj_ = o bj;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  }</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#a7f4ec7d4b8ed3a376739239dd1e1987b"> 106</a></span>  <span class="keywordtype">void</span> <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#a7f4ec7d4b8ed3a376739239dd1e1987b">reset</a>() { <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#a7f4ec7d4b8ed3a376739239dd1e1987b">reset</a>(<a class="code" href="macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a>); }</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#acec5dc3d562adf45d8df3a5d74cc105b"> 108</a></span>  <a class="code" href="python__to__arro w_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#acec5dc3d562adf45d8df3a5d74cc105b">detach</a>() {</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <a class="code" href="python__to__arrow_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* result = obj_;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  obj_ = <a class="code" href="macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a>;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordflow">return</span> result;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  }</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#ac9d1b421eef89af1daff63 c14fe828d2"> 114</a></span>  <a class="code" href="python__to__arrow_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#ac9d1b421eef89af1daff63c14fe828d2">obj</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> obj_; }</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#a4f277e7908da30c544136911ddd5e11e"> 116</a></span>  <a class="code" href="python__to__arrow_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>** <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#a4f277e7908da30c544136911ddd5e11e">ref</a>() { <span class="keywordflow">return</span> &obj_; }</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00118"></a><span class="lineno"><a cl ass="line" href="classarrow_1_1py_1_1_owned_ref.html#aab08c8f7391e16952029b7741d47d803"> 118</a></span>  <span class="keyword">operator</span> bool()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> obj_ != <a class="code" href="macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a>; }</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <a class="code" href="macros_8h.html#a40d72e185b1488b5659b761f0b6115bb">ARROW_DISALLOW_COPY_AND_ASSIGN</a>(<a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a>);</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <a class="code" href="pytho n__to__arrow_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj_;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> };</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment">// Same as OwnedRef, but ensures the GIL is taken when it goes out of scope.</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment">// This is for situations where the GIL is not always known to be held</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment">// (e.g. if it is released in the middle of a function for performance reasons)</span></div><div class="line"><a name="l00129"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html"> 129</a></span> <span class="keyword">class </sp an>ARROW_EXPORT <a class="code" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html">OwnedRefNoGIL</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a> {</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00131"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html#ad0dd0d09fc802fc0dd21718fd827b713"> 131</a></span>  <a class="code" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html#ad0dd0d09fc802fc0dd21718fd827b713">OwnedRefNoGIL</a>() : <a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a>() {}</div><div class="line"><a name="l00132"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html#a0087f6a81e7e6a5b0176494c47607138"> 132</a></span>  <a class="code" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html#a0087f6a81e7 e6a5b0176494c47607138">OwnedRefNoGIL</a>(<a class="code" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html">OwnedRefNoGIL</a>&& other) : <a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a>(other.detach()) {}</div><div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html#a27fb138ed68d2ff91fddff0842d923b9"> 133</a></span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html#a27fb138ed68d2ff91fddff0842d923b9">OwnedRefNoGIL</a>(<a class="code" href="python__to__arrow_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj) : <a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a>(obj) {}</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div><div class="line"><a name="l00135"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html#ae0943d984c 8e64c5609793c149d9a5bc"> 135</a></span>  <a class="code" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html#ae0943d984c8e64c5609793c149d9a5bc">~OwnedRefNoGIL</a>() {</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <a class="code" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html">PyAcquireGIL</a> lock;</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  reset();</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  }</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> };</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment">// A temporary conversion of a Python object to a bytes area.</span></div><div class="line"><a name="l00142"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_py_bytes_vie w.html"> 142</a></span> <span class="keyword">struct </span>ARROW_EXPORT <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html">PyBytesView</a> {</div><div class="line"><a name="l00143"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_py_bytes_view.html#a6dcfada3d934979b6ebac34ccd8f3336"> 143</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a6dcfada3d934979b6ebac34ccd8f3336">bytes</a>;</div><div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_py_bytes_view.html#a2abfcac41c6d2157869190773ab54ddc"> 144</a></span>  Py_ssize_t <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a2abfcac41c6d2157869190773ab54ddc">size</a>;</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div><div class="line"><a name="l00146"></a><span class="lineno"><a class="l ine" href="structarrow_1_1py_1_1_py_bytes_view.html#a9a0bd5cc89fabd0a2ac819411db7847f"> 146</a></span>  <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a9a0bd5cc89fabd0a2ac819411db7847f">PyBytesView</a>() : bytes(<a class="code" href="macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a>), size(0), ref(<a class="code" href="macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a>) {}</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="comment">// View the given Python object as binary-like, i.e. bytes</span></div><div class="line"><a name="l00149"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_py_bytes_view.html#af8a34ca8430d0b7f42b330d50620c725"> 149</a></span>  <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#af8a34c a8430d0b7f42b330d50620c725">FromBinary</a>(<a class="code" href="python__to__arrow_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj) { <span class="keywordflow">return</span> <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#af8a34ca8430d0b7f42b330d50620c725">FromBinary</a>(obj, <span class="stringliteral">"a bytes object"</span>); }</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="comment">// View the given Python object as string-like, i.e. str or (utf8) bytes</span></div><div class="line"><a name="l00152"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_py_bytes_view.html#ad074a47795c12258c55fe6febfb7f5f7"> 152</a></span>  <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#ad074a47795c12258c55fe6febfb7f5f7">FromStrin g</a>(<a class="code" href="python__to__arrow_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj, <span class="keywordtype">bool</span> check_valid = <span class="keyword">false</span>) {</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordflow">if</span> (PyUnicode_Check(obj)) {</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="preprocessor">#if PY_MAJOR_VERSION >= 3</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  Py_ssize_t size;</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="comment">// The utf-8 representation is cached on the unicode object</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* data = PyUnicode_AsUTF8AndSize(obj, &size);</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <a class="code" href="arrow_2python_2common_8h.html#ad99052ac0ced9d8a858bd49d5bfd2ebd">RETURN_IF_PYERROR</a>();</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  this->bytes = data;</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  this->size = size;</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  this->ref.reset();</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#a5c0b0031db6eeec3dcc70485d24cfe03">Status::OK</a>();</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <a class="code" href="python_ _to__arrow_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* converted = PyUnicode_AsUTF8String(obj);</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <a class="code" href="arrow_2python_2common_8h.html#ad99052ac0ced9d8a858bd49d5bfd2ebd">RETURN_IF_PYERROR</a>();</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  this->bytes = PyBytes_AS_STRING(converted);</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  this->size = PyBytes_GET_SIZE(converted);</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  this->ref.reset(converted);</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#a5c0b0031db6eeec3dcc70485d24cfe03">Status::OK</a>();</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <a class="code" href="status_8h.html#a0a03bcf7fdbd9a96c67afa05fc0a545d">RETURN_NOT_OK</a>(FromBinary(obj, <span class="stringliteral">"a string or bytes object"</span>));</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="keywordflow">if</span> (check_valid) {</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="comment">// Check the bytes are valid utf-8</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a> decoded(PyUnicode_FromStringAndSize(bytes, size));</div><div class="line"><a name ="l00176"></a><span class="lineno"> 176</span>  <a class="code" href="arrow_2python_2common_8h.html#ad99052ac0ced9d8a858bd49d5bfd2ebd">RETURN_IF_PYERROR</a>();</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  }</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#a5c0b0031db6eeec3dcc70485d24cfe03">Status::OK</a>();</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  }</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  }</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00183"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_py_bytes_ view.html#a96cb35199dff8192a165ca1952062364"> 183</a></span>  <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a96cb35199dff8192a165ca1952062364">PyBytesView</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* b, Py_ssize_t s, <a class="code" href="python__to__arrow_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj = <a class="code" href="macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a>)</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  : bytes(b), size(s), ref(obj) {}</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div><div class="line"><a name="l00186"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_py_bytes_view.html#a830036d48822762433dc503512ef2204"> 186</a></span>  <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a830036d4882276243 3dc503512ef2204">FromBinary</a>(<a class="code" href="python__to__arrow_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj, <span class="keyword">const</span> <span class="keywordtype">char</span>* expected_msg) {</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <span class="keywordflow">if</span> (PyBytes_Check(obj)) {</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  this->bytes = PyBytes_AS_STRING(obj);</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  this->size = PyBytes_GET_SIZE(obj);</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  this->ref.reset();</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#a5c0b0031db6eeec3dcc70485d24cfe03">Status::OK</a>();</div><div class="line"><a n ame="l00192"></a><span class="lineno"> 192</span>  } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (PyByteArray_Check(obj)) {</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  this->bytes = PyByteArray_AS_STRING(obj);</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  this->size = PyByteArray_GET_SIZE(obj);</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  this->ref.reset();</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#a5c0b0031db6eeec3dcc70485d24cfe03">Status::OK</a>();</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  std::str ingstream ss;</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  ss << <span class="stringliteral">"Expected "</span> << expected_msg << <span class="stringliteral">", got a '"</span> << Py_TYPE(obj)->tp_name</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  << <span class="stringliteral">"' object"</span>;</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#ac618ef5553ac7bd7243461fe3418ce8a">Status::TypeError</a>(ss.str());</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  }</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  }</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> </div><div class="line"><a name= "l00205"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_py_bytes_view.html#a766c1f311246f552e6d90884dd0804d2"> 205</a></span>  <a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a> <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a766c1f311246f552e6d90884dd0804d2">ref</a>;</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> };</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> </div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment">// Return the common PyArrow memory pool</span></div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> ARROW_EXPORT <span class="keywordtype">void</span> <a class="code" href="namespacearrow_1_1py.html#a1c820dd57e25e43fbdfc3accd252efc4">set_default_memory_pool</a>(<a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool);</div><div class= "line"><a name="l00210"></a><span class="lineno"> 210</span> ARROW_EXPORT <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* <a class="code" href="namespacearrow_1_1py.html#a695a28adb44e701429087896352e4a07">get_memory_pool</a>();</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div><div class="line"><a name="l00212"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_buffer.html"> 212</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1py_1_1_py_buffer.html">PyBuffer</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1_buffer.html">Buffer</a> {</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  ~<a class="code" href="classarrow_1_1py_1_1_py_buffer.html">PyBuffer</a>();</div><d iv class="line"><a name="l00217"></a><span class="lineno"> 217</span> </div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> FromPyObject(<a class="code" href="python__to__arrow_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj, std::shared_ptr<Buffer>* out);</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> </div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  <a class="code" href="classarrow_1_1py_1_1_py_buffer.html">PyBuffer</a>();</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Init(<a class="code" href="python__to__arrow_8h.html#ae19630c1f4ca6d5236b3 0719d9140013">PyObject</a>*);</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> </div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  Py_buffer py_buf_;</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> };</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> </div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> } <span class="comment">// namespace py</span></div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> </div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="preprocessor">#endif // ARROW_PYTHON_COMMON_H</span></div><div class="ttc" id="classarrow_1_1py_1_1_owned_ref_no_g_i_l_html_a0087f6a81e7e6a5b0176494c47607138"><div class="ttname"><a href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html#a0087f6a81e7e6a5b0176494c47607138">arrow::py::OwnedRefNoGIL::OwnedRefNoGIL</a></div><div class="ttdeci">OwnedRefNoGIL(OwnedRefNoGIL &&other)</div><div class="ttdef"><b>Definition:</b> common.h:132</div></div> +<a href="arrow_2python_2common_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006">< /a><span class="lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software distributed under the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef ARROW_PYTHON_COMMON_H</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define ARROW_PYTHON_COMMON_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <sstream></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <utility></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="arrow_2python_2con fig_8h.html">arrow/python/config.h</a>"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="buffer_8h.html">arrow/buffer.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="arrow_2util_2macros_8h.html">arrow/util/macros.h</a>"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "<a class="code" href="arrow_2util_2visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace </span><a class="code" href="name spacearrow.html">arrow</a> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span>MemoryPool;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span>py {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> ARROW_EXPORT Status <a class="code" href="namespacearrow_1_1py.html#a3e3b2a009ad096bb408386d7f36c679f">ConvertPyError</a>(<a class="code" href="namespacearrow.html#a331ad1dbd1c157c8be168cb6548d188f">StatusCode</a> code = <a class="code" href="namespacearrow.html#a331ad1dbd1c157c8be168cb6548d188fabfaef30f1c8011c5cefa38ae470fb7aa">StatusCode::UnknownError</a>);</div><div clas s="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// Catch a pending Python exception and return the corresponding Status.</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// If no exception is pending, Status::OK() is returned.</span></div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="namespacearrow_1_1py.html#a37da12f47177606bf2725384804bef19"> 42</a></span> <span class="keyword">inline</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1py.html#a37da12f47177606bf2725384804bef19">CheckPyError</a>(<a class="code" href="namespacearrow.html#a331ad1dbd1c157c8be168cb6548d188f">StatusCode</a> code = <a class="code" href="namespacearrow.html#a331ad1dbd1c157c8be168cb6548d188fabfaef30f1c8011c5cefa38ae470fb7a a">StatusCode::UnknownError</a>) {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">if</span> (<a class="code" href="arrow_2util_2macros_8h.html#a1f418a9edc46d53e62732e7ccd06f329">ARROW_PREDICT_TRUE</a>(!PyErr_Occurred())) {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#a5c0b0031db6eeec3dcc70485d24cfe03">Status::OK</a>();</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">return</span> <a class="code" href="namespacearrow_1_1py.html#a3e3b2a009ad096bb408386d7f36c679f">ConvertPyError</a>(code);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  }</div><div class="line"><a name= "l00048"></a><span class="lineno"> 48</span> }</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> ARROW_EXPORT <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1py.html#a420f8c193475027edf8f2fb07cb6274f">PassPyError</a>();</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// TODO(wesm): We can just let errors pass through. To be explored later</span></div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="arrow_2python_2common_8h.html#ad99052ac0ced9d8a858bd49d5bfd2ebd"> 53</a></span> <span class="preprocessor">#define RETURN_IF_PYERROR() ARROW_RETURN_NOT_OK(CheckPyError());</span></div><div class="line"><a name="l00054"></a><span class="l ineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="arrow_2python_2common_8h.html#acae7d13f31abc214abe5d1e7c901b72f"> 55</a></span> <span class="preprocessor">#define PY_RETURN_IF_ERROR(CODE) ARROW_RETURN_NOT_OK(CheckPyError(CODE));</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html"> 57</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html">PyAcquireGIL</a> {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html#a176ad0a1d753c1e1297a8c8c8e24edfc"> 59</a></span>  <a class= "code" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html#a176ad0a1d753c1e1297a8c8c8e24edfc">PyAcquireGIL</a>() : acquired_gil_(false) { acquire(); }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html#aa07961f7d96ca5dd17319aa4fb65facc"> 61</a></span>  <a class="code" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html#aa07961f7d96ca5dd17319aa4fb65facc">~PyAcquireGIL</a>() { release(); }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html#a705f95bb8ae5f01b9c6615ef3694aef4"> 63</a></span>  <span class="keywordtype">void</span> <a class="code" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html#a705f95bb8ae5f01b9c6615ef3694aef4">acquire</a>() {</div><div clas s="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">if</span> (!acquired_gil_) {</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  state_ = PyGILState_Ensure();</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  acquired_gil_ = <span class="keyword">true</span>;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  }</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  }</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// idempotent</span></div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html#a9b0f2a430dac36520aeedd344d21fb3f"> 71</a></span>  <span class="keywordtype">void</s pan> <a class="code" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html#a9b0f2a430dac36520aeedd344d21fb3f">release</a>() {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">if</span> (acquired_gil_) {</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  PyGILState_Release(state_);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  acquired_gil_ = <span class="keyword">false</span>;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  }</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  }</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span clas s="keywordtype">bool</span> acquired_gil_;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  PyGILState_STATE state_;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="arrow_2util_2macros_8h.html#a40d72e185b1488b5659b761f0b6115bb">ARROW_DISALLOW_COPY_AND_ASSIGN</a>(<a class="code" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html">PyAcquireGIL</a>);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> };</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="arrow_2python_2common_8h.html#a3736d68f2c04b7b41de8a06fb198b577"> 84</a></span> <span class="preprocessor">#define PYARROW_IS_PY2 PY_MAJOR_VERSION <= 2</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a> <span class="lineno"> 86</span> <span class="comment">// A RAII primitive that DECREFs the underlying PyObject* when it</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">// goes out of scope.</span></div><div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html"> 88</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a> {</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#a23c568f39cefb24111a5b126342907fb"> 90</a></span>  <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#a23c568f39cefb24111a5b126342907fb">OwnedRef</a>() : obj_(<a class="code" href="arrow_2util_2macros_8 h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a>) {}</div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#abbf808f76a630e08324908ff8f0164a1"> 91</a></span>  <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#abbf808f76a630e08324908ff8f0164a1">OwnedRef</a>(<a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a>&& other) : <a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a>(other.detach()) {}</div><div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#a4fa414445a0d45fc6876e22a48323818"> 92</a></span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#a4fa414445a0d45fc6876e22a48323818">OwnedRef</a>(<a class="code" href="serialize_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj) : obj_(obj) {}</div><div class="line"><a name="l0 0093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#ac532ea6b2a2ef8f021f1bd195830df69"> 94</a></span>  <a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a>& <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#ac532ea6b2a2ef8f021f1bd195830df69">operator=</a>(<a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a>&& other) {</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  obj_ = other.<a class="code" href="classarrow_1_1py_1_1_owned_ref.html#acec5dc3d562adf45d8df3a5d74cc105b">detach</a>();</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  }</div><div class="line"><a name="l 00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#a8dbf530a3d56e9cc8be52ee72de0a2f8"> 99</a></span>  <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#a8dbf530a3d56e9cc8be52ee72de0a2f8">~OwnedRef</a>() { reset(); }</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#ad99c47163961c1b346c3ea9836783eda"> 101</a></span>  <span class="keywordtype">void</span> <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#ad99c47163961c1b346c3ea9836783eda">reset</a>(<a class="code" href="serialize_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj) {</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  Py_XDECREF(obj_);</div><div class="line"><a name="l0 0103"></a><span class="lineno"> 103</span>  obj_ = obj;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  }</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#a7f4ec7d4b8ed3a376739239dd1e1987b"> 106</a></span>  <span class="keywordtype">void</span> <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#a7f4ec7d4b8ed3a376739239dd1e1987b">reset</a>() { <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#a7f4ec7d4b8ed3a376739239dd1e1987b">reset</a>(<a class="code" href="arrow_2util_2macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a>); }</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#acec5dc3d562adf45d8df3a 5d74cc105b"> 108</a></span>  <a class="code" href="serialize_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#acec5dc3d562adf45d8df3a5d74cc105b">detach</a>() {</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <a class="code" href="serialize_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* result = obj_;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  obj_ = <a class="code" href="arrow_2util_2macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a>;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordflow">return</span> result;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  }</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00114"></a><span class="lineno"><a class=" line" href="classarrow_1_1py_1_1_owned_ref.html#ac9d1b421eef89af1daff63c14fe828d2"> 114</a></span>  <a class="code" href="serialize_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#ac9d1b421eef89af1daff63c14fe828d2">obj</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> obj_; }</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#a4f277e7908da30c544136911ddd5e11e"> 116</a></span>  <a class="code" href="serialize_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>** <a class="code" href="classarrow_1_1py_1_1_owned_ref.html#a4f277e7908da30c544136911ddd5e11e">ref</a>() { <span class="keywordflow">return</span> &obj_; }</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class ="line"><a name="l00118"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref.html#aab08c8f7391e16952029b7741d47d803"> 118</a></span>  <span class="keyword">operator</span> bool()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> obj_ != <a class="code" href="arrow_2util_2macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a>; }</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <a class="code" href="arrow_2util_2macros_8h.html#a40d72e185b1488b5659b761f0b6115bb">ARROW_DISALLOW_COPY_AND_ASSIGN</a>(<a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a>);</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name= "l00123"></a><span class="lineno"> 123</span>  <a class="code" href="serialize_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj_;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> };</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment">// Same as OwnedRef, but ensures the GIL is taken when it goes out of scope.</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment">// This is for situations where the GIL is not always known to be held</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment">// (e.g. if it is released in the middle of a function for performance reasons)</span></div><div class="line"><a name="l00129"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ ref_no_g_i_l.html"> 129</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html">OwnedRefNoGIL</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a> {</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00131"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html#ad0dd0d09fc802fc0dd21718fd827b713"> 131</a></span>  <a class="code" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html#ad0dd0d09fc802fc0dd21718fd827b713">OwnedRefNoGIL</a>() : <a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a>() {}</div><div class="line"><a name="l00132"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html#a0087f6a81e7e6a5b0176494c47607138"> 132</a></span>  <a cla ss="code" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html#a0087f6a81e7e6a5b0176494c47607138">OwnedRefNoGIL</a>(<a class="code" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html">OwnedRefNoGIL</a>&& other) : <a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a>(other.detach()) {}</div><div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html#a27fb138ed68d2ff91fddff0842d923b9"> 133</a></span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html#a27fb138ed68d2ff91fddff0842d923b9">OwnedRefNoGIL</a>(<a class="code" href="serialize_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj) : <a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a>(obj) {}</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div><div class="line"><a name="l00135"></a><span class="lineno"><a class="lin e" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html#ae0943d984c8e64c5609793c149d9a5bc"> 135</a></span>  <a class="code" href="classarrow_1_1py_1_1_owned_ref_no_g_i_l.html#ae0943d984c8e64c5609793c149d9a5bc">~OwnedRefNoGIL</a>() {</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <a class="code" href="classarrow_1_1py_1_1_py_acquire_g_i_l.html">PyAcquireGIL</a> lock;</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  reset();</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  }</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> };</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment">// A temporary conversion of a Python object to a bytes area.</span></div><div class="line"><a name="l00142"></a><span class= "lineno"><a class="line" href="structarrow_1_1py_1_1_py_bytes_view.html"> 142</a></span> <span class="keyword">struct </span><a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html">PyBytesView</a> {</div><div class="line"><a name="l00143"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_py_bytes_view.html#a6dcfada3d934979b6ebac34ccd8f3336"> 143</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a6dcfada3d934979b6ebac34ccd8f3336">bytes</a>;</div><div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_py_bytes_view.html#a2abfcac41c6d2157869190773ab54ddc"> 144</a></span>  Py_ssize_t <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a2abfcac41c6d2157869190773ab54ddc">size</a>;</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div><div class="line">< a name="l00146"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_py_bytes_view.html#a9a0bd5cc89fabd0a2ac819411db7847f"> 146</a></span>  <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a9a0bd5cc89fabd0a2ac819411db7847f">PyBytesView</a>() : <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a6dcfada3d934979b6ebac34ccd8f3336">bytes</a>(<a class="code" href="arrow_2util_2macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a>), <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a2abfcac41c6d2157869190773ab54ddc">size</a>(0), <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a766c1f311246f552e6d90884dd0804d2">ref</a>(<a class="code" href="arrow_2util_2macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a>) {}</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="comment"> // View the given Python object as binary-like, i.e. bytes</span></div><div class="line"><a name="l00149"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_py_bytes_view.html#af8a34ca8430d0b7f42b330d50620c725"> 149</a></span>  <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#af8a34ca8430d0b7f42b330d50620c725">FromBinary</a>(<a class="code" href="serialize_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj) { <span class="keywordflow">return</span> <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#af8a34ca8430d0b7f42b330d50620c725">FromBinary</a>(obj, <span class="stringliteral">"a bytes object"</span>); }</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div><div class="line"><a name="l00151"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_py_bytes_view.html#ad76516b29a48ea1187e59b6777c742d5"> 1 51</a></span>  <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#ad76516b29a48ea1187e59b6777c742d5">FromString</a>(<a class="code" href="serialize_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj) {</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keywordtype">bool</span> ignored = <span class="keyword">false</span>;</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordflow">return</span> <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#ad76516b29a48ea1187e59b6777c742d5">FromString</a>(obj, <span class="keyword">false</span>, &ignored);</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  }</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00156"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_py_bytes_view.html#a1546e527d918a778676a5a3c25619f9b"> 156</a></span>  <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a1546e527d918a778676a5a3c25619f9b">FromString</a>(<a class="code" href="serialize_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj, <span class="keywordtype">bool</span>* is_utf8) {</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keywordflow">return</span> <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#ad76516b29a48ea1187e59b6777c742d5">FromString</a>(obj, <span class="keyword">true</span>, is_utf8);</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  }</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> </div><div class="line"><a name="l00160"></a><span class="lineno"><a class="line" href="structarrow_ 1_1py_1_1_py_bytes_view.html#ae3f7dbace202034b091360e0a2fdde06"> 160</a></span>  <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#ae3f7dbace202034b091360e0a2fdde06">FromUnicode</a>(<a class="code" href="serialize_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj) {</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="preprocessor">#if PY_MAJOR_VERSION >= 3</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  Py_ssize_t <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a2abfcac41c6d2157869190773ab54ddc">size</a>;</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="comment">// The utf-8 representation is cached on the unicode object</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keyword">c onst</span> <span class="keywordtype">char</span>* data = PyUnicode_AsUTF8AndSize(obj, &<a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a2abfcac41c6d2157869190773ab54ddc">size</a>);</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <a class="code" href="arrow_2python_2common_8h.html#ad99052ac0ced9d8a858bd49d5bfd2ebd">RETURN_IF_PYERROR</a>();</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  this->bytes = data;</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  this->size = <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a2abfcac41c6d2157869190773ab54ddc">size</a>;</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  this-><a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a766c1f311246f552e6d90884dd0804d2">ref</a>.<a class="code" href="classarrow_1_1py_1_1_owned_ref.html#ad99c47163961c1b 346c3ea9836783eda">reset</a>();</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <a class="code" href="serialize_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* converted = PyUnicode_AsUTF8String(obj);</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <a class="code" href="arrow_2python_2common_8h.html#ad99052ac0ced9d8a858bd49d5bfd2ebd">RETURN_IF_PYERROR</a>();</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  this->bytes = PyBytes_AS_STRING(converted);</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  this->size = PyBytes_GET_SIZE(converted);</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  this-><a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a 766c1f311246f552e6d90884dd0804d2">ref</a>.<a class="code" href="classarrow_1_1py_1_1_owned_ref.html#ad99c47163961c1b346c3ea9836783eda">reset</a>(converted);</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#a5c0b0031db6eeec3dcc70485d24cfe03">Status::OK</a>();</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  }</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> </div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00180"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_py_bytes_view.html#a96cb35199dff8192a165ca1952062364"> 180</a></span>  <a cl ass="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a96cb35199dff8192a165ca1952062364">PyBytesView</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* b, Py_ssize_t s, <a class="code" href="serialize_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj = <a class="code" href="arrow_2util_2macros_8h.html#a3ef7eab8cd0e570b6586628cc9d5ccab">NULLPTR</a>)</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  : <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a6dcfada3d934979b6ebac34ccd8f3336">bytes</a>(b), <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a2abfcac41c6d2157869190773ab54ddc">size</a>(s), <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a766c1f311246f552e6d90884dd0804d2">ref</a>(obj) {}</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> </div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span c lass="comment">// View the given Python object as string-like, i.e. str or (utf8) bytes</span></div><div class="line"><a name="l00184"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_py_bytes_view.html#a0f27c4778684e07ecc6fef905db6000b"> 184</a></span>  <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a0f27c4778684e07ecc6fef905db6000b">FromString</a>(<a class="code" href="serialize_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj, <span class="keywordtype">bool</span> check_utf8, <span class="keywordtype">bool</span>* is_utf8) {</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="keywordflow">if</span> (PyUnicode_Check(obj)) {</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  *is_utf8 = <span class="keyword">true</span>;</div><div class="line"><a name="l00187"></a><span class="lineno" > 187</span>  <span class="keywordflow">return</span> <a > class="code" > href="structarrow_1_1py_1_1_py_bytes_view.html#ae3f7dbace202034b091360e0a2fdde06">FromUnicode</a>(obj);</div><div > class="line"><a name="l00188"></a><span class="lineno"> 188</span>  > } <span class="keywordflow">else</span> {</div><div class="line"><a > name="l00189"></a><span class="lineno"> 189</span>  <a > class="code" > href="arrow_2status_8h.html#a3d2fb237e60e56c4ce9e342e219219ee">ARROW_RETURN_NOT_OK</a>(<a > class="code" > href="structarrow_1_1py_1_1_py_bytes_view.html#af8a34ca8430d0b7f42b330d50620c725">FromBinary</a>(obj, > <span class="stringliteral">"a string or bytes > object"</span>));</div><div class="line"><a name="l00190"></a><span > class="lineno"> 190</span>  <span class="keywordflow">if</span> > (check_utf8) {</div><div class="line"><a name="l00191"></a><span > class="lineno"> 191</span>  <span class="comment">// Check the > bytes are utf8 utf-8</span></div ><div class="line"><a name="l00192"></a><span class="lineno"> >192</span>  <a class="code" >href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a> >decoded(PyUnicode_FromStringAndSize(<a class="code" >href="structarrow_1_1py_1_1_py_bytes_view.html#a6dcfada3d934979b6ebac34ccd8f3336">bytes</a>, > <a class="code" >href="structarrow_1_1py_1_1_py_bytes_view.html#a2abfcac41c6d2157869190773ab54ddc">size</a>));</div><div > class="line"><a name="l00193"></a><span class="lineno"> 193</span>  > <span class="keywordflow">if</span> (<a class="code" >href="arrow_2util_2macros_8h.html#a1f418a9edc46d53e62732e7ccd06f329">ARROW_PREDICT_TRUE</a>(!PyErr_Occurred())) > {</div><div class="line"><a name="l00194"></a><span class="lineno"> >194</span>  *is_utf8 = <span >class="keyword">true</span>;</div><div class="line"><a >name="l00195"></a><span class="lineno"> 195</span>  } <span >class="keywordflow">else</span> {</div><div class="line"><a >name="l00196"></a><span cla ss="lineno"> 196</span>  *is_utf8 = <span class="keyword">false</span>;</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  PyErr_Clear();</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  }</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  *is_utf8 = <span class="keyword">false</span>;</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  }</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#a5c0b0031db6eeec3dcc70485d24cfe03">Status::OK</a>();</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  }</div><div class="line"><a nam e="l00204"></a><span class="lineno"> 204</span>  }</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> </div><div class="line"><a name="l00206"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_py_bytes_view.html#a830036d48822762433dc503512ef2204"> 206</a></span>  <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a830036d48822762433dc503512ef2204">FromBinary</a>(<a class="code" href="serialize_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj, <span class="keyword">const</span> <span class="keywordtype">char</span>* expected_msg) {</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keywordflow">if</span> (PyBytes_Check(obj)) {</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  this->bytes = PyBytes_AS_STRING(obj);</div><div class="line"><a name="l0 0209"></a><span class="lineno"> 209</span>  this->size = PyBytes_GET_SIZE(obj);</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  this-><a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a766c1f311246f552e6d90884dd0804d2">ref</a>.<a class="code" href="classarrow_1_1py_1_1_owned_ref.html#ad99c47163961c1b346c3ea9836783eda">reset</a>();</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#a5c0b0031db6eeec3dcc70485d24cfe03">Status::OK</a>();</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (PyByteArray_Check(obj)) {</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  this->bytes = PyByteArray_AS_STRING(obj);</div><div class="line"><a name="l00214 "></a><span class="lineno"> 214</span>  this->size = PyByteArray_GET_SIZE(obj);</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  this-><a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a766c1f311246f552e6d90884dd0804d2">ref</a>.<a class="code" href="classarrow_1_1py_1_1_owned_ref.html#ad99c47163961c1b346c3ea9836783eda">reset</a>();</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#a5c0b0031db6eeec3dcc70485d24cfe03">Status::OK</a>();</div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  std::stringstream ss;</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  ss << <span class="stringli teral">"Expected "</span> << expected_msg << <span class="stringliteral">", got a '"</span> << Py_TYPE(obj)->tp_name</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  << <span class="stringliteral">"' object"</span>;</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#ac618ef5553ac7bd7243461fe3418ce8a">Status::TypeError</a>(ss.str());</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  }</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  }</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> </div><div class="line"><a name="l00225"></a><span class="lineno"><a class="line" href="structarrow_1_1py_1_1_py_bytes_view.html#a766c1f311246f552e6d90884dd0804d2"> 22 5</a></span>  <a class="code" href="classarrow_1_1py_1_1_owned_ref.html">OwnedRef</a> <a class="code" href="structarrow_1_1py_1_1_py_bytes_view.html#a766c1f311246f552e6d90884dd0804d2">ref</a>;</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> };</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> </div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment">// Return the common PyArrow memory pool</span></div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> ARROW_EXPORT <span class="keywordtype">void</span> <a class="code" href="namespacearrow_1_1py.html#a1c820dd57e25e43fbdfc3accd252efc4">set_default_memory_pool</a>(<a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool);</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> ARROW_EXPORT <a class="code" href="classarrow_1_1_memory_pool.html">M emoryPool</a>* <a class="code" href="namespacearrow_1_1py.html#a695a28adb44e701429087896352e4a07">get_memory_pool</a>();</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> </div><div class="line"><a name="l00232"></a><span class="lineno"><a class="line" href="classarrow_1_1py_1_1_py_buffer.html"> 232</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1py_1_1_py_buffer.html">PyBuffer</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1_buffer.html">Buffer</a> {</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  ~<a class="code" href="classarrow_1_1py_1_1_py_buffer.html">PyBuffer</a>();</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> </div><div class="line"><a name="l00238"></a><span class="li neno"> 238</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> FromPyObject(<a class="code" href="serialize_8h.html#ae19630c1f4ca6d5236b30719d9140013">PyObject</a>* obj, std::shared_ptr<Buffer>* out);</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> </div><div clas <TRUNCATED>
