reviewboard.datagrids.columns¶

Columns for datagrids.

class BaseStarColumn(label: Optional[StrOrPromise] = None, id: Optional[str] = None, detailed_label: Optional[StrOrPromise] = None, detailed_label_html: Optional[str] = None, field_name: Optional[str] = None, db_field: Optional[str] = None, image_url: Optional[str] = None, image_class: Optional[str] = None, image_width: Optional[int] = None, image_height: Optional[int] = None, image_alt: Optional[str] = '', shrink: bool = False, expand: bool = False, sortable: bool = False, default_sort_dir: int = 0, link: bool = False, link_func: Optional[LinkObjectFunc] = None, link_css_class: Optional[Union[str, LinkCSSClassFunc]] = None, cell_clickable: bool = False, css_class: Union[str, BuildCSSClassFunc] = '')[source]¶

Bases: Column

Indicates if an item is starred.

This is the base class for all columns that deal with starring items.

The star is interactive, allowing the user to star or unstar the item.

detailed_label: Optional[StrOrPromise] = 'Starred'[source]¶

A detailed label to display in the Edit Columns menu.

Defaults to label.

Type:

str

image_alt: Optional[str] = 'Starred'[source]¶

The alt text for an image.

Type:

str

image_class: Optional[str] = 'rb-icon rb-icon-star-on'[source]¶

The CSS spritesheet icon class to use in the header/navigation menu.

Type:

str

shrink: bool = True[source]¶

Whether the column will shrink to the minimum size for the data.

Type:

bool

starrable_model: type[StarrableObject]¶

The starrable model handled by the column.

augment_queryset(state: StatefulColumn, queryset: QuerySet) → QuerySet[source]¶

Add additional queries to the queryset.

This will load the list of starrable object IDs to check in the starred list, and then set them in the user’s star cache for later rendering.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The column state.

• queryset (django.db.models.query.QuerySet) – The queryset to augment.

Returns:

The resulting queryset.

Return type:

django.db.models.query.QuerySet

render_data(state: StatefulColumn, obj: StarrableObject) → SafeString[source]¶

Return the rendered contents of the column.

Parameters:

• state (djblets.datagrids.grids.StatefulColumn) – The state for the DataGrid instance.

• obj (django.db.models.Model) – The starrable model object for the row.

Returns:

The rendered data as HTML.

Return type:

django.utils.safestring.SafeString

get_raw_object_value(state: StatefulColumn, obj: StarrableObject) → bool[source]¶

Return the raw value for the star state.

This will determine whether the object is starred and save it for lookup during rendering.

New in version 7.1.

Parameters:

• state (djblets.datagrids.grids.StatefulColumn) – The state for the DataGrid instance.

• obj (django.db.models.Model) – The starrable model object for the row.

Returns:

The star state for the object.

Return type:

bool

class UsernameColumn(user_relation: Sequence[str] | None = None, *args, **kwargs)[source]¶

Bases: Column

A column for showing a username and the user’s avatar.

The username and avatar will link to the user’s profile page and will show basic profile information when hovering over the link.

When constructing an instance of this column, the relation between the object being represented in the datagrid and the user can be specified as a tuple or list of field names forming a path to the user field.

AVATAR_SIZE = 24[source]¶

label: Optional[StrOrPromise] = 'Username'[source]¶

The label to show in the column header.

Type:

str

css_class: Union[str, BuildCSSClassFunc] = 'submitter-column'[source]¶

A function or string for CSS classes applied to the cell.

Type:

str or callable

shrink: bool = True[source]¶

Whether the column will shrink to the minimum size for the data.

Type:

bool

sortable: bool = True[source]¶

Whether the column can be sorted.

Type:

bool

link: bool = True[source]¶

Whether the contents of the cell will be linked to a URL.

The URL used must be defined by either link_func or DataGrid.link_to_object().

Type:

bool

link_css_class: Optional[Union[str, LinkCSSClassFunc]] = 'user'[source]¶

A function or string for CSS classes applied to a link.

The CSS classes will be defined on the <a> for the cell’s link wrapper. This is only used if link is True.

Type:

str or callable

__init__(user_relation: Sequence[str] | None = None, *args, **kwargs) → None[source]¶

Initialize the column.

Parameters:

• user_relation (list of str, optional) – A list of fields forming a relation path to the user. This can be left blank if representing the user.

• *args (tuple) – Additional positional arguments to pass to the column.

