reviewboard.reviews.signals¶

Signals related to review requests, reviews, and replies.

review_request_publishing = <django.dispatch.dispatcher.Signal object>[source]¶

Emitted when a review request is publishing.

Parameters:

• user (django.contrib.auth.models.User) – The user publishing the review request.

• review_request_draft (reviewboard.reviews.models.ReviewRequestDraft) – The review request draft being published.

review_request_published = <django.dispatch.dispatcher.Signal object>[source]¶

changedesc (reviewboard.changedescs.models.ChangeDescription): The change description associated with the publish, if any.

review_request_closing = <django.dispatch.dispatcher.Signal object>[source]¶

Emitted when a review request is about to be closed.

Parameters:

• user (django.contrib.auth.models.User) – The user closing the review request.

• review_request (reviewboard.reviews.models.ReviewRequest) – The review request being closed.

• close_type (unicode) – Describes how the review request is being closed. It is one of SUBMITTED or DISCARDED.

• description (unicode) – The provided closing description.

• rich_text (bool) – Whether or not the description is rich text (Markdown).

review_request_closed = <django.dispatch.dispatcher.Signal object>[source]¶

Emitted when a review request has been closed.

Parameters:

• user (django.contrib.auth.models.User) – The user who closed the review request.

• review_request (reviewboard.reviews.models.ReviewRequest) – The review request that was closed.

• close_type (unicode) – Describes how the review request was closed. It is one of SUBMITTED or DISCARDED.

• description (unicode) – The provided closing description.

• rich_text (bool) – Whether or not the description is rich text (Markdown).

review_request_reopening = <django.dispatch.dispatcher.Signal object>[source]¶

Emitted when a review request is about to be reopened.

Parameters:

• user (django.contrib.auth.models.User) – The user re-opening the review request.

• review_request (reviewboard.reviews.models.ReviewRequest) – The review request being reopened.

review_request_reopened = <django.dispatch.dispatcher.Signal object>[source]¶

Emitted when a review request has been reopened.

Parameters:

• user (django.contrib.auth.models.User) – The user who re-opened the review request.

• review_request (reviewboard.reviews.models.ReviewRequest) – The review request that was reopened.

• old_status (unicode) – The old status for the review request. This will be PENDING_REVIEW, SUBMITTED, or DISCARDED.

• old_public (bool) – The old public state for the review request.

review_publishing = <django.dispatch.dispatcher.Signal object>[source]¶

Emitted when a review is being published.

Parameters:

• user (django.contrib.auth.models.User) – The user publishing the review.

• review (reviewboard.reviews.models.Review) – The review that’s being published.

• to_owner_only (bool) – Whether the review e-mail should be sent only to the review request submitter.

review_ship_it_revoking = <django.dispatch.dispatcher.Signal object>[source]¶

Emitted when a Ship It is about to be revoked from a review.

Listeners can raise a RevokeShipItError to stop the Ship It from being revoking.

Parameters:

• user (django.contrib.auth.models.User) – The user who requested to revoke the Ship It.

• review (reviewboard.reviews.models.review.Review) – The review that will have its Ship It revoked.

review_ship_it_revoked = <django.dispatch.dispatcher.Signal object>[source]¶

Emitted when a Ship It has been revoked from a review.

Parameters:

• user (django.contrib.auth.models.User) – The user who revoked the Ship It.

• review (reviewboard.reviews.models.review.Review) – The review that had its Ship It revoked.

review_published = <django.dispatch.dispatcher.Signal object>[source]¶

Emitted when a review has been published.

Parameters:

• user (django.contrib.auth.models.User) – The user who published the review.

• review (reviewboard.reviews.models.Review) – The review that was published.

• to_owner_only (bool) – Whether the review e-mail should be sent only to the review request submitter.

• trivial (bool) – Whether to skip e-mail notifications entirely.

• request (django.http.HttpRequest) – The request object if the review was published from an HTTP request.

reply_publishing = <django.dispatch.dispatcher.Signal object>[source]¶

Emitted when a reply to a review is being published.

Parameters:

• user (django.contrib.auth.models.User) – The user publishing the reply.

• review (reviewboard.reviews.models.Review) – The reply that’s being published.

reply_published = <django.dispatch.dispatcher.Signal object>[source]¶

Emitted when a reply to a review has ben published.

Parameters:

• user (django.contrib.auth.models.User) – The user who published the reply.

• review (reviewboard.reviews.models.Review) – The reply that was published.

• trivial (bool) – Whether the reply was considered trivial.

status_update_request_run = <django.dispatch.dispatcher.Signal object>[source]¶

Emitted when a StatusUpdate should run or re-run.

Changed in version 5.0.3: Added the config argument.

Parameters:

• status_update (reviewboard.reviews.models.StatusUpdate) – The StatusUpdate associated with the tool that should be run.

• config (reviewboard.integrations.models.IntegrationConfig) –

  The associated integration configuration being run.

  If provided and set, this should be used instead of scanning for a matching configuration.

  New in version 5.0.3.