Django snippets: common model privacy

def exclude_private(self):
    """filter based on 'privacy_field' model class attribute

    'privacy_field' is a two-tuple whose first item is the name of a
    BooleanField and whose second item is a bool which is True if
    '<privacy_field[0]> == True' indicates private (such as a field 'is_private')
    """
    if not hasattr(self.model, "privacy_field"):
        return self

    privacy_field = self.model.privacy_field
    return self.exclude(**{privacy_policy[0]: privacy_field[1]})

from django.db.models import QuerySet
QuerySet.exclude_private = exclude_private

More like this

CustomQueryManager by zvoase 4 years, 11 months ago
FieldLevelPermissionsAdmin by buriy 5 years, 9 months ago
Modifying the fields of a third/existing model class by marinho 2 years, 5 months ago
is_dirty and dict of changed values by jaredthane 3 years, 10 months ago
convenience parent class for UserProfile model by willhardy 4 years, 1 month ago

A BooleanField indicating privacy is common on models, but the name of the field and whether the field being True indicates private or public both may change across models. If there is more than one potentially private model, a common interface is needed. A commonly-named method would do the job with [a for a in MyModel.objects.all() if not a.is_private()], but it would still retrieve private instances from the database only to filter them out.

This approach puts the name of the privacy field and whether that field being True indicates private or public in a tuple attribute of the model class. A chainable method is added to all QuerySet objects.

example use:

class MyModel(models.Model):

is_public = models.BooleanField(default=True)

# ...

privacy_field = ("is_public", False)

>>> publicMyModels = MyModel.objects.all().exclude_private() >>> values = publicMyModels.values()

Author:: teepark
Posted:: July 31, 2007
Language:: Python
Django Version:: .96
Tags:: models querysets
Score:: 1 (after 1 ratings)

Django snippets

common model privacy

More like this

Tools

Comments

Snippets

About