UserDetailsProviderHook¶

New in version 7.1.

User Detail Providers can provide information about users for specialized purposes. As of now, these can provide:

Badges: Groups of badged text displayed alongside users’ names in parts of the UI (such as discussions and infoboxes).

Creating User Details Providers¶

To create a User Details Provider, you’ll need to subclass reviewboard.accounts.user_details.BaseUserDetailsProvider. You must set the following:

user_details_provider_id:

A unique ID of the provider. This should be prefixed with a vendor or extension ID to avoid collisions.

It may also define:

get_user_badges():

Calculates and returns UserBadge instances for any badges to display for a user.

Example¶

from typing import TYPE_CHECKING

from reviewboard.accounts.user_details import (BaseUserDetailsProvider,
                                               UserBadge)
from reviewboard.extensions.base import Extension
from reviewboard.extensions.hooks import UserDetailsProviderHook

if TYPE_CHECKING:
    from collections.abc import Iterator

    from django.contrib.auth.models import User
    from django.http import HttpRequest
    from reviewboard.site.models import LocalSite


class MyUserDetailsProvider(BaseUserDetailsProvider):
    user_details_provider_id = 'my-user-details-provider'

    def get_user_badges(
        self,
        user: User,
        *,
        local_site: LocalSite,
        request: HttpRequest,
        **kwargs,
    ) -> Iterator[UserBadge]:
        yield UserBadge(user=user,
                        label='Developer')

        if user.is_superuser:
            yield UserBadge(user=user,
                            label='Administrator')


class SampleExtension(Extension):
    def initialize(self) -> None:
        UserDetailsProviderHook(self, MyUserDetailsProvider())