• **kwargs (dict) – Additional keyword arguments to pass to the column.

get_user(obj: Any) → RBUser[source]¶

Return the user associated with this object.

Parameters:

obj (object) – The object provided to the column.

Returns:

The resulting user.

Return type:

reviewboard.accounts.models.User

render_data(state: StatefulColumn, obj: Any) → SafeString[source]¶

Render the user’s name and avatar as HTML.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The column state.

• obj (django.db.models.Model) – The object being rendered in the datagrid.

Returns:

The HTML for the column.

Return type:

django.utils.safestring.SafeString

augment_queryset(state: StatefulColumn, queryset: QuerySet) → QuerySet[source]¶

Add additional queries to the queryset.

This will select fields for the user and the user’s profile, to help with query performance.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The column state.

• queryset (django.db.models.query.QuerySet) – The queryset to augment.

Returns:

The resulting queryset.

Return type:

django.db.models.query.QuerySet

class FullNameColumn(label: Optional[StrOrPromise] = None, id: Optional[str] = None, detailed_label: Optional[StrOrPromise] = None, detailed_label_html: Optional[str] = None, field_name: Optional[str] = None, db_field: Optional[str] = None, image_url: Optional[str] = None, image_class: Optional[str] = None, image_width: Optional[int] = None, image_height: Optional[int] = None, image_alt: Optional[str] = '', shrink: bool = False, expand: bool = False, sortable: bool = False, default_sort_dir: int = 0, link: bool = False, link_func: Optional[LinkObjectFunc] = None, link_css_class: Optional[Union[str, LinkCSSClassFunc]] = None, cell_clickable: bool = False, css_class: Union[str, BuildCSSClassFunc] = '')[source]¶

Bases: Column

Shows the full name of the user when appropriate.

augment_queryset(state: StatefulColumn, queryset: QuerySet) → QuerySet[source]¶

Add additional queries to the queryset.

This will select fields for the user and the user’s profile, to help with query performance.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The column state.

• queryset (django.db.models.query.QuerySet) – The queryset to augment.

Returns:

The resulting queryset.

Return type:

django.db.models.query.QuerySet

get_raw_object_value(state: StatefulColumn, obj: RBUser) → str | None[source]¶

Return the raw value for the full name.

If the profile is private, the full name will not be provided.

New in version 7.1.

Parameters:

• state (djblets.datagrids.grids.StatefulColumn) – The state for the DataGrid instance.

• obj (reviewboard.accounts.models.User) – The user for the row.

Returns:

The full name, or None if the profile is private.

Return type:

str

class BugsColumn(label: Optional[StrOrPromise] = None, id: Optional[str] = None, detailed_label: Optional[StrOrPromise] = None, detailed_label_html: Optional[str] = None, field_name: Optional[str] = None, db_field: Optional[str] = None, image_url: Optional[str] = None, image_class: Optional[str] = None, image_width: Optional[int] = None, image_height: Optional[int] = None, image_alt: Optional[str] = '', shrink: bool = False, expand: bool = False, sortable: bool = False, default_sort_dir: int = 0, link: bool = False, link_func: Optional[LinkObjectFunc] = None, link_css_class: Optional[Union[str, LinkCSSClassFunc]] = None, cell_clickable: bool = False, css_class: Union[str, BuildCSSClassFunc] = '')[source]¶

Bases: Column

Shows the list of bugs specified on a review request.

The list of bugs will be linked to the bug tracker, if a bug tracker was configured for the repository the review request’s change is on.

label: Optional[StrOrPromise] = 'Bugs'[source]¶

The label to show in the column header.

Type:

str

css_class: Union[str, BuildCSSClassFunc] = 'bugs'[source]¶

A function or string for CSS classes applied to the cell.

Type:

str or callable

shrink: bool = True[source]¶

Whether the column will shrink to the minimum size for the data.

Type:

bool

sortable: bool = False[source]¶

Whether the column can be sorted.

Type:

bool

link: bool = False[source]¶

Whether the contents of the cell will be linked to a URL.

The URL used must be defined by either link_func or DataGrid.link_to_object().

Type:

bool

augment_queryset(state: StatefulColumn, queryset: QuerySet) → QuerySet[source]¶

Add additional queries to the queryset.

This will include the repository along with each review request.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The column state.

• queryset (django.db.models.query.QuerySet) – The queryset to augment.

Returns:

The resulting queryset.

Return type:

