Home       Trees       Indices       Help   
Visit WTF Online
Package wtf :: Package ext :: Package db
[hide private]
[frames] | no frames]

Package db

source code

DB stuff.

Author: André Malo

Submodules [hide private]

Classes [hide private]
  DataError
Data error
  InterfaceError
Interface error
  InternalError
Internal error
  IntegrityError
Integrity error
  DatabaseError
Database error
  DBAPIError
DB API Error
  DBError
Base DB exception
  OperationalError
Operational error
  ProgrammingError
Programming error
  NotSupportedError
Not supported error
  DBConfigurationError
DB configuration error
  DBService
DB Service
Functions [hide private]
callable
connection(dbname, arg=None, translate_exceptions=True)
Create decorator to inject SA connection into function		 source code
callable
transaction(arg=None)
Create decorator to wrap a connection into a transaction		 source code
module
driver(dbname)
Determine driver module		 source code
connection object (DBAPI 2)
connect(dbname, **kwargs)
Connect to database		 source code
 
configure(dbconf=None, unpack_password=None)
Configure the databases		 source code
Variables [hide private]
  __package__ = 'wtf.ext.db'
Function Details [hide private]

connection(dbname, arg=None, translate_exceptions=True)

source code 
Create decorator to inject SA connection into function
Parameters:
  • dbname (str) - DB name
  • arg (str) - Argument name. If omitted or None, 'db' is used.
  • translate_exceptions (bool) - Translate adapter exceptions to our ones?
Returns: callable
Decorator function

transaction(arg=None)

source code 
Create decorator to wrap a connection into a transaction
Parameters:
  • arg (str) - Argument name. If omitted or None, 'db' is used.
Returns: callable
Decorator function

driver(dbname)

source code 
Determine driver module
Parameters:
  • dbname (str) - DB name (section token in db.conf)
Returns: module
Driver module
Raises:
  • DBConfigurationError - DB not configured
  • KeyError - DB name not found
  • ImportError - Driver not found

connect(dbname, **kwargs)

source code 
Connect to database
Parameters:
  • dbname (str) - DB name (section token in db.conf)
  • kwargs (dict) - Additional parameters for adapter connect() call
Returns: connection object (DBAPI 2)
new connection
Raises:
  • DBConfigurationError - DB not configured
  • KeyError - DB name not found
  • ImportError - Driver not found

configure(dbconf=None, unpack_password=None)

source code 
Configure the databases
Parameters:
  • dbconf (str) - Config file name. If omitted or None, the environment variable WTF_EXT_DB_CONF is queried. If that's unset, too, it defaults to '/etc/wtf/ext/db.conf'.
  • unpack_password (callable) - Password unpacker. If omitted or None, no password unpacker is applied.
Raises:

   Home       Trees       Indices       Help   
Visit WTF Online