Skip to content

Commit e6bfebb

Browse files
phdruphdru
committed
Updat devel docs
1 parent e658566 commit e6bfebb

File tree

158 files changed

+33
-6062
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

158 files changed

+33
-6062
lines changed

‎devel/News.html

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -182,9 +182,6 @@ <h3>Drivers (work in progress)<a class="headerlink" href="#drivers-work-in-progr
182182
<li>Extend support for PyGreSQL driver. There are still some problems.</li>
183183
<li>Add support for <a class="reference external" href="https://pypi.python.org/pypi/py-postgresql">py-postgresql</a> PostgreSQL driver. There
184184
are still problems with the driver.</li>
185-
<li>Add support for <a class="reference external" href="https://pypi.python.org/pypi/pg8000">pg8000</a>
186-
PostgreSQL driver. There are major problems with the driver caused by both
187-
the driver and SQLObject.</li>
188185
<li>Add support for <a class="reference external" href="https://pypi.python.org/pypi/firebirdsql">pyfirebirdsql</a>.There are still problems with
189186
the driver.</li>
190187
</ul>
@@ -219,10 +216,11 @@ <h3>Tests<a class="headerlink" href="#tests" title="Permalink to this headline">
219216
tests were deprecated in <code class="docutils literal"><span class="pre">pytest</span></code>.</li>
220217
<li>Tests are now run at CIs with Python 3.5.</li>
221218
<li>Drop <code class="docutils literal"><span class="pre">Circle</span> <span class="pre">CI</span></code>.</li>
222-
<li>Run at Travis CI tests with Firebird backend (server version 2.5; drivers fdb
223-
and firebirdsql). There are problems with tests.</li>
224-
<li>Run tests at AppVeyor for windows testing. Run tests with MS SQL, Postgres
225-
and SQLite. There are problems with MS SQL.</li>
219+
<li>Run at Travis CI tests with Firebird backend (server version 2.5;
220+
drivers fdb and firebirdsql). There are problems with tests.</li>
221+
<li>Run tests at AppVeyor for windows testing. Run tests with MS SQL,
222+
MySQL, Postgres and SQLite backends; use Python 2.7, 3.4 and 3.5,
223+
x86 and x64. There are problems with MS SQL and MySQL.</li>
226224
</ul>
227225
</div>
228226
</div>

