django-switchuser 0.4.1

django-switchuser

django-switchuser makes it easy for an administrator to switch to temporarily switch to another account by visiting /su.

Doing Your Own Thing

Doing your own thing is easy. The SuStateMiddleware and su_state context processors add a su_state attribute to the request and a su_state variable to the template rendering context. su_state is an instance of django_switchuser.state.SuState, and has the following attributes:

SuState.is_active():

Returns True if the current user has been switched.

SuState.auth_user:

The original user associated with the request. For example, if the user admin has switched to jane, then su_state.auth_user will be admin.

SuState.active_user:

The user which has been switched to, or None if no user has been switched. For example, if the user admin has switched to jane, then su_state.active_user will be admin.

SuState.can_su():

Returns True if the current user is allowed to switch.

SuState.available_users():

Returns a QuerySet of User of the users which the current user is allowed to switch to. It may be useful to override this method to select_related() on the user’s profile:

def available_users(self):
    return User.objects.all()\
        .select_related("profile")\
        .order_by("profile__client_id")

SuState.user_long_label(user):

Returns the “long” label for the user, used in the list of users. It may be useful to override this method so that it includes information specific to your application:

def user_long_label(self, user):
    return "%s (%s)" %(user.get_profile().client_id, user.username)

SuState.user_short_label(user):

Returns the “short” label for the user, used in the status bar and other places. It may be useful to override this method so that it includes information specific to your application:

def user_short_label(self, user):
    return "%s" %(user.get_profile().client_id, )

SuState.set_su_user_id(su_user_id):

Switches to the user with id su_user_id if they are included in SuState.available_users().

SuState.set_su_user(su_user):

Switches to User su_user. No permissions checks are performed.

SuState.clear_su():

Reverts back to the original user.

For example, if you don’t like the default switch user bar, you could add your own to your base.html:

{% load switchuser %}
{% load url from future %}

{% if su_state.is_active %}
    <a href="{% url "su-logout" %}">deactive {% su_user_short_label su.active_user %}</a>
{% elif su_state.can_su %}
    <a href="{% url "su-login" %}">switch user</a>
{% endif %}