cubicweb: comparison dbapi.py

equal deleted inserted replaced

-:afc757568492
+:d33509b79efe
 rset = Cursor.execute(self, operation, parameters, build_descr=build_descr)
 self.connection.executed_queries.append((operation, parameters,
 time() - tstart, clock() - cstart))
 return rset
+def check_not_closed(func):
+def decorator(self, *args, **kwargs):
+if self._closed is not None:
+raise ProgrammingError('Closed connection')
+return func(self, *args, **kwargs)
+return decorator
 class Connection(object):
 """DB-API 2.0 compatible Connection object for CubicWeb
 """
 # make exceptions available through the connection object
 self.commit()
 else:
 self.rollback()
 return False #propagate the exception
-def _txid(self, cursor=None): # XXX could now handle various isolation level!
+def __del__(self):
-# return a dict as bw compat trick
+"""close the remote connection if necessary"""
-return {'txid': currentThread().getName()}
+if self._closed is None and self._close_on_del:
+try:
-def request(self):
+self.close()
-return DBAPIRequest(self.vreg, DBAPISession(self))
+except:
+pass
-def check(self):
-"""raise `BadConnectionId` if the connection is no more valid"""
+# connection initialization methods ########################################
-if self._closed is not None:
-raise ProgrammingError('Closed connection')
-self._repo.check_session(self.sessionid)
-def set_session_props(self, **props):
-"""raise `BadConnectionId` if the connection is no more valid"""
-if self._closed is not None:
-raise ProgrammingError('Closed connection')
-self._repo.set_session_props(self.sessionid, props)
-def get_shared_data(self, key, default=None, pop=False):
-"""return value associated to `key` in shared data"""
-if self._closed is not None:
-raise ProgrammingError('Closed connection')
-return self._repo.get_shared_data(self.sessionid, key, default, pop)
-def set_shared_data(self, key, value, querydata=False):
-"""set value associated to `key` in shared data
-if `querydata` is true, the value will be added to the repository
-session's query data which are cleared on commit/rollback of the current
-transaction, and won't be available through the connexion, only on the
-repository side.
-"""
-if self._closed is not None:
-raise ProgrammingError('Closed connection')
-return self._repo.set_shared_data(self.sessionid, key, value, querydata)
-def get_schema(self):
-"""Return the schema currently used by the repository.
-This is NOT part of the DB-API.
-"""
-if self._closed is not None:
-raise ProgrammingError('Closed connection')
-return self._repo.get_schema()
 def load_appobjects(self, cubes=_MARKER, subpath=None, expand=True):
 config = self.vreg.config
 if cubes is _MARKER:
 cubes = self._repo.get_cubes()
 self.vreg.config.set_option('base-url', baseurl)
 # XXX why is this needed? if really needed, could be fetched by a query
 if sitetitle is not None:
 self.vreg['propertydefs']['ui.site-title'] = {'default': sitetitle}
+@check_not_closed
 def source_defs(self):
 """Return the definition of sources used by the repository.
 This is NOT part of the DB-API.
 """
-if self._closed is not None:
-raise ProgrammingError('Closed connection')
 return self._repo.source_defs()
+@check_not_closed
 def user(self, req=None, props=None):
 """return the User object associated to this connection"""
 # cnx validity is checked by the call to .user_info
-if self._closed is not None:
-raise ProgrammingError('Closed connection')
 eid, login, groups, properties = self._repo.user_info(self.sessionid,
 props)
 if req is None:
 req = self.request()
 rset = req.eid_rset(eid, 'CWUser')
 from cubicweb.entity import Entity
 user = Entity(req, rset, row=0)
 user['login'] = login # cache login
 return user
-def __del__(self):
+@check_not_closed
-"""close the remote connection if necessary"""
+def check(self):
-if self._closed is None and self._close_on_del:
+"""raise `BadConnectionId` if the connection is no more valid"""
-try:
+self._repo.check_session(self.sessionid)
-self.close()
-except:
+def _txid(self, cursor=None): # XXX could now handle various isolation level!
-pass
+# return a dict as bw compat trick
+return {'txid': currentThread().getName()}
+def request(self):
+return DBAPIRequest(self.vreg, DBAPISession(self))
+# session data methods #####################################################
+@check_not_closed
+def set_session_props(self, **props):
+"""raise `BadConnectionId` if the connection is no more valid"""
+self._repo.set_session_props(self.sessionid, props)
+@check_not_closed
+def get_shared_data(self, key, default=None, pop=False):
+"""return value associated to `key` in shared data"""
+return self._repo.get_shared_data(self.sessionid, key, default, pop)
+@check_not_closed
+def set_shared_data(self, key, value, querydata=False):
+"""set value associated to `key` in shared data
+if `querydata` is true, the value will be added to the repository
+session's query data which are cleared on commit/rollback of the current
+transaction, and won't be available through the connexion, only on the
+repository side.
+"""
+return self._repo.set_shared_data(self.sessionid, key, value, querydata)
+# meta-data accessors ######################################################
+@check_not_closed
+def get_schema(self):
+"""Return the schema currently used by the repository."""
+return self._repo.get_schema()
+@check_not_closed
 def describe(self, eid):
