Deploying to master from @ psycopg/psycopg-website@e879ef3 🚀

Author: dvarrazzo

articles.xml

@@ -80,7 +80,7 @@ <h1>Passing connections to functions using a decorator</h1>
     <p>In many script I write, there are functions requiring database operations. Every time I need them, I try to write such code in functions like:</p>
 <pre class="code python literal-block">
 <span class="nd">&#64;with_connection</span><span class="w">
-</span><span class="k">def</span> <span class="nf">do_some_job</span><span class="p">(</span><span class="n">cnn</span><span class="p">,</span> <span class="n">arg1</span><span class="p">,</span> <span class="n">arg2</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span><span class="w">
+</span><span class="k">def</span><span class="w"> </span><span class="nf">do_some_job</span><span class="p">(</span><span class="n">cnn</span><span class="p">,</span> <span class="n">arg1</span><span class="p">,</span> <span class="n">arg2</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span><span class="w">
 </span>    <span class="n">cur</span> <span class="o">=</span> <span class="n">cnn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span><span class="w">
 </span>    <span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">SQL</span><span class="p">,</span> <span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">arg2</span><span class="p">))</span> <span class="c1"># or something else</span><span class="w">
 
@@ -95,8 +95,8 @@ <h1>Passing connections to functions using a decorator</h1>
 </ul>
 <p>Implementation of such a decorator is straightforward, but because of the many possible variation it never made its way into a proper library. It goes something like:</p>
 <pre class="code python literal-block">
-<span class="k">def</span> <span class="nf">with_connection</span><span class="p">(</span><span class="n">f</span><span class="p">):</span><span class="w">
-</span>    <span class="k">def</span> <span class="nf">with_connection_</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span><span class="w">
+<span class="k">def</span><span class="w"> </span><span class="nf">with_connection</span><span class="p">(</span><span class="n">f</span><span class="p">):</span><span class="w">
+</span>    <span class="k">def</span><span class="w"> </span><span class="nf">with_connection_</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span><span class="w">
 </span>        <span class="c1"># or use a pool, or a factory function...</span><span class="w">
 </span>        <span class="n">cnn</span> <span class="o">=</span> <span class="n">psycopg</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">DSN</span><span class="p">)</span><span class="w">
 </span>        <span class="k">try</span><span class="p">:</span><span class="w">

articles/2010/10/22/passing-connections-functions-using-decorator/index.html

@@ -115,7 +115,7 @@ <h2><a href="/articles/2010/10/22/passing-connections-functions-using-decorator/
     <p>In many script I write, there are functions requiring database operations. Every time I need them, I try to write such code in functions like:</p>
 <pre class="code python literal-block">
 <span class="nd">&#64;with_connection</span><span class="w">
-</span><span class="k">def</span> <span class="nf">do_some_job</span><span class="p">(</span><span class="n">cnn</span><span class="p">,</span> <span class="n">arg1</span><span class="p">,</span> <span class="n">arg2</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span><span class="w">
+</span><span class="k">def</span><span class="w"> </span><span class="nf">do_some_job</span><span class="p">(</span><span class="n">cnn</span><span class="p">,</span> <span class="n">arg1</span><span class="p">,</span> <span class="n">arg2</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span><span class="w">
 </span>    <span class="n">cur</span> <span class="o">=</span> <span class="n">cnn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span><span class="w">
 </span>    <span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">SQL</span><span class="p">,</span> <span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">arg2</span><span class="p">))</span> <span class="c1"># or something else</span><span class="w">
 

articles/2010/10/index.html

@@ -92,12 +92,12 @@ <h2>Eventlet example</h2>
 <p>This example shows how hook the notifications system into Eventlet: using it with a <a class="reference external" href="https://en.wikipedia.org/wiki/WebSockets">WebSocket</a> it is possible to send an event from the database to the application and up to a web browser, all in push mode! The example requires PostgreSQL 9.0 and Psycopg 2.3 as it uses notification payloads.</p>
 <p>This function handles a WebSocket connection in a green thread: it creates a <tt class="docutils literal">Queue</tt> and opens a database connection (calling the <tt class="docutils literal">dblisten()</tt> function), then blocks on the queue waiting to receive notifications: as soon as any is received, its payload is forwarded to the browser. This is obviously just an example: a database connection for every browser wouldn't scale very much...</p>
 <pre class="code python literal-block">
