Changeset 2962

Show
Ignore:
Timestamp:
03/23/07 19:29:16 (2 years ago)
Author:
paul
Message:

Made incremental improvements to some class docstrings, so the api docs
will be marginally more useful in determining context.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/dabo/dApp.py

    r2932 r2962  
    1 """  
    2     dApp.py : The application object for Dabo. 
    3  
    4  
    5     This object gets instantiated from the client app's main.py, 
    6     and lives through the life of the application. 
    7  
    8         -- set up an empty data connections object which holds  
    9         -- connectInfo objects connected to pretty names. If there  
    10         -- is a file named 'default.cnxml' present, it will import the 
    11         -- connection definitions contained in that. If no file of that 
    12         -- name exists, it will import any .cnxml file it finds. If there 
    13         -- are no such files, it will then revert to the old behavior 
    14         -- of importing a file in the current directory called  
    15         -- 'dbConnectionDefs.py', which contains connection 
    16         -- definitions in python code format instead of XML. 
    17  
    18         -- Set up a DB Connection manager, that is basically a dictionary 
    19         -- of dConnection objects. This allows connections to be shared 
    20         -- application-wide. 
    21  
    22         -- decide which ui to use (wx) and gets that ball rolling 
    23  
    24         -- make a system menu bar, based on a combination 
    25         -- of dabo defaults and user resource files. 
    26  
    27         -- ditto for toolbar(s) 
    28  
    29         -- look for a mainFrame ui resource file in an expected  
    30         -- place, otherwise uses default dabo mainFrame, and  
    31         -- instantiate that.  
    32  
    33         -- maintain a forms collection and provide interfaces for 
    34         -- opening dForms, closing them, and iterating through them. 
    35  
    36         -- start the main app event loop. 
    37  
    38         -- clean up and exit gracefully 
    39 """ 
    401import sys 
    412import os 
    …… 
    147108    >>> app = dabo.dApp 
    148109    >>> app.start() 
     110 
     111    Normally, dApp gets instantiated from the client app's main Python script, 
     112    and lives through the life of the application. 
     113 
     114        -- set up an empty data connections object which holds  
     115        -- connectInfo objects connected to pretty names. If there  
     116        -- is a file named 'default.cnxml' present, it will import the 
     117        -- connection definitions contained in that. If no file of that 
     118        -- name exists, it will import any .cnxml file it finds. If there 
     119        -- are no such files, it will then revert to the old behavior 
     120        -- of importing a file in the current directory called  
     121        -- 'dbConnectionDefs.py', which contains connection 
     122        -- definitions in python code format instead of XML. 
     123 
     124        -- Set up a DB Connection manager, that is basically a dictionary 
     125        -- of dConnection objects. This allows connections to be shared 
     126        -- application-wide. 
     127 
     128        -- decide which ui to use (wx) and gets that ball rolling 
     129 
     130        -- look for a MainForm in an expected place, otherwise use default dabo  
     131        -- dMainForm, and instantiate that.  
     132 
     133        -- maintain a forms collection and provide interfaces for 
     134        -- opening dForms, closing them, and iterating through them. 
     135 
     136        -- start the main app event loop. 
     137 
     138        -- clean up and exit gracefully 
     139 
    149140    """ 
    150141    _call_beforeInit, _call_afterInit, _call_initProperties = False, False, True 

  • trunk/dabo/dReportWriter.py

    r2327 r2962  
    66# dReportWriter is simply a raw ReportWriter/dObject mixin: 
    77class dReportWriter(dObject, ReportWriter): 
     8    """The Dabo Report Writer Engine, which mixes a data cursor and a report 
     9    format file (.rfxml) to output a PDF. 
     10 
     11    For each row in the Cursor, a detail band is printed. For each page in the 
     12    report, the pageBackground, pageHeader, pageFooter, and pageForeground  
     13    bands are printed. For each defined grouping, the groupHeader and groupFooter 
     14    bands are printed. 
     15 
     16    Report variables can be defined as accumulators, or for any purpose you 
     17    need. All properties of the report form are evaluated at runtime, so that 
     18    you can achieve full flexibility and ultimate control. 
     19 
     20    There is also a pure-python interface available. 
     21    """ 
    822    def _getEncoding(self): 
    923        try: 

  • trunk/dabo/dSecurityManager.py

    r2853 r2962  
    55 
    66class dSecurityManager(dObject): 
    7      
     7    """Class providing security services for Dabo applications, such as the 
     8    user logging in. 
     9    """  
    810    def login(self): 
    911        """Ask the ui to display the login form to the user. 

  • trunk/dabo/dUserSettingProvider.py

    r2936 r2962  
    55 
    66class dUserSettingProvider(dObject): 
     7    """Class that manages saving and restoring user settings, such as form 
     8    size and position. 
     9    """ 
    710    def getUserSettingKeys(self, spec): 
    811        """Return a list of all keys underneath <spec>. 

  • trunk/dabo/db/dBackend.py

    r2904 r2962  
    1 """ dabo.db.backend.py : abstractions for the various db api's """ 
    21import sys 
    32import re 
    …… 
    1716 
    1817class dBackend(dObject): 
    19     """ Abstract object: inherit from this to define new dabo db interfaces.""" 
     18    """Abstract class inherited by the specific Dabo database connectors.""" 
    2019    # Pattern for determining if a function is present in a string 
    2120    functionPat = re.compile(r".*\([^\)]+\)") 

  • trunk/dabo/db/dCursorMixin.py

    r2942 r2962  
    2727 
    2828class dCursorMixin(dObject): 
     29    """Dabo's cursor class, representing the lowest tier.""" 
    2930    _call_initProperties = False 
    3031    def __init__(self, sql="", *args, **kwargs): 

  • trunk/dabo/db/dbFirebird.py

    r2851 r2962  
    77 
    88class Firebird(dBackend): 
     9    """Class providing Firebird connectivity. Uses kinterbasdb.""" 
    910 
    1011    # Firebird treats quotes names differently than unquoted names. This 

  • trunk/dabo/db/dbMsSQL.py

    r2761 r2962  
    44 
    55class MSSQL(dBackend): 
     6    """Class providing Microsoft SQL Server connectivity. Uses pymssql.""" 
    67    def __init__(self): 
    78        dBackend.__init__(self) 

  • trunk/dabo/db/dbMySQL.py

    r2921 r2962  
    1010 
    1111class MySQL(dBackend): 
     12    """Class providing MySQL connectivity. Uses MySQLdb.""" 
    1213 
    1314    # MySQL uses the backtick to enclose names with spaces. 

  • trunk/dabo/db/dbPostgreSQL.py

    r2927 r2962  
    44 
    55class Postgres(dBackend): 
     6    """Class providing PostgreSQL connectivity. Uses psycopg.""" 
    67    def __init__(self): 
    78        dBackend.__init__(self) 

  • trunk/dabo/db/dbSQLite.py

    r2827 r2962  
    88 
    99class SQLite(dBackend): 
     10    """Class providing SQLite connectivity. Uses sqlite3 or pysqlite2 package.""" 
    1011    def __init__(self): 
    1112        dBackend.__init__(self)