reviewboard.reviews.views.diffviewer¶

Diff viewer view.

class ReviewsDiffViewerContext[source]¶

Bases: DiffViewerContext, ReviewRequestContext

Render context for the diff viewer view.

New in version 7.0.

diffsets: list[DiffSet]¶

All of the DiffSets connected to the review request.

review: Optional[Review]¶

The current review, if present.

review_request_status_html: str¶

The rendered HTML for the review request status.

draft: Optional[ReviewRequestDraft]¶

The draft of the review request, if present.

last_activity_time: datetime¶

The timestamp of the last activity.

file_attachments: list[FileAttachment]¶

The current set of file attachments for the review request.

all_file_attachments: list[FileAttachment]¶

All of the file attachments for the review request.

This includes all current attachments, as well as old versions and files that have been removed.

screenshots: list[Screenshot]¶

The screenshots attached to the review request.

This is a legacy item which has been replaced by the file attachments.

comments: CommentsDict¶

All of the diff comments for the review request.

__closed__ = False¶

__extra_items__ = None¶

__mutable_keys__ = frozenset({'all_file_attachments', 'close_description', 'close_description_rich_text', 'close_timestamp', 'collapseall', 'comments', 'diff_context', 'diffset', 'diffsets', 'draft', 'file_attachments', 'files', 'force_view_user_draft', 'interdiffset', 'last_activity_time', 'mutable_by_user', 'review', 'review_request', 'review_request_details', 'review_request_status_html', 'review_request_visit', 'scmtool', 'screenshots', 'send_email', 'social_page_description', 'social_page_image_url', 'social_page_title', 'social_page_url', 'status_mutable_by_user', 'tabs', 'user_draft_exists', 'viewing_user_draft'})¶

__optional_keys__ = frozenset({})¶

__readonly_keys__ = frozenset({})¶

__required_keys__ = frozenset({'all_file_attachments', 'close_description', 'close_description_rich_text', 'close_timestamp', 'collapseall', 'comments', 'diff_context', 'diffset', 'diffsets', 'draft', 'file_attachments', 'files', 'force_view_user_draft', 'interdiffset', 'last_activity_time', 'mutable_by_user', 'review', 'review_request', 'review_request_details', 'review_request_status_html', 'review_request_visit', 'scmtool', 'screenshots', 'send_email', 'social_page_description', 'social_page_image_url', 'social_page_title', 'social_page_url', 'status_mutable_by_user', 'tabs', 'user_draft_exists', 'viewing_user_draft'})¶

__total__ = True¶

collapseall: bool¶

diff_context: SerializedDiffContext¶

diffset: DiffSet¶

interdiffset: Optional[DiffSet]¶

files: list[SerializedDiffFile]¶

close_description: str¶

close_description_rich_text: bool¶

close_timestamp: Optional[datetime]¶

force_view_user_draft: bool¶

mutable_by_user: bool¶

review_request: ReviewRequest¶

review_request_details: Union[ReviewRequest, ReviewRequestDraft]¶

review_request_visit: NotRequired[ReviewRequestVisit]¶

status_mutable_by_user: bool¶

scmtool: Optional[Tool]¶

send_email: bool¶

social_page_description: str¶

social_page_image_url: Optional[str]¶

social_page_title: str¶

social_page_url: str¶

tabs: list[SerializedReviewRequestTab]¶

user_draft_exists: bool¶

viewing_user_draft: bool¶

class SerializedDiffsetWithComments[source]¶

Bases: TypedDict

Serialized information about a diff with comments.

New in version 7.0.

is_current: bool¶

Whether this diff is currently being viewed.

revision: int¶

The revision of the DiffSet.

__closed__ = False¶

__extra_items__ = None¶

__mutable_keys__ = frozenset({'is_current', 'revision'})¶

__optional_keys__ = frozenset({})¶

__readonly_keys__ = frozenset({})¶

__required_keys__ = frozenset({'is_current', 'revision'})¶

__total__ = True¶

class SerializedInterdiffsetWithComments[source]¶

Bases: TypedDict

Serialized information about an interdiff with comments.

New in version 7.0.

is_current: bool¶

Whether this interdiff is currently being viewed.

new_revision: int¶

The new diff revision in the interdiff pair.

old_revision: int¶

The old diff revision in the interdiff pair.

__closed__ = False¶

__extra_items__ = None¶

