reviewboard.datagrids.grids¶

Datagrids for the Dashboard and other pages.

class ShowClosedReviewRequestsMixin[source]¶

Bases: object

A mixin for showing or hiding closed review requests.

load_extra_state(profile, allow_hide_closed=True)[source]¶

Load extra state for the datagrid.

class DataGridJSMixin(*args, **kwargs)[source]¶

Bases: object

Mixin that provides enhanced JavaScript support for datagrids.

This contains additional information on the JavaScript views/models to load for the page, allowing for enhanced functionality in datagrids.

css_bundle_names = [][source]¶

A list of extra CSS static bundles to load on the page.

js_bundle_names = [][source]¶

A list of extra JavaScript static bundles to load on the page.

js_model_class = 'RB.DatagridPage'[source]¶

The JavaScript Model to use for the page state.

js_view_class = 'RB.DatagridPageView'[source]¶

The JavaScript View to use for the page rendering.

periodic_reload = False[source]¶

Whether or not to periodically reload the contents of the datagrid.

extra_js_model_data = None[source]¶

Extra data to pass to the JavaScript Model.

__init__(*args, **kwargs)[source]¶

Initialize the mixin.

This will pull out the Local Site, which is common to all datagrids, and store it for later use and for JavaScript attribute population.

Parameters:

• *args (tuple) – Positional arguments passed to the datagrid.

• **kwargs (dict) – Keyword arguments passed to the datagrid.

get_js_model_attrs()[source]¶

Return attributes for the JavaScript model.

These will be passed to the model specified in js_model_class during construction.

Subclasses can override this to provide additional data.

Returns:

Attributes to provide to the JavaScript model.

Return type:

dict

get_js_model_options()[source]¶

Return options for the JavaScript model.

These will be passed to the model specified in js_model_class during construction.

Subclasses can override this to provide additional data.

Returns:

Options to provide to the JavaScript model.

Return type:

dict

get_js_view_options()[source]¶

Return options for the JavaScript view.

These will be passed to the view specified in js_view_class during construction.

Subclasses can override this to provide additional data.

Returns:

Options to provide to the JavaScript view.

Return type:

dict

class DataGrid(*args, **kwargs)[source]¶

Bases: DataGridJSMixin, DataGrid

Base class for a datagrid in Review Board.

This contains additional information on JavaScript views/models to load for the page.

__annotations__ = {}¶

class AlphanumericDataGrid(*args, **kwargs)[source]¶

Bases: DataGridJSMixin, AlphanumericDataGrid

Base class for an alphanumeric datagrid in Review Board.

This contains additional information on JavaScript views/models to load for the page.

__annotations__ = {}¶

class ReviewRequestDataGrid(*args, **kwargs)[source]¶

Bases: ShowClosedReviewRequestsMixin, DataGrid

A datagrid that displays a list of review requests.

This datagrid accepts the show_closed parameter in the URL, allowing submitted review requests to be filtered out or displayed.

new_updates = <reviewboard.datagrids.columns.NewUpdatesColumn object>[source]¶

my_comments = <reviewboard.datagrids.columns.MyCommentsColumn object>[source]¶

star = <reviewboard.datagrids.columns.ReviewRequestStarColumn object>[source]¶

ship_it = <reviewboard.datagrids.columns.ShipItColumn object>[source]¶

summary = <reviewboard.datagrids.columns.SummaryColumn object>[source]¶

submitter = <reviewboard.datagrids.columns.UsernameColumn object>[source]¶

branch = <djblets.datagrid.grids.Column object>[source]¶

bugs_closed = <reviewboard.datagrids.columns.BugsColumn object>[source]¶

repository = <reviewboard.datagrids.columns.RepositoryColumn object>[source]¶

time_added = <djblets.datagrid.grids.DateTimeColumn object>[source]¶

last_updated = <djblets.datagrid.grids.DateTimeColumn object>[source]¶

diff_updated = <reviewboard.datagrids.columns.DiffUpdatedColumn object>[source]¶

time_added_since = <reviewboard.datagrids.columns.DateTimeSinceColumn object>[source]¶

last_updated_since = <reviewboard.datagrids.columns.DateTimeSinceColumn object>[source]¶

diff_updated_since = <reviewboard.datagrids.columns.DiffUpdatedSinceColumn object>[source]¶

diff_size = <reviewboard.datagrids.columns.DiffSizeColumn object>[source]¶

review_count = <reviewboard.datagrids.columns.ReviewCountColumn object>[source]¶

target_groups = <reviewboard.datagrids.columns.GroupsColumn object>[source]¶

target_people = <reviewboard.datagrids.columns.PeopleColumn object>[source]¶

to_me = <reviewboard.datagrids.columns.ToMeColumn object>[source]¶

review_id = <reviewboard.datagrids.columns.ReviewRequestIDColumn object>[source]¶

status_query_field = 'status'[source]¶

site_query_field = 'local_site'[source]¶

__init__(*args, **kwargs) → None[source]¶

Initialize the datagrid.

Parameters:

• *args (tuple) – Positional arguments to pass to the parent.

• **kwargs (dict) – Keyword arguments to pass to the parent.

load_extra_state(profile, allow_hide_closed=True)[source]¶

Load extra state for the datagrid.

post_process_queryset(queryset: QuerySet[ReviewRequest]) → QuerySet[ReviewRequest][source]¶

Add additional data to the queryset.

Parameters:

queryset (django.db.models.QuerySet) – The queryset to post-process.

Returns:

The resulting queryset.

Return type:

django.db.models.QuerySet

link_to_object(state, obj, value)[source]¶

Return a link to the given object.

__annotations__ = {'_model': 'Optional[Type[Model]]', 'cell_template': 'str', 'column_map': 'Dict[Column, StatefulColumn]', 'columns': 'List[StatefulColumn]', 'custom_header_template': 'str', 'default_columns': 'List[str]', 'default_sort': 'List[str]', 'extra_context': '_RenderContext', 'id': 'str', 'id_list': 'List[Any]', 'listview_template': 'str', 'optimize_sorts': 'bool', 'page': 'Optional[Page]', 'page_num': 'int', 'paginate_by': 'int', 'paginate_orphans': 'int', 'paginator': 'Optional[DataGridPaginator]', 'paginator_template': 'str', 'profile_columns_field': 'Optional[str]', 'profile_sort_field': 'Optional[str]', 'rows': 'List[_DataGridRow]', 'sort_list': 'Optional[List[str]]', 'special_query_args': 'List[str]', 'state_loaded': 'bool', 'title': 'StrOrPromise', 'use_distinct': 'bool'}¶

class ReviewDataGrid(*args, **kwargs)[source]¶

Bases: ShowClosedReviewRequestsMixin, DataGrid

A datagrid that displays a list of reviews.

This datagrid accepts the show_closed parameter in the URL, allowing submitted review requests to be filtered out or displayed.

timestamp = <djblets.datagrid.grids.DateTimeColumn object>[source]¶

submitter = <reviewboard.datagrids.columns.UsernameColumn object>[source]¶

review_summary = <reviewboard.datagrids.columns.ReviewSummaryColumn object>[source]¶

status_query_field = 'review_request__status'[source]¶

site_query_field = 'review_request__local_site'[source]¶

__init__(*args, **kwargs)[source]¶

Initialize the datagrid.

post_process_queryset(queryset: QuerySet[Review]) → QuerySet[Review][source]¶

Add additional data to the queryset.

Parameters:

queryset (django.db.models.QuerySet) – The queryset to post-process.

Returns:

The resulting queryset.

Return type:

django.db.models.QuerySet

__annotations__ = {'_model': 'Optional[Type[Model]]', 'cell_template': 'str', 'column_map': 'Dict[Column, StatefulColumn]', 'columns': 'List[StatefulColumn]', 'custom_header_template': 'str', 'default_columns': 'List[str]', 'default_sort': 'List[str]', 'extra_context': '_RenderContext', 'id': 'str', 'id_list': 'List[Any]', 'listview_template': 'str', 'optimize_sorts': 'bool', 'page': 'Optional[Page]', 'page_num': 'int', 'paginate_by': 'int', 'paginate_orphans': 'int', 'paginator': 'Optional[DataGridPaginator]', 'paginator_template': 'str', 'profile_columns_field': 'Optional[str]', 'profile_sort_field': 'Optional[str]', 'rows': 'List[_DataGridRow]', 'sort_list': 'Optional[List[str]]', 'special_query_args': 'List[str]', 'state_loaded': 'bool', 'title': 'StrOrPromise', 'use_distinct': 'bool'}¶

class DashboardDataGrid(*args, **kwargs)[source]¶

Bases: DataGridSidebarMixin, ReviewRequestDataGrid

Displays the dashboard.

The dashboard is the main place where users see what review requests are out there that may need their attention.

new_updates = <reviewboard.datagrids.columns.NewUpdatesColumn object>[source]¶

my_comments = <reviewboard.datagrids.columns.MyCommentsColumn object>[source]¶

selected = <reviewboard.datagrids.columns.ReviewRequestCheckboxColumn object>[source]¶

sidebar = <reviewboard.datagrids.sidebar.Sidebar object>[source]¶

js_model_class = 'RB.Dashboard'[source]¶

The JavaScript Model to use for the page state.

js_view_class = 'RB.DashboardView'[source]¶

