Skip to content

Commit 03c3750

Browse files
edgedb-ciedgedb-ci
committed
Automatic documentation update
1 parent 3dd667c commit 03c3750

32 files changed

+1775
-870
lines changed

‎current/.buildinfo

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
2-
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: f5d336afd0916ef3cb7549d07a187cdb
2+
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 8b99e120410157271d4ddd1afccd5ab4
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎current/_modules/asyncpg/connection.html

+277-76
Large diffs are not rendered by default.

‎current/_modules/asyncpg/cursor.html

+32-21
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
1+
2+
13
<!DOCTYPE html>
2-
<html class="writer-html5" lang="en" >
4+
<html class="writer-html5" lang="en" data-content_root="../../">
35
<head>
46
<meta charset="utf-8" />
57
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
68
<title>asyncpg.cursor &mdash; asyncpg Documentation</title>
7-
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
8-
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
9-
<!--[if lt IE 9]>
10-
<script src="../../_static/js/html5shiv.min.js"></script>
11-
<![endif]-->
9+
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
10+
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
11+
1212

13-
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
14-
<script src="../../_static/jquery.js"></script>
15-
<script src="../../_static/underscore.js"></script>
16-
<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
17-
<script src="../../_static/doctools.js"></script>
18-
<script src="../../_static/sphinx_highlight.js"></script>
13+
<script src="../../_static/jquery.js?v=5d32c60e"></script>
14+
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15+
<script src="../../_static/documentation_options.js?v=a7ea5d77"></script>
16+
<script src="../../_static/doctools.js?v=9bcbadda"></script>
17+
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1918
<script src="../../_static/js/theme.js"></script>
2019
<link rel="index" title="Index" href="../../genindex.html" />
2120
<link rel="search" title="Search" href="../../search.html" />
@@ -32,9 +31,6 @@
3231
<a href="../../index.html" class="icon icon-home">
3332
asyncpg
3433
</a>
35-
<div class="version">
36-
0.29.0
37-
</div>
3834
<div role="search">
3935
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
4036
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
@@ -88,7 +84,9 @@ <h1>Source code for asyncpg.cursor</h1><div class="highlight"><pre>
8884
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">exceptions</span>
8985

9086

91-
<div class="viewcode-block" id="CursorFactory"><a class="viewcode-back" href="../../api/index.html#asyncpg.cursor.CursorFactory">[docs]</a><span class="k">class</span> <span class="nc">CursorFactory</span><span class="p">(</span><span class="n">connresource</span><span class="o">.</span><span class="n">ConnectionResource</span><span class="p">):</span>
87+
<div class="viewcode-block" id="CursorFactory">
88+
<a class="viewcode-back" href="../../api/index.html#asyncpg.cursor.CursorFactory">[docs]</a>
89+
<span class="k">class</span> <span class="nc">CursorFactory</span><span class="p">(</span><span class="n">connresource</span><span class="o">.</span><span class="n">ConnectionResource</span><span class="p">):</span>
9290
<span class="w"> </span><span class="sd">&quot;&quot;&quot;A cursor interface for the results of a query.</span>
9391

9492
<span class="sd"> A cursor interface can be used to initiate efficient traversal of the</span>
@@ -157,6 +155,7 @@ <h1>Source code for asyncpg.cursor</h1><div class="highlight"><pre>
157155
<span class="bp">self</span><span class="o">.</span><span class="n">_connection</span><span class="o">.</span><span class="n">_maybe_gc_stmt</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_state</span><span class="p">)</span></div>
158156

159157

158+
160159
<span class="k">class</span> <span class="nc">BaseCursor</span><span class="p">(</span><span class="n">connresource</span><span class="o">.</span><span class="n">ConnectionResource</span><span class="p">):</span>
161160

