Back
Feb 18, 2010

User profiles with inheritance in Django

Vladimir Sidorenko
Vladimir Sidorenko

Usually users' profiles are stored in single model. When there are multiple user types, separation is made by some field like user_type.

Situation is a little more complicated when different data is needed for each user type.

Of course it's better when all users have same type and are granted different permissions. But since we got task to have separate user types - we'll have to solve it.

Simple solution

The most obvious solution is to make base profile with type identifier, which will pull needed model instance:

request.user.get_profile().get_final_profile()

But I don't really like this solution. Firstly, get_final_profile method is basically a big switch-case. Secondly - we must not forget to call extra method.

I wanted to simply write request.user.profile ans get needed profile instance. This is possible by combining two known tricks - Upcast and AutoOneToOneField.

Upcast

Allows to get sublass instance from base class instance.

AutoOneToOneField

Allows creating related objects on request. This field is not needed per se, only idea. Taking AutoOneToOneField as a base, it's easy to create a new one that calls upcast when related objects is requested.

Solution

class UpCastModel(models.Model):
        """
        Base class for models that are ment to be inherited.
        Introduces upcast method that returns child instance.
        """
        final_type = models.ForeignKey(ContentType, editable=False)

        def save(self, args, **kwargs):
            if not self.pk:
                self.final_type = ContentType.objects.get_for_model(type(self))
            super(UpCastModel, self).save(args, **kwargs)

        def upcast(self):
            if not hasattr(self, '_upcast'):
                if self.final_type.model_class == self.class:
                    self._upcast = self
                else:
                    self._upcast = self.final_type.get_object_for_this_type(id=self.pk)
            return self._upcast

        class Meta:
            abstract = True

    class UpCastSingleRelatedObjectDescriptor(SingleRelatedObjectDescriptor):
        def get(self, instance, instance_type=None):
            parent = super(UpCastSingleRelatedObjectDescriptor, self).get(
                      instance, instance_type)
            return parent.upcast()


    class UpCastOneToOneField(models.OneToOneField):
        '''
        UpCastOneToOneField gets child of related object.
        '''
        def contribute_to_related_class(self, cls, related):
            setattr(cls, related.get_accessor_name(),
                    UpCastSingleRelatedObjectDescriptor(related))

Now profile looks like this:

class BaseProfile(UpcastModel):
        user = UpCastOneToOneField(User)

    class BoyProfile(BaseProfile):
        pass

    class GirlProfile(CitizenProfile):
         pass

In order to get users, profile, we just need to write requst.user.profile.

More thoughts

Feb 12, 2020Technology
5 Best Payment Gateways For 2020

We reviewed the best payment gateways in 2020. Here’s our comparison of their features, advantages, and disadvantages.

Vladimir Sidorenko
Vladimir Sidorenko
Oct 22, 2016Technology
Solr Sharding

When dealing with one of our projects (LookSMI media monitoring platform) we have to handle the huge volume of data – and its quantity is constantly growing. At the same time, we must run quick searches with smart rules. In this article I'll explain how we have achieved required performance.

Rostyslav Stekh
Rostyslav Stekh
Mar 06, 2010Technology
Ajax form validation

There was a task to submit form with ajax, with server side validation of course. Obvious solution is to do validation and return json with erros. I didn't like idea of writing separate view for validation and then inserting errors in form html on client side. Especially since I already had a generic template for django form with errors display. In this article I'll describe how I solved the task.

Vladimir Sidorenko
Vladimir Sidorenko
Oct 01, 2017Technology
RESTful API Design: Best Practices

We've collected some useful tips regarding REST aimed for beginner developers.

Vladimir Sidorenko
Vladimir Sidorenko