rbtools.api.resource.review_request¶

Resource definitions for review requests.

Added in version 6.0: This was moved from rbtools.api.resource.

Classes

`ReviewRequestGetListParams`	Params for the review request list GET operation.
`ReviewRequestItemResource`(transport, ...[, ...])	Item resource for review requests.
`ReviewRequestListResource`(transport, ...[, ...])	List resource for review requests.

class rbtools.api.resource.review_request.ReviewRequestGetListParams[source]¶

Bases: BaseGetListParams

Params for the review request list GET operation.

Added in version 6.0.

__firstlineno__ = 578¶

__static_attributes__ = ()¶

branch: ForwardRef('str', module='rbtools.api.resource.review_request')¶: The branch field on a review request to filter by.

changenum: ForwardRef('int', module='rbtools.api.resource.review_request')¶

The change number the review requests must have set.

This will only return one review request per repository, and only works for repository types that support server-side changesets. This is deprecated in favor of the commit_id parameter.

commit_id: ForwardRef('str', module='rbtools.api.resource.review_request')¶

The commit that review requests must have set.

This will only return one review request per repository.

from_user: ForwardRef('str', module='rbtools.api.resource.review_request')¶: The username that the review requests must be owned by.

issue_dropped_count: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with exactly the provided number of dropped issues.

issue_dropped_count_gt: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with more than the provided number of dropped issues.

issue_dropped_count_gte: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with at least the provided number of dropped issues.

issue_dropped_count_lt: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with less than the provided number of dropped issues.

issue_dropped_count_lte: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with at most than the provided number of dropped issues.

issue_open_count: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with exactly the provided number of open issues.

issue_open_count_gt: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with more than the provided number of open issues.

issue_open_count_gte: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with at least the provided number of open issues.

issue_open_count_lt: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with less than the provided number of open issues.

issue_open_count_lte: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with at most than the provided number of open issues.

issue_resolved_count: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with exactly the provided number of resolved issues.

issue_resolved_count_gt: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with more than the provided number of resolved issues.

issue_resolved_count_gte: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with at least the provided number of resolved issues.

issue_resolved_count_lt: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with less than the provided number of resolved issues.

issue_resolved_count_lte: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with at most than the provided number of resolved issues.

last_updated_from: ForwardRef('str', module='rbtools.api.resource.review_request')¶

The earliest date-time the review requests are last updated.

This is compared against the review request’s last_updated field. It should be sent in ISO-8601 format.

last_updated_to: ForwardRef('str', module='rbtools.api.resource.review_request')¶

The latest date-time the review requests are last updated.

This is compared against the review request’s last_updated field. It should be sent in ISO-8601 format.

repository: ForwardRef('int', module='rbtools.api.resource.review_request')¶: The ID of the repository that review requests must be on.

ship_it: ForwardRef('bool', module='rbtools.api.resource.review_request')¶

Return review requests with at least one Ship It!.

This is deprecated in favor of the more specific ship-it count parameters.

ship_it_count: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with exactly the provided number of ship-its.

ship_it_count_gt: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with more than the provided number of ship-its.

ship_it_count_gte: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with at least the provided number of ship-its.

ship_it_count_lt: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with less than the provided number of ship-its.

ship_it_count_lte: ForwardRef('int', module='rbtools.api.resource.review_request')¶: Return results with at most the provided number of ship-its.

show_all_unpublished: ForwardRef('bool', module='rbtools.api.resource.review_request')¶

Return all unpublished review requests.

If the requesting user is an admin or hase the reviews.can_submit_as_another_user permission, unpublished review requests will also be returned.

status: ForwardRef("Literal['all', 'discarded', 'pending', 'submitted']", module='rbtools.api.resource.review_request')¶: The status of review requests to filter.

time_added_from: ForwardRef('str', module='rbtools.api.resource.review_request')¶

The earliest date-time the review requests are added.

This is compared against the review request’s time_added field. It should be sent in ISO-8601 format.

time_added_to: ForwardRef('str', module='rbtools.api.resource.review_request')¶

The latest date-time the review requests are added.

This is compared against the review request’s time_added field. It should be sent in ISO-8601 format.

to_groups: ForwardRef('str', module='rbtools.api.resource.review_request')¶: A comma-separated list of review group names to filter by.

