Documentation: Expected Value Format for "One of"

[mrname]

It looks like the "one of" operator maps to "iregex" under the hood. Does this mean that the value should be a regular expression? The confusion hit for me when I went to input the value, and it provided an autocomplete field which I was only allowed to select one of (I expected to see an interface that would allow me to choose multiple values). So, should the value of this operator type be a regex?

[asfaltboy]

Hi again! You're absolutely right, this is extremely confusing, and better documentation is definitely a good start (to be continued by adding a specialised widget for this operator, as in #23).

The iregex operator is used for "One of" to look up one of any number of results as value. The following test case, for example, will return results where email matches EITHER foo OR bar:

django-advanced-filters/advanced_filters/tests/test_forms.py

Line 174 in 365b646

Q(email__iregex=r'^(foo|bar)$')

We actually transform the input of this field's value, from a comma separated string of values to this iregex form in the following VaryingTypeCharField class:

django-advanced-filters/advanced_filters/form_helpers.py

Line 13 in 6541b53

class VaryingTypeCharField(forms.CharField):