‎devel/SQLObject.html

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -313,8 +313,8 @@ <h2><a class="toc-backref" href="#id12">Introduction</a><a class="headerlink" hr
313313
<h2><a class="toc-backref" href="#id13">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this headline"></a></h2>
314314
<p>Currently SQLObject supports <a class="reference external" href="https://www.mysql.com/">MySQL</a> via <a class="reference external" href="https://sourceforge.net/projects/mysql-python/">MySQLdb</a> aka MySQL-python (called
315315
<a class="reference external" href="https://pypi.python.org/pypi/mysqlclient">mysqlclient</a> for Python 3), <a class="reference external" href="https://pypi.python.org/pypi/mysql-connector">MySQL Connector</a>, <a class="reference external" href="https://github.com/python-oursql/oursql">oursql</a> and <a class="reference external" href="https://github.com/PyMySQL/PyMySQL/">PyMySQL</a>. For
316-
<a class="reference external" href="https://postgresql.org">PostgreSQL</a> <a class="reference external" href="http://initd.org/psycopg/">psycopg2</a> or psycopg1 are recommended; <a class="reference external" href="http://www.pygresql.org/">PyGreSQL</a>, <a class="reference external" href="https://pypi.python.org/pypi/py-postgresql">py-postgresql</a>
317-
and <a class="reference external" href="https://pypi.python.org/pypi/pg8000">pg8000</a> are supported but have problems (not all tests passed). <a class="reference external" href="https://sqlite.org/">SQLite</a> has
316+
<a class="reference external" href="https://postgresql.org">PostgreSQL</a> <a class="reference external" href="http://initd.org/psycopg/">psycopg2</a> or psycopg1 are recommended; <a class="reference external" href="http://www.pygresql.org/">PyGreSQL</a> and <a class="reference external" href="https://pypi.python.org/pypi/py-postgresql">py-postgresql</a>
317+
are supported but have problems (not all tests passed). <a class="reference external" href="https://sqlite.org/">SQLite</a> has
318318
a built-in driver or <a class="reference external" href="https://github.com/ghaering/pysqlite">PySQLite</a>. <a class="reference external" href="http://www.firebirdsql.org/en/python-driver/">Firebird</a> is supported via <a class="reference external" href="http://www.firebirdsql.org/en/devel-python-driver/">fdb</a> or
319319
<a class="reference external" href="http://kinterbasdb.sourceforge.net/">kinterbasdb</a>; <a class="reference external" href="https://pypi.python.org/pypi/firebirdsql">pyfirebirdsql</a> is supported but has problems. <a class="reference external" href="http://maxdb.sap.com/">MAX DB</a> (also
320320
known as SAP DB) is supported via <a class="reference external" href="http://maxdb.sap.com/doc/7_8/50/01923f25b842438a408805774f6989/frameset.htm">sapdb</a>. Sybase via <a class="reference external" href="http://www.object-craft.com.au/projects/sybase/">Sybase</a>. <a class="reference external" href="http://www.microsoft.com/sql/">MSSQL Server</a>
@@ -1811,21 +1811,18 @@ <h2><a class="toc-backref" href="#id57">DBConnection: Database Connections</a><a
18111811
<code class="docutils literal"><span class="pre">stdout</span></code> or <code class="docutils literal"><span class="pre">stderr</span></code> in this case; default is <code class="docutils literal"><span class="pre">stdout</span></code>.</p>
18121812
<p>To configure logging one can do something like that:</p>
18131813
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">logging</span>
1814-
<span class="n">logging</span><span class="o">.</span><span class="n">basicConfig</span><span class="p">()</span>
1815-
<span class="k">for</span> <span class="n">handler</span> <span class="ow">in</span> <span class="n">logging</span><span class="o">.</span><span class="n">root</span><span class="o">.</span><span class="n">handlers</span><span class="p">[:]:</span>
1816-
<span class="n">logging</span><span class="o">.</span><span class="n">root</span><span class="o">.</span><span class="n">removeHandler</span><span class="p">(</span><span class="n">handler</span><span class="p">)</span>
1817-
<span class="n">handler</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">FileHandler</span><span class="p">(</span><span class="s2">&quot;test.log&quot;</span><span class="p">)</span>
1818-
<span class="n">fmt</span> <span class="o">=</span> <span class="s1">&#39;[</span><span class="si">%(asctime)s</span><span class="s1">] </span><span class="si">%(name)s</span><span class="s1"> </span><span class="si">%(levelname)s</span><span class="s1">: </span><span class="si">%(message)s</span><span class="s1">&#39;</span>
1819-
<span class="n">handler</span><span class="o">.</span><span class="n">setFormatter</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span><span class="p">(</span><span class="n">fmt</span><span class="p">))</span>
1820-
<span class="n">logging</span><span class="o">.</span><span class="n">root</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">handler</span><span class="p">)</span>
1821-
<span class="n">logging</span><span class="o">.</span><span class="n">root</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span>
1814+
<span class="n">logging</span><span class="o">.</span><span class="n">basicConfig</span><span class="p">(</span>
1815+
<span class="n">filename</span><span class="o">=</span><span class="s1">&#39;test.log&#39;</span><span class="p">,</span>
1816+
<span class="nb">format</span><span class="o">=</span><span class="s1">&#39;[</span><span class="si">%(asctime)s</span><span class="s1">] </span><span class="si">%(name)s</span><span class="s1"> </span><span class="si">%(levelname)s</span><span class="s1">: </span><span class="si">%(message)s</span><span class="s1">&#39;</span><span class="p">,</span>
1817+
<span class="n">level</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">,</span>
1818+
<span class="p">)</span>
18221819
<span class="n">log</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s2">&quot;TEST&quot;</span><span class="p">)</span>
18231820
<span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Log started&quot;</span><span class="p">)</span>
18241821