django.db.models.query.QuerySet

render_data(state: StatefulColumn, obj: ReviewRequest) → SafeString[source]¶

Return the rendered contents of the column.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The state for the DataGrid instance.

• obj (reviewboard.reviews.models.ReviewRequest) – The review request being rendered for this row.

Returns:

The rendered HTML.

Return type:

django.utils.safestring.SafeString

get_raw_object_value(state: StatefulColumn, obj: ReviewRequest) → Sequence[_BugsColumnData][source]¶

Return the raw value for the bugs information.

This will return the list of bug IDs and URLs (if present) from the review request.

New in version 7.1.

Parameters:

• state (djblets.datagrids.grids.StatefulColumn) – The state for the DataGrid instance.

• obj (reviewboard.reviews.models.ReviewRequest) – The review request for the row.

Returns:

The list of bug information.

Return type:

list of _BugsColumnData

class ReviewRequestCheckboxColumn(checkbox_name: str = 'select', shrink: bool = True, show_checkbox_header: bool = True, detailed_label: Optional[StrOrPromise] = 'Select Rows', *args, **kwargs)[source]¶

Bases: CheckboxColumn

A column containing a check-box.

render_data(state: StatefulColumn, obj: ReviewRequest) → SafeString[source]¶

Return the rendered contents of the column.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The state for the DataGrid instance.

• obj (reviewboard.reviews.models.ReviewRequest) – The review request being rendered for this row.

Returns:

The rendered HTML.

Return type:

django.utils.safestring.SafeString

class DateTimeSinceColumn(label: StrOrPromise | None = None, format: str | None = None, sortable: bool = True, timezone: datetime.tzinfo = datetime.timezone.utc, *args, **kwargs)[source]¶

Bases: DateTimeColumn

Displays how long it has been since a given date/time.

These columns will dynamically update as the page is shown, so that the number of minutes, hours, days, etc. ago is correct.

render_data(state: StatefulColumn, obj: Any) → SafeString[source]¶

Return the rendered contents of the column.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The state for the DataGrid instance.

• obj (object) – The object being rendered for this row.

Returns:

The rendered HTML.

Return type:

django.utils.safestring.SafeString

class DiffUpdatedColumn(label: StrOrPromise | None = None, format: str | None = None, sortable: bool = True, timezone: datetime.tzinfo = datetime.timezone.utc, *args, **kwargs)[source]¶

Bases: DateTimeColumn

Shows the date/time that the diff was last updated.

label: Optional[StrOrPromise] = 'Diff Updated'[source]¶

The label to show in the column header.

Type:

str

db_field: str = 'diffset_history__last_diff_updated'[source]¶

The name of the database field containing the field used for sorting.

Once columns are populated for a datagrid, this is guaranteed to be set.

Type:

str

sortable: bool = True[source]¶

Whether the column can be sorted.

Type:

bool

link: bool = False[source]¶

Whether the contents of the cell will be linked to a URL.

The URL used must be defined by either link_func or DataGrid.link_to_object().

Type:

bool

augment_queryset(state: StatefulColumn, queryset: QuerySet) → QuerySet[source]¶

Add additional queries to the queryset.

This will include the diffset history along with each review request.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The column state.

• queryset (django.db.models.query.QuerySet) – The queryset to augment.

Returns:

The resulting queryset.

Return type:

django.db.models.query.QuerySet

get_raw_object_value(state: StatefulColumn, obj: ReviewRequest) → datetime | None[source]¶

Return the diff updated timestamp.

New in version 7.1.

Parameters:

• state (djblets.datagrids.grids.StatefulColumn) – The state for the DataGrid instance.

• obj (reviewboard.reviews.models.ReviewRequest) – The review request to return the value for.

Returns:

The diff updated timestamp, or None if there’s no diff.

Return type:

datetime.datetime

class DiffUpdatedSinceColumn(label: StrOrPromise | None = None, format: str | None = None, sortable: bool = True, timezone: datetime.tzinfo = datetime.timezone.utc, *args, **kwargs)[source]¶

Bases: DateTimeSinceColumn

Shows the elapsed time since the diff was last updated.

label: Optional[StrOrPromise] = 'Diff Updated'[source]¶

The label to show in the column header.

Type:

str

db_field: str = 'diffset_history__last_diff_updated'[source]¶

The name of the database field containing the field used for sorting.

Once columns are populated for a datagrid, this is guaranteed to be set.

Type:

