This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-nanoarrow.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 98e2af4a update documentation for tag main
98e2af4a is described below
commit 98e2af4aba7b5dd06c98066b931d75207cc7f237
Author: GitHub Actions <[email protected]>
AuthorDate: Thu Oct 23 21:01:08 2025 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1165604 -> 1165604
bytes
main/r/pkgdown.yml | 2 +-
.../as_nanoarrow_schema.python.builtin.object.html | 141 +++++++++++++++++++++
main/r/reference/index.html | 6 +
main/r/search.json | 2 +-
main/r/sitemap.xml | 1 +
6 files changed, 150 insertions(+), 2 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index 2193c1af..f548adb5 100644
Binary files a/main/.doctrees/environment.pickle and
b/main/.doctrees/environment.pickle differ
diff --git a/main/r/pkgdown.yml b/main/r/pkgdown.yml
index 08891574..9ca43cf5 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,4 +2,4 @@ pandoc: 3.1.3
pkgdown: 2.1.3
pkgdown_sha: ~
articles: {}
-last_built: 2025-10-22T02:17Z
+last_built: 2025-10-23T21:00Z
diff --git a/main/r/reference/as_nanoarrow_schema.python.builtin.object.html
b/main/r/reference/as_nanoarrow_schema.python.builtin.object.html
new file mode 100644
index 00000000..fa0c54bf
--- /dev/null
+++ b/main/r/reference/as_nanoarrow_schema.python.builtin.object.html
@@ -0,0 +1,141 @@
+<!DOCTYPE html>
+<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta
http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta
charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta
name="viewport" content="width=device-width, initial-scale=1,
shrink-to-fit=no"><title>Python integration via reticulate —
as_nanoarrow_schema.python.builtin.object • nanoarrow</title><script
src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport"
co [...]
+be used with any function that uses as_nanoarrow_array() or
+as_nanoarrow_array_stream() to accept generic "arrowable" input.
+Implementations for reticulate::py_to_r() and reticulate::r_to_py()
+are also included such that nanoarrow's array/schema/array stream objects
+can be passed as arguments to Python functions that would otherwise accept
+an object implementing the Arrow PyCapsule protocol."><meta
property="og:description" content="These functions enable Python wrapper
objects created via reticulate to
+be used with any function that uses as_nanoarrow_array() or
+as_nanoarrow_array_stream() to accept generic "arrowable" input.
+Implementations for reticulate::py_to_r() and reticulate::r_to_py()
+are also included such that nanoarrow's array/schema/array stream objects
+can be passed as arguments to Python functions that would otherwise accept
+an object implementing the Arrow PyCapsule protocol."></head><body>
+ <a href="#main" class="visually-hidden-focusable">Skip to contents</a>
+
+
+ <nav class="navbar navbar-expand-lg fixed-top bg-light"
data-bs-theme="light" aria-label="Site navigation"><div class="container">
+
+ <a class="navbar-brand me-2" href="../index.html">nanoarrow</a>
+
+ <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip"
data-bs-placement="bottom" title="">0.7.0.9000</small>
+
+
+ <button class="navbar-toggler" type="button" data-bs-toggle="collapse"
data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false"
aria-label="Toggle navigation">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+
+ <div id="navbar" class="collapse navbar-collapse ms-3">
+ <ul class="navbar-nav me-auto"><li class="active nav-item"><a
class="nav-link" href="../reference/index.html">Reference</a></li>
+<li class="nav-item"><a class="nav-link"
href="../news/index.html">Changelog</a></li>
+ </ul><ul class="navbar-nav"><li class="nav-item"><form
class="form-inline" role="search">
+ <input class="form-control" type="search" name="search-input"
id="search-input" autocomplete="off" aria-label="Search site"
placeholder="Search for" data-search-index="../search.json"></form></li>
+<li class="nav-item"><a class="external-link nav-link"
href="https://github.com/apache/arrow-nanoarrow/"; aria-label="GitHub"><span
class="fa fab fa-github fa-lg"></span></a></li>
+ </ul></div>
+
+
+ </div>
+</nav><div class="container template-reference-topic">
+<div class="row">
+ <main id="main" class="col-md-9"><div class="page-header">
+
+ <h1>Python integration via reticulate</h1>
+ <small class="dont-index">Source: <a
href="https://github.com/apache/arrow-nanoarrow/blob/main/r/R/pkg-reticulate.R";
class="external-link"><code>R/pkg-reticulate.R</code></a></small>
+ <div class="d-none
name"><code>as_nanoarrow_schema.python.builtin.object.Rd</code></div>
+ </div>
+
+ <div class="ref-description section level2">
+ <p>These functions enable Python wrapper objects created via reticulate to
+be used with any function that uses <code><a
href="as_nanoarrow_array.html">as_nanoarrow_array()</a></code> or
+<code><a
href="as_nanoarrow_array_stream.html">as_nanoarrow_array_stream()</a></code> to
accept generic "arrowable" input.
+Implementations for <code>reticulate::py_to_r()</code> and
<code>reticulate::r_to_py()</code>
+are also included such that nanoarrow's array/schema/array stream objects
+can be passed as arguments to Python functions that would otherwise accept
+an object implementing the Arrow PyCapsule protocol.</p>
+ </div>
+
+ <div class="section level2">
+ <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor"
href="#ref-usage"></a></h2>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span><span
class="co"># S3 method for class 'python.builtin.object'</span></span>
+<span><span class="fu"><a
href="as_nanoarrow_schema.html">as_nanoarrow_schema</a></span><span
class="op">(</span><span class="va">x</span>, <span class="va">...</span><span
class="op">)</span></span>
+<span></span>
+<span><span class="co"># S3 method for class
'python.builtin.object'</span></span>
+<span><span class="fu"><a
href="as_nanoarrow_array.html">as_nanoarrow_array</a></span><span
class="op">(</span><span class="va">x</span>, <span class="va">...</span>,
schema <span class="op">=</span> <span class="cn">NULL</span><span
class="op">)</span></span>
+<span></span>
+<span><span class="co"># S3 method for class
'python.builtin.object'</span></span>
+<span><span class="fu"><a
href="as_nanoarrow_array_stream.html">as_nanoarrow_array_stream</a></span><span
class="op">(</span><span class="va">x</span>, <span class="va">...</span>,
schema <span class="op">=</span> <span class="cn">NULL</span><span
class="op">)</span></span>
+<span></span>
+<span><span class="fu">test_reticulate_with_nanoarrow</span><span
class="op">(</span><span class="op">)</span></span></code></pre></div>
+ </div>
+
+ <div class="section level2">
+ <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor"
href="#arguments"></a></h2>
+
+
+<dl><dt id="arg-x">x<a class="anchor" aria-label="anchor"
href="#arg-x"></a></dt>
+<dd><p>An Python object to convert</p></dd>
+
+
+<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
+<dd><p>Unused</p></dd>
+
+
+<dt id="arg-schema">schema<a class="anchor" aria-label="anchor"
href="#arg-schema"></a></dt>
+<dd><p>A requested schema, which may or may not be honoured depending
+on the capabilities of the producer</p></dd>
+
+</dl></div>
+ <div class="section level2">
+ <h2 id="value">Value<a class="anchor" aria-label="anchor"
href="#value"></a></h2>
+
+<ul><li><p><code><a
href="as_nanoarrow_schema.html">as_nanoarrow_schema()</a></code> returns an
object of class nanoarrow_schema</p></li>
+<li><p><code><a href="as_nanoarrow_array.html">as_nanoarrow_array()</a></code>
returns an object of class nanoarrow_array</p></li>
+<li><p><code><a
href="as_nanoarrow_array_stream.html">as_nanoarrow_array_stream()</a></code>
returns an object of class
+nanoarrow_array_stream.</p></li>
+</ul></div>
+ <div class="section level2">
+ <h2 id="details">Details<a class="anchor" aria-label="anchor"
href="#details"></a></h2>
+ <p>This implementation uses the
+<a
href="https://arrow.apache.org/docs/format/CDataInterface/PyCapsuleInterface.html";
class="external-link">Arrow PyCapsule protocol</a>
+to interpret an arbitrary Python object as an Arrow array/schema/array stream
+and produces Python objects that implement this protocol. This is currently
+implemented using the nanoarrow Python package which provides similar
+primitives for facilitating interchange in Python.</p>
+ </div>
+
+ <div class="section level2">
+ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor"
href="#ref-examples"></a></h2>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span
class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span
class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span>
<span class="co"># test_reticulate_with_nanoarrow()</span></span></span>
+<span class="r-in"><span><span class="kw"><a
href="https://rdrr.io/r/base/library.html";
class="external-link">library</a></span><span class="op">(</span><span
class="va"><a href="https://rstudio.github.io/reticulate/";
class="external-link">reticulate</a></span><span
class="op">)</span></span></span>
+<span class="r-in"><span></span></span>
+<span class="r-in"><span><span class="fu">py_require</span><span
class="op">(</span><span class="st">"nanoarrow"</span><span
class="op">)</span></span></span>
+<span class="r-in"><span></span></span>
+<span class="r-in"><span><span class="va">na</span> <span
class="op"><-</span> <span class="fu">import</span><span
class="op">(</span><span class="st">"nanoarrow"</span>, convert <span
class="op">=</span> <span class="cn">FALSE</span><span
class="op">)</span></span></span>
+<span class="r-in"><span><span class="va">python_arrayish_thing</span> <span
class="op"><-</span> <span class="va">na</span><span
class="op">$</span><span class="fu">Array</span><span class="op">(</span><span
class="fl">1</span><span class="op">:</span><span class="fl">3</span>, <span
class="fu"><a href="na_type.html">na_int32</a></span><span
class="op">(</span><span class="op">)</span><span
class="op">)</span></span></span>
+<span class="r-in"><span><span class="fu"><a
href="as_nanoarrow_array.html">as_nanoarrow_array</a></span><span
class="op">(</span><span class="va">python_arrayish_thing</span><span
class="op">)</span></span></span>
+<span class="r-in"><span></span></span>
+<span class="r-in"><span><span class="fu">r_to_py</span><span
class="op">(</span><span class="fu"><a
href="as_nanoarrow_array.html">as_nanoarrow_array</a></span><span
class="op">(</span><span class="fl">1</span><span class="op">:</span><span
class="fl">3</span><span class="op">)</span><span
class="op">)</span></span></span>
+<span class="r-in"><span><span class="op">}</span></span></span>
+</code></pre></div>
+ </div>
+ </main><aside class="col-md-3"><nav id="toc" aria-label="Table of
contents"><h2>On this page</h2>
+ </nav></aside></div>
+
+
+ <footer><div class="pkgdown-footer-left">
+ <p>Developed by Dewey Dunnington, Apache Arrow.</p>
+</div>
+
+<div class="pkgdown-footer-right">
+ <p>Site built with <a href="https://pkgdown.r-lib.org/";
class="external-link">pkgdown</a> 2.1.3.</p>
+</div>
+
+ </footer></div>
+
+
+
+
+
+ </body></html>
+
diff --git a/main/r/reference/index.html b/main/r/reference/index.html
index d0539947..cfd2131f 100644
--- a/main/r/reference/index.html
+++ b/main/r/reference/index.html
@@ -74,6 +74,12 @@
<dd>Convert an object to a nanoarrow schema</dd>
</dl><dl><dt>
+ <code><a
href="as_nanoarrow_schema.python.builtin.object.html">as_nanoarrow_schema(<i><python.builtin.object></i>)</a></code>
<code><a
href="as_nanoarrow_schema.python.builtin.object.html">as_nanoarrow_array(<i><python.builtin.object></i>)</a></code>
<code><a
href="as_nanoarrow_schema.python.builtin.object.html">as_nanoarrow_array_stream(<i><python.builtin.object></i>)</a></code>
<code><a
href="as_nanoarrow_schema.python.builtin.object.html">test_reticulate_wi [...]
+
+ </dt>
+ <dd>Python integration via reticulate</dd>
+ </dl><dl><dt>
+
<code><a
href="as_nanoarrow_vctr.html">as_nanoarrow_vctr()</a></code> <code><a
href="as_nanoarrow_vctr.html">nanoarrow_vctr()</a></code>
</dt>
diff --git a/main/r/search.json b/main/r/search.json
index 462a1162..36b92cf5 100644
--- a/main/r/search.json
+++ b/main/r/search.json
@@ -1 +1 @@
-[{"path":"/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"Apache
License","title":"Apache License","text":"Version 2.0, January 2004
<http://www.apache.org/licenses/>","code":""},{"path":[]},{"path":"/LICENSE.html","id":"id_1-definitions","dir":"","previous_headings":"Terms
and Conditions for use, reproduction, and distribution","what":"1.
Definitions","title":"Apache License","text":"“License” shall mean terms
conditions use, reproduction, distribution defined Sections [...]
+[{"path":"/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"Apache
License","title":"Apache License","text":"Version 2.0, January 2004
<http://www.apache.org/licenses/>","code":""},{"path":[]},{"path":"/LICENSE.html","id":"id_1-definitions","dir":"","previous_headings":"Terms
and Conditions for use, reproduction, and distribution","what":"1.
Definitions","title":"Apache License","text":"“License” shall mean terms
conditions use, reproduction, distribution defined Sections [...]
diff --git a/main/r/sitemap.xml b/main/r/sitemap.xml
index 9eb3df20..956fa30a 100644
--- a/main/r/sitemap.xml
+++ b/main/r/sitemap.xml
@@ -9,6 +9,7 @@
<url><loc>/reference/as_nanoarrow_array_stream.html</loc></url>
<url><loc>/reference/as_nanoarrow_buffer.html</loc></url>
<url><loc>/reference/as_nanoarrow_schema.html</loc></url>
+<url><loc>/reference/as_nanoarrow_schema.python.builtin.object.html</loc></url>
<url><loc>/reference/as_nanoarrow_vctr.html</loc></url>
<url><loc>/reference/basic_array_stream.html</loc></url>
<url><loc>/reference/convert_array.html</loc></url>