The JavaScript View to use for the page rendering.

periodic_reload = True[source]¶

Whether or not to periodically reload the contents of the datagrid.

__init__(*args, **kwargs)[source]¶

Initialize the datagrid.

load_extra_state(profile: Profile) → List[str][source]¶

Load extra state for the datagrid.

Parameters:

profile (reviewboard.accounts.models.Profile) – The profile containing state for customizing the dashboard.

Returns:

A list of profile fields that have changed.

Return type:

list of str

__annotations__ = {'_model': 'Optional[Type[Model]]', 'cell_template': 'str', 'column_map': 'Dict[Column, StatefulColumn]', 'columns': 'List[StatefulColumn]', 'custom_header_template': 'str', 'default_columns': 'List[str]', 'default_sort': 'List[str]', 'extra_context': '_RenderContext', 'id': 'str', 'id_list': 'List[Any]', 'listview_template': 'str', 'optimize_sorts': 'bool', 'page': 'Optional[Page]', 'page_num': 'int', 'paginate_by': 'int', 'paginate_orphans': 'int', 'paginator': 'Optional[DataGridPaginator]', 'paginator_template': 'str', 'profile_columns_field': 'Optional[str]', 'profile_sort_field': 'Optional[str]', 'rows': 'List[_DataGridRow]', 'sort_list': 'Optional[List[str]]', 'special_query_args': 'List[str]', 'state_loaded': 'bool', 'title': 'StrOrPromise', 'use_distinct': 'bool'}¶

class UsersDataGrid(request: HttpRequest, queryset: QuerySet[User] = <QuerySet [<User: admin>, <User: doc>, <User: dopey>, <User: grumpy>]>, title: StrOrPromise = 'All users', local_site: Optional[LocalSite] = None)[source]¶

Bases: AlphanumericDataGrid

A datagrid showing a list of users registered on Review Board.

username = <reviewboard.datagrids.columns.UsernameColumn object>[source]¶

fullname = <reviewboard.datagrids.columns.FullNameColumn object>[source]¶

pending_count = <reviewboard.datagrids.columns.PendingCountColumn object>[source]¶

__init__(request: HttpRequest, queryset: QuerySet[User] = <QuerySet [<User: admin>, <User: doc>, <User: dopey>, <User: grumpy>]>, title: StrOrPromise = 'All users', local_site: Optional[LocalSite] = None) → None[source]¶

Initialize the datagrid.

Parameters:

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

• queryset (django.db.models.QuerySet, optional) – The base queryset for this datagrid.

• title (str, optional) – The title for this datagrid.

• local_site (reviewboard.site.models.LocalSite, optional) – The Local Site being accessed.

link_to_object(state, obj, value)[source]¶

Return a link to the given object.

load_extra_state(profile)[source]¶

Load extra state for the datagrid.

This handles hiding or showing inactive users.

Parameters:

profile (reviewboard.accounts.models.Profile) – The user profile which contains some basic configurable settings.

Returns:

Always returns False.

Return type:

bool

post_process_queryset_for_data(queryset: QuerySet, **kwargs) → QuerySet[source]¶

Add additional lookups for the datagrid’s queryset

This will add any column-specific queries to the queryset, and then select-related the Local Sites so that operations that require the Local Site relation can be conducted without an additional query.

New in version 5.0.7.

Parameters:

• 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

__annotations__ = {'_model': 'Optional[Type[Model]]', 'cell_template': 'str', 'column_map': 'Dict[Column, StatefulColumn]', 'columns': 'List[StatefulColumn]', 'current_letter': 'str', 'custom_header_template': 'str', 'default_columns': 'List[str]', 'default_sort': 'List[str]', 'extra_context': '_RenderContext', 'id': 'str', 'id_list': 'List[Any]', 'listview_template': 'str', 'optimize_sorts': 'bool', 'page': 'Optional[Page]', 'page_num': 'int', 'paginate_by': 'int', 'paginate_orphans': 'int', 'paginator': 'Optional[DataGridPaginator]', 'paginator_template': 'str', 'profile_columns_field': 'Optional[str]', 'profile_sort_field': 'Optional[str]', 'rows': 'List[_DataGridRow]', 'sort_list': 'Optional[List[str]]', 'special_query_args': 'List[str]', 'state_loaded': 'bool', 'title': 'StrOrPromise', 'use_distinct': 'bool'}¶

class GroupDataGrid(request, title='All groups', *args, **kwargs)[source]¶

Bases: DataGrid

A datagrid showing a list of review groups accessible by the user.

star = <reviewboard.datagrids.columns.ReviewGroupStarColumn object>[source]¶

name = <djblets.datagrid.grids.Column object>[source]¶

displayname = <djblets.datagrid.grids.Column object>[source]¶

