reviewboard.accounts.user_details¶

Extra user detail introspection and representation.

class UserBadge(label: str, user: User, css_class: Optional[str] = None)[source]¶

Bases: object

A badge shown alongside a user’s name.

Badges can represent some detail about a user. All badges are provided by extensions.

New in version 7.1.

label: str¶

The visual label shown on the badge.

user: User¶

The user this badge belongs to.

css_class: Optional[str] = None¶

An optional CSS class (or classes) used for the badge.

This allows an extension to provide custom styling for a badge, such as custom colors.

Multiple CSS classes can be provided by separating them with spaces.

render_to_string() → SafeString[source]¶

Render the badge to an HTML string.

All badges use a rb-c-user-badge CSS class, along with any CSS classes provided in css_class.

The label for the badge will reflect label.

Returns:

The HTML for the badge.

Return type:

django.utils.safestring.SafeString

__dataclass_fields__ = {'css_class': Field(name='css_class',type='Optional[str]',default=None,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'label': Field(name='label',type='str',default=<dataclasses._MISSING_TYPE object>,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'user': Field(name='user',type='User',default=<dataclasses._MISSING_TYPE object>,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD)}¶

__dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,order=False,unsafe_hash=False,frozen=False,match_args=True,kw_only=False,slots=False,weakref_slot=False)¶

__eq__(other)¶

Return self==value.

__hash__ = None¶

__init__(label: str, user: User, css_class: Optional[str] = None) → None¶

__match_args__ = ('label', 'user', 'css_class')¶

__repr__()¶

Return repr(self).

class BaseUserDetailsProvider[source]¶

Bases: object

Base class for a provider for additional user details.

This enables extensions to provide additional information about users, for specialized rendering and logic.

New in version 7.1.

user_details_provider_id: ClassVar[str]¶

The unique ID of the user details provider.

get_user_badges(user: User, *, local_site: Optional[LocalSite], request: Optional[HttpRequest] = None) → Iterator[UserBadge][source]¶

Return a list of badges to display for a user.

Badges provide a visual indicator about some aspect of a user, for display purposes.

Parameters:

• user (django.contrib.auth.models.User) – The user the badges must correspond to.

• local_site (reviewboard.site.models.LocalSite) – The Local Site the badges must correspond to.

• request (django.http.HttpRequest, optional) – The optional HTTP request from the client.

Yields:

UserBadge – Each badge to display.

class UserDetailsProviderRegistry[source]¶

Bases: OrderedRegistry[BaseUserDetailsProvider]

A registry of user detail providers.

Each provider in the registry will be queried when requesting additional information on users.

New in version 7.1.

lookup_attrs: Sequence[str] = ('user_details_provider_id',)[source]¶

A list of attributes that items can be looked up by.

Type:

list of str

get_user_details_provider(provider_id: str) → Optional[BaseUserDetailsProvider][source]¶

Return the user details provider for a given ID.

Parameters:

provider_id (str) – The ID of the user details provider to return.

Returns:

The user details provider matching the ID, or None if not found.

Return type:

UserDetailsProvider

user_details_provider_registry = <reviewboard.accounts.user_details.UserDetailsProviderRegistry object>[source]¶

The registry managing user details providers.

New in version 7.1.