reviewboard.reviews.features¶

Feature definitions for reviews.

class DiffACLsFeature(register: bool = True)[source]¶

Bases: Feature

A feature for FileDiff ACL checks.

When enabled, FileDiffACLHook will be invoked for each diffset, determining whether the user is allowed to view the diff.

New in version 4.0.5: This is experimental in 4.0.x, with plans to make it stable for 5.0.

feature_id: Optional[str] = 'reviews.diff_acls'[source]¶

The unique ID/slug of the feature.

name: Optional[StrOrPromise] = 'Diff ACLs'[source]¶

The name of the feature.

level: FeatureLevel = 100[source]¶

Stability level of the feature.

summary: Optional[StrOrPromise] = 'Allow extensions to determine per-user access to diffs with FileDiffACLHook.'[source]¶

A summary of the feature.

__annotations__ = {'feature_id': 'Optional[str]', 'level': 'FeatureLevel', 'name': 'Optional[StrOrPromise]', 'summary': 'Optional[StrOrPromise]'}¶

class GeneralCommentsFeature(register: bool = True)[source]¶

Bases: Feature

A feature for general comments.

General comments allow comments to be created directly on a review request without accompanying file attachment or diff. These can be used to raise issues with the review request itself, such as its summary or description, or general implementation issues.

feature_id: Optional[str] = 'reviews.general_comments'[source]¶

The unique ID/slug of the feature.

name: Optional[StrOrPromise] = 'General Comments'[source]¶

The name of the feature.

level: FeatureLevel = 100[source]¶

Stability level of the feature.

summary: Optional[StrOrPromise] = 'Allow comments on review requests without an associated file attachment or diff.'[source]¶

A summary of the feature.

__annotations__ = {'feature_id': 'Optional[str]', 'level': 'FeatureLevel', 'name': 'Optional[StrOrPromise]', 'summary': 'Optional[StrOrPromise]'}¶

class IssueVerificationFeature(register: bool = True)[source]¶

Bases: Feature

A feature for issue verification.

Issue verification allows reviewers to mark that an issue requires verification before closing. In this case, the author of the change will be able to mark the issue as “Fixed”, but then the original author of the comment will need to verify it before the issue is closed.

feature_id: Optional[str] = 'reviews.issue_verification'[source]¶

The unique ID/slug of the feature.

name: Optional[StrOrPromise] = 'Issue Verification'[source]¶

The name of the feature.

level: FeatureLevel = 100[source]¶

Stability level of the feature.

summary: Optional[StrOrPromise] = 'Allow comment authors to require that issues be verified by them before being closed'[source]¶

A summary of the feature.

__annotations__ = {'feature_id': 'Optional[str]', 'level': 'FeatureLevel', 'name': 'Optional[StrOrPromise]', 'summary': 'Optional[StrOrPromise]'}¶

class StatusUpdatesFeature(register: bool = True)[source]¶

Bases: Feature

A feature for status updates.

A status update is a way for third-party tools to provide feedback on a review request. In the past, this was done just as a normal review. Status updates allow those tools (via some integration like Review Bot) to mark their state (such as pending, success, failure, or error) and then associate that with a review.

feature_id: Optional[str] = 'reviews.status_updates'[source]¶

The unique ID/slug of the feature.

name: Optional[StrOrPromise] = 'Status Updates'[source]¶

The name of the feature.

level: FeatureLevel = 100[source]¶

Stability level of the feature.

summary: Optional[StrOrPromise] = 'A way for external tools to do checks on a review request and report the results of those checks.'[source]¶

A summary of the feature.

__annotations__ = {'feature_id': 'Optional[str]', 'level': 'FeatureLevel', 'name': 'Optional[StrOrPromise]', 'summary': 'Optional[StrOrPromise]'}¶

class UnifiedBannerFeature(register: bool = True)[source]¶

Bases: Feature

A feature for a unified banner.

The unified banner provides a common set of buttons for working with all drafts, a high-level overview of your review process, settings for customizing the display of what you’re looking at, and a starting place for beginning a review.

feature_id: Optional[str] = 'reviews.unified_banner'[source]¶

The unique ID/slug of the feature.

name: Optional[StrOrPromise] = 'Unified Banner'[source]¶

The name of the feature.

level: FeatureLevel = 100[source]¶

Stability level of the feature.

summary: Optional[StrOrPromise] = 'A unified banner that offers the functionality for drafts and reviews in a centralized place.'[source]¶

A summary of the feature.

__annotations__ = {'feature_id': 'Optional[str]', 'level': 'FeatureLevel', 'name': 'Optional[StrOrPromise]', 'summary': 'Optional[StrOrPromise]'}¶