-if self._closed is not None:
-raise ProgrammingError('Closed connection')
 return self._repo.describe(self.sessionid, eid, **self._txid())
+# db-api like interface ####################################################
+@check_not_closed
+def commit(self):
+"""Commit pending transaction for this connection to the repository.
+may raises `Unauthorized` or `ValidationError` if we attempted to do
+something we're not allowed to for security or integrity reason.
+If the transaction is undoable, a transaction id will be returned.
+"""
+return self._repo.commit(self.sessionid, **self._txid())
+@check_not_closed
+def rollback(self):
+"""This method is optional since not all databases provide transaction
+support.
+In case a database does provide transactions this method causes the the
+database to roll back to the start of any pending transaction.  Closing
+a connection without committing the changes first will cause an implicit
+rollback to be performed.
+"""
+self._repo.rollback(self.sessionid, **self._txid())
+@check_not_closed
+def cursor(self, req=None):
+"""Return a new Cursor Object using the connection.
+On pyro connection, you should get cursor after calling if
+load_appobjects method if desired (which you should call if you intend
+to use ORM abilities).
+"""
+if req is None:
+req = self.request()
+return self.cursor_class(self, self._repo, req=req)
+@check_not_closed
 def close(self):
 """Close the connection now (rather than whenever __del__ is called).
 The connection will be unusable from this point forward; an Error (or
 subclass) exception will be raised if any operation is attempted with
 the connection. The same applies to all cursor objects trying to use the
 connection.  Note that closing a connection without committing the
 changes first will cause an implicit rollback to be performed.
 """
-if self._closed:
-raise ProgrammingError('Connection is already closed')
 self._repo.close(self.sessionid, **self._txid())
 del self._repo # necessary for proper garbage collection
 self._closed = 1
-def commit(self):
-"""Commit pending transaction for this connection to the repository.
-may raises `Unauthorized` or `ValidationError` if we attempted to do
-something we're not allowed to for security or integrity reason.
-If the transaction is undoable, a transaction id will be returned.
-"""
-if not self._closed is None:
-raise ProgrammingError('Connection is already closed')
-return self._repo.commit(self.sessionid, **self._txid())
-def rollback(self):
-"""This method is optional since not all databases provide transaction
-support.
-In case a database does provide transactions this method causes the the
-database to roll back to the start of any pending transaction.  Closing
-a connection without committing the changes first will cause an implicit
-rollback to be performed.
-"""
-if not self._closed is None:
-raise ProgrammingError('Connection is already closed')
-self._repo.rollback(self.sessionid, **self._txid())
-def cursor(self, req=None):
-"""Return a new Cursor Object using the connection.
-On pyro connection, you should get cursor after calling if
-load_appobjects method if desired (which you should call if you intend
-to use ORM abilities).
-"""
-if self._closed is not None:
-raise ProgrammingError('Can\'t get cursor on closed connection')
-if req is None:
-req = self.request()
-return self.cursor_class(self, self._repo, req=req)
 # undo support ############################################################
+@check_not_closed
 def undoable_transactions(self, ueid=None, req=None, **actionfilters):
 """Return a list of undoable transaction objects by the connection's
 user, ordered by descendant transaction time.
 Managers may filter according to user (eid) who has done the transaction
 req = self.request()
 for txinfo in txinfos:
 txinfo.req = req
 return txinfos
+@check_not_closed
 def transaction_info(self, txuuid, req=None):
 """Return transaction object for the given uid.
 raise `NoSuchTransaction` if not found or if session's user is not
 allowed (eg not in managers group and the transaction doesn't belong to
 if req is None:
 req = self.request()
 txinfo.req = req
 return txinfo
+@check_not_closed
 def transaction_actions(self, txuuid, public=True):
 """Return an ordered list of action effectued during that transaction.
 If public is true, return only 'public' actions, eg not ones triggered
 under the cover by hooks, else return all actions.
 transaction doesn't belong to him).
 """
 return self._repo.transaction_actions(self.sessionid, txuuid, public,
 **self._txid())
+@check_not_closed
 def undo_transaction(self, txuuid):
 """Undo the given transaction. Return potential restoration errors.
 raise `NoSuchTransaction` if not found or if session's user is not
 allowed (eg not in managers group and the transaction doesn't belong to

branch	stable
changeset 6252	d33509b79efe
parent 6061	7cb29eab1c9d
child 6257	7eb5f1aed728