rbtools.api.resource.base_review¶

Base class for review resources.

Classes

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

Bases: ItemResource

Base class for review item resources.

Added in version 6.0.

__firstlineno__ = 30¶

__static_attributes__ = ()¶

body_bottom: str¶

The review content shown below the comments.

body_bottom_text_type: TextType¶

The text type used for the body_bottom field.

body_top: str¶

The review content shown above the comments.

body_top_text_type: TextType¶

The text type used for the body_top field.

force_text_type: TextType¶

The text type, if any, to force for returned text fields.

The contents will be converted to the requested type in the payload, but will not be saved as that type.

get_diff_comments(**kwargs: Unpack[DiffCommentGetListParams]) → DiffCommentListResource[source]¶

Get the diff comments list.

Parameters:

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

Returns:

The diff comment list resource.

Return type:

rbtools.api.resource.DiffCommentListResource

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_attachment_comments(**kwargs: Unpack[BaseGetListParams]) → FileAttachmentCommentListResource[source]¶

Get the file attachment comments list.

Parameters:

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

Returns:

The file attachment comment list resource.

Return type:

rbtools.api.resource.FileAttachmentCommentListResource

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_general_comments(**kwargs: Unpack[BaseGetListParams]) → GeneralCommentListResource[source]¶

Get the general comments list.

Parameters:

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

Returns:

The general comment list resource.

Return type:

rbtools.api.resource.GeneralCommentListResource

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_screenshot_comments(**kwargs: Unpack[BaseGetListParams]) → ScreenshotCommentListResource[source]¶

Get the screenshot comments list.

Parameters:

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

Returns:

The screenshot comment list resource.

Return type:

rbtools.api.resource.ScreenshotCommentListResource

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_user(**kwargs: Unpack[UserGetParams]) → UserItemResource[source]¶

Get the user who owns the review.

Parameters:

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

Returns:

The user item resource.

Return type:

rbtools.api.resource.UserItemResource

Raises:

• rbtools.api.errors.APIError – The Review Board API returned an error.

• rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.

public: bool¶

Whether or not the review is public.

Saving with this set to True will publish the review.

publish_and_archive: bool¶

Whether to archive the review request after the review is published.

publish_to_owner_only: bool¶

Whether to send e-mail only to the owner of the review request.

ship_it: bool¶

Whether or not to mark the review as “Ship It!”

text_type: TextType¶

The mode for text fields.

This is deprecated in favor of the body_bottom_text_type and body_top_text_type fields.