From 99d8bb34fe034161c9f6ca7587a0f8b87a2f1236 Mon Sep 17 00:00:00 2001 From: Adrian Holovaty Date: Wed, 17 Aug 2005 04:05:42 +0000 Subject: [PATCH] Added 'Session object guidlines' section to docs/sessions.txt git-svn-id: http://code.djangoproject.com/svn/django/trunk@524 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/sessions.txt | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/sessions.txt b/docs/sessions.txt index 2566a9f70e..ad715767ca 100644 --- a/docs/sessions.txt +++ b/docs/sessions.txt @@ -63,6 +63,18 @@ It also has these two methods: You can edit ``request.session`` at any point in your view. You can edit it multiple times. +Session object guidelines +------------------------- + + * Use normal Python strings as dictionary keys on ``request.session``. This + is more of a convention than a hard-and-fast rule. + + * Session dictionary keys that begin with an underscore are reserved for + internal use by Django. + + * Don't override ``request.session`` with a new object, and don't access or + set its attributes. Use it like a Python dictionary. + Examples --------