wjones127 commented on code in PR #37797: URL: https://github.com/apache/arrow/pull/37797#discussion_r1339051424
########## docs/source/format/CDataInterface/PyCapsuleInterface.rst: ########## @@ -0,0 +1,238 @@ +.. 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. + + +============================= +The Arrow PyCapsule Interface +============================= + +Rationale +========= + +The :ref:`C data interface <c-data-interface>` and +:ref:`C stream interface <c-stream-interface>` allow moving Arrow data between +different implementations of Arrow. However, these interfaces don't specify how +Python libraries should expose these structs to other libraries. Prior to this, +many libraries simply provided export to PyArrow data structures, using the +``_import_from_c`` and ``_export_from_c`` methods. However, this always required +PyArrow to be installed. + +This interface allows any library to export Arrow data structures to other +libraries that understand the same protocol. + +Goals +----- + +* Standardize the PyCapsule objects that represent ``ArrowSchema``, ``ArrowArray``, + and ``ArrowArrayStream``. +* Define standard methods to get these PyCapsules, so any Python objects that + support export via Arrow can be recognized by other libraries. + + +Non-goals +--------- + +* Standardizing what public APIs should be used for import. This is left up to + individual libraries. + + +Comparison to DataFrame Interchange Protocol +-------------------------------------------- + +:doc:`DataFrame Interchange Protocol <../dataframe.html>` is another protocol Review Comment: I've updated the link to that page. Used a `:doc:` directive instead though. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