str

sortable: bool = True[source]¶

Whether the column can be sorted.

Type:

bool

link: bool = False[source]¶

Whether the contents of the cell will be linked to a URL.

The URL used must be defined by either link_func or DataGrid.link_to_object().

Type:

bool

augment_queryset(state: StatefulColumn, queryset: QuerySet) → QuerySet[source]¶

Add additional queries to the queryset.

This will include the diffset history along with each review request.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The column state.

• queryset (django.db.models.query.QuerySet) – The queryset to augment.

Returns:

The resulting queryset.

Return type:

django.db.models.query.QuerySet

get_raw_object_value(state: StatefulColumn, obj: ReviewRequest) → datetime | None[source]¶

Return the diff updated timestamp.

New in version 7.1.

Parameters:

• state (djblets.datagrids.grids.StatefulColumn) – The state for the DataGrid instance.

• obj (reviewboard.reviews.models.ReviewRequest) – The review request to return the value for.

Returns:

The diff updated timestamp, or None if there’s no diff.

Return type:

datetime.datetime

class GroupMemberCountColumn(label: Optional[StrOrPromise] = None, id: Optional[str] = None, detailed_label: Optional[StrOrPromise] = None, detailed_label_html: Optional[str] = None, field_name: Optional[str] = None, db_field: Optional[str] = None, image_url: Optional[str] = None, image_class: Optional[str] = None, image_width: Optional[int] = None, image_height: Optional[int] = None, image_alt: Optional[str] = '', shrink: bool = False, expand: bool = False, sortable: bool = False, default_sort_dir: int = 0, link: bool = False, link_func: Optional[LinkObjectFunc] = None, link_css_class: Optional[Union[str, LinkCSSClassFunc]] = None, cell_clickable: bool = False, css_class: Union[str, BuildCSSClassFunc] = '')[source]¶

Bases: Column

Shows the number of users that are part of a review group.

link: bool = True[source]¶

Whether the contents of the cell will be linked to a URL.

The URL used must be defined by either link_func or DataGrid.link_to_object().

Type:

bool

augment_queryset_for_data(state: StatefulColumn, queryset: QuerySet, **kwargs) → QuerySet[source]¶

Augment a queryset for data-rendering purposes.

This will count the number of group members for display.

New in version 5.0.7.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The state for the DataGrid instance.

• queryset (django.db.models.query.QuerySet) – The queryset to augment.

• **kwargs (dict) – Additional keyword arguments for future expansion.

Returns:

The resulting augmented QuerySet.

Return type:

django.db.models.query.QuerySet

render_data(state: StatefulColumn, obj: Group) → SafeString[source]¶

Return the rendered contents of the column.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The state for the DataGrid instance.

• obj (reviewboard.reviews.models.group.Group) – The object being rendered for this row.

Returns:

The rendered HTML.

Return type:

django.utils.safestring.SafeString

get_raw_object_value(state: StatefulColumn, obj: Group) → int[source]¶

Return the raw value for the group membership count.

New in version 7.1.

Parameters:

• state (djblets.datagrids.grids.StatefulColumn) – The state for the DataGrid instance.

• obj (reviewboard.reviews.models.Group) – The review group for the row.

Returns:

The group membership count.

Return type:

int

static link_func(state: StatefulColumn, obj: Group, value: str) → str[source]¶

Return the link to the object in the column.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The column state.

• obj (reviewboard.reviews.models.Group) – The review group for the row.

• value (str) – The rendered data.

Returns:

The URL to link to.

Return type:

str

class GroupsColumn(label: Optional[StrOrPromise] = None, id: Optional[str] = None, detailed_label: Optional[StrOrPromise] = None, detailed_label_html: Optional[str] = None, field_name: Optional[str] = None, db_field: Optional[str] = None, image_url: Optional[str] = None, image_class: Optional[str] = None, image_width: Optional[int] = None, image_height: Optional[int] = None, image_alt: Optional[str] = '', shrink: bool = False, expand: bool = False, sortable: bool = False, default_sort_dir: int = 0, link: bool = False, link_func: Optional[LinkObjectFunc] = None, link_css_class: Optional[Union[str, LinkCSSClassFunc]] = None, cell_clickable: bool = False, css_class: Union[str, BuildCSSClassFunc] = '')[source]¶

Bases: Column

Shows the list of groups requested to review the review request.

label: Optional[StrOrPromise] = 'Groups'[source]¶

