rbtools.api.resource.diff_comment¶

Resource definitions for diff comments.

Classes

class rbtools.api.resource.diff_comment.AllDiffCommentsGetListParams[source]¶

Bases: DiffCommentGetListParams

Params for the all diff comments list resource GET operation.

Added in version 6.0.

__firstlineno__ = 128¶

__static_attributes__ = ()¶

file_diff_id: int¶

The file diff ID that the diff comments must be on.

interdiff_revision: int¶

is_reply: bool¶

Whether to return diff comments that are replies.

last_updated_from: str¶

The earliest date/time the comment could be last updated.

This is compared against the comment’s timestamp field. This must be a valid ISO-8601 date/time format.

last_updated_to: str¶

The latest date/time the review could be last updated.

This is compared against the comment’s timestamp field. This must be a valid ISO-8601 date/time format.

line: int¶

order_by: str¶

review_id: str¶

The ID of the review that diff comments must belong to.

review_request_id: str¶

The ID of the review request that diff comments must belong to.

user: str¶

The username of the user that the reviews must be owned by.

class rbtools.api.resource.diff_comment.DiffCommentGetListParams[source]¶

Bases: BaseGetListParams

Params for the diff comment list GET operation.

Added in version 6.0.

__firstlineno__ = 106¶

__static_attributes__ = ()¶

interdiff_revision: int¶

The second revision in an interdiff revision range.

Returned comments will be limited to this range.

line: int¶

The line number that each comment must start on.

This refers to the row number of the two-column diff, not a line number in a file.

order_by: str¶

A comma-separated list of fields to order by.

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

Bases: BaseCommentItemResource

Item resource for diff comments.

This corresponds to Review Board’s Review Diff Comment Resource and Review Reply Diff Comment Resource.

Added in version 6.0.

__firstlineno__ = 29¶

__static_attributes__ = ()¶

first_line: int¶

The line number that the comment starts at.

This refers to the row number of the two-column diff, not a line number in a file.

get_filediff(**kwargs: Unpack[BaseGetParams]) → FileDiffItemResource[source]¶

Get the filediff for this comment.

Parameters:

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

Returns:

The file diff item resource.

Return type:

rbtools.api.resource.FileDiffItemResource

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_interfilediff(**kwargs: Unpack[BaseGetParams]) → FileDiffItemResource[source]¶

Get the interfilediff for this comment.

This will only be present when the comment is on an interdiff.

Parameters:

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

Returns:

The file diff item resource.

Return type:

rbtools.api.resource.FileDiffItemResource

Raises:

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

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

num_lines: int¶

The number of lines the comment spans.

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

Bases: ListResource[DiffCommentItemResource]

List resource for diff comments.

This corresponds to Review Board’s Review Diff Comment List Resource and Review Reply Diff Comment List Resource.

Added in version 6.0.

__firstlineno__ = 163¶

__static_attributes__ = ()¶