Skip to content

Commit 6e71a8a

Browse files
committed
Automatic documentation update
1 parent fe594c4 commit 6e71a8a

22 files changed

Lines changed: 1260 additions & 967 deletions

‎current/_modules/asyncpg/connection.html‎

Lines changed: 403 additions & 348 deletions
Large diffs are not rendered by default.

‎current/_modules/asyncpg/cursor.html‎

Lines changed: 45 additions & 45 deletions
Large diffs are not rendered by default.

‎current/_modules/asyncpg/pool.html‎

Lines changed: 291 additions & 147 deletions
Large diffs are not rendered by default.

‎current/_modules/asyncpg/prepared_stmt.html‎

Lines changed: 52 additions & 52 deletions
Large diffs are not rendered by default.

‎current/_modules/asyncpg/transaction.html‎

Lines changed: 61 additions & 61 deletions
Large diffs are not rendered by default.

‎current/_modules/asyncpg/types.html‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
88
<title>asyncpg.types &mdash; asyncpg Documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
10-
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
10+
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=9edc463e" />
1111

1212

1313
<script src="../../_static/jquery.js?v=5d32c60e"></script>
1414
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15-
<script src="../../_static/documentation_options.js?v=d63f172e"></script>
15+
<script src="../../_static/documentation_options.js?v=4440c9c5"></script>
1616
<script src="../../_static/doctools.js?v=9a2dae69"></script>
1717
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1818
<script src="../../_static/js/theme.js"></script>
@@ -91,8 +91,8 @@ <h1>Source code for asyncpg.types</h1><div class="highlight"><pre>
9191

9292

9393
<span class="n">__all__</span> <span class="o">=</span> <span class="p">(</span>
94-
<span class="s1">&#39;Type&#39;</span><span class="p">,</span> <span class="s1">&#39;Attribute&#39;</span><span class="p">,</span> <span class="s1">&#39;Range&#39;</span><span class="p">,</span> <span class="s1">&#39;BitString&#39;</span><span class="p">,</span> <span class="s1">&#39;Point&#39;</span><span class="p">,</span> <span class="s1">&#39;Path&#39;</span><span class="p">,</span> <span class="s1">&#39;Polygon&#39;</span><span class="p">,</span>
95-
<span class="s1">&#39;Box&#39;</span><span class="p">,</span> <span class="s1">&#39;Line&#39;</span><span class="p">,</span> <span class="s1">&#39;LineSegment&#39;</span><span class="p">,</span> <span class="s1">&#39;Circle&#39;</span><span class="p">,</span> <span class="s1">&#39;ServerVersion&#39;</span><span class="p">,</span>
94+
<span class="s1">'Type'</span><span class="p">,</span> <span class="s1">'Attribute'</span><span class="p">,</span> <span class="s1">'Range'</span><span class="p">,</span> <span class="s1">'BitString'</span><span class="p">,</span> <span class="s1">'Point'</span><span class="p">,</span> <span class="s1">'Path'</span><span class="p">,</span> <span class="s1">'Polygon'</span><span class="p">,</span>
95+
<span class="s1">'Box'</span><span class="p">,</span> <span class="s1">'Line'</span><span class="p">,</span> <span class="s1">'LineSegment'</span><span class="p">,</span> <span class="s1">'Circle'</span><span class="p">,</span> <span class="s1">'ServerVersion'</span><span class="p">,</span>
9696
<span class="p">)</span>
9797

9898

@@ -106,12 +106,12 @@ <h1>Source code for asyncpg.types</h1><div class="highlight"><pre>
106106

107107

108108

109-
<span class="n">Type</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s1">&#39;Database data type.&#39;</span>
110-
<span class="n">Type</span><span class="o">.</span><span class="n">oid</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s1">&#39;OID of the type.&#39;</span>
111-
<span class="n">Type</span><span class="o">.</span><span class="n">name</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s1">&#39;Type name. For example &quot;int2&quot;.&#39;</span>
109+
<span class="n">Type</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s1">'Database data type.'</span>
110+
<span class="n">Type</span><span class="o">.</span><span class="n">oid</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s1">'OID of the type.'</span>
111+
<span class="n">Type</span><span class="o">.</span><span class="n">name</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s1">'Type name. For example "int2".'</span>
112112
<span class="n">Type</span><span class="o">.</span><span class="n">kind</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> \
113-
<span class="s1">&#39;Type kind. Can be &quot;scalar&quot;, &quot;array&quot;, &quot;composite&quot; or &quot;range&quot;.&#39;</span>
114-
<span class="n">Type</span><span class="o">.</span><span class="n">schema</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s1">&#39;Name of the database schema that defines the type.&#39;</span>
113+
<span class="s1">'Type kind. Can be "scalar", "array", "composite" or "range".'</span>
114+
<span class="n">Type</span><span class="o">.</span><span class="n">schema</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s1">'Name of the database schema that defines the type.'</span>
115115

