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 670a6a48 update documentation for tag main
670a6a48 is described below
commit 670a6a48cdfe9941e5cc95a0a42d02c8db389f4f
Author: GitHub Actions <[email protected]>
AuthorDate: Wed Feb 26 21:11:36 2025 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1555621 -> 1555974
bytes
main/.doctrees/getting-started/cpp.doctree | Bin 62113 -> 62097 bytes
main/.doctrees/getting-started/index.doctree | Bin 5650 -> 5650 bytes
main/.doctrees/getting-started/python.doctree | Bin 37064 -> 37048 bytes
main/.doctrees/getting-started/r.doctree | Bin 27702 -> 27686 bytes
main/.doctrees/index.doctree | Bin 31043 -> 31043 bytes
main/.doctrees/reference/c.doctree | Bin 1194153 -> 1195551
bytes
main/.doctrees/reference/cpp.doctree | Bin 140789 -> 140912 bytes
main/.doctrees/reference/device.doctree | Bin 283072 -> 283492 bytes
main/.doctrees/reference/index.doctree | Bin 5872 -> 5872 bytes
main/.doctrees/reference/ipc.doctree | Bin 430909 -> 431497 bytes
main/.doctrees/reference/python/advanced.doctree | Bin 101648 -> 102599 bytes
.../reference/python/array-stream.doctree | Bin 45324 -> 45864 bytes
main/.doctrees/reference/python/array.doctree | Bin 91080 -> 92221 bytes
main/.doctrees/reference/python/index.doctree | Bin 7066 -> 7066 bytes
main/.doctrees/reference/python/schema.doctree | Bin 313989 -> 314033 bytes
main/.doctrees/reference/r.doctree | Bin 5603 -> 5587 bytes
main/.doctrees/reference/testing.doctree | Bin 160864 -> 161101 bytes
main/.doctrees/roadmap.doctree | Bin 24233 -> 24217 bytes
main/_static/basic.css | 8 ---
main/_static/searchtools.js | 13 +++--
main/genindex.html | 2 +-
main/getting-started/cpp.html | 2 +-
main/getting-started/index.html | 2 +-
main/getting-started/python.html | 2 +-
main/getting-started/r.html | 2 +-
main/index.html | 2 +-
main/py-modindex.html | 2 +-
main/r/deps/bootstrap-5.3.1/bootstrap.min.css | 2 +-
main/r/pkgdown.yml | 2 +-
main/reference/c.html | 2 +-
main/reference/cpp.html | 2 +-
main/reference/device.html | 2 +-
main/reference/index.html | 2 +-
main/reference/ipc.html | 2 +-
main/reference/python/advanced.html | 18 +++----
main/reference/python/array-stream.html | 12 ++---
main/reference/python/array.html | 24 ++++-----
main/reference/python/index.html | 2 +-
main/reference/python/schema.html | 54 ++++++++++-----------
main/reference/r.html | 2 +-
main/reference/testing.html | 2 +-
main/roadmap.html | 2 +-
main/search.html | 2 +-
main/searchindex.js | 2 +-
45 files changed, 82 insertions(+), 87 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index d9d8635b..dd5425fc 100644
Binary files a/main/.doctrees/environment.pickle and
b/main/.doctrees/environment.pickle differ
diff --git a/main/.doctrees/getting-started/cpp.doctree
b/main/.doctrees/getting-started/cpp.doctree
index 0768bb43..66cffee6 100644
Binary files a/main/.doctrees/getting-started/cpp.doctree and
b/main/.doctrees/getting-started/cpp.doctree differ
diff --git a/main/.doctrees/getting-started/index.doctree
b/main/.doctrees/getting-started/index.doctree
index 4c85bc6f..2dc6b616 100644
Binary files a/main/.doctrees/getting-started/index.doctree and
b/main/.doctrees/getting-started/index.doctree differ
diff --git a/main/.doctrees/getting-started/python.doctree
b/main/.doctrees/getting-started/python.doctree
index b2855d40..e9b40ab8 100644
Binary files a/main/.doctrees/getting-started/python.doctree and
b/main/.doctrees/getting-started/python.doctree differ
diff --git a/main/.doctrees/getting-started/r.doctree
b/main/.doctrees/getting-started/r.doctree
index 96299435..adc7f93f 100644
Binary files a/main/.doctrees/getting-started/r.doctree and
b/main/.doctrees/getting-started/r.doctree differ
diff --git a/main/.doctrees/index.doctree b/main/.doctrees/index.doctree
index 14df8f62..8ef7371d 100644
Binary files a/main/.doctrees/index.doctree and b/main/.doctrees/index.doctree
differ
diff --git a/main/.doctrees/reference/c.doctree
b/main/.doctrees/reference/c.doctree
index 3d8b2cb9..b1b2e15a 100644
Binary files a/main/.doctrees/reference/c.doctree and
b/main/.doctrees/reference/c.doctree differ
diff --git a/main/.doctrees/reference/cpp.doctree
b/main/.doctrees/reference/cpp.doctree
index 9ddafba8..fd47db74 100644
Binary files a/main/.doctrees/reference/cpp.doctree and
b/main/.doctrees/reference/cpp.doctree differ
diff --git a/main/.doctrees/reference/device.doctree
b/main/.doctrees/reference/device.doctree
index 53b2e879..7ce89895 100644
Binary files a/main/.doctrees/reference/device.doctree and
b/main/.doctrees/reference/device.doctree differ
diff --git a/main/.doctrees/reference/index.doctree
b/main/.doctrees/reference/index.doctree
index 0eb302fd..8f5e3b1e 100644
Binary files a/main/.doctrees/reference/index.doctree and
b/main/.doctrees/reference/index.doctree differ
diff --git a/main/.doctrees/reference/ipc.doctree
b/main/.doctrees/reference/ipc.doctree
index f95e7cb4..46227494 100644
Binary files a/main/.doctrees/reference/ipc.doctree and
b/main/.doctrees/reference/ipc.doctree differ
diff --git a/main/.doctrees/reference/python/advanced.doctree
b/main/.doctrees/reference/python/advanced.doctree
index f1ced9e3..93bcc8b9 100644
Binary files a/main/.doctrees/reference/python/advanced.doctree and
b/main/.doctrees/reference/python/advanced.doctree differ
diff --git a/main/.doctrees/reference/python/array-stream.doctree
b/main/.doctrees/reference/python/array-stream.doctree
index 0f98a1e8..d1f619a5 100644
Binary files a/main/.doctrees/reference/python/array-stream.doctree and
b/main/.doctrees/reference/python/array-stream.doctree differ
diff --git a/main/.doctrees/reference/python/array.doctree
b/main/.doctrees/reference/python/array.doctree
index d2f6952c..b7d71861 100644
Binary files a/main/.doctrees/reference/python/array.doctree and
b/main/.doctrees/reference/python/array.doctree differ
diff --git a/main/.doctrees/reference/python/index.doctree
b/main/.doctrees/reference/python/index.doctree
index 39618fa0..db8a4f7b 100644
Binary files a/main/.doctrees/reference/python/index.doctree and
b/main/.doctrees/reference/python/index.doctree differ
diff --git a/main/.doctrees/reference/python/schema.doctree
b/main/.doctrees/reference/python/schema.doctree
index fa3ac3e8..72266987 100644
Binary files a/main/.doctrees/reference/python/schema.doctree and
b/main/.doctrees/reference/python/schema.doctree differ
diff --git a/main/.doctrees/reference/r.doctree
b/main/.doctrees/reference/r.doctree
index 91f16f1c..9827bbc7 100644
Binary files a/main/.doctrees/reference/r.doctree and
b/main/.doctrees/reference/r.doctree differ
diff --git a/main/.doctrees/reference/testing.doctree
b/main/.doctrees/reference/testing.doctree
index 06127a42..f209ebad 100644
Binary files a/main/.doctrees/reference/testing.doctree and
b/main/.doctrees/reference/testing.doctree differ
diff --git a/main/.doctrees/roadmap.doctree b/main/.doctrees/roadmap.doctree
index 0306732d..3625ffdc 100644
Binary files a/main/.doctrees/roadmap.doctree and
b/main/.doctrees/roadmap.doctree differ
diff --git a/main/_static/basic.css b/main/_static/basic.css
index 7ebbd6d0..4738b2ed 100644
--- a/main/_static/basic.css
+++ b/main/_static/basic.css
@@ -741,14 +741,6 @@ abbr, acronym {
cursor: help;
}
-.translated {
- background-color: rgba(207, 255, 207, 0.2)
-}
-
-.untranslated {
- background-color: rgba(255, 207, 207, 0.2)
-}
-
/* -- code displays ---------------------------------------------------------
*/
pre {
diff --git a/main/_static/searchtools.js b/main/_static/searchtools.js
index 2c774d17..91f4be57 100644
--- a/main/_static/searchtools.js
+++ b/main/_static/searchtools.js
@@ -513,9 +513,11 @@ const Search = {
// perform the search on the required terms
searchTerms.forEach((word) => {
const files = [];
+ // find documents, if any, containing the query word in their text/title
term indices
+ // use Object.hasOwnProperty to avoid mismatching against prototype
properties
const arr = [
- { files: terms[word], score: Scorer.term },
- { files: titleTerms[word], score: Scorer.title },
+ { files: terms.hasOwnProperty(word) ? terms[word] : undefined, score:
Scorer.term },
+ { files: titleTerms.hasOwnProperty(word) ? titleTerms[word] :
undefined, score: Scorer.title },
];
// add support for partial matches
if (word.length > 2) {
@@ -547,8 +549,9 @@ const Search = {
// set score for the word in each file
recordFiles.forEach((file) => {
- if (!scoreMap.has(file)) scoreMap.set(file, {});
- scoreMap.get(file)[word] = record.score;
+ if (!scoreMap.has(file)) scoreMap.set(file, new Map());
+ const fileScores = scoreMap.get(file);
+ fileScores.set(word, record.score);
});
});
@@ -587,7 +590,7 @@ const Search = {
break;
// select one (max) score for the file.
- const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w]));
+ const score = Math.max(...wordList.map((w) =>
scoreMap.get(file).get(w)));
// add result to the result list
results.push([
docNames[file],
diff --git a/main/genindex.html b/main/genindex.html
index 73b077be..449363b6 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -1967,7 +1967,7 @@
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/getting-started/cpp.html b/main/getting-started/cpp.html
index 2d6a632f..e436317c 100644
--- a/main/getting-started/cpp.html
+++ b/main/getting-started/cpp.html
@@ -991,7 +991,7 @@ exposing an Arrow-based API implemented using the nanoarrow
C library.</p>
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/getting-started/index.html b/main/getting-started/index.html
index bcb1c7f6..822a765e 100644
--- a/main/getting-started/index.html
+++ b/main/getting-started/index.html
@@ -499,7 +499,7 @@
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/getting-started/python.html b/main/getting-started/python.html
index 86f9c818..c9c7a122 100644
--- a/main/getting-started/python.html
+++ b/main/getting-started/python.html
@@ -842,7 +842,7 @@ in the working tree.</p>
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/getting-started/r.html b/main/getting-started/r.html
index 13253e73..011d05cc 100644
--- a/main/getting-started/r.html
+++ b/main/getting-started/r.html
@@ -736,7 +736,7 @@ equivalent nanoarrow objects into many arrow functions and
vice versa.</p>
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/index.html b/main/index.html
index 422e2c2a..b30f7d25 100644
--- a/main/index.html
+++ b/main/index.html
@@ -640,7 +640,7 @@ meson<span class="w"> </span><span
class="nb">test</span><span class="w"> </span
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/py-modindex.html b/main/py-modindex.html
index 72a24092..4848e08e 100644
--- a/main/py-modindex.html
+++ b/main/py-modindex.html
@@ -429,7 +429,7 @@
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/r/deps/bootstrap-5.3.1/bootstrap.min.css
b/main/r/deps/bootstrap-5.3.1/bootstrap.min.css
index 5d96aa0d..2ffb9c57 100644
--- a/main/r/deps/bootstrap-5.3.1/bootstrap.min.css
+++ b/main/r/deps/bootstrap-5.3.1/bootstrap.min.css
@@ -2,4 +2,4 @@
* Bootstrap v5.3.1 (https://getbootstrap.com/)
* Copyright 2011-2023 The Bootstrap Authors
* Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)
- */:root,[data-bs-theme="light"]{--bs-blue: #0d6efd;--bs-indigo:
#6610f2;--bs-purple: #6f42c1;--bs-pink: #d63384;--bs-red: #dc3545;--bs-orange:
#fd7e14;--bs-yellow: #ffc107;--bs-green: #198754;--bs-teal: #20c997;--bs-cyan:
#0dcaf0;--bs-black: #000;--bs-white: #fff;--bs-gray: #6c757d;--bs-gray-dark:
#343a40;--bs-gray-100: #f8f9fa;--bs-gray-200: #e9ecef;--bs-gray-300:
#dee2e6;--bs-gray-400: #ced4da;--bs-gray-500: #adb5bd;--bs-gray-600:
#6c757d;--bs-gray-700: #495057;--bs-gray-800: #343a4 [...]
+ */:root,[data-bs-theme="light"]{--bs-blue: #0d6efd;--bs-indigo:
#6610f2;--bs-purple: #6f42c1;--bs-pink: #d63384;--bs-red: #dc3545;--bs-orange:
#fd7e14;--bs-yellow: #ffc107;--bs-green: #198754;--bs-teal: #20c997;--bs-cyan:
#0dcaf0;--bs-black: #000;--bs-white: #fff;--bs-gray: #6c757d;--bs-gray-dark:
#343a40;--bs-gray-100: #f8f9fa;--bs-gray-200: #e9ecef;--bs-gray-300:
#dee2e6;--bs-gray-400: #ced4da;--bs-gray-500: #adb5bd;--bs-gray-600:
#6c757d;--bs-gray-700: #495057;--bs-gray-800: #343a4 [...]
diff --git a/main/r/pkgdown.yml b/main/r/pkgdown.yml
index 97ec68ba..25246aed 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,4 +2,4 @@ pandoc: 3.1.3
pkgdown: 2.1.1
pkgdown_sha: ~
articles: {}
-last_built: 2025-02-08T15:48Z
+last_built: 2025-02-26T21:11Z
diff --git a/main/reference/c.html b/main/reference/c.html
index ce25e13b..fe0ba7bd 100644
--- a/main/reference/c.html
+++ b/main/reference/c.html
@@ -3089,7 +3089,7 @@
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/reference/cpp.html b/main/reference/cpp.html
index 06743a68..0351cc9b 100644
--- a/main/reference/cpp.html
+++ b/main/reference/cpp.html
@@ -852,7 +852,7 @@ This class allows a standard C++ class to be exported to a
generic <a class="ref
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/reference/device.html b/main/reference/device.html
index e7d40d14..5703efe0 100644
--- a/main/reference/device.html
+++ b/main/reference/device.html
@@ -997,7 +997,7 @@
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/reference/index.html b/main/reference/index.html
index bb31e9c1..f4996cbe 100644
--- a/main/reference/index.html
+++ b/main/reference/index.html
@@ -529,7 +529,7 @@
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/reference/ipc.html b/main/reference/ipc.html
index bcfe17d2..5aa8fdf3 100644
--- a/main/reference/ipc.html
+++ b/main/reference/ipc.html
@@ -1352,7 +1352,7 @@
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/reference/python/advanced.html
b/main/reference/python/advanced.html
index 9a1e5545..a23c8061 100644
--- a/main/reference/python/advanced.html
+++ b/main/reference/python/advanced.html
@@ -472,14 +472,14 @@ parameterized types). This wrapper extends that facility
to Python.</p>
<span id="c-array-utilities"></span><h2>C Array Utilities<a class="headerlink"
href="#module-nanoarrow.c_array" title="Link to this heading">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="nanoarrow.c_array.ArrayBuilder">
-<em class="property"><span class="pre">class</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">ArrayBuilder</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">schema</span></span></em><span class="sig-paren">)</span><a
class="headerlink" href="#nanoarrow.c_array.ArrayBuilder" title="Link to this
definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">class</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">ArrayBuilder</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">schema</span></span></em><span class="sig-paren">)</span><a
class="headerlink" href="#nanoarrow.c_array.ArrayBuilder" title="Link to this
definition">#</a></dt>
<dd><p>Internal utility to build CArrays from various types of input</p>
<p>This class and its subclasses are designed to help separate the code
that actually builds a CArray from the code that chooses the strategy
used to do the building.</p>
<dl class="py method">
<dt class="sig sig-object py" id="nanoarrow.c_array.ArrayBuilder.infer_schema">
-<em class="property"><span class="pre">classmethod</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">infer_schema</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span
class="sig-paren">)</span> <span class="sig-return"><span
class="sig-return-icon">→</span> <span class="sig-return-typehint"><span
class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><sp
[...]
+<em class="property"><span class="k"><span
class="pre">classmethod</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">infer_schema</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">obj</span></span></em><span class="sig-paren">)</span> <span
class="sig-return"><span class="sig-return-icon">→</span> <span
class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span
class=" [...]
<dd><p>Infer the Arrow data type from a target object</p>
<p>Returns the type as a <code class="xref py py-class docutils literal
notranslate"><span class="pre">CSchema</span></code> and an object that can be
consumed in the same way by append() in the event it had to be
@@ -491,7 +491,7 @@ necessary to consume the first element from the original
iterator).</p>
<dl class="py class">
<dt class="sig sig-object py" id="nanoarrow.c_array.ArrayFromIterableBuilder">
-<em class="property"><span class="pre">class</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">ArrayFromIterableBuilder</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">schema</span></span></em><span class="sig-paren">)</span><a
class="headerlink" href="#nanoarrow.c_array.ArrayFromIterableBuilder"
title="Link to this definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">class</span></span><span class="w"> </span></em><span
class="sig-name descname"><span
class="pre">ArrayFromIterableBuilder</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">schema</span></span></em><span class="sig-paren">)</span><a
class="headerlink" href="#nanoarrow.c_array.ArrayFromIterableBuilder"
title="Link to this definition">#</a></dt>
<dd><p>Build a CArray from an iterable of scalar objects</p>
<p>This builder converts an iterable to a CArray using some heuristics to pick
the fastest available method for converting to a particular type of array.
@@ -500,7 +500,7 @@ library (string, binary), (2) array.array() (integer/float
except float16),
(3) CBufferBuilder.write_elements() (everything else).</p>
<dl class="py method">
<dt class="sig sig-object py"
id="nanoarrow.c_array.ArrayFromIterableBuilder.infer_schema">
-<em class="property"><span class="pre">classmethod</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">infer_schema</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span
class="sig-paren">)</span> <span class="sig-return"><span
class="sig-return-icon">→</span> <span class="sig-return-typehint"><span
class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><sp
[...]
+<em class="property"><span class="k"><span
class="pre">classmethod</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">infer_schema</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">obj</span></span></em><span class="sig-paren">)</span> <span
class="sig-return"><span class="sig-return-icon">→</span> <span
class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span
class=" [...]
<dd><p>Infer the Arrow data type from a target object</p>
<p>Returns the type as a <code class="xref py py-class docutils literal
notranslate"><span class="pre">CSchema</span></code> and an object that can be
consumed in the same way by append() in the event it had to be
@@ -512,13 +512,13 @@ necessary to consume the first element from the original
iterator).</p>
<dl class="py class">
<dt class="sig sig-object py" id="nanoarrow.c_array.ArrayFromPyBufferBuilder">
-<em class="property"><span class="pre">class</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">ArrayFromPyBufferBuilder</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">schema</span></span></em><span class="sig-paren">)</span><a
class="headerlink" href="#nanoarrow.c_array.ArrayFromPyBufferBuilder"
title="Link to this definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">class</span></span><span class="w"> </span></em><span
class="sig-name descname"><span
class="pre">ArrayFromPyBufferBuilder</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">schema</span></span></em><span class="sig-paren">)</span><a
class="headerlink" href="#nanoarrow.c_array.ArrayFromPyBufferBuilder"
title="Link to this definition">#</a></dt>
<dd><p>Build a CArray from a Python Buffer</p>
<p>This builder converts a Python buffer (e.g., numpy array, bytes,
array.array)
to a CArray (without copying the contents of the buffer).</p>
<dl class="py method">
<dt class="sig sig-object py"
id="nanoarrow.c_array.ArrayFromPyBufferBuilder.infer_schema">
-<em class="property"><span class="pre">classmethod</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">infer_schema</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span
class="sig-paren">)</span> <span class="sig-return"><span
class="sig-return-icon">→</span> <span class="sig-return-typehint"><span
class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><sp
[...]
+<em class="property"><span class="k"><span
class="pre">classmethod</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">infer_schema</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">obj</span></span></em><span class="sig-paren">)</span> <span
class="sig-return"><span class="sig-return-icon">→</span> <span
class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span
class=" [...]
<dd><p>Infer the Arrow data type from a target object</p>
<p>Returns the type as a <code class="xref py py-class docutils literal
notranslate"><span class="pre">CSchema</span></code> and an object that can be
consumed in the same way by append() in the event it had to be
@@ -530,13 +530,13 @@ necessary to consume the first element from the original
iterator).</p>
<dl class="py class">
<dt class="sig sig-object py" id="nanoarrow.c_array.EmptyArrayBuilder">
-<em class="property"><span class="pre">class</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">EmptyArrayBuilder</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">schema</span></span></em><span class="sig-paren">)</span><a
class="headerlink" href="#nanoarrow.c_array.EmptyArrayBuilder" title="Link to
this definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">class</span></span><span class="w"> </span></em><span
class="sig-name descname"><span
class="pre">EmptyArrayBuilder</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">schema</span></span></em><span class="sig-paren">)</span><a
class="headerlink" href="#nanoarrow.c_array.EmptyArrayBuilder" title="Link to
this definition">#</a></dt>
<dd><p>Build an empty CArray of any type</p>
<p>This builder accepts any empty input and produces a valid length zero
array as output.</p>
<dl class="py method">
<dt class="sig sig-object py"
id="nanoarrow.c_array.EmptyArrayBuilder.infer_schema">
-<em class="property"><span class="pre">classmethod</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">infer_schema</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span
class="sig-paren">)</span> <span class="sig-return"><span
class="sig-return-icon">→</span> <span class="sig-return-typehint"><span
class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><sp
[...]
+<em class="property"><span class="k"><span
class="pre">classmethod</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">infer_schema</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">obj</span></span></em><span class="sig-paren">)</span> <span
class="sig-return"><span class="sig-return-icon">→</span> <span
class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span
class=" [...]
<dd><p>Infer the Arrow data type from a target object</p>
<p>Returns the type as a <code class="xref py py-class docutils literal
notranslate"><span class="pre">CSchema</span></code> and an object that can be
consumed in the same way by append() in the event it had to be
@@ -914,7 +914,7 @@ These objects are usually created using
<cite>nanoarrow.c_array_stream()</cite>.
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/reference/python/array-stream.html
b/main/reference/python/array-stream.html
index 31b92d3c..6fb5eac5 100644
--- a/main/reference/python/array-stream.html
+++ b/main/reference/python/array-stream.html
@@ -388,7 +388,7 @@
<span id="high-level-arraystream-implementation"></span><h1>High-level
ArrayStream Implementation<a class="headerlink"
href="#module-nanoarrow.array_stream" title="Link to this heading">#</a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="nanoarrow.array_stream.ArrayStream">
-<em class="property"><span class="pre">class</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">ArrayStream</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em
class="sig-param"><span class="n"><span class="pre">schema</span></span><span
class="o"><span class="pre">=</span></span><span class="default_value"><span
class="pre">None</span></span></em><span class="sig-paren">)</span [...]
+<em class="property"><span class="k"><span
class="pre">class</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">ArrayStream</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">obj</span></span></em>, <em class="sig-param"><span class="n"><span
class="pre">schema</span></span><span class="o"><span
class="pre">=</span></span><span class="default_value"><span
class="pre">None</span></span></em><span cl [...]
<dd><p>High-level ArrayStream representation</p>
<p>The ArrayStream is nanoarrow’s high-level representation of zero
or more contiguous arrays that have not neccessarily been materialized.
@@ -447,7 +447,7 @@ this stream.</p>
<dl class="py method">
<dt class="sig sig-object py"
id="nanoarrow.array_stream.ArrayStream.from_path">
-<em class="property"><span class="pre">static</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">from_path</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em
class="sig-param"><span class="o"><span class="pre">*</span></span><span
class="n"><span class="pre">args</span></span></em>, <em
class="sig-param"><span class="o"><span class="pre">**</span></span><span
class="n"><span cl [...]
+<em class="property"><span class="k"><span
class="pre">static</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">from_path</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">obj</span></span></em>, <em class="sig-param"><span class="o"><span
class="pre">*</span></span><span class="n"><span
class="pre">args</span></span></em>, <em class="sig-param"><span
class="o"><span class="pre">**</span></span>< [...]
<dd><p>Create an ArrayStream from an IPC stream at a local file path</p>
<section id="id2">
<h3>Examples<a class="headerlink" href="#id2" title="Link to this
heading">#</a></h3>
@@ -473,7 +473,7 @@ this stream.</p>
<dl class="py method">
<dt class="sig sig-object py"
id="nanoarrow.array_stream.ArrayStream.from_readable">
-<em class="property"><span class="pre">static</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">from_readable</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span
class="sig-paren">)</span><a class="headerlink"
href="#nanoarrow.array_stream.ArrayStream.from_readable" title="Link to this
definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">static</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">from_readable</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">obj</span></span></em><span class="sig-paren">)</span><a
class="headerlink" href="#nanoarrow.array_stream.ArrayStream.from_readable"
title="Link to this definition">#</a></dt>
<dd><p>Create an ArrayStream from an IPC stream in a readable file or
buffer</p>
<section id="id3">
<h3>Examples<a class="headerlink" href="#id3" title="Link to this
heading">#</a></h3>
@@ -492,7 +492,7 @@ this stream.</p>
<dl class="py method">
<dt class="sig sig-object py" id="nanoarrow.array_stream.ArrayStream.from_url">
-<em class="property"><span class="pre">static</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">from_url</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em
class="sig-param"><span class="o"><span class="pre">*</span></span><span
class="n"><span class="pre">args</span></span></em>, <em
class="sig-param"><span class="o"><span class="pre">**</span></span><span
class="n"><span cla [...]
+<em class="property"><span class="k"><span
class="pre">static</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">from_url</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">obj</span></span></em>, <em class="sig-param"><span class="o"><span
class="pre">*</span></span><span class="n"><span
class="pre">args</span></span></em>, <em class="sig-param"><span
class="o"><span class="pre">**</span></span><s [...]
<dd><p>Create an ArrayStream from an IPC stream at a URL</p>
<section id="id4">
<h3>Examples<a class="headerlink" href="#id4" title="Link to this
heading">#</a></h3>
@@ -614,7 +614,7 @@ in this stream.</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.array_stream.ArrayStream.schema">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">schema</span></span><a class="headerlink"
href="#nanoarrow.array_stream.ArrayStream.schema" title="Link to this
definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">schema</span></span><a
class="headerlink" href="#nanoarrow.array_stream.ArrayStream.schema"
title="Link to this definition">#</a></dt>
<dd><p>The <code class="xref py py-class docutils literal notranslate"><span
class="pre">Schema</span></code> associated with this stream</p>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span><span class="w"> </span><span
class="nn">nanoarrow</span><span class="w"> </span><span
class="k">as</span><span class="w"> </span><span class="nn">na</span>
<span class="gp">>>> </span><span class="n">stream</span> <span
class="o">=</span> <span class="n">na</span><span class="o">.</span><span
class="n">ArrayStream</span><span class="p">([</span><span
class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span
class="p">,</span> <span class="mi">3</span><span class="p">],</span> <span
class="n">na</span><span class="o">.</span><span class="n">int32</span><span
class="p">())</span>
@@ -751,7 +751,7 @@ in this stream.</p>
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/reference/python/array.html b/main/reference/python/array.html
index 356b8b7a..3f69dd36 100644
--- a/main/reference/python/array.html
+++ b/main/reference/python/array.html
@@ -388,7 +388,7 @@
<span id="high-level-arraystream-implementation"></span><h1>High-level
ArrayStream Implementation<a class="headerlink" href="#module-nanoarrow.array"
title="Link to this heading">#</a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="nanoarrow.array.Array">
-<em class="property"><span class="pre">class</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">Array</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em
class="sig-param"><span class="n"><span class="pre">schema</span></span><span
class="o"><span class="pre">=</span></span><span class="default_value"><span
class="pre">None</span></span></em>, <em class="sig-param"><span class=" [...]
+<em class="property"><span class="k"><span
class="pre">class</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">Array</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">obj</span></span></em>, <em class="sig-param"><span class="n"><span
class="pre">schema</span></span><span class="o"><span
class="pre">=</span></span><span class="default_value"><span
class="pre">None</span></span></em>, <em class="s [...]
<dd><p>High-level in-memory Array representation</p>
<p>The Array is nanoarrow’s high-level in-memory array representation whose
scope maps to that of a fully-consumed ArrowArrayStream in the Arrow C Data
@@ -440,7 +440,7 @@ Defaults to the CPU device.</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.array.Array.buffers">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">buffers</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span
class="pre">CBufferView</span><span class="p"><span
class="pre">,</span></span><span class="w"> </span><span class="p"><span
class="pre">...</span></span><span [...]
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">buffers</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">Tuple</span><span class="p"><span
class="pre">[</span></span><span class="pre">CBufferView</span><span
class="p"><span class="pre">,</span></span><span class="w"> </span><span
class="p"><span class="pre" [...]
<dd><p>Access buffers of a contiguous array.</p>
<section id="id2">
<h3>Examples<a class="headerlink" href="#id2" title="Link to this
heading">#</a></h3>
@@ -512,7 +512,7 @@ Defaults to the CPU device.</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.array.Array.device">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">device</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">Device</span></em><a class="headerlink"
href="#nanoarrow.array.Array.device" title="Link to this definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">device</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">Device</span></em><a class="headerlink"
href="#nanoarrow.array.Array.device" title="Link to this definition">#</a></dt>
<dd><p>Get the device on which the buffers for this array are allocated</p>
<section id="id7">
<h3>Examples<a class="headerlink" href="#id7" title="Link to this
heading">#</a></h3>
@@ -529,7 +529,7 @@ Defaults to the CPU device.</p>
<dl class="py method">
<dt class="sig sig-object py" id="nanoarrow.array.Array.from_chunks">
-<em class="property"><span class="pre">static</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">from_chunks</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">obj</span></span><span
class="p"><span class="pre">:</span></span><span class="w"> </span><span
class="n"><span class="pre">Iterable</span></span></em>, <em
class="sig-param"><span class="n"><span class="pre">schema</span></span><span
class="o"><sp [...]
+<em class="property"><span class="k"><span
class="pre">static</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">from_chunks</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">obj</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">Iterable</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">schema</span></s [...]
<dd><p>Create an Array with explicit chunks</p>
<p>Creates an <a class="reference internal" href="#nanoarrow.array.Array"
title="nanoarrow.array.Array"><code class="xref py py-class docutils literal
notranslate"><span class="pre">Array</span></code></a> with explicit chunking
from an iterable of
objects that can be converted to a <code class="xref py py-func docutils
literal notranslate"><span class="pre">c_array()</span></code>.</p>
@@ -701,7 +701,7 @@ contiguous in memory.</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.array.Array.n_buffers">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">n_buffers</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">int</span></em><a class="headerlink"
href="#nanoarrow.array.Array.n_buffers" title="Link to this
definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">n_buffers</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">int</span></em><a class="headerlink"
href="#nanoarrow.array.Array.n_buffers" title="Link to this
definition">#</a></dt>
<dd><p>Get the number of buffers in each chunk of this Array</p>
<section id="id16">
<h3>Examples<a class="headerlink" href="#id16" title="Link to this
heading">#</a></h3>
@@ -716,7 +716,7 @@ contiguous in memory.</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.array.Array.n_children">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">n_children</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">int</span></em><a class="headerlink"
href="#nanoarrow.array.Array.n_children" title="Link to this
definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">n_children</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">int</span></em><a class="headerlink"
href="#nanoarrow.array.Array.n_children" title="Link to this
definition">#</a></dt>
<dd><p>Get the number of children for an Array of this type.</p>
<section id="id17">
<h3>Examples<a class="headerlink" href="#id17" title="Link to this
heading">#</a></h3>
@@ -736,7 +736,7 @@ contiguous in memory.</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.array.Array.n_chunks">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">n_chunks</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">int</span></em><a class="headerlink"
href="#nanoarrow.array.Array.n_chunks" title="Link to this
definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">n_chunks</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">int</span></em><a class="headerlink"
href="#nanoarrow.array.Array.n_chunks" title="Link to this
definition">#</a></dt>
<dd><p>Get the number of chunks in the underlying representation of this
Array.</p>
<section id="id18">
<h3>Examples<a class="headerlink" href="#id18" title="Link to this
heading">#</a></h3>
@@ -751,7 +751,7 @@ contiguous in memory.</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.array.Array.offset">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">offset</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">int</span></em><a class="headerlink"
href="#nanoarrow.array.Array.offset" title="Link to this definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">offset</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">int</span></em><a class="headerlink"
href="#nanoarrow.array.Array.offset" title="Link to this definition">#</a></dt>
<dd><p>Access the logical offset of a contiguous array</p>
<section id="id19">
<h3>Examples<a class="headerlink" href="#id19" title="Link to this
heading">#</a></h3>
@@ -766,7 +766,7 @@ contiguous in memory.</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.array.Array.schema">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">schema</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><a class="reference
internal" href="schema.html#nanoarrow.schema.Schema"
title="nanoarrow.schema.Schema"><span class="pre">Schema</span></a></em><a
class="headerlink" href="#nanoarrow.array.Array.schema" title="Link to this
definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">schema</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><a class="reference internal"
href="schema.html#nanoarrow.schema.Schema"
title="nanoarrow.schema.Schema"><span class="pre">Schema</span></a></em><a
class="headerlink" href="#nanoarrow.array.Array.schema" title="Link to thi [...]
<dd><p>Get the schema (data type) of this Array</p>
</dd></dl>
@@ -790,7 +790,7 @@ and return the serialized result.</p>
<dl class="py class">
<dt class="sig sig-object py" id="nanoarrow.array.Scalar">
-<em class="property"><span class="pre">class</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">Scalar</span></span><a class="headerlink"
href="#nanoarrow.array.Scalar" title="Link to this definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">class</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">Scalar</span></span><a
class="headerlink" href="#nanoarrow.array.Scalar" title="Link to this
definition">#</a></dt>
<dd><p>Generic wrapper around an <a class="reference internal"
href="#nanoarrow.array.Array" title="nanoarrow.array.Array"><code class="xref
py py-class docutils literal notranslate"><span
class="pre">Array</span></code></a> element</p>
<p>This class exists to provide a generic implementation of
array-like indexing for the <a class="reference internal"
href="#nanoarrow.array.Array" title="nanoarrow.array.Array"><code class="xref
py py-class docutils literal notranslate"><span
class="pre">Array</span></code></a>. These objects
@@ -819,7 +819,7 @@ iterate over an <a class="reference internal"
href="#nanoarrow.array.Array" titl
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.array.Scalar.schema">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">schema</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><a class="reference
internal" href="schema.html#nanoarrow.schema.Schema"
title="nanoarrow.schema.Schema"><span class="pre">Schema</span></a></em><a
class="headerlink" href="#nanoarrow.array.Scalar.schema" title="Link to this
definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">schema</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><a class="reference internal"
href="schema.html#nanoarrow.schema.Schema"
title="nanoarrow.schema.Schema"><span class="pre">Schema</span></a></em><a
class="headerlink" href="#nanoarrow.array.Scalar.schema" title="Link to th [...]
<dd><p>Get the schema (data type) of this scalar</p>
</dd></dl>
@@ -972,7 +972,7 @@ iterate over an <a class="reference internal"
href="#nanoarrow.array.Array" titl
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/reference/python/index.html b/main/reference/python/index.html
index 942c6989..f77b030a 100644
--- a/main/reference/python/index.html
+++ b/main/reference/python/index.html
@@ -554,7 +554,7 @@ Arrow C Data and Arrow C Stream interfaces.</p>
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/reference/python/schema.html
b/main/reference/python/schema.html
index efc54e12..efaa7568 100644
--- a/main/reference/python/schema.html
+++ b/main/reference/python/schema.html
@@ -388,23 +388,23 @@
<span id="schema-data-type-objects"></span><h1>Schema/Data Type Objects<a
class="headerlink" href="#module-nanoarrow.schema" title="Link to this
heading">#</a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="nanoarrow.schema.ExtensionAccessor">
-<em class="property"><span class="pre">class</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">ExtensionAccessor</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">schema</span></span></em><span class="sig-paren">)</span><a
class="headerlink" href="#nanoarrow.schema.ExtensionAccessor" title="Link to
this definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">class</span></span><span class="w"> </span></em><span
class="sig-name descname"><span
class="pre">ExtensionAccessor</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">schema</span></span></em><span class="sig-paren">)</span><a
class="headerlink" href="#nanoarrow.schema.ExtensionAccessor" title="Link to
this definition">#</a></dt>
<dd><p>Accessor for extension type parameters</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.ExtensionAccessor.metadata">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">metadata</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">bytes</span></em><a class="headerlink"
href="#nanoarrow.schema.ExtensionAccessor.metadata" title="Link to this
definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">metadata</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">bytes</span></em><a class="headerlink"
href="#nanoarrow.schema.ExtensionAccessor.metadata" title="Link to this
definition">#</a></dt>
<dd><p>Extension metadata for this extension type if present</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.ExtensionAccessor.name">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">name</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">str</span></em><a class="headerlink"
href="#nanoarrow.schema.ExtensionAccessor.name" title="Link to this
definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">name</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">str</span></em><a class="headerlink"
href="#nanoarrow.schema.ExtensionAccessor.name" title="Link to this
definition">#</a></dt>
<dd><p>Extension name for this extension type</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.ExtensionAccessor.storage">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">storage</span></span><a class="headerlink"
href="#nanoarrow.schema.ExtensionAccessor.storage" title="Link to this
definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">storage</span></span><a
class="headerlink" href="#nanoarrow.schema.ExtensionAccessor.storage"
title="Link to this definition">#</a></dt>
<dd><p>Storage type for this extension type</p>
</dd></dl>
@@ -412,7 +412,7 @@
<dl class="py class">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema">
-<em class="property"><span class="pre">class</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">Schema</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em
class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em
class="sig-param"><span class="n"><span class="pre">name</span></span><span
class="o"><span class="pre">=</span></span><span class="default_value">< [...]
+<em class="property"><span class="k"><span
class="pre">class</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">Schema</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">obj</span></span></em>, <em class="sig-param"><span
class="keyword-only-separator o"><abbr title="Keyword-only parameters separator
(PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em
class="sig-param"><span class="n"><s [...]
<dd><p>Create a nanoarrow Schema</p>
<p>The Schema is nanoarrow’s high-level data type representation, encompassing
the role of PyArrow’s <code class="docutils literal notranslate"><span
class="pre">Schema</span></code>, <code class="docutils literal
notranslate"><span class="pre">Field</span></code>, and <code class="docutils
literal notranslate"><span class="pre">DataType</span></code>. This scope
@@ -450,7 +450,7 @@ includes:
</div>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.byte_width">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">byte_width</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">int</span><span class="w"> </span><span class="p"><span
class="pre">|</span></span><span class="w"> </span><span
class="pre">None</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.byte_width" title="Link to th [...]
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">byte_width</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">int</span><span class="w"> </span><span
class="p"><span class="pre">|</span></span><span class="w"> </span><span
class="pre">None</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.byte_w [...]
<dd><p>Element byte width for fixed-size binary type</p>
<p>Returns <code class="docutils literal notranslate"><span
class="pre">None</span></code> for types for which this property is not
relevant.</p>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span><span class="w"> </span><span
class="nn">nanoarrow</span><span class="w"> </span><span
class="k">as</span><span class="w"> </span><span class="nn">na</span>
@@ -462,7 +462,7 @@ includes:
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.dictionary_ordered">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">dictionary_ordered</span></span><em class="property"><span
class="p"><span class="pre">:</span></span><span class="w"> </span><span
class="pre">bool</span><span class="w"> </span><span class="p"><span
class="pre">|</span></span><span class="w"> </span><span
class="pre">None</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.dictionary_ordered" [...]
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">dictionary_ordered</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">bool</span><span class="w"> </span><span
class="p"><span class="pre">|</span></span><span class="w"> </span><span
class="pre">None</span></em><a class="headerlink" href="#nanoarrow.schema.Sche
[...]
<dd><p>Dictionary ordering</p>
<p>For dictionary types, returns <code class="docutils literal
notranslate"><span class="pre">True</span></code> if the order of dictionary
values
are meaningful.</p>
@@ -475,7 +475,7 @@ are meaningful.</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.extension">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">extension</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><a class="reference
internal" href="#nanoarrow.schema.ExtensionAccessor"
title="nanoarrow.schema.ExtensionAccessor"><span
class="pre">ExtensionAccessor</span></a><span class="w"> </span><span
class="p"><span class="pre">|</span></span><span c [...]
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">extension</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><a class="reference internal"
href="#nanoarrow.schema.ExtensionAccessor"
title="nanoarrow.schema.ExtensionAccessor"><span
class="pre">ExtensionAccessor</span></a><span class="w"> </span><span
class="p"><span class="pre" [...]
<dd><p>Access extension type attributes</p>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span><span class="w"> </span><span
class="nn">nanoarrow</span><span class="w"> </span><span
class="k">as</span><span class="w"> </span><span class="nn">na</span>
<span class="gp">>>> </span><span class="n">schema</span> <span
class="o">=</span> <span class="n">na</span><span class="o">.</span><span
class="n">extension_type</span><span class="p">(</span><span
class="n">na</span><span class="o">.</span><span class="n">int32</span><span
class="p">(),</span> <span class="s2">"arrow.example"</span><span
class="p">,</span> <span class="sa">b</span><span class="s2">"</span><span
class="si">{}</span><span class="s2">"</span>< [...]
@@ -501,7 +501,7 @@ are meaningful.</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.fields">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">fields</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">List</span><span class="p"><span class="pre">[</span></span><a
class="reference internal" href="#nanoarrow.schema.Schema"
title="nanoarrow.schema.Schema"><span class="pre">Schema</span></a><span
class="p"><span class="pre">]</s [...]
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">fields</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">List</span><span class="p"><span
class="pre">[</span></span><a class="reference internal"
href="#nanoarrow.schema.Schema" title="nanoarrow.schema.Schema"><span
class="pre">Schema</span></a><span class="p" [...]
<dd><p>Iterate over child Schemas</p>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span><span class="w"> </span><span
class="nn">nanoarrow</span><span class="w"> </span><span
class="k">as</span><span class="w"> </span><span class="nn">na</span>
<span class="gp">>>> </span><span class="n">schema</span> <span
class="o">=</span> <span class="n">na</span><span class="o">.</span><span
class="n">struct</span><span class="p">({</span><span
class="s2">"col1"</span><span class="p">:</span> <span
class="n">na</span><span class="o">.</span><span class="n">int32</span><span
class="p">()})</span>
@@ -515,7 +515,7 @@ are meaningful.</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.index_type">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">index_type</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><a class="reference
internal" href="#nanoarrow.schema.Schema" title="nanoarrow.schema.Schema"><span
class="pre">Schema</span></a><span class="w"> </span><span class="p"><span
class="pre">|</span></span><span class="w"> </span><span class="pr [...]
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">index_type</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><a class="reference internal" href="#nanoarrow.schema.Schema"
title="nanoarrow.schema.Schema"><span class="pre">Schema</span></a><span
class="w"> </span><span class="p"><span class="pre">|</span></span><span
class="w"> [...]
<dd><p>Dictionary index type</p>
<p>For dictionary types, the type corresponding to the indices.
See also <a class="reference internal"
href="#nanoarrow.schema.Schema.value_type"
title="nanoarrow.schema.Schema.value_type"><code class="xref py py-attr
docutils literal notranslate"><span
class="pre">value_type</span></code></a>.</p>
@@ -528,7 +528,7 @@ See also <a class="reference internal"
href="#nanoarrow.schema.Schema.value_type
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.key_type">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">key_type</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><a class="reference
internal" href="#nanoarrow.schema.Schema" title="nanoarrow.schema.Schema"><span
class="pre">Schema</span></a><span class="w"> </span><span class="p"><span
class="pre">|</span></span><span class="w"> </span><span class="pre" [...]
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">key_type</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><a class="reference internal" href="#nanoarrow.schema.Schema"
title="nanoarrow.schema.Schema"><span class="pre">Schema</span></a><span
class="w"> </span><span class="p"><span class="pre">|</span></span><span
class="w"> < [...]
<dd><p>Map key type</p>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span><span class="w"> </span><span
class="nn">nanoarrow</span><span class="w"> </span><span
class="k">as</span><span class="w"> </span><span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">map_</span><span class="p">(</span><span
class="n">na</span><span class="o">.</span><span class="n">int32</span><span
class="p">(),</span> <span class="n">na</span><span class="o">.</span><span
class="n">string</span><span class="p">())</span><span class="o">.</span><span
class="n">key_type</span>
@@ -539,7 +539,7 @@ See also <a class="reference internal"
href="#nanoarrow.schema.Schema.value_type
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.list_size">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">list_size</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">int</span><span class="w"> </span><span class="p"><span
class="pre">|</span></span><span class="w"> </span><span
class="pre">None</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.list_size" title="Link to this [...]
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">list_size</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">int</span><span class="w"> </span><span
class="p"><span class="pre">|</span></span><span class="w"> </span><span
class="pre">None</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.list_si [...]
<dd><p>Fixed-size list element size</p>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span><span class="w"> </span><span
class="nn">nanoarrow</span><span class="w"> </span><span
class="k">as</span><span class="w"> </span><span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">fixed_size_list</span><span
class="p">(</span><span class="n">na</span><span class="o">.</span><span
class="n">int32</span><span class="p">(),</span> <span
class="mi">123</span><span class="p">)</span><span class="o">.</span><span
class="n">list_size</span>
@@ -550,7 +550,7 @@ See also <a class="reference internal"
href="#nanoarrow.schema.Schema.value_type
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.metadata">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">metadata</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">Mapping</span><span class="p"><span
class="pre">[</span></span><span class="pre">bytes</span><span class="p"><span
class="pre">,</span></span><span class="w"> </span><span
class="pre">bytes</span><span class="p"><span class=" [...]
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">metadata</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">Mapping</span><span class="p"><span
class="pre">[</span></span><span class="pre">bytes</span><span class="p"><span
class="pre">,</span></span><span class="w"> </span><span
class="pre">bytes</span><span [...]
<dd><p>Access field metadata of this field</p>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span><span class="w"> </span><span
class="nn">nanoarrow</span><span class="w"> </span><span
class="k">as</span><span class="w"> </span><span class="nn">na</span>
<span class="gp">>>> </span><span class="n">schema</span> <span
class="o">=</span> <span class="n">na</span><span class="o">.</span><span
class="n">Schema</span><span class="p">(</span><span class="n">na</span><span
class="o">.</span><span class="n">int32</span><span class="p">(),</span> <span
class="n">metadata</span><span class="o">=</span><span class="p">{</span><span
class="s2">"key"</span><span class="p">:</span> <span
class="s2">"value"</span><span clas [...]
@@ -562,7 +562,7 @@ See also <a class="reference internal"
href="#nanoarrow.schema.Schema.value_type
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.n_fields">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">n_fields</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">int</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.n_fields" title="Link to this
definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">n_fields</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">int</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.n_fields" title="Link to this
definition">#</a></dt>
<dd><p>Number of child Schemas</p>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span><span class="w"> </span><span
class="nn">nanoarrow</span><span class="w"> </span><span
class="k">as</span><span class="w"> </span><span class="nn">na</span>
<span class="gp">>>> </span><span class="n">schema</span> <span
class="o">=</span> <span class="n">na</span><span class="o">.</span><span
class="n">struct</span><span class="p">({</span><span
class="s2">"col1"</span><span class="p">:</span> <span
class="n">na</span><span class="o">.</span><span class="n">int32</span><span
class="p">()})</span>
@@ -574,7 +574,7 @@ See also <a class="reference internal"
href="#nanoarrow.schema.Schema.value_type
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.name">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">name</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">str</span><span class="w"> </span><span class="p"><span
class="pre">|</span></span><span class="w"> </span><span
class="pre">None</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.name" title="Link to this definitio [...]
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">name</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">str</span><span class="w"> </span><span
class="p"><span class="pre">|</span></span><span class="w"> </span><span
class="pre">None</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.name" title= [...]
<dd><p>Field name of this Schema</p>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span><span class="w"> </span><span
class="nn">nanoarrow</span><span class="w"> </span><span
class="k">as</span><span class="w"> </span><span class="nn">na</span>
<span class="gp">>>> </span><span class="n">schema</span> <span
class="o">=</span> <span class="n">na</span><span class="o">.</span><span
class="n">struct</span><span class="p">({</span><span
class="s2">"col1"</span><span class="p">:</span> <span
class="n">na</span><span class="o">.</span><span class="n">int32</span><span
class="p">()})</span>
@@ -586,7 +586,7 @@ See also <a class="reference internal"
href="#nanoarrow.schema.Schema.value_type
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.nullable">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">nullable</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">bool</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.nullable" title="Link to this
definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">nullable</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">bool</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.nullable" title="Link to this
definition">#</a></dt>
<dd><p>Nullability of this field</p>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span><span class="w"> </span><span
class="nn">nanoarrow</span><span class="w"> </span><span
class="k">as</span><span class="w"> </span><span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">int32</span><span class="p">()</span><span
class="o">.</span><span class="n">nullable</span>
@@ -599,7 +599,7 @@ See also <a class="reference internal"
href="#nanoarrow.schema.Schema.value_type
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.params">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">params</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">Mapping</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.params" title="Link to this
definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">params</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">Mapping</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.params" title="Link to this
definition">#</a></dt>
<dd><p>Get parameter names and values for this type</p>
<p>Returns a dictionary of parameters that can be used to reconstruct
this type together with its type identifier.</p>
@@ -612,7 +612,7 @@ this type together with its type identifier.</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.precision">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">precision</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">int</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.precision" title="Link to this
definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">precision</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">int</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.precision" title="Link to this
definition">#</a></dt>
<dd><p>Decimal precision</p>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span><span class="w"> </span><span
class="nn">nanoarrow</span><span class="w"> </span><span
class="k">as</span><span class="w"> </span><span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">decimal128</span><span
class="p">(</span><span class="mi">10</span><span class="p">,</span> <span
class="mi">3</span><span class="p">)</span><span class="o">.</span><span
class="n">precision</span>
@@ -623,7 +623,7 @@ this type together with its type identifier.</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.scale">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">scale</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">int</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.scale" title="Link to this definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">scale</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">int</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.scale" title="Link to this definition">#</a></dt>
<dd><p>Decimal scale</p>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span><span class="w"> </span><span
class="nn">nanoarrow</span><span class="w"> </span><span
class="k">as</span><span class="w"> </span><span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">decimal128</span><span
class="p">(</span><span class="mi">10</span><span class="p">,</span> <span
class="mi">3</span><span class="p">)</span><span class="o">.</span><span
class="n">scale</span>
@@ -649,7 +649,7 @@ return the serialized result.</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.timezone">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">timezone</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">str</span><span class="w"> </span><span class="p"><span
class="pre">|</span></span><span class="w"> </span><span
class="pre">None</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.timezone" title="Link to this d [...]
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">timezone</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><span class="pre">str</span><span class="w"> </span><span
class="p"><span class="pre">|</span></span><span class="w"> </span><span
class="pre">None</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.timezone [...]
<dd><p>Timezone for timestamp types</p>
<p>Returns <code class="docutils literal notranslate"><span
class="pre">None</span></code> for types for which this property is not
relevant or
for timezone types for which the timezone is not set.</p>
@@ -662,7 +662,7 @@ for timezone types for which the timezone is not set.</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.type">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">type</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><a class="reference
internal" href="#nanoarrow.schema.Type" title="nanoarrow.schema.Type"><span
class="pre">Type</span></a></em><a class="headerlink"
href="#nanoarrow.schema.Schema.type" title="Link to this definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">type</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><a class="reference internal" href="#nanoarrow.schema.Type"
title="nanoarrow.schema.Type"><span class="pre">Type</span></a></em><a
class="headerlink" href="#nanoarrow.schema.Schema.type" title="Link to this
definition">#</a></dt>
<dd><p>Type enumerator value of this Schema</p>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span><span class="w"> </span><span
class="nn">nanoarrow</span><span class="w"> </span><span
class="k">as</span><span class="w"> </span><span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">int32</span><span class="p">()</span><span
class="o">.</span><span class="n">type</span>
@@ -673,7 +673,7 @@ for timezone types for which the timezone is not set.</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.unit">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">unit</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><a class="reference
internal" href="#nanoarrow.schema.TimeUnit"
title="nanoarrow.schema.TimeUnit"><span class="pre">TimeUnit</span></a><span
class="w"> </span><span class="p"><span class="pre">|</span></span><span
class="w"> </span><span class="pr [...]
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">unit</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><a class="reference internal"
href="#nanoarrow.schema.TimeUnit" title="nanoarrow.schema.TimeUnit"><span
class="pre">TimeUnit</span></a><span class="w"> </span><span class="p"><span
class="pre">|</span></span><span class="w"> [...]
<dd><p>TimeUnit for timestamp, time, and duration types</p>
<p>Returns <code class="docutils literal notranslate"><span
class="pre">None</span></code> for types for which this property is not
relevant.</p>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span><span class="w"> </span><span
class="nn">nanoarrow</span><span class="w"> </span><span
class="k">as</span><span class="w"> </span><span class="nn">na</span>
@@ -685,7 +685,7 @@ for timezone types for which the timezone is not set.</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.value_type">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">value_type</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><a class="reference
internal" href="#nanoarrow.schema.Schema" title="nanoarrow.schema.Schema"><span
class="pre">Schema</span></a><span class="w"> </span><span class="p"><span
class="pre">|</span></span><span class="w"> </span><span class="pr [...]
+<em class="property"><span class="k"><span
class="pre">property</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">value_type</span></span><em
class="property"><span class="p"><span class="pre">:</span></span><span
class="w"> </span><a class="reference internal" href="#nanoarrow.schema.Schema"
title="nanoarrow.schema.Schema"><span class="pre">Schema</span></a><span
class="w"> </span><span class="p"><span class="pre">|</span></span><span
class="w"> [...]
<dd><p>Dictionary, map, or list value type</p>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span><span class="w"> </span><span
class="nn">nanoarrow</span><span class="w"> </span><span
class="k">as</span><span class="w"> </span><span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">list_</span><span class="p">(</span><span
class="n">na</span><span class="o">.</span><span class="n">int32</span><span
class="p">())</span><span class="o">.</span><span class="n">value_type</span>
@@ -703,11 +703,11 @@ for timezone types for which the timezone is not set.</p>
<dl class="py class">
<dt class="sig sig-object py" id="nanoarrow.schema.TimeUnit">
-<em class="property"><span class="pre">class</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">TimeUnit</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">value</span></span></em>,
<em class="sig-param"><span class="n"><span class="pre">names=<not</span>
<span class="pre">given></span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">*values</span></span></em>, <em class="sig-pa [...]
+<em class="property"><span class="k"><span
class="pre">class</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">TimeUnit</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="o"><span
class="pre">*</span></span><span class="n"><span
class="pre">values</span></span></em><span class="sig-paren">)</span><a
class="headerlink" href="#nanoarrow.schema.TimeUnit" title="Link to this
definition">#</a></dt>
<dd><p>Unit enumerator for timestamp, duration, and time types.</p>
<dl class="py method">
<dt class="sig sig-object py" id="nanoarrow.schema.TimeUnit.create">
-<em class="property"><span class="pre">static</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">create</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span
class="sig-paren">)</span><a class="headerlink"
href="#nanoarrow.schema.TimeUnit.create" title="Link to this
definition">#</a></dt>
+<em class="property"><span class="k"><span
class="pre">static</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">create</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">obj</span></span></em><span class="sig-paren">)</span><a
class="headerlink" href="#nanoarrow.schema.TimeUnit.create" title="Link to this
definition">#</a></dt>
<dd><p>Create a TimeUnit from parameter input.</p>
<p>This constructor will accept the abbreviations “s”, “ms”, “us”, and “ns”
and return the appropriate enumerator value.</p>
@@ -722,7 +722,7 @@ and return the appropriate enumerator value.</p>
<dl class="py class">
<dt class="sig sig-object py" id="nanoarrow.schema.Type">
-<em class="property"><span class="pre">class</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">Type</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">value</span></span></em>,
<em class="sig-param"><span class="n"><span class="pre">names=<not</span>
<span class="pre">given></span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">*values</span></span></em>, <em class="sig-param"
[...]
+<em class="property"><span class="k"><span
class="pre">class</span></span><span class="w"> </span></em><span
class="sig-name descname"><span class="pre">Type</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="o"><span
class="pre">*</span></span><span class="n"><span
class="pre">values</span></span></em><span class="sig-paren">)</span><a
class="headerlink" href="#nanoarrow.schema.Type" title="Link to this
definition">#</a></dt>
<dd><p>The Type enumerator provides a means by which the various type
categories can be identified. Type values can be used in place of
<a class="reference internal" href="#nanoarrow.schema.Schema"
title="nanoarrow.schema.Schema"><code class="xref py py-class docutils literal
notranslate"><span class="pre">Schema</span></code></a> instances in most
places for parameter-free types.</p>
@@ -1772,7 +1772,7 @@ inherited from the schema-like object.</p></li>
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/reference/r.html b/main/reference/r.html
index 67f7b3a6..80c138a5 100644
--- a/main/reference/r.html
+++ b/main/reference/r.html
@@ -484,7 +484,7 @@
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/reference/testing.html b/main/reference/testing.html
index 669695cb..6e229040 100644
--- a/main/reference/testing.html
+++ b/main/reference/testing.html
@@ -754,7 +754,7 @@
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/roadmap.html b/main/roadmap.html
index 3a859fa7..752323c2 100644
--- a/main/roadmap.html
+++ b/main/roadmap.html
@@ -578,7 +578,7 @@ types are not yet supported (e.g., struct, list, datetime
objects)
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/search.html b/main/search.html
index e4359acb..fdcc2316 100644
--- a/main/search.html
+++ b/main/search.html
@@ -407,7 +407,7 @@
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.1.3.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.2.1.
<br/>
</p>
</div>
diff --git a/main/searchindex.js b/main/searchindex.js
index dd13d56a..f8c2d9aa 100644
--- a/main/searchindex.js
+++ b/main/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"API Reference": [[8, null]], "Array Stream
utilities": [[6, "array-stream-utilities"]], "Array Streams": [[3,
"array-streams"]], "Array streams": [[2, "array-streams"]], "Arrays": [[2,
"arrays"], [3, "arrays"]], "Arrow C Data Interface": [[5,
"arrow-c-data-interface"]], "Arrow C Device Interface": [[7,
"arrow-c-device-interface"]], "Arrow C data/nanoarrow interface basics": [[0,
"arrow-c-data-nanoarrow-interface-basics"]], "Bitmap utilities": [[5, "bitmap-
[...]
\ No newline at end of file
+Search.setIndex({"alltitles":{"API Reference":[[8,null]],"Array Stream
utilities":[[6,"array-stream-utilities"]],"Array
Streams":[[3,"array-streams"]],"Array
streams":[[2,"array-streams"]],"Arrays":[[2,"arrays"],[3,"arrays"]],"Arrow C
Data Interface":[[5,"arrow-c-data-interface"]],"Arrow C Device
Interface":[[7,"arrow-c-device-interface"]],"Arrow C data/nanoarrow interface
basics":[[0,"arrow-c-data-nanoarrow-interface-basics"]],"Bitmap
utilities":[[5,"bitmap-utilities"]],"Buffer utilitie [...]
\ No newline at end of file