162161
<span class="vm">__slots__</span> <span class="o">=</span> <span class="p">(</span>
@@ -324,7 +323,9 @@ <h1>Source code for asyncpg.cursor</h1><div class="highlight"><pre>
324323
<span class="k">raise</span> <span class="ne">StopAsyncIteration</span>
325324

326325

327-
<div class="viewcode-block" id="Cursor"><a class="viewcode-back" href="../../api/index.html#asyncpg.cursor.Cursor">[docs]</a><span class="k">class</span> <span class="nc">Cursor</span><span class="p">(</span><span class="n">BaseCursor</span><span class="p">):</span>
326+
<div class="viewcode-block" id="Cursor">
327+
<a class="viewcode-back" href="../../api/index.html#asyncpg.cursor.Cursor">[docs]</a>
328+
<span class="k">class</span> <span class="nc">Cursor</span><span class="p">(</span><span class="n">BaseCursor</span><span class="p">):</span>
328329
<span class="w"> </span><span class="sd">&quot;&quot;&quot;An open *portal* into the results of a query.&quot;&quot;&quot;</span>
329330

330331
<span class="vm">__slots__</span> <span class="o">=</span> <span class="p">()</span>
@@ -342,7 +343,9 @@ <h1>Source code for asyncpg.cursor</h1><div class="highlight"><pre>
342343
<span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bind</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span>
343344
<span class="k">return</span> <span class="bp">self</span>
344345

345-
<div class="viewcode-block" id="Cursor.fetch"><a class="viewcode-back" href="../../api/index.html#asyncpg.cursor.Cursor.fetch">[docs]</a> <span class="nd">@connresource</span><span class="o">.</span><span class="n">guarded</span>
346+
<div class="viewcode-block" id="Cursor.fetch">
347+
<a class="viewcode-back" href="../../api/index.html#asyncpg.cursor.Cursor.fetch">[docs]</a>
348+
<span class="nd">@connresource</span><span class="o">.</span><span class="n">guarded</span>
346349
<span class="k">async</span> <span class="k">def</span> <span class="nf">fetch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
347350
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;Return the next *n* rows as a list of :class:`Record` objects.</span>
348351

@@ -360,7 +363,10 @@ <h1>Source code for asyncpg.cursor</h1><div class="highlight"><pre>
360363
<span class="bp">self</span><span class="o">.</span><span class="n">_exhausted</span> <span class="o">=</span> <span class="kc">True</span>
361364
<span class="k">return</span> <span class="n">recs</span></div>
362365

363-
<div class="viewcode-block" id="Cursor.fetchrow"><a class="viewcode-back" href="../../api/index.html#asyncpg.cursor.Cursor.fetchrow">[docs]</a> <span class="nd">@connresource</span><span class="o">.</span><span class="n">guarded</span>
366+
367+
<div class="viewcode-block" id="Cursor.fetchrow">
368+
<a class="viewcode-back" href="../../api/index.html#asyncpg.cursor.Cursor.fetchrow">[docs]</a>
369+
<span class="nd">@connresource</span><span class="o">.</span><span class="n">guarded</span>
364370
<span class="k">async</span> <span class="k">def</span> <span class="nf">fetchrow</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
365371
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;Return the next row.</span>
366372

@@ -377,7 +383,10 @@ <h1>Source code for asyncpg.cursor</h1><div class="highlight"><pre>
377383
<span class="k">return</span> <span class="kc">None</span>
378384
<span class="k">return</span> <span class="n">recs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span></div>
379385

380-
<div class="viewcode-block" id="Cursor.forward"><a class="viewcode-back" href="../../api/index.html#asyncpg.cursor.Cursor.forward">[docs]</a> <span class="nd">@connresource</span><span class="o">.</span><span class="n">guarded</span>
386+
387+
<div class="viewcode-block" id="Cursor.forward">
388+
<a class="viewcode-back" href="../../api/index.html#asyncpg.cursor.Cursor.forward">[docs]</a>
389+
<span class="nd">@connresource</span><span class="o">.</span><span class="n">guarded</span>
381390
<span class="k">async</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
382391
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;Skip over the next *n* rows.</span>
383392

@@ -397,7 +406,9 @@ <h1>Source code for asyncpg.cursor</h1><div class="highlight"><pre>
397406
<span class="k">if</span> <span class="n">advanced</span> <span class="o">&lt;</span> <span class="n">n</span><span class="p">:</span>
398407
<span class="bp">self</span><span class="o">.</span><span class="n">_exhausted</span> <span class="o">=</span> <span class="kc">True</span>
399408

400-
<span class="k">return</span> <span class="n">advanced</span></div></div>
409+
<span class="k">return</span> <span class="n">advanced</span></div>
410+
</div>
411+
401412
</pre></div>
402413

403414
</div>

0 commit comments

Comments
 (0)