rbtools.hooks.common¶

Common functionality for working with repository hooks.

Functions

`close_review_request`(server_url, username, ...)	Closes the specified review request as submitted.
`execute`(command, *[, text, strip])	Execute the specified command and return the stdout output.
`get_api`(server_url, **kwargs)	Returns an RBClient instance and the associated root resource.
`get_review_request`(review_request_id, api_root)	Returns the review request resource for the given ID.
`get_review_request_approval`(server_url, ...)	Returns the approval information for the given review request.
`get_review_request_id`(regex, commit_message)	Returns the review request ID referenced in the commit message.
`initialize_logging`([debug])	Sets up a log handler to format log messages.

Exceptions

rbtools.hooks.common.get_api(server_url, **kwargs)[source]¶

Returns an RBClient instance and the associated root resource.

Hooks should use this method to gain access to the API, instead of instantiating their own client.

Parameters:

server_url (unicode) – The server URL to retrieve.
**kwargs (dict) – Additional keyword arguments to pass to the RBClient constructor. See SyncTransport.__init__() for arguments that are accepted.

Returns:

This returns a 2-tuple of the RBClient and <root resource> rbtools.api.resource.Resource.

Return type:

tuple

rbtools.hooks.common.execute(command: Union[List[str], str], *, text: bool = False, strip: bool = True) → Optional[Union[bytes, str]][source]¶

Execute the specified command and return the stdout output.

Changed in version 5.0: Added the text and strip arguments.

Deprecated since version 5.0: Deprecated in favor of run_process().

Parameters:

command (str or list of str) – The command to execute.
text (bool, optional) –
If True, this will return the output as a string, otherwise it will return bytes. This defaults to False.

New in version 5.0.
strip (bool, optional) –
Whether to strip leading and trailing whitespace from the output of the command. This defaults to True.

New in version 5.0.

Returns:

The stdout output of the command or None if the command failed to execute.

Return type:

bytes or str

rbtools.hooks.common.initialize_logging(debug: bool = False) → None[source]¶

Sets up a log handler to format log messages.

Warning, error, and critical messages will show the level name as a prefix, followed by the message. Debug logs can optionally be enabled as well.

Changed in version 4.1: Added the debug argument.

Parameters:

debug (bool, optional) –

Whether to enable debug logging.

New in version 4.1.

rbtools.hooks.common.get_review_request_id(regex, commit_message)[source]¶

Returns the review request ID referenced in the commit message.

We assume there is at most one review request associated with each commit. If a matching review request cannot be found, we return 0.

rbtools.hooks.common.get_review_request(review_request_id, api_root)[source]¶: Returns the review request resource for the given ID.

rbtools.hooks.common.close_review_request(server_url, username, password, review_request_id, description)[source]¶: Closes the specified review request as submitted.

rbtools.hooks.common.get_review_request_approval(server_url, username, password, review_request_id)[source]¶: Returns the approval information for the given review request.