reviewboard.datagrids.grids¶
-
class
ShowClosedReviewRequestsMixin
[source]¶ Bases:
object
A mixin for showing or hiding closed review requests.
-
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.
-
periodic_reload
= False[source]¶ Whether or not to periodically reload the contents of the datagrid.
-
__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:
-
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:
reviewboard.datagrids.grids.DataGridJSMixin
,djblets.datagrid.grids.DataGrid
Base class for a datagrid in Review Board.
This contains additional information on JavaScript views/models to load for the page.
-
class
AlphanumericDataGrid
(*args, **kwargs)[source]¶ Bases:
reviewboard.datagrids.grids.DataGridJSMixin
,djblets.datagrid.grids.AlphanumericDataGrid
Base class for an alphanumeric datagrid in Review Board.
This contains additional information on JavaScript views/models to load for the page.
-
class
ReviewRequestDataGrid
(*args, **kwargs)[source]¶ Bases:
reviewboard.datagrids.grids.ShowClosedReviewRequestsMixin
,reviewboard.datagrids.grids.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.
-
class
ReviewDataGrid
(*args, **kwargs)[source]¶ Bases:
reviewboard.datagrids.grids.ShowClosedReviewRequestsMixin
,reviewboard.datagrids.grids.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.
-
class
DashboardDataGrid
(*args, **kwargs)[source]¶ Bases:
reviewboard.datagrids.sidebar.DataGridSidebarMixin
,reviewboard.datagrids.grids.ReviewRequestDataGrid
Displays the dashboard.
The dashboard is the main place where users see what review requests are out there that may need their attention.
-
class
UsersDataGrid
(request, queryset=<QuerySet [<User: admin>, <User: doc>, <User: dopey>, <User: grumpy>]>, title=u'All users', local_site=None)[source]¶ Bases:
reviewboard.datagrids.grids.AlphanumericDataGrid
A datagrid showing a list of users registered on Review Board.
-
__init__
(request, queryset=<QuerySet [<User: admin>, <User: doc>, <User: dopey>, <User: grumpy>]>, title=u'All users', local_site=None)[source]¶ Initialize the datagrid.
-
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
-
-
class
GroupDataGrid
(request, title=u'All groups', *args, **kwargs)[source]¶ Bases:
reviewboard.datagrids.grids.DataGrid
A datagrid showing a list of review groups accessible by the user.
-
class
UserPageDataGridMixin
[source]¶ Bases:
reviewboard.datagrids.sidebar.DataGridSidebarMixin
An abstract class for data grids on the user page.
This will display information about the user on the side.
-
class
UserPageReviewRequestDataGrid
(request, user, *args, **kwargs)[source]¶ Bases:
reviewboard.datagrids.grids.UserPageDataGridMixin
,reviewboard.datagrids.grids.ReviewRequestDataGrid
A data grid for the user page.
This will show the review requests the user has out for review.
-
class
UserPageReviewsDataGrid
(request, user, *args, **kwargs)[source]¶ Bases:
reviewboard.datagrids.grids.UserPageDataGridMixin
,reviewboard.datagrids.grids.ReviewDataGrid
A data grid for the user page.
This will show reviews the user has made on other review requests.