pending_count = <reviewboard.datagrids.columns.PendingCountColumn object>[source]¶

member_count = <reviewboard.datagrids.columns.GroupMemberCountColumn object>[source]¶

__init__(request, title='All groups', *args, **kwargs)[source]¶

Initialize the datagrid.

post_process_queryset_for_data(queryset: QuerySet, **kwargs) → QuerySet[source]¶

Add additional lookups for the datagrid’s queryset

This will add any column-specific queries to the queryset, and then select-related the Local Sites so that operations that require the Local Site relation can be conducted without an additional query.

New in version 5.0.7.

Parameters:

• 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

static link_to_object(state, obj, value)[source]¶

Return a link to the given object.

__annotations__ = {'_model': 'Optional[Type[Model]]', 'cell_template': 'str', 'column_map': 'Dict[Column, StatefulColumn]', 'columns': 'List[StatefulColumn]', 'custom_header_template': 'str', 'default_columns': 'List[str]', 'default_sort': 'List[str]', 'extra_context': '_RenderContext', 'id': 'str', 'id_list': 'List[Any]', 'listview_template': 'str', 'optimize_sorts': 'bool', 'page': 'Optional[Page]', 'page_num': 'int', 'paginate_by': 'int', 'paginate_orphans': 'int', 'paginator': 'Optional[DataGridPaginator]', 'paginator_template': 'str', 'profile_columns_field': 'Optional[str]', 'profile_sort_field': 'Optional[str]', 'rows': 'List[_DataGridRow]', 'sort_list': 'Optional[List[str]]', 'special_query_args': 'List[str]', 'state_loaded': 'bool', 'title': 'StrOrPromise', 'use_distinct': 'bool'}¶

class UserPageDataGridMixin[source]¶

Bases: DataGridSidebarMixin

An abstract class for data grids on the user page.

This will display information about the user on the side.

sidebar = <reviewboard.datagrids.sidebar.Sidebar object>[source]¶

__annotations__ = {}¶

class UserPageReviewRequestDataGrid(request, user, *args, **kwargs)[source]¶

Bases: UserPageDataGridMixin, ReviewRequestDataGrid

A data grid for the user page.

This will show the review requests the user has out for review.

tab_title = 'Review Requests'[source]¶

__init__(request, user, *args, **kwargs)[source]¶

Initialize the datagrid.

__annotations__ = {'_model': 'Optional[Type[Model]]', 'cell_template': 'str', 'column_map': 'Dict[Column, StatefulColumn]', 'columns': 'List[StatefulColumn]', 'custom_header_template': 'str', 'default_columns': 'List[str]', 'default_sort': 'List[str]', 'extra_context': '_RenderContext', 'id': 'str', 'id_list': 'List[Any]', 'listview_template': 'str', 'optimize_sorts': 'bool', 'page': 'Optional[Page]', 'page_num': 'int', 'paginate_by': 'int', 'paginate_orphans': 'int', 'paginator': 'Optional[DataGridPaginator]', 'paginator_template': 'str', 'profile_columns_field': 'Optional[str]', 'profile_sort_field': 'Optional[str]', 'rows': 'List[_DataGridRow]', 'sort_list': 'Optional[List[str]]', 'special_query_args': 'List[str]', 'state_loaded': 'bool', 'title': 'StrOrPromise', 'use_distinct': 'bool'}¶

class UserPageReviewsDataGrid(request, user, *args, **kwargs)[source]¶

Bases: UserPageDataGridMixin, ReviewDataGrid

A data grid for the user page.

This will show reviews the user has made on other review requests.

tab_title = 'Reviews'[source]¶

__init__(request, user, *args, **kwargs)[source]¶

Initialize the datagrid.

__annotations__ = {'_model': 'Optional[Type[Model]]', 'cell_template': 'str', 'column_map': 'Dict[Column, StatefulColumn]', 'columns': 'List[StatefulColumn]', 'custom_header_template': 'str', 'default_columns': 'List[str]', 'default_sort': 'List[str]', 'extra_context': '_RenderContext', 'id': 'str', 'id_list': 'List[Any]', 'listview_template': 'str', 'optimize_sorts': 'bool', 'page': 'Optional[Page]', 'page_num': 'int', 'paginate_by': 'int', 'paginate_orphans': 'int', 'paginator': 'Optional[DataGridPaginator]', 'paginator_template': 'str', 'profile_columns_field': 'Optional[str]', 'profile_sort_field': 'Optional[str]', 'rows': 'List[_DataGridRow]', 'sort_list': 'Optional[List[str]]', 'special_query_args': 'List[str]', 'state_loaded': 'bool', 'title': 'StrOrPromise', 'use_distinct': 'bool'}¶