Code

Opened 2 years ago

Closed 2 years ago

#17236 closed Cleanup/optimization (fixed)

Documentation of session behavior during login

Reported by: bruth Owned by: krzysiumed
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)

patch.diff​ (592 bytes) - added by krzysiumed 2 years ago.
17236_v2.diff​ (1.1 KB) - added by krzysiumed 2 years ago.

Download all attachments as: .zip

Change History (10)

comment:1 Changed 2 years ago by PaulM

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

The docs need to point out that while going from an anonymous session to a logged in session, data set during the anonymous session is retained.

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

Version 1, edited 2 years ago by PaulM (previous) (next) (diff)

comment:2 Changed 2 years ago by krzysiumed

  • Owner changed from nobody to krzysiumed
  • Status changed from new to assigned

Changed 2 years ago by krzysiumed

comment:3 Changed 2 years ago by krzysiumed

  • Cc krzysiumed@… added
  • Has patch set
  • Type changed from Uncategorized to Cleanup/optimization

comment:4 Changed 2 years ago by ptone

  • 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.

Changed 2 years ago by krzysiumed

comment:5 Changed 2 years ago by krzysiumed

  • Cc krzysiumed@… removed
  • Patch needs improvement unset

OK, I amended the patch: the grammar was improved and a note in sphinx docs was added.

comment:6 Changed 2 years ago by krzysiumed

  • Cc krzysiumed@… added

comment:7 Changed 2 years ago by jezdez

  • Triage Stage changed from Accepted to Ready for checkin

comment:8 Changed 2 years ago by claudep

  • Resolution set to fixed
  • Status changed from assigned to closed

In [17704]:

Fixed #17236 -- Clarified that anonymous session data are retained after login. Thanks krzysiumed for the patch.

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

Attachments ↑
 
Note: See TracTickets for help on using tickets.