rbtools.api.resource.repository¶

Resource definitions for repositories.

Classes

class rbtools.api.resource.repository.RepositoryGetListParams[source]¶

Bases: BaseGetListParams

Params for the repository list GET operation.

Added in version 6.0.

__firstlineno__ = 253¶

__static_attributes__ = ()¶

hosting_service: str¶

A comma-separated list of hosting service IDs to filter by.

name: str¶

A comma-separated list of repository names to filter by.

name_or_path: str¶

A comma-separated list of names, paths, or mirror paths to filter by.

path: str¶

A comma-separated list of paths or mirror paths to filter by.

q: str¶

A search query to filter by.

This will match the start of repository names.

show_invisible: bool¶

Whether to show all repositories, including ones marked as not visible.

tool: str¶

A comma-separated list of tool names to filter by.

username: str¶

A comma-separated list of usernames to filter by.

These are matched against the repository (or hosting service account) username.

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

Bases: ItemResource

Item resource for repositories.

This corresponds to Review Board’s Repository Resource.

Added in version 6.0.

__firstlineno__ = 47¶

__static_attributes__ = ()¶

bug_tracker: str¶

The URL to the bug tracker for this repository.

This is a format string, where %s is in place of the bug ID.

extra_data: ResourceExtraDataField¶

Extra data as part of the repository.

Some of this will be dependent on the type of repository or hosting service being used, and those entries should not be modified.

get_branches(**kwargs: Unpack[BaseGetParams]) → RepositoryBranchListResource[source]¶

Get the repository branches resource.

Parameters:

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

Returns:

The repository branches.

Return type:

rbtools.api.resource.RepositoryBranchListResource

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_commits(**kwargs: Unpack[RepositoryCommitGetListParams]) → RepositoryCommitListResource[source]¶

Get the repository commits resource.

Parameters:

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

Returns:

The repository commits.

Return type:

rbtools.api.resource.RepositoryCommitListResource

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_file_attachments(**kwargs: Unpack[DiffFileAttachmentGetListParams]) → DiffFileAttachmentListResource[source]¶

Get the diff file attachments list resource for this repository.

Parameters:

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

Returns:

The diff file attachment list.

Return type:

rbtools.api.resource.DiffFileAttachmentListResource

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

Get the repository info resource.

Parameters:

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

Returns:

The repository commits.

Return type:

rbtools.api.resource.RepositoryInfoResource

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_repository_groups(**kwargs: Unpack[ReviewGroupGetListParams]) → RepositoryGroupListResource[source]¶

Get the repository group list resource.

Parameters:

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

Returns:

The repository group list resource.

Return type:

rbtools.api.resource.RepositoryGroupListResource

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_repository_users(**kwargs: Unpack[UserGetListParams]) → RepositoryUserListResource[source]¶

Get the repository users resource.

Parameters:

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

Returns:

The repository commits.

Return type:

rbtools.api.resource.RepositoryUserListResource

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 repository.

mirror_path: str¶

An alternate path to the repository, for lookup purposes.

name: str¶

The name of the repository.

path: str¶

The main path to the repository.

This is used for communicating with the repository and accessing files.

requires_basedir: bool¶

Whether the repository requires a patch base directory.

requires_change_number: bool¶

Whether the repository requires a change number for new review requests.

supports_post_commit: bool¶

Whether the repository supports post-commit review.

This indicates whether this repository can be used to create review requests for committed changes on the “New Review Request” page.

tool: str¶

The name of the internal repository communication class.

visible: bool | None¶

Whether or not this repository is visible.

This will only be present when interacting with the API as an admin user.

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

Bases: ListResource[RepositoryItemResource]

List resource for repositories.

This corresponds to Review Board’s Repository List Resource.

Added in version 6.0.

__firstlineno__ = 290¶

__static_attributes__ = ()¶