The current documentation for the sqlite3 module on the web fails to 
make any mention of the fetch* functions posessed by the Cursor class 
of that module. It in fact gives no indication of how one should 
extract results from sql queries. The docstrings in the module (viewed 
using the help() function) are woefully incomplete, and are 
inconsistent with the function names:

 |  fetchall(...)
 |      Fetches one row from the resultset.
 |  
 |  fetchmany(...)
 |      Fetches all rows from the resultset.
 |  
 |  fetchone(...)
 |      Fetches several rows from the resultset.
 |  

Both of these things need to be fixed in order for this module to be 
useful for someone who doesn't already know how to use it.

Are you able to provide a patch? Please use a snapshot or svn checkout
of 2.5 for the patch. We have a new documentation system.

I could try, but I honestly don't know exactly how the fetch*
functions work. It would probably take me a good couple of hours of
reading before I could write decent documentation, and as much as that
would be great, I'm not about to squeeze that into my college
schedule. I don't actually have a 2.5 checkout, but I thought that at
one point those methods were documented. Is there a way to check the
history of the online documentation and revert those pages?

-Peter Mawhorter

On 11/28/07, Christian Heimes <report@bugs.python.org> wrote:
>
> Christian Heimes added the comment:
>
> Are you able to provide a patch? Please use a snapshot or svn checkout
> of 2.5 for the patch. We have a new documentation system.
>
> ----------
> nosy: +tiran
>
> __________________________________
> Tracker <report@bugs.python.org>
> <http://bugs.python.org/issue1509>
> __________________________________
>

> I thought that at one point those methods were documented

sqlite3 implements the DB-API:
http://www.python.org/dev/peps/pep-0249/
is it the documentation you had in mind?

Yes actually... the fetch documentation there is a sufficient
explanation of the functions provided. If it could be added to
docs.python.org, that would be great.

There still remains the fact that the docstrings in the sqlite3 module
don't agree with their function names, but that's a very minor issue,
and wouldn't normally impact usability of the module.

-Peter Mawhorter

On 11/28/07, Amaury Forgeot d'Arc <report@bugs.python.org> wrote:
>
> Amaury Forgeot d'Arc added the comment:
>
> > I thought that at one point those methods were documented
>
> sqlite3 implements the DB-API:
> http://www.python.org/dev/peps/pep-0249/
> is it the documentation you had in mind?
>
> ----------
> nosy: +amaury.forgeotdarc
>
> __________________________________
> Tracker <report@bugs.python.org>
> <http://bugs.python.org/issue1509>
> __________________________________
>

Attaching a patch that adds fetchXXX() description to the documentation
for Python 2.6.

Attaching a patch that fixes the docstrings for Python 2.6.

Attaching a patch that fixes the docstrings for Python 2.5.

Fixed in r60103.

Attaching a patch that adds fetchXXX() description to the documentation
for Python 2.5.

BTW, the first 2 patches (for Python 2.6) work also on version 3.0a2 for me.