Opened 12 years ago
Closed 12 years ago
#17236 closed Cleanup/optimization (fixed)
Documentation of session behavior during login
| Reported by: | Byron Ruth | Owned by: | Christopher Medrela |
|---|---|---|---|
| Component: | Documentation | Version: | |
| Severity: | Normal | Keywords: | |
| Cc: | krzysiumed@… | Triage Stage: | Ready for checkin |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description
Discussion here: http://groups.google.com/group/django-developers/browse_thread/thread/93dd04dc07ddf612
This slice of code regarding the session behavior during login should be documented: https://github.com/django/django/blob/master/django/contrib/auth/__init__.py#L63-70
Attachments (2)
Change History (10)
comment:1 by , 12 years ago
| Triage Stage: | Unreviewed → Accepted |
|---|
Version 0, edited 12 years ago by (next)
comment:2 by , 12 years ago
| Owner: | changed from to |
|---|---|
| Status: | new → assigned |
by , 12 years ago
| Attachment: | patch.diff added |
|---|
comment:3 by , 12 years ago
| Cc: | added |
|---|---|
| Has patch: | set |
| Type: | Uncategorized → Cleanup/optimization |
comment:4 by , 12 years ago
| Patch needs improvement: | set |
|---|
"Note that when logging in session," the grammar is off, not sure what exactly you meant
Also this is a change to a docstring, and Django's docs are not autogenerated, so docs should also be updated in the source files of the sphinx documentation.
by , 12 years ago
| Attachment: | 17236_v2.diff added |
|---|
comment:5 by , 12 years ago
| Cc: | removed |
|---|---|
| Patch needs improvement: | unset |
OK, I amended the patch: the grammar was improved and a note in sphinx docs was added.
comment:6 by , 12 years ago
| Cc: | added |
|---|
comment:7 by , 12 years ago
| Triage Stage: | Accepted → Ready for checkin |
|---|
Note:
See TracTickets
for help on using tickets.
The docs need to point out that session data is retained when going from anonymous session to a logged in session retains data set during the anonymous session, but that sessions are cleared entirely when logging out.
The first bullet point in the email is incorrect - the flush code does delete the session, causing a new session id to be created.
https://github.com/django/django/blob/master/django/contrib/sessions/backends/base.py#L240-257