-<span class="kn">import</span> <span class="nn">eventlet</span><span class="w">
-</span><span class="kn">from</span> <span class="nn">eventlet</span> <span class="kn">import</span> <span class="n">wsgi</span><span class="w">
-</span><span class="kn">from</span> <span class="nn">eventlet</span> <span class="kn">import</span> <span class="n">websocket</span><span class="w">
+<span class="kn">import</span><span class="w"> </span><span class="nn">eventlet</span><span class="w">
+</span><span class="kn">from</span><span class="w"> </span><span class="nn">eventlet</span><span class="w"> </span><span class="kn">import</span> <span class="n">wsgi</span><span class="w">
+</span><span class="kn">from</span><span class="w"> </span><span class="nn">eventlet</span><span class="w"> </span><span class="kn">import</span> <span class="n">websocket</span><span class="w">
 
 </span><span class="nd">&#64;websocket</span><span class="o">.</span><span class="n">WebSocketWSGI</span><span class="w">
-</span><span class="k">def</span> <span class="nf">handle</span><span class="p">(</span><span class="n">ws</span><span class="p">):</span><span class="w">
+</span><span class="k">def</span><span class="w"> </span><span class="nf">handle</span><span class="p">(</span><span class="n">ws</span><span class="p">):</span><span class="w">
     </span><span class="sd">&quot;&quot;&quot;
     Receive a connection and send it database notifications.
     &quot;&quot;&quot;</span><span class="w">
@@ -111,11 +111,11 @@ <h2>Eventlet example</h2>
 <p>When <tt class="docutils literal">handle()</tt> blocks on the queue the control of the program switches to a different green thread, allowing the rest of the program to keep on running even if single-threaded.</p>
 <p>The <tt class="docutils literal">dblisten</tt> function sets up the listening database connection:</p>
 <pre class="code python literal-block">
-<span class="kn">import</span> <span class="nn">psycopg2</span><span class="w">
-</span><span class="kn">from</span> <span class="nn">psycopg2.extensions</span> <span class="kn">import</span> <span class="n">ISOLATION_LEVEL_AUTOCOMMIT</span><span class="w">
-</span><span class="kn">from</span> <span class="nn">eventlet.hubs</span> <span class="kn">import</span> <span class="n">trampoline</span><span class="w">
+<span class="kn">import</span><span class="w"> </span><span class="nn">psycopg2</span><span class="w">
+</span><span class="kn">from</span><span class="w"> </span><span class="nn">psycopg2.extensions</span><span class="w"> </span><span class="kn">import</span> <span class="n">ISOLATION_LEVEL_AUTOCOMMIT</span><span class="w">
+</span><span class="kn">from</span><span class="w"> </span><span class="nn">eventlet.hubs</span><span class="w"> </span><span class="kn">import</span> <span class="n">trampoline</span><span class="w">
 
-</span><span class="k">def</span> <span class="nf">dblisten</span><span class="p">(</span><span class="n">q</span><span class="p">):</span><span class="w">
+</span><span class="k">def</span><span class="w"> </span><span class="nf">dblisten</span><span class="p">(</span><span class="n">q</span><span class="p">):</span><span class="w">
     </span><span class="sd">&quot;&quot;&quot;
     Open a db connection and add notifications to *q*.
     &quot;&quot;&quot;</span><span class="w">

articles/2010/12/01/postgresql-notifications-psycopg2-eventlet/index.html

@@ -100,7 +100,7 @@ <h1>Psycopg 2.4.2 released</h1>
 <p>a much handier syntax for an often used connection property.</p>
 <p>The improvements to the transactions control are not only at interface level: Psycopg doesn't require any more setup queries when connecting to a database. A sequence of statements:</p>
 <pre class="code python literal-block">
-<span class="kn">import</span> <span class="nn">psycopg2</span><span class="w">
+<span class="kn">import</span><span class="w"> </span><span class="nn">psycopg2</span><span class="w">
 </span><span class="n">conn</span> <span class="o">=</span> <span class="n">psycopg2</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s1">''</span><span class="p">)</span><span class="w">
 </span><span class="n">curs</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span><span class="w">
 </span><span class="n">curs</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s1">'SELECT 1'</span><span class="p">)</span><span class="w">

articles/2011/06/12/psycopg-242-released/index.html

@@ -81,10 +81,10 @@ <h1>Cancelling PostgreSQL statements from Python</h1>
 <!-- CUT-HERE -->
 <p>Using psycopg in <a class="reference external" href="/docs/advanced.html#support-for-coroutine-libraries">green mode</a> moves the waiting from the libpq C code to Python: this gives Python some chance of interaction: it is possible for instance to catch a ctrl-c and send a cancel request:</p>
 <pre class="code python literal-block">