The label to show in the column header.

Type:

str

detailed_label: Optional[StrOrPromise] = 'Target Groups'[source]¶

A detailed label to display in the Edit Columns menu.

Defaults to label.

Type:

str

sortable: bool = False[source]¶

Whether the column can be sorted.

Type:

bool

shrink: bool = False[source]¶

Whether the column will shrink to the minimum size for the data.

Type:

bool

augment_queryset(state: StatefulColumn, queryset: QuerySet) → QuerySet[source]¶

Add additional queries to the queryset.

This will pre-fetch the review groups for each review request.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The column state.

• queryset (django.db.models.query.QuerySet) – The queryset to augment.

Returns:

The resulting queryset.

Return type:

django.db.models.query.QuerySet

render_data(state: StatefulColumn, obj: ReviewRequest) → SafeString[source]¶

Return the rendered contents of the column.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The state for the datagrid.

• obj (reviewboard.reviews.models.review_request.ReviewRequest) – The review request.

Returns:

The rendered HTML.

Return type:

django.utils.safestring.SafeString

get_raw_object_value(state: StatefulColumn, obj: ReviewRequest) → Sequence[Group][source]¶

Return the list of review groups.

New in version 7.1.

Parameters:

• state (djblets.datagrids.grids.StatefulColumn) – The state for the DataGrid instance.

• obj (reviewboard.reviews.models.ReviewRequest) – The review request to return the value for.

Returns:

The list of review groups.

Return type:

list of reviewboard.reviews.models.Group

class MyCommentsColumn(label: Optional[StrOrPromise] = None, id: Optional[str] = None, detailed_label: Optional[StrOrPromise] = None, detailed_label_html: Optional[str] = None, field_name: Optional[str] = None, db_field: Optional[str] = None, image_url: Optional[str] = None, image_class: Optional[str] = None, image_width: Optional[int] = None, image_height: Optional[int] = None, image_alt: Optional[str] = '', shrink: bool = False, expand: bool = False, sortable: bool = False, default_sort_dir: int = 0, link: bool = False, link_func: Optional[LinkObjectFunc] = None, link_css_class: Optional[Union[str, LinkCSSClassFunc]] = None, cell_clickable: bool = False, css_class: Union[str, BuildCSSClassFunc] = '')[source]¶

Bases: Column

Shows if the current user has reviewed the review request.

detailed_label: Optional[StrOrPromise] = 'My Comments'[source]¶

A detailed label to display in the Edit Columns menu.

Defaults to label.

Type:

str

image_alt: Optional[str] = 'My Comments'[source]¶

The alt text for an image.

Type:

str

image_class: Optional[str] = 'rb-icon rb-icon-datagrid-comment-draft'[source]¶

The CSS spritesheet icon class to use in the header/navigation menu.

Type:

str

shrink: bool = True[source]¶

Whether the column will shrink to the minimum size for the data.

Type:

bool

augment_queryset(state: StatefulColumn, queryset: QuerySet) → QuerySet[source]¶

Add additional queries to the queryset.

This will add subqueries for determining whether there are posted reviews, draft reviews, or Ship It! reviews.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The state for the DataGrid instance.

• queryset (django.db.models.query.QuerySet) – The queryset to augment.

Returns:

The resulting augmented QuerySet.

Return type:

django.db.models.query.QuerySet

render_data(state: StatefulColumn, obj: ReviewRequest) → SafeString[source]¶

Return the rendered contents of the column.

Parameters:

• state (djblets.datagrids.grids.StatefulColumn) – The state for the DataGrid instance.

• obj (reviewboard.reviews.models.ReviewRequest) – The review request being rendered for this row.

get_raw_object_value(state: StatefulColumn, obj: ReviewRequest) → Mapping[str, Any][source]¶

Return the raw value for review status.

New in version 7.1.

Parameters:

• state (djblets.datagrids.grids.StatefulColumn) – The state for the DataGrid instance.

• obj (reviewboard.reviews.models.ReviewRequest) – The review request for the row.

Returns:

Information on the review status.

Return type:

dict

