with dal new structure, API doc generation was left out of the picture. GROAN!

This commit is contained in:
niphlod
2014-09-30 23:37:54 +02:00
parent 05689aa526
commit 88113637ae
5 changed files with 270 additions and 41 deletions
+150
View File
@@ -0,0 +1,150 @@
gluon.dal.adapters package
==========================
Submodules
----------
gluon.dal.adapters.base module
------------------------------
.. automodule:: gluon.dal.adapters.base
:members:
:undoc-members:
:show-inheritance:
gluon.dal.adapters.couchdb module
---------------------------------
.. automodule:: gluon.dal.adapters.couchdb
:members:
:undoc-members:
:show-inheritance:
gluon.dal.adapters.cubrid module
--------------------------------
.. automodule:: gluon.dal.adapters.cubrid
:members:
:undoc-members:
:show-inheritance:
gluon.dal.adapters.db2 module
-----------------------------
.. automodule:: gluon.dal.adapters.db2
:members:
:undoc-members:
:show-inheritance:
gluon.dal.adapters.firebird module
----------------------------------
.. automodule:: gluon.dal.adapters.firebird
:members:
:undoc-members:
:show-inheritance:
gluon.dal.adapters.google module
--------------------------------
.. automodule:: gluon.dal.adapters.google
:members:
:undoc-members:
:show-inheritance:
gluon.dal.adapters.imap module
------------------------------
.. automodule:: gluon.dal.adapters.imap
:members:
:undoc-members:
:show-inheritance:
gluon.dal.adapters.informix module
----------------------------------
.. automodule:: gluon.dal.adapters.informix
:members:
:undoc-members:
:show-inheritance:
gluon.dal.adapters.ingres module
--------------------------------
.. automodule:: gluon.dal.adapters.ingres
:members:
:undoc-members:
:show-inheritance:
gluon.dal.adapters.mongo module
-------------------------------
.. automodule:: gluon.dal.adapters.mongo
:members:
:undoc-members:
:show-inheritance:
gluon.dal.adapters.mssql module
-------------------------------
.. automodule:: gluon.dal.adapters.mssql
:members:
:undoc-members:
:show-inheritance:
gluon.dal.adapters.mysql module
-------------------------------
.. automodule:: gluon.dal.adapters.mysql
:members:
:undoc-members:
:show-inheritance:
gluon.dal.adapters.oracle module
--------------------------------
.. automodule:: gluon.dal.adapters.oracle
:members:
:undoc-members:
:show-inheritance:
gluon.dal.adapters.postgre module
---------------------------------
.. automodule:: gluon.dal.adapters.postgre
:members:
:undoc-members:
:show-inheritance:
gluon.dal.adapters.sapdb module
-------------------------------
.. automodule:: gluon.dal.adapters.sapdb
:members:
:undoc-members:
:show-inheritance:
gluon.dal.adapters.sqlite module
--------------------------------
.. automodule:: gluon.dal.adapters.sqlite
:members:
:undoc-members:
:show-inheritance:
gluon.dal.adapters.teradata module
----------------------------------
.. automodule:: gluon.dal.adapters.teradata
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: gluon.dal.adapters
:members:
:undoc-members:
:show-inheritance:
+38
View File
@@ -0,0 +1,38 @@
gluon.dal.helpers package
=========================
Submodules
----------
gluon.dal.helpers.classes module
--------------------------------
.. automodule:: gluon.dal.helpers.classes
:members:
:undoc-members:
:show-inheritance:
gluon.dal.helpers.methods module
--------------------------------
.. automodule:: gluon.dal.helpers.methods
:members:
:undoc-members:
:show-inheritance:
gluon.dal.helpers.regex module
------------------------------
.. automodule:: gluon.dal.helpers.regex
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: gluon.dal.helpers
:members:
:undoc-members:
:show-inheritance:
+40 -2
View File
@@ -1,6 +1,44 @@
gluon.dal package
=================
:mod:`dal` Module Subpackages
----------------- -----------
.. toctree::
dal.adapters
dal.helpers
Submodules
----------
gluon.dal.base module
---------------------
.. automodule:: gluon.dal.base
:members:
:undoc-members:
:show-inheritance:
gluon.dal.connection module
---------------------------
.. automodule:: gluon.dal.connection
:members:
:undoc-members:
:show-inheritance:
gluon.dal.objects module
------------------------
.. automodule:: gluon.dal.objects
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: gluon.dal .. automodule:: gluon.dal
:members: :members:
+4 -2
View File
@@ -521,7 +521,8 @@ class GoogleDatastoreAdapter(NoSQLAdapter):
use of the GAE projection queries. note that there are rules for use of the GAE projection queries. note that there are rules for
what is accepted imposed by GAE: each field must be indexed, what is accepted imposed by GAE: each field must be indexed,
projection queries cannot contain blob or text fields, and you projection queries cannot contain blob or text fields, and you
cannot use == and also select that same field. see https://developers.google.com/appengine/docs/python/datastore/queries#Query_Projection cannot use == and also select that same field.
see https://developers.google.com/appengine/docs/python/datastore/queries#Query_Projection
- optional attribute 'filterfields' when set to True web2py will only - optional attribute 'filterfields' when set to True web2py will only
parse the explicitly listed fields into the Rows object, even though parse the explicitly listed fields into the Rows object, even though
all fields are returned in the query. This can be used to reduce all fields are returned in the query. This can be used to reduce
@@ -532,7 +533,8 @@ class GoogleDatastoreAdapter(NoSQLAdapter):
first query, set it to the value of db['_lastcursor'] to continue first query, set it to the value of db['_lastcursor'] to continue
a previous query. The user must save the cursor value between a previous query. The user must save the cursor value between
requests, and the filters must be identical. It is up to the user requests, and the filters must be identical. It is up to the user
to follow google's limitations: https://developers.google.com/appengine/docs/python/datastore/queries#Query_Cursors to follow google's limitations:
https://developers.google.com/appengine/docs/python/datastore/queries#Query_Cursors
""" """
(items, tablename, fields) = self.select_raw(query,fields,attributes) (items, tablename, fields) = self.select_raw(query,fields,attributes)
+7 -6
View File
@@ -12,7 +12,6 @@ from .base import NoSQLAdapter
class IMAPAdapter(NoSQLAdapter): class IMAPAdapter(NoSQLAdapter):
drivers = ('imaplib',)
""" IMAP server adapter """ IMAP server adapter
@@ -44,8 +43,9 @@ class IMAPAdapter(NoSQLAdapter):
Here is a list of supported fields: Here is a list of supported fields:
=========== ============== ===========
Field Type Description Field Type Description
################################################################ =========== ============== ===========
uid string uid string
answered boolean Flag answered boolean Flag
created date created date
@@ -62,11 +62,12 @@ class IMAPAdapter(NoSQLAdapter):
seen boolean Flag seen boolean Flag
subject string subject string
mime string The mime header declaration mime string The mime header declaration
email string The complete RFC822 message** email string The complete RFC822 message (*)
attachments <type list> Each non text part as dict attachments list Each non text part as dict
encoding string The main detected encoding encoding string The main detected encoding
=========== ============== ===========
*At the application side it is measured as the length of the RFC822 (*) At the application side it is measured as the length of the RFC822
message string message string
WARNING: As row id's are mapped to email sequence numbers, WARNING: As row id's are mapped to email sequence numbers,
@@ -141,7 +142,7 @@ class IMAPAdapter(NoSQLAdapter):
imapdb(q).select(imapdb.INBOX.sender, imapdb.INBOX.subject) imapdb(q).select(imapdb.INBOX.sender, imapdb.INBOX.subject)
""" """
drivers = ('imaplib',)
types = { types = {
'string': str, 'string': str,
'text': str, 'text': str,