to_user_groups: ForwardRef('str', module='rbtools.api.resource.review_request')¶: A comma-separated list of usernames who are in assigned groups.

to_users: ForwardRef('str', module='rbtools.api.resource.review_request')¶

A comma-separated list of usernames who are assigned.

These users must be in the user list either directly or as a group member.

to_users_directly: ForwardRef('str', module='rbtools.api.resource.review_request')¶: A comma-separated list of usernames who are directly assigned.

class rbtools.api.resource.review_request.ReviewRequestItemResource(transport: Transport, payload: JSONDict, url: str, token: str | None = None, **kwargs)[source]¶

Bases: BaseReviewRequestItemResource

Item resource for review requests.

This corresponds to Review Board’s Review Request Resource.

Changed in version 6.0: Renamed from ReviewRequestResource.

__firstlineno__ = 59¶

__static_attributes__ = ()¶

property absolute_url: str[source]¶

The absolute URL for the Review Request.

The value of absolute_url is returned if it’s defined. Otherwise the absolute URL is generated and returned.

Type:: str

approval_failure: str | None¶: The reason why the review request was not approved.

approved: bool¶

Whether the review request has been approved by reviewers.

On a default install, a review request is approved if it has at least one Ship It! and no open issues. Extensions may change these requirements.

blocks: ResourceListField[ReviewRequestItemResource]¶: The list of review requests that this review request is blocking.

build_dependency_graph() → defaultdict[Self, set[Self]][source]¶

Build the dependency graph for the review request.

Only review requests in the same repository as this one will be in the graph.

A ValueError is raised if the graph would contain cycles.

changenum: int | None¶

The change number that the review request represents.

These are server-side repository-specific change numbers, and are not supported by all types of repositories. This is deprecated in favor of the commit_id field.

close_description: str¶: The text describing the closing of the review request.

close_description_text_type: TextType¶: The current or forced text type for the close_description field.

created_with_history: bool¶

Whether or not the review request was created with history support.

A value of True indicates that the review request will have commits attached.

get_changes(**kwargs: Unpack[BaseGetListParams]) → ChangeListResource[source]¶

Get the change descriptions for the review request.

Parameters:

**kwargs (dict) – Query arguments to include with the request.

Returns:

The change description list resource.

Return type:

rbtools.api.resource.ChangeListResource

Raises:

rbtools.api.errors.APIError – The Review Board API returned an error.
rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.

get_diff_context(**kwargs: Unpack[DiffContextGetParams]) → DiffContextResource[source]¶

Get the diff context resource.

Parameters:

**kwargs (dict) – Query arguments to include with the request.

Returns:

The diff context resource.

Return type:

rbtools.api.resource.DiffContextResource

Raises:

rbtools.api.errors.APIError – The Review Board API returned an error.
rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.

get_diffs(**kwargs: Unpack[BaseGetListParams]) → DiffListResource[source]¶

Get the diff list for the review request.

Parameters:

**kwargs (dict) – Query arguments to include with the request.

Returns:

The diff list resource.

Return type:

rbtools.api.resource.DiffListResource

Raises:

rbtools.api.errors.APIError – The Review Board API returned an error.
rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.

get_draft(internal: Literal[False] = False, **kwargs: Unpack[BaseGetParams]) → ReviewRequestDraftResource[source]¶

get_draft(internal: Literal[True], **kwargs: Unpack[BaseGetParams]) → HttpRequest

Get the review request draft.

Parameters:

**kwargs (dict) – Query arguments to include with the request.

Returns:

The draft resource.

Return type:

rbtools.api.resource.ReviewRequestDraftResource

Raises:

rbtools.api.errors.APIError – The Review Board API returned an error.
rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.

get_file_attachments(**kwargs: Unpack[BaseGetListParams]) → FileAttachmentListResource[source]¶

Get the file attachment list for the review request.

Parameters:

**kwargs (dict) – Query arguments to include with the request.

Returns:

The file attachment list resource.

Return type:

rbtools.api.resource.FileAttachmentListResource

Raises:

rbtools.api.errors.APIError – The Review Board API returned an error.
rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.

get_last_update(**kwargs: Unpack[BaseGetParams]) → LastUpdateResource[source]¶

Get the last update resource for a review request.

Parameters:

**kwargs (dict) – Query arguments to include with the request.

Returns:

The last update resource.

Return type:

rbtools.api.resource.LastUpdateResource

Raises:

rbtools.api.errors.APIError – The Review Board API returned an error.
rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.

get_latest_diff(**kwargs: Unpack[BaseGetParams]) → DiffItemResource[source]¶

Get the most recent diff list for the review request.

Parameters:

**kwargs (dict) – Query arguments to include with the request.

Returns:

The diff item resource.

Return type:

rbtools.api.resource.DiffItemResource

Raises:

rbtools.api.errors.APIError – The Review Board API returned an error.
rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.

get_or_create_draft(**kwargs: Unpack[BaseGetParams]) → HttpRequest[source]¶

Retrieve or create a draft.

Parameters:: **kwargs (dict of rbtools.api.request.QueryArgs) – Query arguments to include with the request.
Returns:: The review request draft.
Return type:: rbtools.api.resource.ReviewRequestDraftResource

get_repository(**kwargs: Unpack[BaseGetParams]) → RepositoryItemResource[source]¶

Get the repository for this review request.

Parameters:

**kwargs (dict) – Query arguments to include with the request.

Returns:

The repository item resource.

Return type:

rbtools.api.resource.RepositoryItemResource

Raises:

rbtools.api.errors.APIError – The Review Board API returned an error.
rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.

get_reviews(**kwargs: Unpack[BaseGetListParams]) → ReviewListResource[source]¶

Get the reviews for this review request.

Parameters:

**kwargs (dict) – Query arguments to include with the request.

Returns:

The review list resource.

Return type:

rbtools.api.resource.ReviewListResource

Raises:

rbtools.api.errors.APIError – The Review Board API returned an error.
rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.

get_screenshots(**kwargs: Unpack[BaseGetListParams]) → ScreenshotListResource[source]¶

Get the screenshot list for the review request.

Parameters:

**kwargs (dict) – Query arguments to include with the request.

Returns:

The screenshot list resource.

Return type:

rbtools.api.resource.ScreenshotListResource

Raises:

rbtools.api.errors.APIError – The Review Board API returned an error.
rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.

get_status_updates(**kwargs: Unpack[StatusUpdateGetListParams]) → StatusUpdateListResource[source]¶

Get the status updates for the review request.

Parameters:

**kwargs (dict) – Query arguments to include with the request.

Returns:

The status update list resource.

Return type:

rbtools.api.resource.StatusUpdateListResource

Raises:

rbtools.api.errors.APIError – The Review Board API returned an error.
rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.

id: int¶: The numeric ID of the review request.

issue_dropped_count: int¶: The number of dropped issues on this review request.

issue_open_count: int¶: The number of open issues on this review request.

issue_resolved_count: int¶: The number of resolved issues on this review request.

issue_verifying_count: int¶: The number of issues waiting for verification to resolve or drop.

latest_diff: ResourceLinkField[DiffItemResource] | None¶: The most recent diff.

public: bool¶: Whether or not the review request is currently visible to other users.

ship_it_count: int¶: The number of Ship It-s given to this review request.

status: Literal['discarded', 'pending', 'submitted']¶: The current status of the review request.

submit(description: str | None = None, changenum: str | None = None) → HttpRequest[source]¶

Submit a review request.

Parameters:

description (str, optional) – The close description text to include.
changenum (str, optional) – The change number (commit ID) for the review request now that the code has been submitted.

Returns:

The updated review request.

Return type:

ReviewRequestResource

time_added: str¶: The date and time that the review request was added.

property url: str[source]¶

The relative URL to the Review Request.

The value of ‘url’ is returned if it’s defined. Otherwise, a relative URL is generated and returned.

This provides compatibility with versions of Review Board older than 1.7.8, which do not have a ‘url’ field.

Type:: str

class rbtools.api.resource.review_request.ReviewRequestListResource(transport: Transport, payload: JSONDict, url: str, token: str | None = None, item_mime_type: str | None = None, **kwargs)[source]¶

Bases: ListResource[ReviewRequestItemResource]

List resource for review requests.

This corresponds to Review Board’s Review Request List Resource.

Added in version 6.0.

__firstlineno__ = 722¶

__static_attributes__ = ()¶