Skip to content

Commit 8864344

Browse files
phdruphdru
committed
Update devel docs
1 parent 1fae4a0 commit 8864344

File tree

84 files changed

+1023
-254
lines changed

Some content is hidden

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

84 files changed

+1023
-254
lines changed

‎devel/News.html

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ <h3><a href="index.html">Table Of Contents</a></h3>
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>
6464
<li><a class="reference internal" href="#drivers-work-in-progress">Drivers (work in progress)</a></li>
65-
<li><a class="reference internal" href="#bug-fix">Bug fix</a></li>
65+
<li><a class="reference internal" href="#bug-fixes">Bug fixes</a></li>
6666
<li><a class="reference internal" href="#documentation">Documentation</a></li>
6767
<li><a class="reference internal" href="#tests">Tests</a></li>
6868
</ul>
@@ -125,7 +125,7 @@ <h1>News<a class="headerlink" href="#news" title="Permalink to this headline">¶
125125
<li><a class="reference internal" href="#sqlobject-3-2-0-master" id="id8">SQLObject 3.2.0 (master)</a><ul>
126126
<li><a class="reference internal" href="#minor-features" id="id9">Minor features</a></li>
127127
<li><a class="reference internal" href="#drivers-work-in-progress" id="id10">Drivers (work in progress)</a></li>
128-
<li><a class="reference internal" href="#bug-fix" id="id11">Bug fix</a></li>
128+
<li><a class="reference internal" href="#bug-fixes" id="id11">Bug fixes</a></li>
129129
<li><a class="reference internal" href="#documentation" id="id12">Documentation</a></li>
130130
<li><a class="reference internal" href="#tests" id="id13">Tests</a></li>
131131
</ul>
@@ -158,9 +158,9 @@ <h3>Minor features<a class="headerlink" href="#minor-features" title="Permalink
158158
the name of the attached database to vacuum.</li>
159159
<li>Remove <code class="docutils literal"><span class="pre">driver</span></code> keyword from RdbhostConnection as it allows one driver
160160
<code class="docutils literal"><span class="pre">rdbhdb</span></code>.</li>
161-
<li>Add <code class="docutils literal"><span class="pre">driver</span></code> keyword for FirebirdConnection. Allowed values are &#8216;fdb&#8217;
162-
or &#8216;kinterbasdb&#8217;. Default is to test &#8216;fdb&#8217; and &#8216;kinterbasdb&#8217; in that
163-
order. pyfirebirdsql is supported but has problems.</li>
161+
<li>Add <code class="docutils literal"><span class="pre">driver</span></code> keyword for FirebirdConnection. Allowed values are &#8216;fdb&#8217;,
162+
&#8216;kinterbasdb&#8217; and &#8216;pyfirebirdsql&#8217;. Default is to test &#8216;fdb&#8217; and
163+
&#8216;kinterbasdb&#8217; in that order. pyfirebirdsql is supported but has problems.</li>
164164
<li>Add <code class="docutils literal"><span class="pre">driver</span></code> keyword for MySQLConnection. Allowed value are &#8216;mysqldb&#8217;,
165165
&#8216;connector&#8217;, &#8216;oursql&#8217; and &#8216;pymysql&#8217;. Default is to test for mysqldb only.</li>
166166
<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
@@ -183,13 +183,15 @@ <h3>Drivers (work in progress)<a class="headerlink" href="#drivers-work-in-progr
183183
<li>Add support for <a class="reference external" href="https://pypi.python.org/pypi/pg8000">pg8000</a>
184184
PostgreSQL driver. There are major problems with the driver caused by both
185185
the driver and SQLObject.</li>
186-
<li>Add support for <a class="reference external" href="https://pypi.python.org/pypi/firebirdsql">pyfirebirdsql</a>.</li>
186+
<li>Add support for <a class="reference external" href="https://pypi.python.org/pypi/firebirdsql">pyfirebirdsql</a>.There are still problems with
187+
the driver.</li>
187188
</ul>
188189
</div>
189-
<div class="section" id="bug-fix">
190-
<h3>Bug fix<a class="headerlink" href="#bug-fix" title="Permalink to this headline"></a></h3>
190+
<div class="section" id="bug-fixes">
191+
<h3>Bug fixes<a class="headerlink" href="#bug-fixes" title="Permalink to this headline"></a></h3>
191192
<ul class="simple">
192-
<li>Fix MSSQLConnection.columnsFromSchema: remove () from default value.</li>
193+
<li>Fix MSSQLConnection.columnsFromSchema: remove <cite>(</cite> and <cite>)</cite> from default
194+
value.</li>
193195
<li>Fix MSSQLConnection and SybaseConnection: insert default values into a table
194196
with just one IDENTITY column.</li>
195197
<li>Remove excessive NULLs for MSSQL/Sybase.</li>
@@ -213,13 +215,12 @@ <h3>Tests<a class="headerlink" href="#tests" title="Permalink to this headline">
213215
to <code class="docutils literal"><span class="pre">SOTestXXX</span></code> to prevent <code class="docutils literal"><span class="pre">pytest</span></code> to recognize them as test classes.</li>
214216
<li>Fix <code class="docutils literal"><span class="pre">pytest</span></code> warnings by converting yield tests to plain calls: yield
215217
tests were deprecated in <code class="docutils literal"><span class="pre">pytest</span></code>.</li>
216-
<li>Tests are now run at CIs with <code class="docutils literal"><span class="pre">python3.5</span></code>.</li>
218+
<li>Tests are now run at CIs with Python 3.5.</li>
217219
<li>Drop <code class="docutils literal"><span class="pre">Circle</span> <span class="pre">CI</span></code>.</li>
218220
<li>Run at Travis CI tests with Firebird backend (server version 2.5; drivers fdb
219221
and firebirdsql). There are problems with tests.</li>
220-
<li>Add AppVeyor for windows testing. Run tests with Postgres and MS SQL. There
221-
are problems with MS SQL.</li>
222-
<li>Run sqlite tests at AppVeyor.</li>
222+
<li>Add AppVeyor for windows testing. Run tests with MS SQL, Postgres and
223+
SQLite. There are problems with MS SQL.</li>
223224
</ul>
224225
</div>
225226
</div>

