source: trunk/docs/future.txt @ 636

Last change on this file since 636 was 636, checked in by cito, 4 years ago

Clean up the docs

We had used .txt for the old docs and .rst for the new Sphinx docs,
which unfortunately got out of sync. I have merged the duplicates,
keeping the latest version of the text, and left them only as .txt
files for the time being until we give Sphinx another go.

The index file is not auto generated - the index.rst file is only
a reminder that we want to move everything to Sphinx.

  • Property svn:keywords set to Author Date Id Revision
File size: 2.1 KB
Line 
1PyGreSQL future directions
2==========================
3
4This list has been closed since tasks are now managed with the PyGreSQL
5tracker that can be found at http://trac.vex.net:8000/pgtracker.
6(ticket numbers have been added below):
7
8To Do
9-----
10
11- Add docs for the pgdb module (everything specific to PyGreSQL) (#5).
12- The fetch method should use real cursors (#7).
13- The C module needs to be cleaned up and redundant code merged,
14  and should get its own unit test module (#8).
15- The test suite for the classic module should also check that quoted
16  mixed-case identifiers can be used everywhere - currently they can't.
17  Improve pg.py accordingly, adding quotes etc. as needed (#10).
18- What shall we do with the "tutorial" directory - it's rather a tutorial
19  for Postgres/SQL than for PyGreSQL, it's using only the query method from
20  the classic pg module and no other PyGreSQL functionality, it's rather
21  a demo than a tutorial (#11)?
22
23Proposed Patches
24----------------
25
26- Support for asynchronous command processing (#49).
27
28Wish List
29---------
30
31- Make use of PQexecParams() and PQprepare(). This could speed up
32  executemany() and allow retrieving binary data directly by setting
33  the resultFormat parameter to one (#16).
34- Enhance cursor.description attribute, delivering more information
35  available with PQfmod() or PQftable() for instance (#17).
36- Support optional "errorhandler" extension (#18).
37- Support optional cursor and connection attribute "messages" (#19).
38- Users should be able to register their own types with _pg (#21).
39- pg has now got a new method namedresult() that returns named tuples.
40  pgdb should also support named tuples, maybe via a row_factory attribute
41  on the connection, similar to sqlite3 (see #22).
42- New methods in the classic module, similar to getresult() and
43  dictresult(), but returning dictionaries of rows instead of lists
44  of rows (with primary key or oids as keys) (#23).
45- Make PyGreSQL thread-safe on the connection level (#24).
46- The API documentation could be created with Epydoc or Sphinx (#4).
47- Write a tutorial for beginners and advanced use (#11).
48- More and better documented examples (#4, #5, #11).
Note: See TracBrowser for help on using the repository browser.