Skip to content

Commit d6d6121

Browse files
phdruphdru
committed
Update devel docs: add support for new drivers
1 parent acd4dce commit d6d6121

14 files changed

+123
-47
lines changed

‎devel/News.html

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ <h3><a href="index.html">Table Of Contents</a></h3>
6161
<li><a class="reference internal" href="#">News</a><ul>
6262
<li><a class="reference internal" href="#sqlobject-3-2-0-master">SQLObject 3.2.0 (master)</a><ul>
6363
<li><a class="reference internal" href="#minor-features">Minor features</a></li>
64-
<li><a class="reference internal" href="#work-in-progress">Work in progress</a></li>
64+
<li><a class="reference internal" href="#drivers-work-in-progress">Drivers (work in progress)</a></li>
6565
<li><a class="reference internal" href="#documentation">Documentation</a></li>
6666
<li><a class="reference internal" href="#tests">Tests</a></li>
6767
</ul>
@@ -123,7 +123,7 @@ <h1>News<a class="headerlink" href="#news" title="Permalink to this headline">¶
123123
<li><a class="reference internal" href="#news" id="id7">News</a><ul>
124124
<li><a class="reference internal" href="#sqlobject-3-2-0-master" id="id8">SQLObject 3.2.0 (master)</a><ul>
125125
<li><a class="reference internal" href="#minor-features" id="id9">Minor features</a></li>
126-
<li><a class="reference internal" href="#work-in-progress" id="id10">Work in progress</a></li>
126+
<li><a class="reference internal" href="#drivers-work-in-progress" id="id10">Drivers (work in progress)</a></li>
127127
<li><a class="reference internal" href="#documentation" id="id11">Documentation</a></li>
128128
<li><a class="reference internal" href="#tests" id="id12">Tests</a></li>
129129
</ul>
@@ -158,14 +158,14 @@ <h3>Minor features<a class="headerlink" href="#minor-features" title="Permalink
158158
<code class="docutils literal"><span class="pre">rdbhdb</span></code>.</li>
159159
<li>Add <code class="docutils literal"><span class="pre">driver</span></code> keyword for FirebirdConnection. Allowed values are &#8216;fdb&#8217;
160160
or &#8216;kinterbasdb&#8217;. Default is to test &#8216;fdb&#8217; and &#8216;kinterbasdb&#8217; in that
161-
order.</li>
161+
order. pyfirebirdsql is supported but untested.</li>
162162
<li>Add <code class="docutils literal"><span class="pre">driver</span></code> keyword for MySQLConnection. Allowed value are &#8216;mysqldb&#8217;,
163163
&#8216;connector&#8217;, &#8216;oursql&#8217; and &#8216;pymysql&#8217;. Default is to test for mysqldb only;
164164
(connector, oursql and pymysql drivers still cause problems).</li>
165165
</ul>
166166
</div>
167-
<div class="section" id="work-in-progress">
168-
<h3>Work in progress<a class="headerlink" href="#work-in-progress" title="Permalink to this headline"></a></h3>
167+
<div class="section" id="drivers-work-in-progress">
168+
<h3>Drivers (work in progress)<a class="headerlink" href="#drivers-work-in-progress" title="Permalink to this headline"></a></h3>
169169
<ul class="simple">
170170
<li>Add support for <a class="reference external" href="https://pypi.python.org/pypi/mysql-connector">MySQL Connector</a> (pure python; <a class="reference external" href="https://dev.mysql.com/doc/connector-python/en/">binary
171171
packages</a> are not at
@@ -177,6 +177,12 @@ <h3>Work in progress<a class="headerlink" href="#work-in-progress" title="Permal
177177
<li>Add support for <a class="reference external" href="https://github.com/PyMySQL/PyMySQL/">PyMySQL</a> - pure
178178
python mysql interface; most tests are passed, but there are still
179179
problems).</li>
180+
<li>Extend support for PyGreSQL driver. There are still some problems.</li>
181+
<li>Add support for <a class="reference external" href="https://pypi.python.org/pypi/py-postgresql">py-postgresql</a> PostgreSQL driver. There
182+
are major problems with the driver.</li>
183+
<li>Add support for <a class="reference external" href="https://pypi.python.org/pypi/pg8000">pg8000</a>
184+
PostgreSQL driver. There are still some problems.</li>
185+
<li>Add support for <a class="reference external" href="https://pypi.python.org/pypi/firebirdsql">pyfirebirdsql</a> (untested).</li>
180186
</ul>
181187
</div>
182188
<div class="section" id="documentation">

‎devel/SQLObject.html

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -312,11 +312,14 @@ <h2><a class="toc-backref" href="#id12">Introduction</a><a class="headerlink" hr
312312
<div class="section" id="requirements">
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
315-
<a class="reference external" href="https://pypi.python.org/pypi/mysqlclient">mysqlclient</a> for Python 3) or <a class="reference external" href="https://pypi.python.org/pypi/mysql-connector">MySQL Connector</a> or <a class="reference external" href="https://github.com/python-oursql/oursql">oursql</a> or <a class="reference external" href="https://github.com/PyMySQL/PyMySQL/">PyMySQL</a>, <a class="reference external" href="https://postgresql.org">PostgreSQL</a>
316-
via <a class="reference external" href="http://initd.org/psycopg/">psycopg2</a> or psycopg1, <a class="reference external" href="https://sqlite.org/">SQLite</a> via <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> via <a class="reference external" href="http://www.firebirdsql.org/en/devel-python-driver/">fdb</a> or
317-
<a class="reference external" href="http://kinterbasdb.sourceforge.net/">kinterbasdb</a>, <a class="reference external" href="http://maxdb.sap.com/">MAX DB</a> (also known as SAP DB) via <a class="reference external" href="http://maxdb.sap.com/doc/7_8/50/01923f25b842438a408805774f6989/frameset.htm">sapdb</a>, Sybase via
318-
<a class="reference external" href="http://www.object-craft.com.au/projects/sybase/">Sybase</a>, and <a class="reference external" href="http://www.microsoft.com/sql/">MSSQL Server</a> via <a class="reference external" href="http://www.pymssql.org/en/latest/index.html">pymssql</a> (+ <a class="reference external" href="http://www.freetds.org/">FreeTDS</a>) or <a class="reference external" href="http://adodbapi.sourceforge.net/">adodbapi</a>
319-
(Win32).</p>
315+
<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> are
316+
supported but have problems (not all tests passed). For <a class="reference external" href="https://postgresql.org">PostgreSQL</a>
317+
<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> and
318+
<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
319+
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
320+
<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 untested. <a class="reference external" href="http://maxdb.sap.com/">MAX DB</a> (also
321+
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
322+
Server</a> via <a class="reference external" href="http://www.pymssql.org/en/latest/index.html">pymssql</a> (+ <a class="reference external" href="http://www.freetds.org/">FreeTDS</a>) or <a class="reference external" href="http://adodbapi.sourceforge.net/">adodbapi</a> (Win32).</p>
320323
<p>Python 2.6, 2.7 or 3.4+ is required.</p>
321324
</div>
322325
<div class="section" id="compared-to-other-database-wrappers">

‎devel/TODO.html

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -155,12 +155,6 @@ <h1>TODO<a class="headerlink" href="#todo" title="Permalink to this headline">¶
155155
</li>
156156
<li><p class="first">Switch from setuptools to distribute.</p>
157157
</li>
158-
<li><p class="first"><a class="reference external" href="https://pypi.python.org/pypi/pg8000">pg8000 driver</a>.</p>
159-
</li>
160-
<li><p class="first"><a class="reference external" href="https://pypi.python.org/pypi/py-postgresql">py-postgresql driver</a>.</p>
161-
</li>
162-
<li><p class="first"><a class="reference external" href="https://pypi.python.org/pypi/firebirdsql">pyfirebirdsql</a>.</p>
163-
</li>
164158
<li><p class="first"><a class="reference external" href="https://pypi.python.org/pypi/dbms">dbms</a> is a DB API wrapper for DB
165159
API drivers for IBM DB2, Firebird, MSSQL Server, MySQL, Oracle,
166160
PostgreSQL, SQLite and ODBC.</p>

‎devel/_modules/sqlobject/col.html

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -673,8 +673,7 @@ <h1>Source code for sqlobject.col</h1><div class="highlight"><pre>
673673
<span class="k">if</span> <span class="n">dbName</span> <span class="o">==</span> <span class="s1">&#39;mysql&#39;</span><span class="p">:</span>
674674
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">bytearray</span><span class="p">):</span>
675675
<span class="k">if</span> <span class="n">PY2</span><span class="p">:</span>
676-
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">dbEncoding</span><span class="p">)</span>
677-
<span class="k">return</span> <span class="n">value</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">dbEncoding</span><span class="p">)</span> <span class="c1"># convrt to bytes</span>
676+
<span class="k">return</span> <span class="nb">bytes</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
678677
<span class="k">else</span><span class="p">:</span>
679678
<span class="k">return</span> <span class="n">value</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">dbEncoding</span><span class="p">,</span> <span class="n">errors</span><span class="o">=</span><span class="s1">&#39;surrogateescape&#39;</span><span class="p">)</span>
680679
<span class="k">if</span> <span class="ow">not</span> <span class="n">PY2</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
@@ -1913,7 +1912,10 @@ <h1>Source code for sqlobject.col</h1><div class="highlight"><pre>
19131912
<span class="k">return</span> <span class="kc">None</span>
19141913
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">unicode_type</span><span class="p">):</span>
19151914
<span class="n">dbEncoding</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getDbEncoding</span><span class="p">(</span><span class="n">state</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s1">&#39;ascii&#39;</span><span class="p">)</span>
1916-
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">dbEncoding</span><span class="p">)</span>
1915+
<span class="k">if</span> <span class="n">PY2</span><span class="p">:</span>
1916+
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">dbEncoding</span><span class="p">)</span>
1917+
<span class="k">else</span><span class="p">:</span>
1918+
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">dbEncoding</span><span class="p">,</span> <span class="n">errors</span><span class="o">=</span><span class="s1">&#39;surrogateescape&#39;</span><span class="p">)</span>
19171919
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
19181920
<span class="k">return</span> <span class="n">pickle</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
19191921
<span class="k">raise</span> <span class="n">validators</span><span class="o">.</span><span class="n">Invalid</span><span class="p">(</span>
@@ -1961,6 +1963,8 @@ <h1>Source code for sqlobject.col</h1><div class="highlight"><pre>
19611963
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">&#39;ascii&#39;</span><span class="p">)</span>
19621964
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
19631965
<span class="k">return</span> <span class="n">UUID</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
1966+
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">UUID</span><span class="p">):</span>
1967+
<span class="k">return</span> <span class="n">value</span>
19641968
<span class="k">raise</span> <span class="n">validators</span><span class="o">.</span><span class="n">Invalid</span><span class="p">(</span>
19651969
<span class="s2">&quot;expected string in the UuidCol &#39;</span><span class="si">%s</span><span class="s2">&#39;, &quot;</span>
19661970
<span class="s2">&quot;got </span><span class="si">%s</span><span class="s2"> </span><span class="si">%r</span><span class="s2"> instead&quot;</span> <span class="o">%</span> <span class="p">(</span>

‎devel/_modules/sqlobject/converters.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ <h1>Source code for sqlobject.converters</h1><div class="highlight"><pre>
152152
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">tounicode</span><span class="p">()</span>
153153
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
154154
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">tostring</span><span class="p">()</span>
155-
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="p">(</span><span class="nb">bytearray</span><span class="p">,</span> <span class="n">buffer_type</span><span class="p">)):</span>
155+
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">buffer_type</span><span class="p">):</span>
156156
<span class="n">value</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
157157

158158
<span class="k">if</span> <span class="n">db</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;mysql&#39;</span><span class="p">,</span> <span class="s1">&#39;postgres&#39;</span><span class="p">,</span> <span class="s1">&#39;rdbhost&#39;</span><span class="p">):</span>

‎devel/_modules/sqlobject/firebird/firebirdconnection.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,10 +105,13 @@ <h1>Source code for sqlobject.firebird.firebirdconnection</h1><div class="highli
105105
<span class="c1"># unicode.</span>
106106
<span class="n">kinterbasdb</span><span class="o">.</span><span class="n">init</span><span class="p">(</span><span class="n">type_conv</span><span class="o">=</span><span class="mi">200</span><span class="p">)</span>
107107
<span class="bp">self</span><span class="o">.</span><span class="n">module</span> <span class="o">=</span> <span class="n">kinterbasdb</span>
108+
<span class="k">elif</span> <span class="n">driver</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;firebirdsql&#39;</span><span class="p">,</span> <span class="s1">&#39;pyfirebirdsql&#39;</span><span class="p">):</span>
109+
<span class="kn">import</span> <span class="nn">firebirdsql</span>
110+
<span class="bp">self</span><span class="o">.</span><span class="n">module</span> <span class="o">=</span> <span class="n">firebirdsql</span>
108111
<span class="k">else</span><span class="p">:</span>
109112
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
110113
<span class="s1">&#39;Unknown FireBird driver &quot;</span><span class="si">%s</span><span class="s1">&quot;, &#39;</span>
111-
<span class="s1">&#39;expected fdb or kinterbasdb&#39;</span> <span class="o">%</span> <span class="n">driver</span><span class="p">)</span>
114+
<span class="s1">&#39;expected fdb, kinterbasdb or firebirdsql&#39;</span> <span class="o">%</span> <span class="n">driver</span><span class="p">)</span>
112115
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
113116
<span class="k">pass</span>
114117
<span class="k">else</span><span class="p">:</span>

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