Ticket #7770: 7770.2.diff

django/http/__init__.py

@@ +1 @@
+import datetime
 import os
 import re
+import time
 from Cookie import BaseCookie, SimpleCookie, CookieError
 from pprint import pformat
 from urllib import urlencode
@@ -12 +14 @@
 
 from django.utils.datastructures import MultiValueDict, ImmutableList
 from django.utils.encoding import smart_str, iri_to_uri, force_unicode
+from django.utils.http import cookie_date
 from django.http.multipartparser import MultiPartParser
 from django.conf import settings
 from django.core.files import uploadhandler
@@ -373 +376 @@
 
     def set_cookie(self, key, value='', max_age=None, expires=None, path='/',
                    domain=None, secure=False):
+        """
+        Sets a cookie.
+
+        ``expires`` can be a string in the correct format or a datetime object
+        (either datetime.datetime or datetime.timedelta) in UTC. If ``expires``
+        is a datetime object then ``max_age`` will be calculated.
+        """
         self.cookies[key] = value
-        if max_age is not None:
-            self.cookies[key]['max-age'] = max_age
         if expires is not None:
+            if isinstance(expires, (datetime.datetime, datetime.timedelta)):
+                if isinstance(expires, datetime.datetime):
+                    expires = expires - expires.utcnow()
+                    # Add one second so the date matches exactly (a fraction of
+                    # time gets lost between converting to a timedelta and
+                    # then the date string).
+                    expires = expires + datetime.timedelta(seconds=1)
+                max_age = max(0, expires.days * 86400 + expires.seconds)
+                expires = cookie_date(time.time() + max_age)
             self.cookies[key]['expires'] = expires
+        if max_age is not None:
+            self.cookies[key]['max-age'] = max_age
         if path is not None:
             self.cookies[key]['path'] = path
         if domain is not None:

docs/ref/request-response.txt

@@ -512 +512 @@
     Sets a cookie. The parameters are the same as in the `cookie Morsel`_
     object in the Python standard library.
 
+        * ``expires`` should either be a string in the format
+          ``"Wdy, DD-Mon-YY HH:MM:SS GMT"`` or a ``datetime`` object
+          (either ``datetime.datetime`` in UTC or ``datetime.timedelta``).
+          If ``expires`` is either type of ``datetime`` object, the ``max_age``
+          will be calculated.
         * ``max_age`` should be a number of seconds, or ``None`` (default) if
           the cookie should last only as long as the client's browser session.
-        * ``expires`` should be a string in the format
-          ``"Wdy, DD-Mon-YY HH:MM:SS GMT"``.
         * Use ``domain`` if you want to set a cross-domain cookie. For example,
           ``domain=".lawrence.com"`` will set a cookie that is readable by
           the domains www.lawrence.com, blogs.lawrence.com and

tests/regressiontests/requests/tests.py

@@ -1 +1 @@
 """
->>> from django.http import HttpRequest
+>>> from django.http import HttpRequest, HttpResponse
 >>> print repr(HttpRequest())
 <HttpRequest
 GET:{},
@@ -44 +44 @@
 >>> request.path = ''
 >>> print request.build_absolute_uri(location="/path/with:colons")
 http://www.example.com/path/with:colons
+
+
+# Test cookie datetime expiration logic
+>>> from datetime import datetime, timedelta
+>>> delta = timedelta(seconds=10)
+>>> response = HttpResponse()
+>>> response.set_cookie('datetime', expires=datetime.utcnow()+delta)
+>>> response.set_cookie('delta', expires=delta)
+>>> datetime_cookie = response.cookies['datetime']
+>>> timedelta_cookie = response.cookies['datetime']
+>>> datetime_cookie['max-age']
+10
+>>> datetime_cookie['max-age'] == timedelta_cookie['max-age']
+True
+>>> datetime_cookie['expires'] == timedelta_cookie['expires']
+True
+>>> response.set_cookie('datetime', expires=datetime(2028, 1, 1, 4, 5, 6))
+>>> response.cookies['datetime']['expires']
+'Sat, 01-Jan-2028 04:05:06 GMT'
 """