reviewboard.reviews.context¶
Methods to help with building the review request rendering context.
- class SerializedReviewRequestTab¶
Bases:
TypedDict
Serialized information about a tab on the review request page.
New in version 7.0.
- __annotations__ = {'active': ForwardRef('NotRequired[bool]', module='reviewboard.reviews.context'), 'text': ForwardRef('str', module='reviewboard.reviews.context'), 'url': ForwardRef('str', module='reviewboard.reviews.context')}¶
- __optional_keys__ = frozenset({})¶
- __orig_bases__ = (<function TypedDict>,)¶
- __required_keys__ = frozenset({'active', 'text', 'url'})¶
- __total__ = True¶
- class ReviewRequestContext¶
Bases:
TypedDict
Template context for rendering the review request.
New in version 7.0.
- review_request: ReviewRequest¶
The review request object.
- review_request_visit: NotRequired[ReviewRequestVisit]¶
The most recent review request visit info, if available.
- tabs: list[SerializedReviewRequestTab]¶
The tabs to show for the review request.
- __annotations__ = {'mutable_by_user': ForwardRef('bool', module='reviewboard.reviews.context'), 'review_request': ForwardRef('ReviewRequest', module='reviewboard.reviews.context'), 'review_request_visit': ForwardRef('NotRequired[ReviewRequestVisit]', module='reviewboard.reviews.context'), 'scmtool': ForwardRef('Optional[Tool]', module='reviewboard.reviews.context'), 'send_email': ForwardRef('bool', module='reviewboard.reviews.context'), 'social_page_description': ForwardRef('str', module='reviewboard.reviews.context'), 'social_page_image_url': ForwardRef('Optional[str]', module='reviewboard.reviews.context'), 'social_page_title': ForwardRef('str', module='reviewboard.reviews.context'), 'social_page_url': ForwardRef('str', module='reviewboard.reviews.context'), 'status_mutable_by_user': ForwardRef('bool', module='reviewboard.reviews.context'), 'tabs': ForwardRef('list[SerializedReviewRequestTab]', module='reviewboard.reviews.context')}¶
- __optional_keys__ = frozenset({})¶
- __orig_bases__ = (<function TypedDict>,)¶
- __required_keys__ = frozenset({'mutable_by_user', 'review_request', 'review_request_visit', 'scmtool', 'send_email', 'social_page_description', 'social_page_image_url', 'social_page_title', 'social_page_url', 'status_mutable_by_user', 'tabs'})¶
- __total__ = True¶
- make_review_request_context(*, request: HttpRequest, review_request: ReviewRequest, extra_context: Optional[dict[str, Any]] = None, is_diff_view: bool = False, social_page_image_url: Optional[str] = None, social_page_title: str = '') ReviewRequestContext ¶
Return a dictionary for template contexts used for review requests.
The dictionary will contain the common data that is used for all review request-related pages (the review request detail page, the diff viewer, and the screenshot pages).
For convenience, extra data can be passed to this dictionary.
Changed in version 7.0: Added
social_page_image_url
andsocial_page_title
arguments.- Parameters:
request (
django.http.HttpRequest
) – The HTTP request.review_request (
reviewboard.reviews.models.ReviewRequest
) – The review request.extra_context (
dict
, optional) – Extra information to include in the context.is_diff_view (
bool
, optional) – Whether the user is viewing a diff.social_page_image_url (
str
, optional) –The image URL to include for social media thumbnails.
New in version 7.0.
social_page_title (
str
, optional) –The page title to include for social media thumbnails.
New in version 7.0.
- Returns:
The context for rendering review request templates.
- Return type: