rbtools.api.capabilities¶

Review Board server capability management.

Classes

class rbtools.api.capabilities.Capabilities(capabilities: JSONDict)[source]¶

Bases: object

Provides information on Review Board server capabilities.

__firstlineno__ = 13¶

__init__(capabilities: JSONDict) → None[source]¶

Initialize the capabilities information.

Parameters:

capabilities (dict) – The capabilities dictionary from the server.

__static_attributes__ = ('capabilities',)¶

capabilities: JSONDict¶

The dictionary of capabilities from the Review Board API.

Type:

dict

get_capability(*cap_path) → Any[source]¶

Return the capability at the given path.

Added in version 5.0.

Parameters:

*cap_path (tuple of str) – The keys forming a path to the capability.

Returns:

The given capability setting. If not present, this will return None.

Return type:

Any

has_capability(*cap_path) → bool[source]¶

Return whether the server provides a given capability.

Parameters:

*cap_path (tuple of str) – The keys forming a path to the capability.

Returns:

True if the capability is explicitly set to True. False if the capability is set to False or is not present in the API capabilities.

Return type:

bool