1# Exports 

2 

3__all__ = ( 

4 "Session", 

5) 

6 

7# Classes 

8 

9 

10class Session(object): 

11 """A simplistic helper for working with session variables in a sane way.""" 

12 

13 def __init__(self, request, prefix=None): 

14 """Initialize session interface. 

15 

16 :param request: The current request. 

17 :type request: django.http.request.HttpRequest 

18 

19 :param prefix: The variable name prefix, if any. 

20 :type prefix: str 

21 

22 """ 

23 self.prefix = prefix 

24 self.request = request 

25 

26 def get(self, name, default=None): 

27 """Get a session variable, automatically prefixing the name. 

28 

29 :param name: The variable name. 

30 :type name: str 

31 

32 :param default: The value to use if no value is already set. 

33 

34 """ 

35 name = self._get_name(name) 

36 

37 # noinspection PyUnresolvedReferences 

38 return self.request.session.get(name, default) 

39 

40 def has(self, name): 

41 """Indicates whether the current session has the given variable. 

42 

43 :rtype: bool 

44 

45 """ 

46 name = self._get_name(name) 

47 

48 # noinspection PyUnresolvedReferences 

49 return name in self.request.session 

50 

51 def set(self, name, value): 

52 """Set a session variable, automatically prefixing the name. 

53 

54 :param name: The variable name. 

55 :type name: str 

56 

57 :param value: The value to set. 

58 

59 """ 

60 name = self._get_name(name) 

61 

62 # noinspection PyUnresolvedReferences 

63 self.request.session[name] = value 

64 

65 # https://stackoverflow.com/q/2166856/241720 

66 # noinspection PyUnresolvedReferences 

67 self.request.session.modified = True 

68 

69 def unset(self, name): 

70 name = self._get_name(name) 

71 

72 # noinspection PyUnresolvedReferences 

73 if name in self.request.session: 

74 # noinspection PyUnresolvedReferences 

75 del(self.request.session[name]) 

76 

77 def _get_name(self, name): 

78 """Get the variable name stored in the session, including the prefix if one has been provided. 

79 

80 :param name: The un-prefixed variable name. 

81 :type name: str 

82 

83 :rtype: str 

84 

85 """ 

86 if self.prefix is not None: 

87 return "%s_%s" % (self.prefix, name) 

88 

89 return name