10. セッションを使用する

10.1. 概要

Kay には匿名セッションの仕組があります。この仕組を有効にすると全ての request オブジェクトには自動的に session 属性が付加されます。pickle できるデータならなんでもこのセッションに格納できます。

10.2. 設定

セッションを使用するには kay.sessions アプリケーション を settings.INSTALLED_APPS へ kay.sessions.middleware.SessionMiddleware を settings.MIDDLEWARE_CLASSES にセットする必要があります。また settings.SESSION_STORE の設定でセッションをどのように保存するか選べます。有効な値は kay.sessions.sessionstore.GAESessionStore か kay.session.sessionstore.SecureCookieSessionStore です。

SESSION_STORE = 'kay.session.sessionstore.GAESessionStore'
#SESSION_STORE = 'kay.session.sessionstore.SecureCookieSessionStore'

INSTALLED_APPS = (
  'kay.sessions',
  'myapp',
)

# ...

MIDDLEWARE_CLASSES = (
  'kay.sessions.middleware.SessionMiddleware',
  'kay.auth.middleware.GoogleAuthenticationMiddleware',
)

GAESessionStore では、セッションデータは Datastore に保存され、セッションIDのみがユーザー側の Cookie に渡されます。また SecureCookieSessionStore ではユーザー側の Cookie にセッションデータが保存されます。 SecureCookieSessionStore を使用した場合には、セッションに保存するデータは id 等の保存のみにして、大きなデータを保存する事は避けてください。

10.3. デコレーター

kay.sessions.decorators.no_session デコレーターを使用すれば、特定のビューではセッションを使用しないようにできます。下記のように使用します:

from kay.sessions.decorators import no_session

def custom_page(request):
  """ This view use session capability.
  """
  #...
  #...

@no_session
def public_page(request):
  """ This view doesn't use session
  """
  #...
  #...

10.4. 古いセッションを破棄する

GAESessionStore を使用する場合には、期限切れの古いセッションを破棄する必要があります。古いセッションを破棄するためのビューが kay.sessions.views.purge_old_sessions にあります。このビューはデフォルトでは /sessions/purge_old_sessions に結び付けられています。古いセッションを消したければ、このビューを cron か何かで定期的に呼出す必要があります。下記はサンプルの cron 設定です:

cron.yaml

cron:
- description: purge old session data
  url: /sessions/purge_old_sessions
  schedule: every 1 hours

10.5. セッションにデータを保存する

request.session を辞書のように扱ってください。下記は単純なカウンターの例です:

def index(request):
  count = request.session.get('count', 0) + 1
  request.session['count'] = count
  #...
  #...