18251822
<span class="n">__connection__</span> <span class="o">=</span> <span class="s2">&quot;sqlite:/:memory:?debug=1&amp;logger=TEST&amp;loglevel=debug&quot;</span>
18261823
</pre></div>
18271824
</div>
1828-
<p>The code redirects SQLObject debug messages to the <cite>test.log</cite> file.</p>
1825+
<p>The code redirects SQLObject debug messages to <cite>test.log</cite> file.</p>
18291826
<div class="section" id="id3">
18301827
<h3><a class="toc-backref" href="#id58">MySQL</a><a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
18311828
<p><cite>MySQLConnection</cite> takes the keyword arguments <cite>host</cite>, <cite>port</cite>, <cite>db</cite>, <cite>user</cite>,
@@ -1874,8 +1871,8 @@ <h3><a class="toc-backref" href="#id59">Postgres</a><a class="headerlink" href="
18741871
<p>The user can choose a DB API driver for PostgreSQL by using a <code class="docutils literal"><span class="pre">driver</span></code>
18751872
parameter in DB URI or PostgresConnection that can be a comma-separated
18761873
list of driver names. Possible drivers are: <code class="docutils literal"><span class="pre">psycopg2</span></code>, psycopg1,
1877-
<code class="docutils literal"><span class="pre">psycopg</span></code> (tries psycopg2 and psycopg1), <code class="docutils literal"><span class="pre">pygresql</span></code>, <code class="docutils literal"><span class="pre">pygresql</span></code>,
1878-
<code class="docutils literal"><span class="pre">pg8000</span></code> or <code class="docutils literal"><span class="pre">pypostgresql</span></code>. Default is <code class="docutils literal"><span class="pre">psycopg</span></code>.</p>
1874+
<code class="docutils literal"><span class="pre">psycopg</span></code> (tries psycopg2 and psycopg1), <code class="docutils literal"><span class="pre">pygresql</span></code>, <code class="docutils literal"><span class="pre">pygresql</span></code>
1875+
or <code class="docutils literal"><span class="pre">pypostgresql</span></code>. Default is <code class="docutils literal"><span class="pre">psycopg</span></code>.</p>
18791876
<p>Connection-specific parameters are: <code class="docutils literal"><span class="pre">sslmode</span></code>, <code class="docutils literal"><span class="pre">unicodeCols</span></code>,
18801877
<code class="docutils literal"><span class="pre">schema</span></code>, <code class="docutils literal"><span class="pre">charset</span></code>.</p>
18811878
</div>

‎devel/_modules/sqlobject/postgres/pgconnection.html

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,7 @@ <h3>Quick search</h3>
6969
<div class="body" role="main">
7070