class NewUpdatesColumn(label: Optional[StrOrPromise] = None, id: Optional[str] = None, detailed_label: Optional[StrOrPromise] = None, detailed_label_html: Optional[str] = None, field_name: Optional[str] = None, db_field: Optional[str] = None, image_url: Optional[str] = None, image_class: Optional[str] = None, image_width: Optional[int] = None, image_height: Optional[int] = None, image_alt: Optional[str] = '', shrink: bool = False, expand: bool = False, sortable: bool = False, default_sort_dir: int = 0, link: bool = False, link_func: Optional[LinkObjectFunc] = None, link_css_class: Optional[Union[str, LinkCSSClassFunc]] = None, cell_clickable: bool = False, css_class: Union[str, BuildCSSClassFunc] = '')[source]¶

Bases: Column

Indicates if there are new updates on a review request.

This will show an icon if the review request has had any new updates or reviews since the user last saw it.

detailed_label: Optional[StrOrPromise] = 'New Updates'[source]¶

A detailed label to display in the Edit Columns menu.

Defaults to label.

Type:

str

image_alt: Optional[str] = 'New Updates'[source]¶

The alt text for an image.

Type:

str

image_class: Optional[str] = 'rb-icon rb-icon-new-updates'[source]¶

The CSS spritesheet icon class to use in the header/navigation menu.

Type:

str

shrink: bool = True[source]¶

Whether the column will shrink to the minimum size for the data.

Type:

bool

render_data(state: StatefulColumn, obj: ReviewRequest) → SafeString[source]¶

Return the rendered contents of the column.

Parameters:

• state (djblets.datagrids.grids.StatefulColumn) – The state for the DataGrid instance.

• obj (reviewboard.reviews.models.ReviewRequest) – The group or review request being rendered for this row.

get_raw_object_value(state: StatefulColumn, obj: ReviewRequest) → int[source]¶

Return the raw value for the new review count.

New in version 7.1.

Parameters:

• state (djblets.datagrids.grids.StatefulColumn) – The state for the DataGrid instance.

• obj (reviewboard.reviews.models.ReviewRequest) – The review request for the row.

Returns:

The new review count for the review request.

Return type:

int

class PendingCountColumn(label: Optional[StrOrPromise] = None, id: Optional[str] = None, detailed_label: Optional[StrOrPromise] = None, detailed_label_html: Optional[str] = None, field_name: Optional[str] = None, db_field: Optional[str] = None, image_url: Optional[str] = None, image_class: Optional[str] = None, image_width: Optional[int] = None, image_height: Optional[int] = None, image_alt: Optional[str] = '', shrink: bool = False, expand: bool = False, sortable: bool = False, default_sort_dir: int = 0, link: bool = False, link_func: Optional[LinkObjectFunc] = None, link_css_class: Optional[Union[str, LinkCSSClassFunc]] = None, cell_clickable: bool = False, css_class: Union[str, BuildCSSClassFunc] = '')[source]¶

Bases: Column

Shows the pending number of review requests for a user or group.

This will show the pending number of review requests for the given review group or user. It only applies to group or user lists.

augment_queryset_for_data(state: StatefulColumn, queryset: QuerySet, **kwargs) → QuerySet[source]¶

Augment a queryset for data-rendering purposes.

This will count the number of accessible open review requests.

New in version 5.0.7.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The state for the DataGrid instance.

• queryset (django.db.models.query.QuerySet) – The queryset to augment.

• **kwargs (dict) – Additional keyword arguments for future expansion.

Returns:

The resulting augmented QuerySet.

Return type:

django.db.models.query.QuerySet

render_data(state: StatefulColumn, obj: Group) → SafeString[source]¶

Return the rendered contents of the column.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The state for the datagrid.

• review_request (reviewboard.reviews.models.review_request.ReviewRequest) – The review request.

Returns:

The rendered HTML.

Return type:

django.utils.safestring.SafeString

get_raw_object_value(state: StatefulColumn, obj: Group) → int[source]¶

Return the raw value for the pending review request count.

New in version 7.1.

Parameters:

• state (djblets.datagrids.grids.StatefulColumn) – The state for the DataGrid instance.

• obj (reviewboard.reviews.models.Group) – The review request for the row.

Returns:

The pending review request count.

Return type:

int

class PeopleColumn(label: Optional[StrOrPromise] = None, id: Optional[str] = None, detailed_label: Optional[StrOrPromise] = None, detailed_label_html: Optional[str] = None, field_name: Optional[str] = None, db_field: Optional[str] = None, image_url: Optional[str] = None, image_class: Optional[str] = None, image_width: Optional[int] = None, image_height: Optional[int] = None, image_alt: Optional[str] = '', shrink: bool = False, expand: bool = False, sortable: bool = False, default_sort_dir: int = 0, link: bool = False, link_func: Optional[LinkObjectFunc] = None, link_css_class: Optional[Union[str, LinkCSSClassFunc]] = None, cell_clickable: bool = False, css_class: Union[str, BuildCSSClassFunc] = '')[source]¶

