rbtools.api.transport¶

Base class for API Transport layers.

Classes

class rbtools.api.transport.Transport(url: str, *args, **kwargs)[source]¶

Bases: object

Base class for API Transport layers.

An API Transport layer acts as an intermediary between the API user and the Resource objects. All access to a resource’s data, and all communication with the Review Board server are handled by the Transport. This allows for Transport implementations with unique interfaces which operate on the same underlying resource classes. Specifically, this allows for both a synchronous, and an asynchronous implementation of the transport.

__annotations_cache__ = {}¶

__firstlineno__ = 14¶

__init__(url: str, *args, **kwargs) → None[source]¶

Initialize the transport.

Parameters:

• url (str) – The URL of the Review Board server

• *args (tuple, unused) – Positional arguments, reserved for future expansion.

• **kwargs (tuple, unused) – Keyword arguments, reserved for future expansion.

__static_attributes__ = ('url',)¶

disable_cache() → None[source]¶

Disable caching for all future HTTP requests.

Added in version 5.0.

enable_cache(cache_location: str | None = None, in_memory: bool = False) → None[source]¶

Enable caching for all future HTTP requests.

The cache will be created at the default location if none is provided.

If the in_memory parameter is True, the cache will be created in memory instead of on disk. This overrides the cache_location parameter.

Parameters:

• cache_location (str, optional) – The filename to store the cache in, if using a persistent cache.

• in_memory (bool, optional) – Whether to keep the cache data in memory rather than persisting to a file.

execute_request_method(method: Callable[..., Any], *args, **kwargs) → Any[source]¶

Execute a method and carry out the returned HttpRequest.

Parameters:

• method (callable) – The method to run.

• *args (tuple) – Positional arguments to pass to the method.

• **kwargs (dict) – Keyword arguments to pass to the method.

Returns:

If the method returns an HttpRequest, this will construct a resource from that. If it returns another value, that value will be returned directly.

Return type:

rbtools.api.resource.Resource or object

get_path(path: str, *args, **kwargs) → Resource[source]¶

Return the API resource at the provided path.

Parameters:

• path (str) – The path to the API resource.

• *args (tuple, unused) – Positional arguments (may be used by the transport implementation).

• **kwargs (dict, unused) – Keyword arguments (may be used by the transport implementation).

Returns:

The resource at the given path.

Return type:

rbtools.api.resource.Resource

get_root(*args, **kwargs) → RootResource[source]¶

Return the root API resource.

Parameters:

• *args (tuple, unused) – Positional arguments (may be used by the transport implementation).

• **kwargs (dict, unused) – Keyword arguments (may be used by the transport implementation).

Returns:

The root API resource.

Return type:

rbtools.api.resource.Resource

get_url(url: str, *args, **kwargs) → Resource[source]¶

Return the API resource at the provided URL.

The URL is not guaranteed to be part of the configured Review Board domain.

Parameters:

• url (str) – The URL to the API resource.

• *args (tuple, unused) – Positional arguments (may be used by the transport implementation).

• **kwargs (dict, unused) – Keyword arguments (may be used by the transport implementation).

Returns:

The resource at the given path.

Return type:

rbtools.api.resource.Resource

has_session_cookie() → bool[source]¶

Return whether a local session cookie exists for this server.

This does not guarantee that the session is valid server-side (the cookie may be stale), this just returns whether a local session cookie has been set for this server.

Added in version 6.0.

Returns:

Whether a local session cookie exists for this server.

Return type:

bool

login(username: str | None = None, password: str | None = None, api_token: str | None = None, *args, **kwargs) → None[source]¶

Log in to the Review Board server.

Changed in version 5.0: Added an optional api_token parameter and made the username and password parameters optional to allow logging in with either a username and password or API token.

Parameters:

• username (str, optional) – The username to log in with.

• password (str, optional) – The password to log in with.

• api_token (str, optional) – The API token to log in with.

• *args (tuple, unused) – Positional arguments (may be used by the transport implementation).

• **kwargs (dict, unused) – Keyword arguments (may be used by the transport implementation).

logout() → None[source]¶

Log out of a session on the Review Board server.