‎devel/SQLObject.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -316,9 +316,9 @@ <h2><a class="toc-backref" href="#id13">Requirements</a><a class="headerlink" hr
316316
<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>
317317
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
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
319-
<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 known
320-
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> via
321-
<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>
319+
<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
320+
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>
321+
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>
322322
<p>Python 2.6, 2.7 or 3.4+ is required.</p>
323323
</div>
324324
<div class="section" id="compared-to-other-database-wrappers">

‎devel/_modules/sqlobject/tests/test_mysql.html

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,21 +74,25 @@ <h1>Source code for sqlobject.tests.test_mysql</h1><div class="highlight"><pre>
7474
<span class="kn">from</span> <span class="nn">sqlobject.tests.dbtest</span> <span class="k">import</span> <span class="n">getConnection</span><span class="p">,</span> <span class="n">setupClass</span>
7575

7676

77+
<span class="k">try</span><span class="p">:</span>
78+
<span class="n">connection</span> <span class="o">=</span> <span class="n">getConnection</span><span class="p">()</span>
79+
<span class="k">except</span> <span class="p">(</span><span class="ne">AttributeError</span><span class="p">,</span> <span class="ne">NameError</span><span class="p">):</span>
80+
<span class="c1"># The module was imported during documentation building</span>
81+
<span class="k">pass</span>
82+
<span class="k">else</span><span class="p">:</span>
83+
<span class="k">if</span> <span class="n">connection</span><span class="o">.</span><span class="n">dbName</span> <span class="o">!=</span> <span class="s2">&quot;mysql&quot;</span><span class="p">:</span>
84+
<span class="n">pytestmark</span> <span class="o">=</span> <span class="n">pytest</span><span class="o">.</span><span class="n">mark</span><span class="o">.</span><span class="n">skip</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">)</span>
85+
86+
7787
<div class="viewcode-block" id="SOTestSOListMySQL"><a class="viewcode-back" href="../../../api/sqlobject.tests.test_mysql.html#sqlobject.tests.test_mysql.SOTestSOListMySQL">[docs]</a><span class="k">class</span> <span class="nc">SOTestSOListMySQL</span><span class="p">(</span><span class="n">SQLObject</span><span class="p">):</span>
7888
<span class="k">pass</span></div>
7989

8090

8191
<div class="viewcode-block" id="test_list_databases"><a class="viewcode-back" href="../../../api/sqlobject.tests.test_mysql.html#sqlobject.tests.test_mysql.test_list_databases">[docs]</a><span class="k">def</span> <span class="nf">test_list_databases</span><span class="p">():</span>
82-
<span class="n">connection</span> <span class="o">=</span> <span class="n">getConnection</span><span class="p">()</span>
83-
<span class="k">if</span> <span class="n">connection</span><span class="o">.</span><span class="n">dbName</span> <span class="o">!=</span> <span class="s2">&quot;mysql&quot;</span><span class="p">:</span>
84-
<span class="n">pytest</span><span class="o">.</span><span class="n">skip</span><span class="p">(</span><span class="s2">&quot;These tests require MySQL&quot;</span><span class="p">)</span>
8592
<span class="k">assert</span> <span class="n">connection</span><span class="o">.</span><span class="n">db</span> <span class="ow">in</span> <span class="n">connection</span><span class="o">.</span><span class="n">listDatabases</span><span class="p">()</span></div>
8693

8794

8895
<div class="viewcode-block" id="test_list_tables"><a class="viewcode-back" href="../../../api/sqlobject.tests.test_mysql.html#sqlobject.tests.test_mysql.test_list_tables">[docs]</a><span class="k">def</span> <span class="nf">test_list_tables</span><span class="p">():</span>
89-
<span class="n">connection</span> <span class="o">=</span> <span class="n">getConnection</span><span class="p">()</span>
90-
<span class="k">if</span> <span class="n">connection</span><span class="o">.</span><span class="n">dbName</span> <span class="o">!=</span> <span class="s2">&quot;mysql&quot;</span><span class="p">:</span>
91-
<span class="n">pytest</span><span class="o">.</span><span class="n">skip</span><span class="p">(</span><span class="s2">&quot;These tests require MySQL&quot;</span><span class="p">)</span>
9296
<span class="n">setupClass</span><span class="p">(</span><span class="n">SOTestSOListMySQL</span><span class="p">)</span>
9397
<span class="k">assert</span> <span class="n">SOTestSOListMySQL</span><span class="o">.</span><span class="n">sqlmeta</span><span class="o">.</span><span class="n">table</span> <span class="ow">in</span> <span class="n">connection</span><span class="o">.</span><span class="n">listTables</span><span class="p">()</span></div>
9498
</pre></div>

‎devel/_modules/sqlobject/tests/test_postgres.html

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -80,15 +80,24 @@ <h1>Source code for sqlobject.tests.test_postgres</h1><div class="highlight"><pr
8080
<span class="c1">########################################</span>
8181

8282

83+
<span class="k">try</span><span class="p">:</span>
84+
<span class="n">connection</span> <span class="o">=</span> <span class="n">getConnection</span><span class="p">()</span>
85+
<span class="k">except</span> <span class="p">(</span><span class="ne">AttributeError</span><span class="p">,</span> <span class="ne">NameError</span><span class="p">):</span>
86+
<span class="c1"># The module was imported during documentation building</span>
87+
<span class="k">pass</span>
88+
<span class="k">else</span><span class="p">:</span>
89+
<span class="k">if</span> <span class="n">connection</span><span class="o">.</span><span class="n">dbName</span> <span class="o">!=</span> <span class="s2">&quot;postgres&quot;</span><span class="p">:</span>
90+
<span class="n">pytestmark</span> <span class="o">=</span> <span class="n">pytest</span><span class="o">.</span><span class="n">mark</span><span class="o">.</span><span class="n">skip</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">)</span>
91+
92+
8393
<div class="viewcode-block" id="SOTestSSLMode"><a class="viewcode-back" href="../../../api/sqlobject.tests.test_postgres.html#sqlobject.tests.test_postgres.SOTestSSLMode">[docs]</a><span class="k">class</span> <span class="nc">SOTestSSLMode</span><span class="p">(</span><span class="n">SQLObject</span><span class="p">):</span>
8494
<span class="n">test</span> <span class="o">=</span> <span class="n">StringCol</span><span class="p">()</span></div>
8595

8696