-<span class="kn">from</span> <span class="nn">select</span> <span class="kn">import</span> <span class="n">select</span><span class="w">
-</span><span class="kn">from</span> <span class="nn">psycopg2.extensions</span> <span class="kn">import</span> <span class="n">POLL_OK</span><span class="p">,</span> <span class="n">POLL_READ</span><span class="p">,</span> <span class="n">POLL_WRITE</span><span class="w">
+<span class="kn">from</span><span class="w"> </span><span class="nn">select</span><span class="w"> </span><span class="kn">import</span> <span class="n">select</span><span class="w">
+</span><span class="kn">from</span><span class="w"> </span><span class="nn">psycopg2.extensions</span><span class="w"> </span><span class="kn">import</span> <span class="n">POLL_OK</span><span class="p">,</span> <span class="n">POLL_READ</span><span class="p">,</span> <span class="n">POLL_WRITE</span><span class="w">
 
-</span><span class="k">def</span> <span class="nf">wait_select_inter</span><span class="p">(</span><span class="n">conn</span><span class="p">):</span><span class="w">
+</span><span class="k">def</span><span class="w"> </span><span class="nf">wait_select_inter</span><span class="p">(</span><span class="n">conn</span><span class="p">):</span><span class="w">
 </span>    <span class="k">while</span> <span class="mi">1</span><span class="p">:</span><span class="w">
 </span>        <span class="k">try</span><span class="p">:</span><span class="w">
 </span>            <span class="n">state</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">poll</span><span class="p">()</span><span class="w">

articles/2014/07/20/cancelling-postgresql-statements-python/index.html

@@ -216,8 +216,8 @@ <h2>Customising psycopg3 adaptation</h2>
 infinity, we could create a subclass for the dumper and register it in the
 scope we want to use it, globally or just on a connection or cursor:</p>
 <pre class="code python literal-block">
-<span class="k">class</span> <span class="nc">InfDateDumper</span><span class="p">(</span><span class="n">DateDumper</span><span class="p">):</span><span class="w">
-</span>    <span class="k">def</span> <span class="nf">dump</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">):</span><span class="w">
+<span class="k">class</span><span class="w"> </span><span class="nc">InfDateDumper</span><span class="p">(</span><span class="n">DateDumper</span><span class="p">):</span><span class="w">
+</span>    <span class="k">def</span><span class="w"> </span><span class="nf">dump</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">):</span><span class="w">
 </span>        <span class="k">if</span> <span class="n">obj</span> <span class="o">==</span> <span class="n">date</span><span class="o">.</span><span class="n">max</span><span class="p">:</span><span class="w">
 </span>            <span class="k">return</span> <span class="sa">b</span><span class="s2">&quot;infinity&quot;</span><span class="w">
 </span>        <span class="k">else</span><span class="p">:</span><span class="w">
@@ -237,8 +237,8 @@ <h2>Customising psycopg3 adaptation</h2>
 <tt class="docutils literal">date.max</tt> (instead of raising an exception), it could be done using a
 subclass of the builtin loader (or using an entirely new object if required):</p>
 <pre class="code python literal-block">
-<span class="k">class</span> <span class="nc">InfDateLoader</span><span class="p">(</span><span class="n">DateLoader</span><span class="p">):</span><span class="w">
-</span>    <span class="k">def</span> <span class="nf">load</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span><span class="w">
+<span class="k">class</span><span class="w"> </span><span class="nc">InfDateLoader</span><span class="p">(</span><span class="n">DateLoader</span><span class="p">):</span><span class="w">
+</span>    <span class="k">def</span><span class="w"> </span><span class="nf">load</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span><span class="w">
 </span>        <span class="k">if</span> <span class="n">data</span> <span class="o">==</span> <span class="sa">b</span><span class="s2">&quot;infinity&quot;</span><span class="p">:</span><span class="w">
 </span>            <span class="k">return</span> <span class="n">date</span><span class="o">.</span><span class="n">max</span><span class="w">
 </span>        <span class="k">else</span><span class="p">:</span><span class="w">
@@ -247,7 +247,7 @@ <h2>Customising psycopg3 adaptation</h2>
 </span><span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">&quot;select '2020-12-31'::date, 'infinity'::date&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span><span class="w">
 </span><span class="c1"># Raises DataError: Python date doesn't support years after 9999: got infinity</span><span class="w">
 
-</span><span class="kn">from</span> <span class="nn">psycopg3.oids</span> <span class="kn">import</span> <span class="n">builtins</span><span class="w">
+</span><span class="kn">from</span><span class="w"> </span><span class="nn">psycopg3.oids</span><span class="w"> </span><span class="kn">import</span> <span class="n">builtins</span><span class="w">
 </span><span class="n">InfDateLoader</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">builtins</span><span class="p">[</span><span class="s2">&quot;date&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">oid</span><span class="p">,</span> <span class="n">cur</span><span class="p">)</span><span class="w">
 
 </span><span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">&quot;select '2020-12-31'::date, 'infinity'::date&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span><span class="w">