cubicweb: comparison server/session.py

equal deleted inserted replaced

-:182c620c960b
+:1d109fb9c67c
 return obj.allow_all_hooks_but(*categories)
 elif mode == HOOKS_DENY_ALL:
 return obj.deny_all_hooks_but(*categories)
-class _hooks_control(object):
+class _hooks_control(object): # XXX repoapi: remove me when
+# session stop being connection
 """context manager to control activated hooks categories.
 If mode is`HOOKS_DENY_ALL`, given hooks categories will
 be enabled.
 else:
 self.cnx.enable_hook_categories(*self.categories)
 finally:
 self.cnx.hooks_mode = self.oldmode
-class _session_hooks_control(_hooks_control):
+class _session_hooks_control(_hooks_control): # XXX repoapi: remove me when
+# session stop being connection
 """hook control context manager for session
 Necessary to handle some unholy transaction scope logic."""
 def cnx_attr(attr_name, writable=False):
 """return a property to forward attribute access to connection.
 This is to be used by session"""
 args = {}
+@deprecated('[4.0] use a Connection object instead')
 def attr_from_cnx(session):
 return getattr(session._cnx, attr_name)
 args['fget'] = attr_from_cnx
 if writable:
+@deprecated('[4.0] use a Connection object instead')
 def write_attr(session, value):
 return setattr(session._cnx, attr_name, value)
 args['fset'] = write_attr
 return property(**args)
 def cnx_meth(meth_name):
 """return a function forwarding calls to connection.
 This is to be used by session"""
+@deprecated('[4.0] use a Connection object instead')
 def meth_from_cnx(session, *args, **kwargs):
 result = getattr(session._cnx, meth_name)(*args, **kwargs)
 if getattr(result, '_cw', None) is not None:
 result._cw = session
 return result
 def __float__(self):
 return float(self.value)
-class Session(RequestSessionBase):
+class Session(RequestSessionBase): # XXX repoapi: stop being a
+# RequestSessionBase at some point
 """Repository user session
 This tie all together:
 * session id,
 * user,
 is_request = False
 is_internal_session = False
 def __init__(self, user, repo, cnxprops=None, _id=None):
 super(Session, self).__init__(repo.vreg)
-self.id = _id or make_uid(unormalize(user.login).encode('UTF8'))
+self.sessionid = _id or make_uid(unormalize(user.login).encode('UTF8'))
-self.user = user
+self.user = user # XXX repoapi: deprecated and store only a login.
 self.repo = repo
 self._timestamp = Timestamp()
 self.default_mode = 'read'
 # short cut to querier .execute method
 self._execute = repo.querier.execute
 self.data = {}
 # i18n initialization
 self.set_language(user.prefered_language())
 ### internals
 # Connection of this section
-self._cnxs = {}
+self._cnxs = {} # XXX repoapi: remove this when nobody use the session
+# as a Connection
 # Data local to the thread
-self.__threaddata = threading.local()
+self.__threaddata = threading.local() # XXX repoapi: remove this when
+# nobody use the session as a Connection
 self._cnxset_tracker = CnxSetTracker()
 self._closed = False
 self._lock = threading.RLock()
 def __unicode__(self):
 @property
 def timestamp(self):
 return float(self._timestamp)
 @property
-def sessionid(self):
+@deprecated('[4.0] session.id is deprecated. use session.sessionid')
-return self.id
+def id(self):
+return self.sessionid
 @property
 def login(self):
-# XXX backward compat with dbapi. deprecate me ASAP.
 return self.user.login
 def new_cnx(self):
 """Return a new Connection object linked to the session
 del self.__threaddata.cnx
 except AttributeError:
 pass
 def set_cnx(self, cnxid=None):
+# XXX repoapi: remove this when nobody use the session as a Connection
 """set the default connection of the current thread to <cnxid>
 Connection is created if necessary"""
 if cnxid is None:
 cnxid = threading.currentThread().getName()
 return self.__threaddata.cnx
 except AttributeError:
 self.set_cnx()
 return self.__threaddata.cnx
+@deprecated('[4.0] use a Connection object instead')
 def get_option_value(self, option, foreid=None):
 return self.repo.get_option_value(option, foreid)
+@deprecated('[4.0] use a Connection object instead')
 def transaction(self, free_cnxset=True):
 """return context manager to enter a transaction for the session: when
 exiting the `with` block on exception, call `session.rollback()`, else
 call `session.commit()` on normal exit.
 added_in_transaction = cnx_meth('added_in_transaction')
 rtype_eids_rdef = cnx_meth('rtype_eids_rdef')
 # security control #########################################################