7171
<h1>Source code for sqlobject.postgres.pgconnection</h1><div class="highlight"><pre>
72-
<span></span><span class="kn">from</span> <span class="nn">getpass</span> <span class="k">import</span> <span class="n">getuser</span>
73-
<span class="kn">import</span> <span class="nn">re</span>
74-
<span class="kn">import</span> <span class="nn">sys</span>
72+
<span></span><span class="kn">import</span> <span class="nn">re</span>
7573
<span class="kn">from</span> <span class="nn">sqlobject</span> <span class="k">import</span> <span class="n">col</span>
7674
<span class="kn">from</span> <span class="nn">sqlobject</span> <span class="k">import</span> <span class="n">dberrors</span>
7775
<span class="kn">from</span> <span class="nn">sqlobject</span> <span class="k">import</span> <span class="n">sqlbuilder</span>
@@ -126,14 +124,11 @@ <h1>Source code for sqlobject.postgres.pgconnection</h1><div class="highlight"><
126124
<span class="k">elif</span> <span class="n">driver</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;py-postgresql&#39;</span><span class="p">,</span> <span class="s1">&#39;pypostgresql&#39;</span><span class="p">):</span>
127125
<span class="kn">from</span> <span class="nn">postgresql.driver</span> <span class="k">import</span> <span class="n">dbapi20</span>
128126
<span class="bp">self</span><span class="o">.</span><span class="n">module</span> <span class="o">=</span> <span class="n">dbapi20</span>
129-
<span class="k">elif</span> <span class="n">driver</span> <span class="o">==</span> <span class="s1">&#39;pg8000&#39;</span><span class="p">:</span>
130-
<span class="kn">import</span> <span class="nn">pg8000</span>
131-
<span class="bp">self</span><span class="o">.</span><span class="n">module</span> <span class="o">=</span> <span class="n">pg8000</span>
132127
<span class="k">else</span><span class="p">:</span>
133128
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
134129
<span class="s1">&#39;Unknown PostgreSQL driver &quot;</span><span class="si">%s</span><span class="s1">&quot;, &#39;</span>
135130
<span class="s1">&#39;expected psycopg2, psycopg1, &#39;</span>
136-
<span class="s1">&#39;pygresql, pg8000 or pypostgresql&#39;</span> <span class="o">%</span> <span class="n">driver</span><span class="p">)</span>
131+
<span class="s1">&#39;pygresql or pypostgresql&#39;</span> <span class="o">%</span> <span class="n">driver</span><span class="p">)</span>
137132
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
138133
<span class="k">pass</span>
139134
<span class="k">else</span><span class="p">:</span>
@@ -213,12 +208,6 @@ <h1>Source code for sqlobject.postgres.pgconnection</h1><div class="highlight"><
213208
<span class="k">else</span><span class="p">:</span>
214209
<span class="k">if</span> <span class="s2">&quot;unix&quot;</span> <span class="ow">in</span> <span class="n">dsn_dict</span><span class="p">:</span>
215210
<span class="k">del</span> <span class="n">dsn_dict</span><span class="p">[</span><span class="s2">&quot;unix&quot;</span><span class="p">]</span>
216-
<span class="k">if</span> <span class="n">driver</span> <span class="o">==</span> <span class="s1">&#39;pg8000&#39;</span><span class="p">:</span>
217-
<span class="k">if</span> <span class="n">host</span> <span class="ow">and</span> <span class="n">host</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">):</span>
218-
<span class="n">dsn_dict</span><span class="p">[</span><span class="s2">&quot;host&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
219-
<span class="n">dsn_dict</span><span class="p">[</span><span class="s2">&quot;unix_sock&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">host</span>
220-
<span class="k">if</span> <span class="n">user</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
221-
<span class="n">dsn_dict</span><span class="p">[</span><span class="s2">&quot;user&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">getuser</span><span class="p">()</span>
222211
<span class="bp">self</span><span class="o">.</span><span class="n">driver</span> <span class="o">=</span> <span class="n">driver</span>
223212
<span class="bp">self</span><span class="o">.</span><span class="n">dsn</span> <span class="o">=</span> <span class="n">dsn</span>
224213
<span class="bp">self</span><span class="o">.</span><span class="n">unicodeCols</span> <span class="o">=</span> <span class="n">kw</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">&#39;unicodeCols&#39;</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
@@ -254,11 +243,6 @@ <h1>Source code for sqlobject.postgres.pgconnection</h1><div class="highlight"><
254243
<span class="k">raise</span> <span class="n">dberrors</span><span class="o">.</span><span class="n">OperationalError</span><span class="p">(</span>
255244
<span class="n">ErrorMessage</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="s2">&quot;used connection string </span><span class="si">%r</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">dsn</span><span class="p">))</span>
256245

257-
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">driver</span> <span class="o">==</span> <span class="s1">&#39;pg8000&#39;</span> <span class="ow">and</span> \
258-
<span class="s1">&#39;sqlobject.tests.dbtest&#39;</span> <span class="ow">in</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span> <span class="ow">and</span> \
259-
<span class="nb">hasattr</span><span class="p">(</span><span class="n">conn</span><span class="p">,</span> <span class="s1">&#39;set_cache_size&#39;</span><span class="p">):</span>
260-
<span class="n">conn</span><span class="o">.</span><span class="n">set_cache_size</span><span class="p">(</span><span class="mi">1000</span><span class="p">)</span> <span class="c1"># rows</span>
261-
262246
<span class="c1"># For printDebug in _executeRetry</span>
263247
<span class="bp">self</span><span class="o">.</span><span class="n">_connectionNumbers</span><span class="p">[</span><span class="nb">id</span><span class="p">(</span><span class="n">conn</span><span class="p">)]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_connectionCount</span>
264248

‎devel/_sources/Authors.rst.txt

Lines changed: 0 additions & 45 deletions
This file was deleted.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy