rbtools.api.resource.diff_file_attachment¶

Resource definitions for diff file attachments.

Classes

class rbtools.api.resource.diff_file_attachment.DiffFileAttachmentGetListParams[source]¶

Bases: BaseGetListParams

Params for the diff file attachment list GET operation.

Added in version 6.0.

__firstlineno__ = 119¶

__static_attributes__ = ()¶

mimetype: str¶

Return only file attachments with the given mimetype.

repository_file_path: str¶

Filter file attachments with the given path in the repository.

repository_revision: str¶

Filter file attachments with the given revision in the repository.

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

Bases: ItemResource

Item resource for diff file attachments.

This corresponds to Review Board’s Diff File Attachment Resource.

Added in version 6.0.

__firstlineno__ = 35¶

__static_attributes__ = ()¶

absolute_url: str¶

The absolute URL of the file, for downloading purposes.

caption: str¶

The file’s descriptive caption.

extra_data: ResourceExtraDataField¶

Extra data as part of the file attachment.

filename: str¶

The name of the file.

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

Get the file diff that this attachment was added in.

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.

icon_url: str¶

The URL to a 24x24 icon representing the file.

The use of these icons is deprecated and this property may be removed in a future version of Review Board.

id: int¶

The numeric ID of the file.

mimetype: str¶

The mimetype for the file.

repository_file_path: str¶

The file path inside the repository for this file attachment.

repository_revision: str¶

The revision that introduced this version of the file.

review_url: str¶

The URL to a review UI for this file.

revision: int¶

The revision of the file attachment.

thumbnail: str¶

A thumbnail representing this file.

url: str¶

The URL of the file, for downloading purposes.

This is deprecated in favor of the absolute_url attribute.

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

Bases: ListResource[DiffFileAttachmentItemResource]

List resource for diff file attachments.

This corresponds to Review Board’s Diff File Attachment List Resource.

Added in version 5.0.

__firstlineno__ = 136¶

__static_attributes__ = ()¶

upload_attachment(*, filename: str, content: bytes, filediff_id: str, source_file: bool = False, **kwargs: QueryArgs) → HttpRequest[source]¶

Upload a new attachment.

Parameters:

• filename (str) – The name of the file.

• content (bytes) – The content of the file to upload.

• filediff_id (str) – The ID of the filediff to attach the file to.

• source_file (bool, optional) – Whether to upload the source version of a file.

• **kwargs (dict of rbtools.api.request.QueryArgs) – Query arguments to include with the request.

Returns:

The newly created diff file attachment.

Return type:

DiffFileAttachmentItemResource

Raises:

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

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