This documentation covers Review Board 2.5.
You can select a version above or
view the latest documentation.
reviewboard.datagrids.grids
-
class
ShowClosedReviewRequestsMixin
[source]
Bases: object
A mixin for showing or hiding closed review requests.
Load extra state for the datagrid.
-
class
DataGridJSMixin
[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
= u’RB.DatagridPage’[source]
The JavaScript Model to use for the page state.
-
js_view_class
= u’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 data to pass to the JavaScript Model.
-
class
DataGrid
(request, queryset=None, title=u”, extra_context={}, optimize_sorts=True, model=None)[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
(request, queryset, sortable_column, extra_regex=u’^[0-9].*’, *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.
-
new_updates
= <reviewboard.datagrids.columns.NewUpdatesColumn 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.SubmitterColumn 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
= u’status’[source]
-
site_query_field
= u’local_site’[source]
-
__init__
(*args, **kwargs)[source]
Initialize the datagrid.
Load extra state for the datagrid.
-
post_process_queryset
(queryset)[source]
Add additional data to the queryset.
-
link_to_object
(state, obj, value)[source]
Return a link to the given object.
-
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.
-
timestamp
= <djblets.datagrid.grids.DateTimeColumn object>[source]
-
submitter
= <reviewboard.datagrids.columns.ReviewSubmitterColumn object>[source]
-
review_summary
= <reviewboard.datagrids.columns.ReviewSummaryColumn object>[source]
-
status_query_field
= u’review_request__status’[source]
-
site_query_field
= u’review_request__local_site’[source]
-
__init__
(*args, **kwargs)[source]
Initialize the datagrid.
-
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.
-
new_updates
= <reviewboard.datagrids.columns.NewUpdatesColumn object>[source]
-
selected
= <reviewboard.datagrids.columns.ReviewRequestCheckboxColumn object>[source]
-
js_model_class
= u’RB.Dashboard’[source]
-
js_view_class
= u’RB.DashboardView’[source]
-
periodic_reload
= True[source]
-
__init__
(*args, **kwargs)[source]
Initialize the datagrid.
Load extra state for the datagrid.
-
class
UsersDataGrid
(request, 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.
-
username
= <djblets.datagrid.grids.Column object>[source]
-
fullname
= <djblets.datagrid.grids.Column object>[source]
-
pending_count
= <reviewboard.datagrids.columns.PendingCountColumn object>[source]
-
__init__
(request, queryset=[<User: admin>, <User: doc>, <User: dopey>, <User: grumpy>], title=_(u’All users’), local_site=None)[source]
Initialize the datagrid.
-
link_to_object
(state, obj, value)[source]
Return a link to the given object.
-
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.
-
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=_(u’All groups’), *args, **kwargs)[source]
Initialize the datagrid.
-
static
link_to_object
(state, obj, value)[source]
Return a link to the given object.
-
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.
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.
Initialize the datagrid.
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.
Initialize the datagrid.