116116

117117
<div class="viewcode-block" id="Attribute">
@@ -122,9 +122,9 @@ <h1>Source code for asyncpg.types</h1><div class="highlight"><pre>
122122

123123

124124

125-
<span class="n">Attribute</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s1">&#39;Database relation attribute.&#39;</span>
126-
<span class="n">Attribute</span><span class="o">.</span><span class="n">name</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s1">&#39;Attribute name.&#39;</span>
127-
<span class="n">Attribute</span><span class="o">.</span><span class="n">type</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s1">&#39;Attribute data type :class:`asyncpg.types.Type`.&#39;</span>
125+
<span class="n">Attribute</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s1">'Database relation attribute.'</span>
126+
<span class="n">Attribute</span><span class="o">.</span><span class="n">name</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s1">'Attribute name.'</span>
127+
<span class="n">Attribute</span><span class="o">.</span><span class="n">type</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s1">'Attribute data type :class:`asyncpg.types.Type`.'</span>
128128

129129

130130
<div class="viewcode-block" id="ServerVersion">
@@ -138,7 +138,7 @@ <h1>Source code for asyncpg.types</h1><div class="highlight"><pre>
138138

139139

140140

141-
<span class="n">ServerVersion</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s1">&#39;PostgreSQL server version tuple.&#39;</span>
141+
<span class="n">ServerVersion</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s1">'PostgreSQL server version tuple.'</span>
142142

143143

144144
<span class="k">class</span><span class="w"> </span><span class="nc">_RangeValue</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">Protocol</span><span class="p">):</span>
@@ -152,15 +152,15 @@ <h1>Source code for asyncpg.types</h1><div class="highlight"><pre>
152152
<span class="o">...</span>
153153

154154

155-
<span class="n">_RV</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">TypeVar</span><span class="p">(</span><span class="s1">&#39;_RV&#39;</span><span class="p">,</span> <span class="n">bound</span><span class="o">=</span><span class="n">_RangeValue</span><span class="p">)</span>
155+
<span class="n">_RV</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">TypeVar</span><span class="p">(</span><span class="s1">'_RV'</span><span class="p">,</span> <span class="n">bound</span><span class="o">=</span><span class="n">_RangeValue</span><span class="p">)</span>
156156

157157

158158
<div class="viewcode-block" id="Range">
159159
<a class="viewcode-back" href="../../api/index.html#asyncpg.types.Range">[docs]</a>
160160
<span class="k">class</span><span class="w"> </span><span class="nc">Range</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">Generic</span><span class="p">[</span><span class="n">_RV</span><span class="p">]):</span>
161-
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Immutable representation of PostgreSQL `range` type.&quot;&quot;&quot;</span>
161+
<span class="w"> </span><span class="sd">"""Immutable representation of PostgreSQL `range` type."""</span>
162162

163-
<span class="vm">__slots__</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;_lower&#39;</span><span class="p">,</span> <span class="s1">&#39;_upper&#39;</span><span class="p">,</span> <span class="s1">&#39;_lower_inc&#39;</span><span class="p">,</span> <span class="s1">&#39;_upper_inc&#39;</span><span class="p">,</span> <span class="s1">&#39;_empty&#39;</span><span class="p">)</span>
163+
<span class="vm">__slots__</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'_lower'</span><span class="p">,</span> <span class="s1">'_upper'</span><span class="p">,</span> <span class="s1">'_lower_inc'</span><span class="p">,</span> <span class="s1">'_upper_inc'</span><span class="p">,</span> <span class="s1">'_empty'</span><span class="p">)</span>
164164

165165
<span class="n">_lower</span><span class="p">:</span> <span class="n">_RV</span> <span class="o">|</span> <span class="kc">None</span>
166166
<span class="n">_upper</span><span class="p">:</span> <span class="n">_RV</span> <span class="o">|</span> <span class="kc">None</span>
@@ -280,29 +280,29 @@ <h1>Source code for asyncpg.types</h1><div class="highlight"><pre>
280280

281281
<span class="k">def</span><span class="w"> </span><span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
282282
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_empty</span><span class="p">:</span>
283-
<span class="n">desc</span> <span class="o">=</span> <span class="s1">&#39;empty&#39;</span>
283+
<span class="n">desc</span> <span class="o">=</span> <span class="s1">'empty'</span>
284284
<span class="k">else</span><span class="p">:</span>
285285
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lower</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lower_inc</span><span class="p">:</span>
286-
<span class="n">lb</span> <span class="o">=</span> <span class="s1">&#39;(&#39;</span>
286+
<span class="n">lb</span> <span class="o">=</span> <span class="s1">'('</span>
287287
<span class="k">else</span><span class="p">:</span>
288-
<span class="n">lb</span> <span class="o">=</span> <span class="s1">&#39;[&#39;</span>
288+
<span class="n">lb</span> <span class="o">=</span> <span class="s1">'['</span>
289289