__mutable_keys__ = frozenset({'is_current', 'new_revision', 'old_revision'})¶

__optional_keys__ = frozenset({})¶

__readonly_keys__ = frozenset({})¶

__required_keys__ = frozenset({'is_current', 'new_revision', 'old_revision'})¶

__total__ = True¶

class SerializedCommitWithComments[source]¶

Bases: TypedDict

Serialized information about a commit with comments.

New in version 7.0.

base_commit_id: Optional[str]¶

The commit ID of the base commit in the commit range.

base_commit_pk: Optional[int]¶

The PK of the base DiffCommit in the commit range.

is_current: bool¶

Whether this commit range is currently being viewed.

revision: int¶

The revision of the diff that contains this commit range.

tip_commit_id: Optional[str]¶

The commit ID of the tip commit in the commit range.

tip_commit_pk: Optional[int]¶

The PK of the tip DiffCommit in the commit range.

__closed__ = False¶

__extra_items__ = None¶

__mutable_keys__ = frozenset({'base_commit_id', 'base_commit_pk', 'is_current', 'revision', 'tip_commit_id', 'tip_commit_pk'})¶

__optional_keys__ = frozenset({})¶

__readonly_keys__ = frozenset({})¶

__required_keys__ = frozenset({'base_commit_id', 'base_commit_pk', 'is_current', 'revision', 'tip_commit_id', 'tip_commit_pk'})¶

__total__ = True¶

class SerializedCommentsHint[source]¶

Bases: TypedDict

Serialized information about comments in other revisions.

New in version 7.0.

commits_with_comments: list[SerializedCommitWithComments]¶

The set of commit ranges that have draft comments.

diffsets_with_comments: list[SerializedDiffsetWithComments]¶

The set of diffs that have draft comments.

has_other_comments: bool¶

Whether there are draft comments in other revisions.

interdiffs_with_comments: list[SerializedInterdiffsetWithComments]¶

The set of interdiffs that have draft comments.

__closed__ = False¶

__extra_items__ = None¶

__mutable_keys__ = frozenset({'commits_with_comments', 'diffsets_with_comments', 'has_other_comments', 'interdiffs_with_comments'})¶

__optional_keys__ = frozenset({})¶

__readonly_keys__ = frozenset({})¶

__required_keys__ = frozenset({'commits_with_comments', 'diffsets_with_comments', 'has_other_comments', 'interdiffs_with_comments'})¶

__total__ = True¶

class SerializedReviewsDiffContext[source]¶

Bases: SerializedDiffContext

Serialized diff context information.

New in version 7.0.

comments_hint: SerializedCommentsHint¶

The hint to show for draft reviews with comments in other revisions.

files: list[SerializedReviewsDiffFile]¶

The list of files in the current diff view.

num_diffs: int¶

The number of diff revisions.

__closed__ = False¶

__extra_items__ = None¶

__mutable_keys__ = frozenset({'comments_hint', 'commit_history_diff', 'commits', 'filename_patterns', 'files', 'num_diffs', 'pagination', 'revision'})¶

__optional_keys__ = frozenset({})¶

__readonly_keys__ = frozenset({})¶

__required_keys__ = frozenset({'comments_hint', 'commit_history_diff', 'commits', 'filename_patterns', 'files', 'num_diffs', 'pagination', 'revision'})¶

__total__ = True¶

commits: Optional[list[SerializedDiffCommit]]¶

commit_history_diff: Optional[list[SerializedCommitHistoryDiffEntry]]¶

filename_patterns: list[str]¶

pagination: SerializedPaginationInfo¶

revision: SerializedRevisionInfo¶

class SerializedDiffFileFileDiff[source]¶

Bases: TypedDict

Serialized information about a FileDiff inside the diff files.

New in version 7.0.

id: int¶

The ID of the FileDiff.

revision: int¶

The revision of the FileDiff.

__closed__ = False¶

__extra_items__ = None¶

__mutable_keys__ = frozenset({'id', 'revision'})¶

__optional_keys__ = frozenset({})¶

__readonly_keys__ = frozenset({})¶

__required_keys__ = frozenset({'id', 'revision'})¶

__total__ = True¶

class SerializedReviewsDiffFile[source]¶

Bases: TypedDict

Serialized information about a file in the diff.

New in version 7.0.

base_filediff_id: Optional[int]¶

