Opened 2 years ago

Closed 23 months ago

Last modified 23 months ago

#21404 closed Cleanup/optimization (fixed)

session.set_expiry() causes a TypeError when using JSONSerializer

Reported by: pwr Owned by: nobody
Component: Documentation Version: 1.6
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no


I am using django.contrib.sessions.backends.cached_db as the SESSION_ENGINE and django.contrib.sessions.serializers.JSONSerializer as the SESSION_SERIALIZER.

Setting a session expiration date using session.set_expiry() results in a TypeError when the session is saved:

File "/Users/pwr/Library/Python/2.7/lib/python/site-packages/django/core/handlers/" in get_response
  201.                 response = middleware_method(request, response)
File "/Users/pwr/Library/Python/2.7/lib/python/site-packages/django/contrib/sessions/" in process_response
File "/Users/pwr/Library/Python/2.7/lib/python/site-packages/django/contrib/sessions/backends/" in save
  62.         super(SessionStore, self).save(must_create)
File "/Users/pwr/Library/Python/2.7/lib/python/site-packages/django/contrib/sessions/backends/" in save
  57.             session_data=self.encode(self._get_session(no_load=must_create)),
File "/Users/pwr/Library/Python/2.7/lib/python/site-packages/django/contrib/sessions/backends/" in encode
  87.         serialized = self.serializer().dumps(session_dict)
File "/Users/pwr/Library/Python/2.7/lib/python/site-packages/django/core/" in dumps
  88.         return json.dumps(obj, separators=(',', ':')).encode('latin-1')
File "/opt/local/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/json/" in dumps
  250.         sort_keys=sort_keys, **kw).encode(obj)
File "/opt/local/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/json/" in encode
  207.         chunks = self.iterencode(o, _one_shot=True)
File "/opt/local/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/json/" in iterencode
  270.         return _iterencode(o, 0)
File "/opt/local/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/json/" in default
  184.         raise TypeError(repr(o) + " is not JSON serializable")

Exception Type: TypeError at /users/login/
Exception Value: datetime.datetime(2013, 11, 9, 5, 0, tzinfo=<DstTzInfo 'Europe/Berlin' CET+1:00:00 STD>) is not JSON serializable

The documentation already notes that JSONSerializer cannot handle datetime values, which is working as intended according to #21124. The documentation for set_expiry also notes that "datetime and timedelta values are only serializable if you are using the PickleSerializer".

If this is indeed intentional, I suggest that the 1.6 release notes should at least mention that session expiration times can no longer be set in the default configuration.

Attachments (1)

21404.diff (1.4 KB) - added by timo 23 months ago.

Download all attachments as: .zip

Change History (7)

comment:1 Changed 2 years ago by timo

  • Component changed from contrib.sessions to Documentation
  • Easy pickings set
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted
  • Type changed from Bug to Cleanup/optimization

Accepting as a documentation addition.

comment:2 Changed 2 years ago by G.Z.

I can confirm that this seems like a relevant issue - there should be at least clear warning about a possibility of such errors coming up just from using default settings and methods.

Changed 23 months ago by timo

comment:3 Changed 23 months ago by timo

  • Has patch set

Attached is a proposed patch. Please let me know if you would add anything else.

comment:4 Changed 23 months ago by pwr

Looks good to me. Thank you!

comment:5 Changed 23 months ago by Tim Graham <timograham@…>

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

In ffdae5b66d681145d6e9288fd98718e6c7b263e4:

Fixed #21404 -- Added session.set_expiry() note to 1.6 release notes.

Thanks pwr for the suggestion.

comment:6 Changed 23 months ago by Tim Graham <timograham@…>

In a776e3f42088a5a82bd0ec9c5353981a1a23e10c:

[1.6.x] Fixed #21404 -- Added session.set_expiry() note to 1.6 release notes.

Thanks pwr for the suggestion.

Backport of ffdae5b66d from master

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