290290
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lower</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
291291
<span class="n">lb</span> <span class="o">+=</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_lower</span><span class="p">)</span>
292292

293293
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_upper</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
294294
<span class="n">ub</span> <span class="o">=</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_upper</span><span class="p">)</span>
295295
<span class="k">else</span><span class="p">:</span>
296-
<span class="n">ub</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
296+
<span class="n">ub</span> <span class="o">=</span> <span class="s1">''</span>
297297

298298
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_upper</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_upper_inc</span><span class="p">:</span>
299-
<span class="n">ub</span> <span class="o">+=</span> <span class="s1">&#39;)&#39;</span>
299+
<span class="n">ub</span> <span class="o">+=</span> <span class="s1">')'</span>
300300
<span class="k">else</span><span class="p">:</span>
301-
<span class="n">ub</span> <span class="o">+=</span> <span class="s1">&#39;]&#39;</span>
301+
<span class="n">ub</span> <span class="o">+=</span> <span class="s1">']'</span>
302302

303-
<span class="n">desc</span> <span class="o">=</span> <span class="s1">&#39;</span><span class="si">{}</span><span class="s1">, </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">lb</span><span class="p">,</span> <span class="n">ub</span><span class="p">)</span>
303+
<span class="n">desc</span> <span class="o">=</span> <span class="s1">'</span><span class="si">{}</span><span class="s1">, </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">lb</span><span class="p">,</span> <span class="n">ub</span><span class="p">)</span>
304304

305-
<span class="k">return</span> <span class="s1">&#39;&lt;Range </span><span class="si">{}</span><span class="s1">&gt;&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">desc</span><span class="p">)</span>
305+
<span class="k">return</span> <span class="s1">'&lt;Range </span><span class="si">{}</span><span class="s1">&gt;'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">desc</span><span class="p">)</span>
306306

307307
<span class="fm">__str__</span> <span class="o">=</span> <span class="fm">__repr__</span></div>
308308

‎current/_modules/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
88
<title>Overview: module code &mdash; asyncpg Documentation</title>
99
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
10-
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
10+
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" />
1111

1212

1313
<script src="../_static/jquery.js?v=5d32c60e"></script>
1414
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15-
<script src="../_static/documentation_options.js?v=d63f172e"></script>
15+
<script src="../_static/documentation_options.js?v=4440c9c5"></script>
1616
<script src="../_static/doctools.js?v=9a2dae69"></script>
1717
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
1818
<script src="../_static/js/theme.js"></script>

‎current/_sources/api/index.rst.txt‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,20 @@ a need to run the same query again.
5050

5151
asyncpg automatically maintains a small LRU cache for queries executed
5252
during calls to the :meth:`~Connection.fetch`, :meth:`~Connection.fetchrow`,
53-
or :meth:`~Connection.fetchval` methods.
53+
or :meth:`~Connection.fetchval` methods. :meth:`~Connection.execute`
54+
also uses the cache when query arguments are provided.
55+
56+
To confirm that a single row was inserted, inspect the command status
57+
string returned by :meth:`~Connection.execute`:
58+
59+
.. code-block:: pycon
60+
61+
>>> result = await con.execute(
62+
... 'INSERT INTO mytab (a) VALUES ($1)', 1)
63+
>>> assert result == 'INSERT 0 1'
64+
65+
An ``INSERT 0 0`` status is a legitimate result for queries that insert
66+
zero rows (for example, ``INSERT INTO mytab (a) SELECT 1 WHERE false``).
5467

5568
.. warning::
5669

‎current/_sources/index.rst.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ of PostgreSQL server binary protocol for use with Python's ``asyncio``
1616
framework.
1717

1818
**asyncpg** requires Python 3.9 or later and is supported for PostgreSQL
19-
versions 9.5 to 18. Other PostgreSQL versions or other databases implementing
19+
versions 9.5 to 19. Other PostgreSQL versions or other databases implementing
2020
the PostgreSQL protocol *may* work, but are not being actively tested.
2121

2222
Contents

‎current/_sources/usage.rst.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,10 @@ The table below shows the correspondence between PostgreSQL and Python types.
138138
| ``integer``, | |
139139
| ``bigint`` | |
140140
+----------------------+-----------------------------------------------------+
141+
| ``oid8`` | :class:`int <python:int>` |
142+
+----------------------+-----------------------------------------------------+
143+
| ``regdatabase`` | :class:`str <python:str>` |
144+
+----------------------+-----------------------------------------------------+
141145
| ``numeric`` | :class:`Decimal <python:decimal.Decimal>` |
142146
+----------------------+-----------------------------------------------------+
143147
| ``json``, ``jsonb`` | :class:`str <python:str>` |

0 commit comments

Comments
 (0)