Opened 11 years ago

Closed 10 years ago

Last modified 9 years ago

#21357 closed Bug (fixed)

Test client session does not behave as stated in the django documentation.

Reported by: aaronmerriam@… Owned by: nobody
Component: Testing framework Version: dev
Severity: Normal Keywords:
Cc: bmispelon@… Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: no UI/UX: no


In the documentation for testing, it states that you can run the following code to manually insert values into the test client session.

def test_something(self):
    session = self.client.session
    session['somekey'] = 'test'

In actuality, self.client.session is of type dict and a calling save() raises an AttributeError.

Change History (7)

comment:1 by Baptiste Mispelon, 11 years ago

Cc: bmispelon@… added
Triage Stage: UnreviewedAccepted
Version: 1.5master

I can reproduce this issue.

It looks like the nature of client.session can depend on the settings [1] which might be what's causing the discrepancy here.

I'm not sure if that's indicative of a bug in the test client (maybe it should return something other than a plain dict if contrib.sessions is not installed) or if it's a documentation issue (in which case it should be mentionned that the given code only works with contrib.sessions installed).

In any case, I'm marking this as accepted.

Thanks for the report.


comment:2 by Harm Geerts <hgeerts@…>, 11 years ago

There also seems to be a regression in that code from the commit

>>> from django.test.client import Client
>>> client = Client()
>>> client.session
>>> client.session['var'] = 'val'
>>> client.session

A test case which tested the above used to exist but was removed in

comment:3 by Preston Timmons, 11 years ago

I added a pull request with a fix for this:

For reference, this issue was reported in #15740. That was marked as a duplicate of #10899, but I no longer think that is correct. While the feature in #10899 would fix this case, the behavior it tries to add is more clever than it needs to be.

comment:4 by Tim Graham, 10 years ago

Has patch: set
Patch needs improvement: set

Test on PR does not currently pass (possibly due to upstream changes since the PR was submitted).

comment:5 by Tim Graham <timograham@…>, 10 years ago

Resolution: fixed
Status: newclosed

In be88b062afaa58559bb12623e8ed8843f07b97a1:

Fixed #21357 -- Fixed test client session initialization.

The test client will now create a session when it is first accessed
if no session already exists.

comment:6 by Simon Bächler, 9 years ago

The fix has only been added to the 1.8 branch. In Django 1.7 the behavior is still not the same as stated in the documentation.

comment:7 by Tim Graham <timograham@…>, 9 years ago

In d42cbde0:

[1.7.x] Refs #21357 -- Added a working session example to the docs.

Note: See TracTickets for help on using tickets.
Back to Top