+@deprecated('[4.0] use a Connection object instead')
 def security_enabled(self, read=None, write=None):
 return _session_security_enabled(self, read=read, write=write)
 read_security = cnx_attr('read_security', writable=True)
 write_security = cnx_attr('write_security', writable=True)
 running_dbapi_query = cnx_attr('running_dbapi_query')
 # hooks activation control #################################################
 # all hooks should be activated during normal execution
+@deprecated('[4.0] use a Connection object instead')
 def allow_all_hooks_but(self, *categories):
 return _session_hooks_control(self, HOOKS_ALLOW_ALL, *categories)
+@deprecated('[4.0] use a Connection object instead')
 def deny_all_hooks_but(self, *categories):
 return _session_hooks_control(self, HOOKS_DENY_ALL, *categories)
 hooks_mode = cnx_attr('hooks_mode')
 is_hook_category_activated = cnx_meth('is_hook_category_activated')
 is_hook_activated = cnx_meth('is_hook_activated')
 # connection management ###################################################
+@deprecated('[4.0] use a Connection object instead')
 def keep_cnxset_mode(self, mode):
 """set `mode`, e.g. how the session will keep its connections set:
 * if mode == 'write', the connections set is freed after each ready
 query, but kept until the transaction's end (eg commit or rollback)
 mode = cnx_attr('mode', writable=True)
 commit_state = cnx_attr('commit_state', writable=True)
 @property
+@deprecated('[4.0] use a Connection object instead')
 def cnxset(self):
 """connections set, set according to transaction mode for each query"""
 if self._closed:
 self.free_cnxset(True)
 raise SessionClosedError('try to access connections set on a closed session %s' % self.id)
 call_service = cnx_meth('call_service')
 # request interface #######################################################
 @property
+@deprecated('[4.0] use a Connection object instead')
 def cursor(self):
 """return a rql cursor"""
 return self
 set_entity_cache  = cnx_meth('set_entity_cache')
 source_defs = cnx_meth('source_defs')
 describe = cnx_meth('describe')
 source_from_eid = cnx_meth('source_from_eid')
+@deprecated('[4.0] use a Connection object instead')
 def execute(self, *args, **kwargs):
 """db-api like method directly linked to the querier execute method.
 See :meth:`cubicweb.dbapi.Cursor.execute` documentation.
 """
 else:
 cnx.clear()
 else:
 cnx.clear()
+@deprecated('[4.0] use a Connection object instead')
 def commit(self, free_cnxset=True, reset_pool=None):
 """commit the current session's transaction"""
 cstate = self._cnx.commit_state
 if cstate == 'uncommitable':
 raise QueryError('transaction must be rollbacked')
 try:
 return self._cnx.commit(free_cnxset, reset_pool)
 finally:
 self._clear_thread_data(free_cnxset)
+@deprecated('[4.0] use a Connection object instead')
 def rollback(self, free_cnxset=True, **kwargs):
 """rollback the current session's transaction"""
 try:
 return self._cnx.rollback(free_cnxset, **kwargs)
 finally:
 rql_rewriter = cnx_attr('_rewriter')
 # deprecated ###############################################################
 @property
+@deprecated('[4.0] use a Connection object instead')
 def anonymous_session(self):
 # XXX for now, anonymous-user is a web side option.
 # It will only be present inside all-in-one instance.
 # there is plan to move it down to global config.
 return self.user.login == self.repo.config.get('anonymous-user')

changeset 9122	1d109fb9c67c
parent 9121	182c620c960b
child 9123	c992811edec2