Bases: Column

Shows the list of people requested to review the review request.

label: Optional[StrOrPromise] = 'People'[source]¶

The label to show in the column header.

Type:

str

detailed_label: Optional[StrOrPromise] = 'Target People'[source]¶

A detailed label to display in the Edit Columns menu.

Defaults to label.

Type:

str

sortable: bool = False[source]¶

Whether the column can be sorted.

Type:

bool

shrink: bool = False[source]¶

Whether the column will shrink to the minimum size for the data.

Type:

bool

augment_queryset(state: StatefulColumn, queryset: QuerySet) → QuerySet[source]¶

Add additional queries to the queryset.

This will pre-fetch the reviewers for each review request.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The column state.

• queryset (django.db.models.query.QuerySet) – The queryset to augment.

Returns:

The resulting queryset.

Return type:

django.db.models.query.QuerySet

render_data(state: StatefulColumn, obj: ReviewRequest) → SafeString[source]¶

Return the rendered contents of the column.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The state for the datagrid.

• obj (reviewboard.reviews.models.review_request.ReviewRequest) – The review request.

Returns:

The rendered HTML.

Return type:

django.utils.safestring.SafeString

get_raw_object_value(state: StatefulColumn, obj: ReviewRequest) → Sequence[User][source]¶

Return the list of reviewers.

New in version 7.1.

Parameters:

• state (djblets.datagrids.grids.StatefulColumn) – The state for the DataGrid instance.

• obj (reviewboard.reviews.models.ReviewRequest) – The review request to return the value for.

Returns:

The list of reviewers.

Return type:

list of django.contrib.auth.models.User

class RepositoryColumn(label: Optional[StrOrPromise] = None, id: Optional[str] = None, detailed_label: Optional[StrOrPromise] = None, detailed_label_html: Optional[str] = None, field_name: Optional[str] = None, db_field: Optional[str] = None, image_url: Optional[str] = None, image_class: Optional[str] = None, image_width: Optional[int] = None, image_height: Optional[int] = None, image_alt: Optional[str] = '', shrink: bool = False, expand: bool = False, sortable: bool = False, default_sort_dir: int = 0, link: bool = False, link_func: Optional[LinkObjectFunc] = None, link_css_class: Optional[Union[str, LinkCSSClassFunc]] = None, cell_clickable: bool = False, css_class: Union[str, BuildCSSClassFunc] = '')[source]¶

Bases: Column

Shows the name of the repository the review request’s change is on.

field_name: str = 'repository'[source]¶

The name of the field on the model containing the data to render.

Once columns are populated for a datagrid, this is guaranteed to be set.

Type:

str

label: Optional[StrOrPromise] = 'Repository'[source]¶

The label to show in the column header.

Type:

str

db_field: str = 'repository__name'[source]¶

The name of the database field containing the field used for sorting.

Once columns are populated for a datagrid, this is guaranteed to be set.

Type:

str

css_class: Union[str, BuildCSSClassFunc] = 'repository-column'[source]¶

A function or string for CSS classes applied to the cell.

Type:

str or callable

shrink: bool = True[source]¶

Whether the column will shrink to the minimum size for the data.

Type:

bool

sortable: bool = True[source]¶

Whether the column can be sorted.

Type:

bool

link: bool = False[source]¶

Whether the contents of the cell will be linked to a URL.

The URL used must be defined by either link_func or DataGrid.link_to_object().

Type:

bool

augment_queryset(state: StatefulColumn, queryset: QuerySet) → QuerySet[source]¶

Add additional queries to the queryset.

This will include the repository for each review request.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The column state.

• queryset (django.db.models.query.QuerySet) – The queryset to augment.

Returns:

The resulting queryset.

Return type:

django.db.models.query.QuerySet

render_data(state: StatefulColumn, obj: ReviewRequest) → SafeString[source]¶

Return the rendered contents of the column.

Parameters:

• state (djblets.datagrid.grids.StatefulColumn) – The state for the datagrid.

• obj (reviewboard.reviews.models.review_request.ReviewRequest) – The review request.

Returns:

The rendered HTML.

Return type:

django.utils.safestring.SafeString