Ticket #251: and_or_clauses.patch

django/core/meta/__init__.py

@@ -1106 +1106 @@
             select.extend(['%s.%s' % (db_table, f2.name) for f2 in f.rel.to.fields])
             _fill_table_cache(f.rel.to, select, tables, where, db_table, cache_tables_seen)
 
+def AND(**kwargs):
+    # Helper function for _parse_lookup below
+    return ' AND ', kwargs.items()
+
+def OR(**kwargs):
+    # Helper function for _parse_lookup below
+    return ' OR ', kwargs.items()
+
 def _throw_bad_kwarg_error(kwarg):
     # Helper function to remove redundancy.
     raise TypeError, "got unexpected keyword argument '%s'" % kwarg
@@ -1125 +1133 @@
             continue
         if kwarg_value is None:
             continue
-        if kwarg == '_or':
-            for val in kwarg_value:
-                tables2, join_where2, where2, params2, table_count = _parse_lookup(val, opts, table_count)
-                tables.extend(tables2)
-                join_where.extend(join_where2)
-                where.append('(%s)' % ' OR '.join(where2))
-                params.extend(params2)
+        if kwarg.startswith('clause') and (len(kwarg) == 6 or kwarg[6:].isdigit()):
+            clause_type, clause_kwarg_items = kwarg_value
+            tables2, join_where2, where2, params2, table_count = _parse_lookup(clause_kwarg_items, opts, table_count)
+            tables.extend(tables2)
+            join_where.extend(join_where2)
+            where.append('(%s)' % clause_type.join(where2))  # clause_type is either ' AND ' or ' OR '
+            params.extend(params2)
             continue
         lookup_list = kwarg.split(LOOKUP_SEPARATOR)
         # pk="value" is shorthand for (primary key)__exact="value"

tests/testapp/models/__init__.py

@@ -1 +1 @@
 __all__ = ['basic', 'repr', 'custom_methods', 'many_to_one', 'many_to_many',
            'ordering', 'lookup', 'get_latest', 'm2m_intermediary', 'one_to_one',
-           'm2o_recursive', 'm2o_recursive2']
+           'm2o_recursive', 'm2o_recursive2', 'complex']

tests/testapp/models/complex.py

@@ +1 @@
+"""
+13. Building complex queries.
+
+To build complex queries involving AND and OR clauses, use the meta.AND
+and meta.OR functions.
+"""
+
+from django.core import meta
+
+class Person(meta.Model):
+    fields = (
+        meta.CharField('fname', maxlength=25),
+        meta.CharField('lname', maxlength=25),
+        meta.IntegerField('age'),
+    )
+    def __repr__(self):
+        return '%s %s (%s)' % (self.fname, self.lname, self.age)
+
+API_TESTS = """
+# Make sure meta gets imported; we'll need it later
+>>> from django.core import meta
+
+# Add some people to the system
+>>> p = persons.Person(fname='John', lname='Smith', age=26)
+>>> p.save()
+>>> p = persons.Person(fname='Mary', lname='Smith', age=31)
+>>> p.save()
+>>> p = persons.Person(fname='Betty', lname='Jones', age=30)
+>>> p.save()
+>>> p = persons.Person(fname='Bob', lname='Jones', age=42)
+>>> p.save()
+>>> p = persons.Person(fname='Susan', lname='White', age=70)
+>>> p.save()
+>>> p = persons.Person(fname='James', lname='White', age=65)
+>>> p.save()
+>>> p = persons.Person(fname='Karen', lname='White', age=33)
+>>> p.save()
+
+# Verify that the test data got loaded correctly.
+>>> persons.get_list(order_by=['age'])
+[John Smith (26), Betty Jones (30), Mary Smith (31), Karen White (33), \
+Bob Jones (42), James White (65), Susan White (70)]
+
+# Search clauses are joined with an AND by default
+>>> persons.get_list(order_by=['age'], lname__exact='Smith')
+[John Smith (26), Mary Smith (31)]
+>>> persons.get_list(order_by=['age'], lname__exact='Smith', age__gte=30)
+[Mary Smith (31)]
+
+# Use "clause=meta.OR" to join with an OR instead
+>>> persons.get_list(order_by=['age'], clause=meta.OR(lname__exact='Smith', age__gte=50))
+[John Smith (26), Mary Smith (31), James White (65), Susan White (70)]
+
+# You can nest AND clauses inside OR clauses
+>>> persons.get_list(order_by=['age'], clause=meta.OR(lname__exact='Smith', 
+...     clause=meta.AND(lname__exact='White', age__lte=65)))
+[John Smith (26), Mary Smith (31), Karen White (33), James White (65)]
+
+# Since Python doesn't let you repeat the same keyword parameter twice in a
+# function call, use clause# (where # is a number) if you want to have
+# multiple AND or OR clauses in a single get_list
+# (Remember that the outer level of clauses is joined by AND)
+>>> persons.get_list(order_by=['age'], clause1=meta.OR(age__lte=30, age__gte=60),
+...     clause2=meta.OR(fname__startswith='B', lname__startswith='W'))
+[Betty Jones (30), James White (65), Susan White (70)]
+"""