8797
<div class="viewcode-block" id="test_sslmode"><a class="viewcode-back" href="../../../api/sqlobject.tests.test_postgres.html#sqlobject.tests.test_postgres.test_sslmode">[docs]</a><span class="k">def</span> <span class="nf">test_sslmode</span><span class="p">():</span>
8898
<span class="n">setupClass</span><span class="p">(</span><span class="n">SOTestSSLMode</span><span class="p">)</span>
8999
<span class="n">connection</span> <span class="o">=</span> <span class="n">SOTestSSLMode</span><span class="o">.</span><span class="n">_connection</span>
90-
<span class="k">if</span> <span class="p">(</span><span class="n">connection</span><span class="o">.</span><span class="n">dbName</span> <span class="o">!=</span> <span class="s1">&#39;postgres&#39;</span><span class="p">)</span> <span class="ow">or</span> \
91-
<span class="p">(</span><span class="ow">not</span> <span class="n">connection</span><span class="o">.</span><span class="n">module</span><span class="o">.</span><span class="n">__name__</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;psycopg&#39;</span><span class="p">))</span> <span class="ow">or</span> \
100+
<span class="k">if</span> <span class="p">(</span><span class="ow">not</span> <span class="n">connection</span><span class="o">.</span><span class="n">module</span><span class="o">.</span><span class="n">__name__</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;psycopg&#39;</span><span class="p">))</span> <span class="ow">or</span> \
92101
<span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="s1">&#39;nt&#39;</span><span class="p">):</span>
93102
<span class="n">pytest</span><span class="o">.</span><span class="n">skip</span><span class="p">(</span><span class="s2">&quot;The test requires PostgreSQL, psycopg and ssl mode; &quot;</span>
94103
<span class="s2">&quot;also it doesn&#39;t work on w32&quot;</span><span class="p">)</span>
@@ -112,16 +121,10 @@ <h1>Source code for sqlobject.tests.test_postgres</h1><div class="highlight"><pr
112121

113122

114123
<div class="viewcode-block" id="test_list_databases"><a class="viewcode-back" href="../../../api/sqlobject.tests.test_postgres.html#sqlobject.tests.test_postgres.test_list_databases">[docs]</a><span class="k">def</span> <span class="nf">test_list_databases</span><span class="p">():</span>
115-
<span class="n">connection</span> <span class="o">=</span> <span class="n">getConnection</span><span class="p">()</span>
116-
<span class="k">if</span> <span class="n">connection</span><span class="o">.</span><span class="n">dbName</span> <span class="o">!=</span> <span class="s2">&quot;postgres&quot;</span><span class="p">:</span>
117-
<span class="n">pytest</span><span class="o">.</span><span class="n">skip</span><span class="p">(</span><span class="s2">&quot;These tests require PostgreSQL&quot;</span><span class="p">)</span>
118124
<span class="k">assert</span> <span class="n">connection</span><span class="o">.</span><span class="n">db</span> <span class="ow">in</span> <span class="n">connection</span><span class="o">.</span><span class="n">listDatabases</span><span class="p">()</span></div>
119125

120126

121127
<div class="viewcode-block" id="test_list_tables"><a class="viewcode-back" href="../../../api/sqlobject.tests.test_postgres.html#sqlobject.tests.test_postgres.test_list_tables">[docs]</a><span class="k">def</span> <span class="nf">test_list_tables</span><span class="p">():</span>
122-
<span class="n">connection</span> <span class="o">=</span> <span class="n">getConnection</span><span class="p">()</span>
123-
<span class="k">if</span> <span class="n">connection</span><span class="o">.</span><span class="n">dbName</span> <span class="o">!=</span> <span class="s2">&quot;postgres&quot;</span><span class="p">:</span>
124-
<span class="n">pytest</span><span class="o">.</span><span class="n">skip</span><span class="p">(</span><span class="s2">&quot;These tests require PostgreSQL&quot;</span><span class="p">)</span>
125128
<span class="n">setupClass</span><span class="p">(</span><span class="n">SOTestSOList</span><span class="p">)</span>
126129
<span class="k">assert</span> <span class="n">SOTestSOList</span><span class="o">.</span><span class="n">sqlmeta</span><span class="o">.</span><span class="n">table</span> <span class="ow">in</span> <span class="n">connection</span><span class="o">.</span><span class="n">listTables</span><span class="p">()</span></div>
127130
</pre></div>

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