Django queryset filtering by ISO week number

Question

I have a model that contains datefield. I'm trying to get query set of that model that contains current week (starts on Monday).

So since Django datefield contains simple datetime.date model I assumed to filter by using .isocalendar(). Logically it's exactly what I want without no extra comparisons and calculations by current week day.

So what I want to do essentially is force .filter statement to behave in this logic:

if model.date.isocalendar()[2] == datetime.date.today().isocalendar()[2]
    ...

Yet how to write it inside filter statement? .filter(model__date__isocalendar=datetime.date.today().isocalendar()) will give wrong results (same as comparing to today not this week).

As digging true http://docs.python.org/library/datetime.html I have not noticed any other week day options...

Note from documentation:

date.isocalendar() Return a 3-tuple, (ISO year, ISO week number, ISO weekday).

Update:

Although I disliked the solution of using ranges yet it's the best option. However in my case I made a variable that marks the beginning of the week and just look greater or equal value because if I'm looking for a matches for current week. In case of giving the number of the week It would require both ends.

today = datetime.date.today()
monday = today - datetime.timedelta(days=today.weekday())

... \
.filter(date__gte=monday)

Answer 1

You're not going to be able to do this. Remember it's not just an issue of what Python supports, Django has to communicate the filter to the database, and the database doesn't support such complex date calculations. You can use __range, though, with a start date and end date.

Answer 2

(This answer should only work for postgres, but might work for other databases.)

A quick and elegant solution for this problem would be to define these two custom transformers:

from django.db import models
from django.db.models.lookups import DateTransform

@models.DateTimeField.register_lookup
class WeekTransform(DateTransform):
    lookup_name = 'week'


@models.DateTimeField.register_lookup
class ISOYearTransform(DateTransform):
    lookup_name = 'isoyear'

Now you can query by week like this:

from django.utils.timezone import now
year, week, _ = now().isocalendar()

MyModel.objects.filter(created__isoyear=year, created__week=week)

Behinds the scenes, the Django DateTransform object uses the postgres EXTRACT function, which supports week and isoyear.

Answer 3

ExtractWeek has been introduced in Django 1.11 for filtering based on isoweek number.

For Django 1.10 and lower versions, following solution works for filtering by iso number week on postgres database:

from django.db.models.functions import Extract
from django.db import models
@models.DateTimeField.register_lookup
class ExtractWeek(Extract):
    lookup_name = 'week'

Now do query as follows

queryset.annotate(week=ExtractWeek('date'))\
            .filter(week=week_number)

Answer 4

Even simpler than using Extract function that Amit mentioned in his answer is using __week field lookup added in Django 1.11, so you can simply do:

.filter(model__date__week=datetime.date.today().isocalendar()[1])