A loose federation of distributed, typed datasets
1<!DOCTYPE html>
2<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
3
4<meta charset="utf-8">
5<meta name="generator" content="quarto-1.7.34">
6
7<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
8
9
10<title>schemaloader – atdata</title>
11<style>
12code{white-space: pre-wrap;}
13span.smallcaps{font-variant: small-caps;}
14div.columns{display: flex; gap: min(4vw, 1.5em);}
15div.column{flex: auto; overflow-x: auto;}
16div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
17ul.task-list{list-style: none;}
18ul.task-list li input[type="checkbox"] {
19 width: 0.8em;
20 margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */
21 vertical-align: middle;
22}
23/* CSS for syntax highlighting */
24html { -webkit-text-size-adjust: 100%; }
25pre > code.sourceCode { white-space: pre; position: relative; }
26pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
27pre > code.sourceCode > span:empty { height: 1.2em; }
28.sourceCode { overflow: visible; }
29code.sourceCode > span { color: inherit; text-decoration: inherit; }
30div.sourceCode { margin: 1em 0; }
31pre.sourceCode { margin: 0; }
32@media screen {
33div.sourceCode { overflow: auto; }
34}
35@media print {
36pre > code.sourceCode { white-space: pre-wrap; }
37pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
38}
39pre.numberSource code
40 { counter-reset: source-line 0; }
41pre.numberSource code > span
42 { position: relative; left: -4em; counter-increment: source-line; }
43pre.numberSource code > span > a:first-child::before
44 { content: counter(source-line);
45 position: relative; left: -1em; text-align: right; vertical-align: baseline;
46 border: none; display: inline-block;
47 -webkit-touch-callout: none; -webkit-user-select: none;
48 -khtml-user-select: none; -moz-user-select: none;
49 -ms-user-select: none; user-select: none;
50 padding: 0 4px; width: 4em;
51 }
52pre.numberSource { margin-left: 3em; padding-left: 4px; }
53div.sourceCode
54 { }
55@media screen {
56pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
57}
58</style>
59
60
61<script src="../site_libs/quarto-nav/quarto-nav.js"></script>
62<script src="../site_libs/quarto-nav/headroom.min.js"></script>
63<script src="../site_libs/clipboard/clipboard.min.js"></script>
64<script src="../site_libs/quarto-search/autocomplete.umd.js"></script>
65<script src="../site_libs/quarto-search/fuse.min.js"></script>
66<script src="../site_libs/quarto-search/quarto-search.js"></script>
67<meta name="quarto:offset" content="../">
68<script src="../site_libs/quarto-html/quarto.js" type="module"></script>
69<script src="../site_libs/quarto-html/tabsets/tabsets.js" type="module"></script>
70<script src="../site_libs/quarto-html/popper.min.js"></script>
71<script src="../site_libs/quarto-html/tippy.umd.min.js"></script>
72<script src="../site_libs/quarto-html/anchor.min.js"></script>
73<link href="../site_libs/quarto-html/tippy.css" rel="stylesheet">
74<link href="../site_libs/quarto-html/quarto-syntax-highlighting-9582434199d49cc9e91654cdeeb4866b.css" rel="stylesheet" class="quarto-color-scheme" id="quarto-text-highlighting-styles">
75<link href="../site_libs/quarto-html/quarto-syntax-highlighting-dark-8dcd8563ea6803ab7cbb3d71ca5772e1.css" rel="stylesheet" class="quarto-color-scheme quarto-color-alternate" id="quarto-text-highlighting-styles">
76<link href="../site_libs/quarto-html/quarto-syntax-highlighting-9582434199d49cc9e91654cdeeb4866b.css" rel="stylesheet" class="quarto-color-scheme-extra" id="quarto-text-highlighting-styles">
77<script src="../site_libs/bootstrap/bootstrap.min.js"></script>
78<link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
79<link href="../site_libs/bootstrap/bootstrap-62bce24ca844314e7bb1a34dbdfe05cc.min.css" rel="stylesheet" append-hash="true" class="quarto-color-scheme" id="quarto-bootstrap" data-mode="light">
80<link href="../site_libs/bootstrap/bootstrap-dark-7964ffd8887b0991fe8d71c6c8bc75d6.min.css" rel="stylesheet" append-hash="true" class="quarto-color-scheme quarto-color-alternate" id="quarto-bootstrap" data-mode="dark">
81<link href="../site_libs/bootstrap/bootstrap-62bce24ca844314e7bb1a34dbdfe05cc.min.css" rel="stylesheet" append-hash="true" class="quarto-color-scheme-extra" id="quarto-bootstrap" data-mode="light">
82<script id="quarto-search-options" type="application/json">{
83 "location": "navbar",
84 "copy-button": false,
85 "collapse-after": 3,
86 "panel-placement": "end",
87 "type": "overlay",
88 "limit": 50,
89 "keyboard-shortcut": [
90 "f",
91 "/",
92 "s"
93 ],
94 "show-item-context": false,
95 "language": {
96 "search-no-results-text": "No results",
97 "search-matching-documents-text": "matching documents",
98 "search-copy-link-title": "Copy link to search",
99 "search-hide-matches-text": "Hide additional matches",
100 "search-more-match-text": "more match in this document",
101 "search-more-matches-text": "more matches in this document",
102 "search-clear-button-title": "Clear",
103 "search-text-placeholder": "",
104 "search-detached-cancel-button-title": "Cancel",
105 "search-submit-button-title": "Submit",
106 "search-label": "Search"
107 }
108}</script>
109
110
111<link rel="stylesheet" href="../assets/styles.css">
112</head>
113
114<body class="nav-fixed quarto-light"><script id="quarto-html-before-body" type="application/javascript">
115 const toggleBodyColorMode = (bsSheetEl) => {
116 const mode = bsSheetEl.getAttribute("data-mode");
117 const bodyEl = window.document.querySelector("body");
118 if (mode === "dark") {
119 bodyEl.classList.add("quarto-dark");
120 bodyEl.classList.remove("quarto-light");
121 } else {
122 bodyEl.classList.add("quarto-light");
123 bodyEl.classList.remove("quarto-dark");
124 }
125 }
126 const toggleBodyColorPrimary = () => {
127 const bsSheetEl = window.document.querySelector("link#quarto-bootstrap:not([rel=disabled-stylesheet])");
128 if (bsSheetEl) {
129 toggleBodyColorMode(bsSheetEl);
130 }
131 }
132 const setColorSchemeToggle = (alternate) => {
133 const toggles = window.document.querySelectorAll('.quarto-color-scheme-toggle');
134 for (let i=0; i < toggles.length; i++) {
135 const toggle = toggles[i];
136 if (toggle) {
137 if (alternate) {
138 toggle.classList.add("alternate");
139 } else {
140 toggle.classList.remove("alternate");
141 }
142 }
143 }
144 };
145 const toggleColorMode = (alternate) => {
146 // Switch the stylesheets
147 const primaryStylesheets = window.document.querySelectorAll('link.quarto-color-scheme:not(.quarto-color-alternate)');
148 const alternateStylesheets = window.document.querySelectorAll('link.quarto-color-scheme.quarto-color-alternate');
149 manageTransitions('#quarto-margin-sidebar .nav-link', false);
150 if (alternate) {
151 // note: dark is layered on light, we don't disable primary!
152 enableStylesheet(alternateStylesheets);
153 for (const sheetNode of alternateStylesheets) {
154 if (sheetNode.id === "quarto-bootstrap") {
155 toggleBodyColorMode(sheetNode);
156 }
157 }
158 } else {
159 disableStylesheet(alternateStylesheets);
160 enableStylesheet(primaryStylesheets)
161 toggleBodyColorPrimary();
162 }
163 manageTransitions('#quarto-margin-sidebar .nav-link', true);
164 // Switch the toggles
165 setColorSchemeToggle(alternate)
166 // Hack to workaround the fact that safari doesn't
167 // properly recolor the scrollbar when toggling (#1455)
168 if (navigator.userAgent.indexOf('Safari') > 0 && navigator.userAgent.indexOf('Chrome') == -1) {
169 manageTransitions("body", false);
170 window.scrollTo(0, 1);
171 setTimeout(() => {
172 window.scrollTo(0, 0);
173 manageTransitions("body", true);
174 }, 40);
175 }
176 }
177 const disableStylesheet = (stylesheets) => {
178 for (let i=0; i < stylesheets.length; i++) {
179 const stylesheet = stylesheets[i];
180 stylesheet.rel = 'disabled-stylesheet';
181 }
182 }
183 const enableStylesheet = (stylesheets) => {
184 for (let i=0; i < stylesheets.length; i++) {
185 const stylesheet = stylesheets[i];
186 if(stylesheet.rel !== 'stylesheet') { // for Chrome, which will still FOUC without this check
187 stylesheet.rel = 'stylesheet';
188 }
189 }
190 }
191 const manageTransitions = (selector, allowTransitions) => {
192 const els = window.document.querySelectorAll(selector);
193 for (let i=0; i < els.length; i++) {
194 const el = els[i];
195 if (allowTransitions) {
196 el.classList.remove('notransition');
197 } else {
198 el.classList.add('notransition');
199 }
200 }
201 }
202 const isFileUrl = () => {
203 return window.location.protocol === 'file:';
204 }
205 const hasAlternateSentinel = () => {
206 let styleSentinel = getColorSchemeSentinel();
207 if (styleSentinel !== null) {
208 return styleSentinel === "alternate";
209 } else {
210 return false;
211 }
212 }
213 const setStyleSentinel = (alternate) => {
214 const value = alternate ? "alternate" : "default";
215 if (!isFileUrl()) {
216 window.localStorage.setItem("quarto-color-scheme", value);
217 } else {
218 localAlternateSentinel = value;
219 }
220 }
221 const getColorSchemeSentinel = () => {
222 if (!isFileUrl()) {
223 const storageValue = window.localStorage.getItem("quarto-color-scheme");
224 return storageValue != null ? storageValue : localAlternateSentinel;
225 } else {
226 return localAlternateSentinel;
227 }
228 }
229 const toggleGiscusIfUsed = (isAlternate, darkModeDefault) => {
230 const baseTheme = document.querySelector('#giscus-base-theme')?.value ?? 'light';
231 const alternateTheme = document.querySelector('#giscus-alt-theme')?.value ?? 'dark';
232 let newTheme = '';
233 if(authorPrefersDark) {
234 newTheme = isAlternate ? baseTheme : alternateTheme;
235 } else {
236 newTheme = isAlternate ? alternateTheme : baseTheme;
237 }
238 const changeGiscusTheme = () => {
239 // From: https://github.com/giscus/giscus/issues/336
240 const sendMessage = (message) => {
241 const iframe = document.querySelector('iframe.giscus-frame');
242 if (!iframe) return;
243 iframe.contentWindow.postMessage({ giscus: message }, 'https://giscus.app');
244 }
245 sendMessage({
246 setConfig: {
247 theme: newTheme
248 }
249 });
250 }
251 const isGiscussLoaded = window.document.querySelector('iframe.giscus-frame') !== null;
252 if (isGiscussLoaded) {
253 changeGiscusTheme();
254 }
255 };
256 const authorPrefersDark = false;
257 const darkModeDefault = authorPrefersDark;
258 document.querySelector('link#quarto-text-highlighting-styles.quarto-color-scheme-extra').rel = 'disabled-stylesheet';
259 document.querySelector('link#quarto-bootstrap.quarto-color-scheme-extra').rel = 'disabled-stylesheet';
260 let localAlternateSentinel = darkModeDefault ? 'alternate' : 'default';
261 // Dark / light mode switch
262 window.quartoToggleColorScheme = () => {
263 // Read the current dark / light value
264 let toAlternate = !hasAlternateSentinel();
265 toggleColorMode(toAlternate);
266 setStyleSentinel(toAlternate);
267 toggleGiscusIfUsed(toAlternate, darkModeDefault);
268 window.dispatchEvent(new Event('resize'));
269 };
270 // Switch to dark mode if need be
271 if (hasAlternateSentinel()) {
272 toggleColorMode(true);
273 } else {
274 toggleColorMode(false);
275 }
276 </script>
277
278<div id="quarto-search-results"></div>
279 <header id="quarto-header" class="headroom fixed-top">
280 <nav class="navbar navbar-expand-lg " data-bs-theme="dark">
281 <div class="navbar-container container-fluid">
282 <div class="navbar-brand-container mx-auto">
283 <a class="navbar-brand" href="../index.html">
284 <span class="navbar-title">atdata</span>
285 </a>
286 </div>
287 <div id="quarto-search" class="" title="Search"></div>
288 <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarCollapse" aria-controls="navbarCollapse" role="menu" aria-expanded="false" aria-label="Toggle navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
289 <span class="navbar-toggler-icon"></span>
290</button>
291 <div class="collapse navbar-collapse" id="navbarCollapse">
292 <ul class="navbar-nav navbar-nav-scroll me-auto">
293 <li class="nav-item">
294 <a class="nav-link" href="../index.html">
295<span class="menu-text">Guide</span></a>
296 </li>
297 <li class="nav-item dropdown ">
298 <a class="nav-link dropdown-toggle" href="#" id="nav-menu-tutorials" role="link" data-bs-toggle="dropdown" aria-expanded="false">
299 <span class="menu-text">Tutorials</span>
300 </a>
301 <ul class="dropdown-menu" aria-labelledby="nav-menu-tutorials">
302 <li>
303 <a class="dropdown-item" href="../tutorials/quickstart.html">
304 <span class="dropdown-text">Quick Start</span></a>
305 </li>
306 <li>
307 <a class="dropdown-item" href="../tutorials/local-workflow.html">
308 <span class="dropdown-text">Local Workflow</span></a>
309 </li>
310 <li>
311 <a class="dropdown-item" href="../tutorials/atmosphere.html">
312 <span class="dropdown-text">Atmosphere Publishing</span></a>
313 </li>
314 <li>
315 <a class="dropdown-item" href="../tutorials/promotion.html">
316 <span class="dropdown-text">Promotion Workflow</span></a>
317 </li>
318 </ul>
319 </li>
320 <li class="nav-item dropdown ">
321 <a class="nav-link dropdown-toggle" href="#" id="nav-menu-reference" role="link" data-bs-toggle="dropdown" aria-expanded="false">
322 <span class="menu-text">Reference</span>
323 </a>
324 <ul class="dropdown-menu" aria-labelledby="nav-menu-reference">
325 <li>
326 <a class="dropdown-item" href="../reference/architecture.html">
327 <span class="dropdown-text">Architecture Overview</span></a>
328 </li>
329 <li>
330 <a class="dropdown-item" href="../reference/packable-samples.html">
331 <span class="dropdown-text">Packable Samples</span></a>
332 </li>
333 <li>
334 <a class="dropdown-item" href="../reference/datasets.html">
335 <span class="dropdown-text">Datasets</span></a>
336 </li>
337 <li>
338 <a class="dropdown-item" href="../reference/lenses.html">
339 <span class="dropdown-text">Lenses</span></a>
340 </li>
341 <li>
342 <a class="dropdown-item" href="../reference/local-storage.html">
343 <span class="dropdown-text">Local Storage</span></a>
344 </li>
345 <li>
346 <a class="dropdown-item" href="../reference/atmosphere.html">
347 <span class="dropdown-text">Atmosphere</span></a>
348 </li>
349 <li>
350 <a class="dropdown-item" href="../reference/promotion.html">
351 <span class="dropdown-text">Promotion</span></a>
352 </li>
353 <li>
354 <a class="dropdown-item" href="../reference/load-dataset.html">
355 <span class="dropdown-text">load_dataset API</span></a>
356 </li>
357 <li>
358 <a class="dropdown-item" href="../reference/protocols.html">
359 <span class="dropdown-text">Protocols</span></a>
360 </li>
361 <li>
362 <a class="dropdown-item" href="../reference/uri-spec.html">
363 <span class="dropdown-text">URI Specification</span></a>
364 </li>
365 <li>
366 <a class="dropdown-item" href="../reference/troubleshooting.html">
367 <span class="dropdown-text">Troubleshooting & FAQ</span></a>
368 </li>
369 <li>
370 <a class="dropdown-item" href="../reference/deployment.html">
371 <span class="dropdown-text">Deployment Guide</span></a>
372 </li>
373 </ul>
374 </li>
375 <li class="nav-item">
376 <a class="nav-link" href="../api/index.html">
377<span class="menu-text">API</span></a>
378 </li>
379</ul>
380 <ul class="navbar-nav navbar-nav-scroll ms-auto">
381 <li class="nav-item compact">
382 <a class="nav-link" href="https://github.com/your-org/atdata"> <i class="bi bi-github" role="img">
383</i>
384<span class="menu-text"></span></a>
385 </li>
386</ul>
387 </div> <!-- /navcollapse -->
388 <div class="quarto-navbar-tools">
389 <a href="" class="quarto-color-scheme-toggle quarto-navigation-tool px-1" onclick="window.quartoToggleColorScheme(); return false;" title="Toggle dark mode"><i class="bi"></i></a>
390</div>
391 </div> <!-- /container-fluid -->
392 </nav>
393</header>
394<!-- content -->
395<div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article page-navbar">
396<!-- sidebar -->
397<!-- margin-sidebar -->
398 <div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
399 <nav id="TOC" role="doc-toc" class="toc-active">
400 <h2 id="toc-title">On this page</h2>
401
402 <ul>
403 <li><a href="#atdata.atmosphere.SchemaLoader" id="toc-atdata.atmosphere.SchemaLoader" class="nav-link active" data-scroll-target="#atdata.atmosphere.SchemaLoader">SchemaLoader</a>
404 <ul class="collapse">
405 <li><a href="#examples" id="toc-examples" class="nav-link" data-scroll-target="#examples">Examples</a></li>
406 <li><a href="#methods" id="toc-methods" class="nav-link" data-scroll-target="#methods">Methods</a>
407 <ul class="collapse">
408 <li><a href="#atdata.atmosphere.SchemaLoader.get" id="toc-atdata.atmosphere.SchemaLoader.get" class="nav-link" data-scroll-target="#atdata.atmosphere.SchemaLoader.get">get</a></li>
409 <li><a href="#atdata.atmosphere.SchemaLoader.list_all" id="toc-atdata.atmosphere.SchemaLoader.list_all" class="nav-link" data-scroll-target="#atdata.atmosphere.SchemaLoader.list_all">list_all</a></li>
410 </ul></li>
411 </ul></li>
412 </ul>
413<div class="toc-actions"><ul><li><a href="https://github.com/your-org/atdata/edit/main/api/SchemaLoader.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/your-org/atdata/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></nav>
414 </div>
415<!-- main -->
416<main class="content" id="quarto-document-content"><header id="title-block-header" class="quarto-title-block"></header>
417
418
419
420
421
422<section id="atdata.atmosphere.SchemaLoader" class="level1">
423<h1>SchemaLoader</h1>
424<div class="sourceCode" id="cb1"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a>atmosphere.SchemaLoader(client)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
425<p>Loads PackableSample schemas from ATProto.</p>
426<p>This class fetches schema records from ATProto and can list available schemas from a repository.</p>
427<section id="examples" class="level2 doc-section doc-section-examples">
428<h2 class="doc-section doc-section-examples anchored" data-anchor-id="examples">Examples</h2>
429<div class="sourceCode" id="cb2"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="op">>>></span> client <span class="op">=</span> AtmosphereClient()</span>
430<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="op">>>></span> client.login(<span class="st">"handle"</span>, <span class="st">"password"</span>)</span>
431<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a><span class="op">>>></span></span>
432<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a><span class="op">>>></span> loader <span class="op">=</span> SchemaLoader(client)</span>
433<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a><span class="op">>>></span> schema <span class="op">=</span> loader.get(<span class="st">"at://did:plc:.../ac.foundation.dataset.sampleSchema/..."</span>)</span>
434<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a><span class="op">>>></span> <span class="bu">print</span>(schema[<span class="st">"name"</span>])</span>
435<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a><span class="co">'MySample'</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
436</section>
437<section id="methods" class="level2">
438<h2 class="anchored" data-anchor-id="methods">Methods</h2>
439<table class="caption-top table">
440<thead>
441<tr class="header">
442<th>Name</th>
443<th>Description</th>
444</tr>
445</thead>
446<tbody>
447<tr class="odd">
448<td><a href="#atdata.atmosphere.SchemaLoader.get">get</a></td>
449<td>Fetch a schema record by AT URI.</td>
450</tr>
451<tr class="even">
452<td><a href="#atdata.atmosphere.SchemaLoader.list_all">list_all</a></td>
453<td>List schema records from a repository.</td>
454</tr>
455</tbody>
456</table>
457<section id="atdata.atmosphere.SchemaLoader.get" class="level3">
458<h3 class="anchored" data-anchor-id="atdata.atmosphere.SchemaLoader.get">get</h3>
459<div class="sourceCode" id="cb3"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a>atmosphere.SchemaLoader.get(uri)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
460<p>Fetch a schema record by AT URI.</p>
461<section id="parameters" class="level4 doc-section doc-section-parameters">
462<h4 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters">Parameters</h4>
463<table class="caption-top table">
464<thead>
465<tr class="header">
466<th>Name</th>
467<th>Type</th>
468<th>Description</th>
469<th>Default</th>
470</tr>
471</thead>
472<tbody>
473<tr class="odd">
474<td>uri</td>
475<td><a href="`str`">str</a> | <a href="`atdata.atmosphere._types.AtUri`">AtUri</a></td>
476<td>The AT URI of the schema record.</td>
477<td><em>required</em></td>
478</tr>
479</tbody>
480</table>
481</section>
482<section id="returns" class="level4 doc-section doc-section-returns">
483<h4 class="doc-section doc-section-returns anchored" data-anchor-id="returns">Returns</h4>
484<table class="caption-top table">
485<thead>
486<tr class="header">
487<th>Name</th>
488<th>Type</th>
489<th>Description</th>
490</tr>
491</thead>
492<tbody>
493<tr class="odd">
494<td></td>
495<td><a href="`dict`">dict</a></td>
496<td>The schema record as a dictionary.</td>
497</tr>
498</tbody>
499</table>
500</section>
501<section id="raises" class="level4 doc-section doc-section-raises">
502<h4 class="doc-section doc-section-raises anchored" data-anchor-id="raises">Raises</h4>
503<table class="caption-top table">
504<thead>
505<tr class="header">
506<th>Name</th>
507<th>Type</th>
508<th>Description</th>
509</tr>
510</thead>
511<tbody>
512<tr class="odd">
513<td></td>
514<td><a href="`ValueError`">ValueError</a></td>
515<td>If the record is not a schema record.</td>
516</tr>
517<tr class="even">
518<td></td>
519<td><a href="`atproto`">atproto</a>.<a href="`atproto.exceptions`">exceptions</a>.<a href="`atproto.exceptions.AtProtocolError`">AtProtocolError</a></td>
520<td>If record not found.</td>
521</tr>
522</tbody>
523</table>
524</section>
525</section>
526<section id="atdata.atmosphere.SchemaLoader.list_all" class="level3">
527<h3 class="anchored" data-anchor-id="atdata.atmosphere.SchemaLoader.list_all">list_all</h3>
528<div class="sourceCode" id="cb4"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a>atmosphere.SchemaLoader.list_all(repo<span class="op">=</span><span class="va">None</span>, limit<span class="op">=</span><span class="dv">100</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
529<p>List schema records from a repository.</p>
530<section id="parameters-1" class="level4 doc-section doc-section-parameters">
531<h4 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-1">Parameters</h4>
532<table class="caption-top table">
533<thead>
534<tr class="header">
535<th>Name</th>
536<th>Type</th>
537<th>Description</th>
538<th>Default</th>
539</tr>
540</thead>
541<tbody>
542<tr class="odd">
543<td>repo</td>
544<td><a href="`typing.Optional`">Optional</a>[<a href="`str`">str</a>]</td>
545<td>The DID of the repository. Defaults to authenticated user.</td>
546<td><code>None</code></td>
547</tr>
548<tr class="even">
549<td>limit</td>
550<td><a href="`int`">int</a></td>
551<td>Maximum number of records to return.</td>
552<td><code>100</code></td>
553</tr>
554</tbody>
555</table>
556</section>
557<section id="returns-1" class="level4 doc-section doc-section-returns">
558<h4 class="doc-section doc-section-returns anchored" data-anchor-id="returns-1">Returns</h4>
559<table class="caption-top table">
560<thead>
561<tr class="header">
562<th>Name</th>
563<th>Type</th>
564<th>Description</th>
565</tr>
566</thead>
567<tbody>
568<tr class="odd">
569<td></td>
570<td><a href="`list`">list</a>[<a href="`dict`">dict</a>]</td>
571<td>List of schema records.</td>
572</tr>
573</tbody>
574</table>
575
576
577</section>
578</section>
579</section>
580</section>
581
582</main> <!-- /main -->
583<script id="quarto-html-after-body" type="application/javascript">
584 window.document.addEventListener("DOMContentLoaded", function (event) {
585 // Ensure there is a toggle, if there isn't float one in the top right
586 if (window.document.querySelector('.quarto-color-scheme-toggle') === null) {
587 const a = window.document.createElement('a');
588 a.classList.add('top-right');
589 a.classList.add('quarto-color-scheme-toggle');
590 a.href = "";
591 a.onclick = function() { try { window.quartoToggleColorScheme(); } catch {} return false; };
592 const i = window.document.createElement("i");
593 i.classList.add('bi');
594 a.appendChild(i);
595 window.document.body.appendChild(a);
596 }
597 setColorSchemeToggle(hasAlternateSentinel())
598 const icon = "";
599 const anchorJS = new window.AnchorJS();
600 anchorJS.options = {
601 placement: 'right',
602 icon: icon
603 };
604 anchorJS.add('.anchored');
605 const isCodeAnnotation = (el) => {
606 for (const clz of el.classList) {
607 if (clz.startsWith('code-annotation-')) {
608 return true;
609 }
610 }
611 return false;
612 }
613 const onCopySuccess = function(e) {
614 // button target
615 const button = e.trigger;
616 // don't keep focus
617 button.blur();
618 // flash "checked"
619 button.classList.add('code-copy-button-checked');
620 var currentTitle = button.getAttribute("title");
621 button.setAttribute("title", "Copied!");
622 let tooltip;
623 if (window.bootstrap) {
624 button.setAttribute("data-bs-toggle", "tooltip");
625 button.setAttribute("data-bs-placement", "left");
626 button.setAttribute("data-bs-title", "Copied!");
627 tooltip = new bootstrap.Tooltip(button,
628 { trigger: "manual",
629 customClass: "code-copy-button-tooltip",
630 offset: [0, -8]});
631 tooltip.show();
632 }
633 setTimeout(function() {
634 if (tooltip) {
635 tooltip.hide();
636 button.removeAttribute("data-bs-title");
637 button.removeAttribute("data-bs-toggle");
638 button.removeAttribute("data-bs-placement");
639 }
640 button.setAttribute("title", currentTitle);
641 button.classList.remove('code-copy-button-checked');
642 }, 1000);
643 // clear code selection
644 e.clearSelection();
645 }
646 const getTextToCopy = function(trigger) {
647 const codeEl = trigger.previousElementSibling.cloneNode(true);
648 for (const childEl of codeEl.children) {
649 if (isCodeAnnotation(childEl)) {
650 childEl.remove();
651 }
652 }
653 return codeEl.innerText;
654 }
655 const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', {
656 text: getTextToCopy
657 });
658 clipboard.on('success', onCopySuccess);
659 if (window.document.getElementById('quarto-embedded-source-code-modal')) {
660 const clipboardModal = new window.ClipboardJS('.code-copy-button[data-in-quarto-modal]', {
661 text: getTextToCopy,
662 container: window.document.getElementById('quarto-embedded-source-code-modal')
663 });
664 clipboardModal.on('success', onCopySuccess);
665 }
666 var localhostRegex = new RegExp(/^(?:http|https):\/\/localhost\:?[0-9]*\//);
667 var mailtoRegex = new RegExp(/^mailto:/);
668 var filterRegex = new RegExp("https:\/\/github\.com\/your-org\/atdata");
669 var isInternal = (href) => {
670 return filterRegex.test(href) || localhostRegex.test(href) || mailtoRegex.test(href);
671 }
672 // Inspect non-navigation links and adorn them if external
673 var links = window.document.querySelectorAll('a[href]:not(.nav-link):not(.navbar-brand):not(.toc-action):not(.sidebar-link):not(.sidebar-item-toggle):not(.pagination-link):not(.no-external):not([aria-hidden]):not(.dropdown-item):not(.quarto-navigation-tool):not(.about-link)');
674 for (var i=0; i<links.length; i++) {
675 const link = links[i];
676 if (!isInternal(link.href)) {
677 // undo the damage that might have been done by quarto-nav.js in the case of
678 // links that we want to consider external
679 if (link.dataset.originalHref !== undefined) {
680 link.href = link.dataset.originalHref;
681 }
682 }
683 }
684 function tippyHover(el, contentFn, onTriggerFn, onUntriggerFn) {
685 const config = {
686 allowHTML: true,
687 maxWidth: 500,
688 delay: 100,
689 arrow: false,
690 appendTo: function(el) {
691 return el.parentElement;
692 },
693 interactive: true,
694 interactiveBorder: 10,
695 theme: 'quarto',
696 placement: 'bottom-start',
697 };
698 if (contentFn) {
699 config.content = contentFn;
700 }
701 if (onTriggerFn) {
702 config.onTrigger = onTriggerFn;
703 }
704 if (onUntriggerFn) {
705 config.onUntrigger = onUntriggerFn;
706 }
707 window.tippy(el, config);
708 }
709 const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]');
710 for (var i=0; i<noterefs.length; i++) {
711 const ref = noterefs[i];
712 tippyHover(ref, function() {
713 // use id or data attribute instead here
714 let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href');
715 try { href = new URL(href).hash; } catch {}
716 const id = href.replace(/^#\/?/, "");
717 const note = window.document.getElementById(id);
718 if (note) {
719 return note.innerHTML;
720 } else {
721 return "";
722 }
723 });
724 }
725 const xrefs = window.document.querySelectorAll('a.quarto-xref');
726 const processXRef = (id, note) => {
727 // Strip column container classes
728 const stripColumnClz = (el) => {
729 el.classList.remove("page-full", "page-columns");
730 if (el.children) {
731 for (const child of el.children) {
732 stripColumnClz(child);
733 }
734 }
735 }
736 stripColumnClz(note)
737 if (id === null || id.startsWith('sec-')) {
738 // Special case sections, only their first couple elements
739 const container = document.createElement("div");
740 if (note.children && note.children.length > 2) {
741 container.appendChild(note.children[0].cloneNode(true));
742 for (let i = 1; i < note.children.length; i++) {
743 const child = note.children[i];
744 if (child.tagName === "P" && child.innerText === "") {
745 continue;
746 } else {
747 container.appendChild(child.cloneNode(true));
748 break;
749 }
750 }
751 if (window.Quarto?.typesetMath) {
752 window.Quarto.typesetMath(container);
753 }
754 return container.innerHTML
755 } else {
756 if (window.Quarto?.typesetMath) {
757 window.Quarto.typesetMath(note);
758 }
759 return note.innerHTML;
760 }
761 } else {
762 // Remove any anchor links if they are present
763 const anchorLink = note.querySelector('a.anchorjs-link');
764 if (anchorLink) {
765 anchorLink.remove();
766 }
767 if (window.Quarto?.typesetMath) {
768 window.Quarto.typesetMath(note);
769 }
770 if (note.classList.contains("callout")) {
771 return note.outerHTML;
772 } else {
773 return note.innerHTML;
774 }
775 }
776 }
777 for (var i=0; i<xrefs.length; i++) {
778 const xref = xrefs[i];
779 tippyHover(xref, undefined, function(instance) {
780 instance.disable();
781 let url = xref.getAttribute('href');
782 let hash = undefined;
783 if (url.startsWith('#')) {
784 hash = url;
785 } else {
786 try { hash = new URL(url).hash; } catch {}
787 }
788 if (hash) {
789 const id = hash.replace(/^#\/?/, "");
790 const note = window.document.getElementById(id);
791 if (note !== null) {
792 try {
793 const html = processXRef(id, note.cloneNode(true));
794 instance.setContent(html);
795 } finally {
796 instance.enable();
797 instance.show();
798 }
799 } else {
800 // See if we can fetch this
801 fetch(url.split('#')[0])
802 .then(res => res.text())
803 .then(html => {
804 const parser = new DOMParser();
805 const htmlDoc = parser.parseFromString(html, "text/html");
806 const note = htmlDoc.getElementById(id);
807 if (note !== null) {
808 const html = processXRef(id, note);
809 instance.setContent(html);
810 }
811 }).finally(() => {
812 instance.enable();
813 instance.show();
814 });
815 }
816 } else {
817 // See if we can fetch a full url (with no hash to target)
818 // This is a special case and we should probably do some content thinning / targeting
819 fetch(url)
820 .then(res => res.text())
821 .then(html => {
822 const parser = new DOMParser();
823 const htmlDoc = parser.parseFromString(html, "text/html");
824 const note = htmlDoc.querySelector('main.content');
825 if (note !== null) {
826 // This should only happen for chapter cross references
827 // (since there is no id in the URL)
828 // remove the first header
829 if (note.children.length > 0 && note.children[0].tagName === "HEADER") {
830 note.children[0].remove();
831 }
832 const html = processXRef(null, note);
833 instance.setContent(html);
834 }
835 }).finally(() => {
836 instance.enable();
837 instance.show();
838 });
839 }
840 }, function(instance) {
841 });
842 }
843 let selectedAnnoteEl;
844 const selectorForAnnotation = ( cell, annotation) => {
845 let cellAttr = 'data-code-cell="' + cell + '"';
846 let lineAttr = 'data-code-annotation="' + annotation + '"';
847 const selector = 'span[' + cellAttr + '][' + lineAttr + ']';
848 return selector;
849 }
850 const selectCodeLines = (annoteEl) => {
851 const doc = window.document;
852 const targetCell = annoteEl.getAttribute("data-target-cell");
853 const targetAnnotation = annoteEl.getAttribute("data-target-annotation");
854 const annoteSpan = window.document.querySelector(selectorForAnnotation(targetCell, targetAnnotation));
855 const lines = annoteSpan.getAttribute("data-code-lines").split(",");
856 const lineIds = lines.map((line) => {
857 return targetCell + "-" + line;
858 })
859 let top = null;
860 let height = null;
861 let parent = null;
862 if (lineIds.length > 0) {
863 //compute the position of the single el (top and bottom and make a div)
864 const el = window.document.getElementById(lineIds[0]);
865 top = el.offsetTop;
866 height = el.offsetHeight;
867 parent = el.parentElement.parentElement;
868 if (lineIds.length > 1) {
869 const lastEl = window.document.getElementById(lineIds[lineIds.length - 1]);
870 const bottom = lastEl.offsetTop + lastEl.offsetHeight;
871 height = bottom - top;
872 }
873 if (top !== null && height !== null && parent !== null) {
874 // cook up a div (if necessary) and position it
875 let div = window.document.getElementById("code-annotation-line-highlight");
876 if (div === null) {
877 div = window.document.createElement("div");
878 div.setAttribute("id", "code-annotation-line-highlight");
879 div.style.position = 'absolute';
880 parent.appendChild(div);
881 }
882 div.style.top = top - 2 + "px";
883 div.style.height = height + 4 + "px";
884 div.style.left = 0;
885 let gutterDiv = window.document.getElementById("code-annotation-line-highlight-gutter");
886 if (gutterDiv === null) {
887 gutterDiv = window.document.createElement("div");
888 gutterDiv.setAttribute("id", "code-annotation-line-highlight-gutter");
889 gutterDiv.style.position = 'absolute';
890 const codeCell = window.document.getElementById(targetCell);
891 const gutter = codeCell.querySelector('.code-annotation-gutter');
892 gutter.appendChild(gutterDiv);
893 }
894 gutterDiv.style.top = top - 2 + "px";
895 gutterDiv.style.height = height + 4 + "px";
896 }
897 selectedAnnoteEl = annoteEl;
898 }
899 };
900 const unselectCodeLines = () => {
901 const elementsIds = ["code-annotation-line-highlight", "code-annotation-line-highlight-gutter"];
902 elementsIds.forEach((elId) => {
903 const div = window.document.getElementById(elId);
904 if (div) {
905 div.remove();
906 }
907 });
908 selectedAnnoteEl = undefined;
909 };
910 // Handle positioning of the toggle
911 window.addEventListener(
912 "resize",
913 throttle(() => {
914 elRect = undefined;
915 if (selectedAnnoteEl) {
916 selectCodeLines(selectedAnnoteEl);
917 }
918 }, 10)
919 );
920 function throttle(fn, ms) {
921 let throttle = false;
922 let timer;
923 return (...args) => {
924 if(!throttle) { // first call gets through
925 fn.apply(this, args);
926 throttle = true;
927 } else { // all the others get throttled
928 if(timer) clearTimeout(timer); // cancel #2
929 timer = setTimeout(() => {
930 fn.apply(this, args);
931 timer = throttle = false;
932 }, ms);
933 }
934 };
935 }
936 // Attach click handler to the DT
937 const annoteDls = window.document.querySelectorAll('dt[data-target-cell]');
938 for (const annoteDlNode of annoteDls) {
939 annoteDlNode.addEventListener('click', (event) => {
940 const clickedEl = event.target;
941 if (clickedEl !== selectedAnnoteEl) {
942 unselectCodeLines();
943 const activeEl = window.document.querySelector('dt[data-target-cell].code-annotation-active');
944 if (activeEl) {
945 activeEl.classList.remove('code-annotation-active');
946 }
947 selectCodeLines(clickedEl);
948 clickedEl.classList.add('code-annotation-active');
949 } else {
950 // Unselect the line
951 unselectCodeLines();
952 clickedEl.classList.remove('code-annotation-active');
953 }
954 });
955 }
956 const findCites = (el) => {
957 const parentEl = el.parentElement;
958 if (parentEl) {
959 const cites = parentEl.dataset.cites;
960 if (cites) {
961 return {
962 el,
963 cites: cites.split(' ')
964 };
965 } else {
966 return findCites(el.parentElement)
967 }
968 } else {
969 return undefined;
970 }
971 };
972 var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]');
973 for (var i=0; i<bibliorefs.length; i++) {
974 const ref = bibliorefs[i];
975 const citeInfo = findCites(ref);
976 if (citeInfo) {
977 tippyHover(citeInfo.el, function() {
978 var popup = window.document.createElement('div');
979 citeInfo.cites.forEach(function(cite) {
980 var citeDiv = window.document.createElement('div');
981 citeDiv.classList.add('hanging-indent');
982 citeDiv.classList.add('csl-entry');
983 var biblioDiv = window.document.getElementById('ref-' + cite);
984 if (biblioDiv) {
985 citeDiv.innerHTML = biblioDiv.innerHTML;
986 }
987 popup.appendChild(citeDiv);
988 });
989 return popup.innerHTML;
990 });
991 }
992 }
993 });
994 </script>
995</div> <!-- /content -->
996<footer class="footer">
997 <div class="nav-footer">
998 <div class="nav-footer-left">
999<p>Built with <a href="https://quarto.org/">Quarto</a></p>
1000</div>
1001 <div class="nav-footer-center">
1002
1003 <div class="toc-actions d-sm-block d-md-none"><ul><li><a href="https://github.com/your-org/atdata/edit/main/api/SchemaLoader.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/your-org/atdata/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></div>
1004 <div class="nav-footer-right">
1005<p>MIT License</p>
1006</div>
1007 </div>
1008</footer>
1009
1010
1011
1012
1013</body></html>