The ID of the base FileDiff when viewing a commit range.

binary: bool¶

Whether the file is binary.

deleted: bool¶

Whether the file was deleted in the change.

extra: DiffFileExtraContext¶

Extra information about the diff file.

New in version 7.0.4.

id: int¶

The ID of the FileDiff.

index: int¶

The index of the file in the list of all files.

interdiff_revision: NotRequired[int]¶

The revision of the interdiff FileDiff, when present.

interfilediff: NotRequired[SerializedDiffFileFileDiff]¶

Information about the interdiff FileDiff, when present.

filediff: SerializedDiffFileFileDiff¶

Information about the FileDiff.

force_interdiff: NotRequired[bool]¶

Whether to force rendering an interdiff.

This is used to ensure that reverted files render correctly.

modified_filename: str¶

The filename of the modified version of the file.

modified_revision: str¶

The revision of the modified version of the file.

newfile: bool¶

Whether the file is newly-added in the diff.

orig_filename: str¶

The filename of the original version of the file.

orig_revision: str¶

The revision of the original version of the file.

public: bool¶

Whether the file is part of a published diff.

serialized_comment_blocks: SerializedCommentBlocks[SerializedDiffComment]¶

The serialized comments already attached to the file’s diff.

__closed__ = False¶

__extra_items__ = None¶

__mutable_keys__ = frozenset({'base_filediff_id', 'binary', 'deleted', 'extra', 'filediff', 'force_interdiff', 'id', 'index', 'interdiff_revision', 'interfilediff', 'modified_filename', 'modified_revision', 'newfile', 'orig_filename', 'orig_revision', 'public', 'serialized_comment_blocks'})¶

__optional_keys__ = frozenset({})¶

__readonly_keys__ = frozenset({})¶

__required_keys__ = frozenset({'base_filediff_id', 'binary', 'deleted', 'extra', 'filediff', 'force_interdiff', 'id', 'index', 'interdiff_revision', 'interfilediff', 'modified_filename', 'modified_revision', 'newfile', 'orig_filename', 'orig_revision', 'public', 'serialized_comment_blocks'})¶

__total__ = True¶

class ReviewsDiffViewerView(**kwargs)[source]¶

Bases: ReviewRequestViewMixin, UserProfileRequiredViewMixin, DiffViewerView

Renders the diff viewer for a review request.

This wraps the base DiffViewerView to display a diff for the given review request and the given diff revision or range.

The view expects the following parameters to be provided:

review_request_id:

The ID of the ReviewRequest containing the diff to render.

The following may also be provided:

revision:

The DiffSet revision to render.

interdiff_revision:

The second DiffSet revision in an interdiff revision range.

local_site:

The LocalSite the ReviewRequest must be on, if any.

See DiffViewerView’s documentation for the accepted query parameters.

__init__(**kwargs) → None[source]¶

Initialize a view for the request.

Parameters:

**kwargs (dict) – Keyword arguments passed to as_view().

get(request: HttpRequest, revision: Optional[int] = None, interdiff_revision: Optional[int] = None, *args, **kwargs) → HttpResponse[source]¶

Handle HTTP GET requests for this view.

This will look up the review request and DiffSets, given the provided information, and pass them to the parent class for rendering.

Parameters:

• request (django.http.HttpRequest) – The HTTP request from the client.

• revision (int, optional) – The revision of the diff to view. This defaults to the latest diff.

• interdiff_revision (int, optional) – The revision to use for an interdiff, if viewing an interdiff.

• *args (tuple) – Positional arguments passed to the handler.

• **kwargs (dict) – Keyword arguments passed to the handler.

Returns:

The HTTP response to send to the client.

Return type:

django.http.HttpResponse

get_context_data(diffset: DiffSet, interdiffset: Optional[DiffSet], **kwargs) → ReviewsDiffViewerContext[source]¶

Return additional context data for the template.

This provides some additional data used for rendering the diff viewer. This data is more specific to the reviewing functionality, as opposed to the data calculated by DiffViewerView.get_context_data which is more focused on the actual diff.

Parameters:

• diffset (reviewboard.diffviewer.models.DiffSet) – The diffset being viewed.

• interdiffset (reviewboard.diffviewer.models.DiffSet) – The interdiff diffset, if present.

• **kwargs (dict) – Keyword arguments passed to the handler.

Returns:

Context data used to render the template.

Return type:

dict