reviewboard.reviews.builtin_fields¶
- class BuiltinFieldMixin(*args, **kwargs)[source]¶
Mixin for built-in fields.
This overrides some functions to work with native fields on a ReviewRequest or ReviewRequestDraft, rather than working with those stored in extra_data.
- class BuiltinTextAreaFieldMixin(*args, **kwargs)[source]¶
Mixin for built-in text area fields.
This will ensure that the text is always rendered in Markdown, no matter whether the source text is plain or Markdown. It will still escape the text if it’s not in Markdown format before rendering.
- class ReviewRequestPageDataMixin(review_request_details, data=None, *args, **kwargs)[source]¶
Mixin for internal fields needing access to the page data.
These are used by fields that operate on state generated when creating the review request page. The view handling that page makes a lot of queries, and stores the results. This mixin allows access to those results, preventing additional queries.
The data structure is not meant to be public API, and this mixin should not be used by any classes outside this file.
By default, this will not render or handle any value loading or change entry recording. Subclasses must implement those manually.
- load_value(review_request_details)[source]¶
Load a value from the review request or draft.
- Parameters
review_request_details (reviewboard.reviews.models.base_review_request_details.BaseReviewRequestDetails) – The review request or draft.
- Returns
The loaded value.
- Return type
- record_change_entry(changedesc, old_value, new_value)[source]¶
Record information on the changed values in a ChangeDescription.
- Parameters
changedesc (reviewboard.changedescs.models.ChangeDescription) – The change description to record the entry in.
old_value (object) – The old value of the field.
new_value (object) – The new value of the field.
- class BaseCaptionsField(review_request_details, data=None, *args, **kwargs)[source]¶
Base class for rendering captions for attachments.
This serves as a base for FileAttachmentCaptionsField and ScreenshotCaptionsField. It provides the base rendering and for caption changes on file attachments or screenshots.
- render_change_entry_html(info)[source]¶
Render a change entry to HTML.
This function is expected to return safe, valid HTML. Any values coming from a field or any other form of user input must be properly escaped.
- Parameters
info (dict) – A dictionary describing how the field has changed. This is guaranteed to have
new
andold
keys, but may also containadded
andremoved
keys as well.- Returns
The HTML representation of the change entry.
- Return type
unicode
- serialize_change_entry(changedesc)[source]¶
Serialize a change entry for public consumption.
This will output a version of the change entry for use in the API. It can be the same content stored in the
ChangeDescription
, but does not need to be.- Parameters
changedesc (reviewboard.changedescs.models.ChangeDescription) – The change description whose field is to be serialized.
- Returns
An appropriate serialization for the field.
- Return type
- class BaseModelListEditableField(review_request_details, request=None)[source]¶
Base class for editable comma-separated list of model instances.
This is used for built-in classes that work with ManyToManyFields.
- record_change_entry(changedesc, old_value, new_value)[source]¶
Record information on the changed values in a ChangeDescription.
- Parameters
changedesc (reviewboard.changedescs.models.ChangeDescription) – The change description to record the entry in.
old_value (object) – The old value of the field.
new_value (object) – The new value of the field.
- class DescriptionField(*args, **kwargs)[source]¶
The Description field on a review request.
- class TestingDoneField(*args, **kwargs)[source]¶
The Testing Done field on a review request.
- class OwnerField(*args, **kwargs)[source]¶
The Owner field on a review request.
- model[source]¶
alias of
django.contrib.auth.models.User
- js_view_class = 'RB.ReviewRequestFields.OwnerFieldView'[source]¶
The class name for the JavaScript view representing this field.
- render_value(user)[source]¶
Render the value in the field.
- Parameters
user (django.contrib.auth.models.User) – The value to render.
- Returns
The rendered value.
- Return type
unicode
- record_change_entry(changedesc, old_value, new_value)[source]¶
Record information on the changed values in a ChangeDescription.
- Parameters
changedesc (reviewboard.changedescs.models.ChangeDescription) – The change description to record the entry in.
old_value (object) – The old value of the field.
new_value (object) – The new value of the field.
- render_change_entry_value_html(info, item)[source]¶
Render the value for a change description string to HTML.
- serialize_change_entry(changedesc)[source]¶
Serialize a change entry for public consumption.
This will output a version of the change entry for use in the API. It can be the same content stored in the
ChangeDescription
, but does not need to be.- Parameters
changedesc (reviewboard.changedescs.models.ChangeDescription) – The change description whose field is to be serialized.
- Returns
An appropriate serialization for the field.
- Return type
- class RepositoryField(*args, **kwargs)[source]¶
The Repository field on a review request.
- class BugsField(*args, **kwargs)[source]¶
The Bugs field on a review request.
- js_view_class = 'RB.ReviewRequestFields.BugsFieldView'[source]¶
The class name for the JavaScript view representing this field.
- load_value(review_request_details)[source]¶
Load a value from the review request or draft.
- Parameters
review_request_details (reviewboard.reviews.models.base_review_request_details.BaseReviewRequestDetails) – The review request or draft.
- Returns
The loaded value.
- Return type
- save_value(value)[source]¶
Save the value in the review request or draft.
- Parameters
value (object) – The new value for the field.
- class DependsOnField(*args, **kwargs)[source]¶
The Depends On field on a review request.
- js_view_class = 'RB.ReviewRequestFields.DependsOnFieldView'[source]¶
The class name for the JavaScript view representing this field.
- class BlocksField(*args, **kwargs)[source]¶
The Blocks field on a review request.
- class ChangeField(*args, **kwargs)[source]¶
The Change field on a review request.
This is shown for repositories supporting changesets. The change number is similar to a commit ID, with the exception that it’s only ever stored on the ReviewRequest and never changes.
If both
changenum
andcommit_id
are provided on the review request, only this field will be shown, as both are likely to have values.
- class CommitField(*args, **kwargs)[source]¶
The Commit field on a review request.
This displays the ID of the commit the review request is representing.
Since the
commit_id
andchangenum
fields are both populated, we let ChangeField take precedence. It knows how to render information based on a changeset ID.
- class DiffField(review_request_details, data=None, *args, **kwargs)[source]¶
Represents a newly uploaded diff on a review request.
This is not shown as an actual displayable field on the review request itself. Instead, it is used only during the ChangeDescription population and processing steps.
- render_change_entry_html(info)[source]¶
Render a change entry to HTML.
This function is expected to return safe, valid HTML. Any values coming from a field or any other form of user input must be properly escaped.
- Parameters
info (dict) – A dictionary describing how the field has changed. This is guaranteed to have
new
andold
keys, but may also containadded
andremoved
keys as well.- Returns
The HTML representation of the change entry.
- Return type
unicode
- load_value(review_request_details)[source]¶
Load a value from the review request or draft.
- Parameters
review_request_details (reviewboard.reviews.models.base_review_request_details.BaseReviewRequestDetails) – The review request or draft.
- Returns
The loaded value.
- Return type
- record_change_entry(changedesc, unused, diffset)[source]¶
Record information on the changed values in a ChangeDescription.
- Parameters
changedesc (reviewboard.changedescs.models.ChangeDescription) – The change description to record the entry in.
old_value (object) – The old value of the field.
new_value (object) – The new value of the field.
- serialize_change_entry(changedesc)[source]¶
Serialize a change entry for public consumption.
This will output a version of the change entry for use in the API. It can be the same content stored in the
ChangeDescription
, but does not need to be.- Parameters
changedesc (reviewboard.changedescs.models.ChangeDescription) – The change description whose field is to be serialized.
- Returns
An appropriate serialization for the field.
- Return type
- class FileAttachmentCaptionsField(review_request_details, data=None, *args, **kwargs)[source]¶
Renders caption changes for file attachments.
This is not shown as an actual displayable field on the review request itself. Instead, it is used only during the ChangeDescription rendering stage. It is not, however, used for populating entries in ChangeDescription.
- class FileAttachmentsField(review_request_details, data=None, *args, **kwargs)[source]¶
Renders removed or added file attachments.
This is not shown as an actual displayable field on the review request itself. Instead, it is used only during the ChangeDescription rendering stage. It is not, however, used for populating entries in ChangeDescription.
- get_change_entry_sections_html(info)[source]¶
Return sections of change entries with titles and rendered HTML.
- Parameters
info (dict) – A dictionary describing how the field has changed. This is guaranteed to have
new
andold
keys, but may also containadded
andremoved
keys as well.- Returns
A list of the change entry sections.
- Return type
list of dict
- render_change_entry_html(values)[source]¶
Render a change entry to HTML.
This function is expected to return safe, valid HTML. Any values coming from a field or any other form of user input must be properly escaped.
- Parameters
info (list) – A list of the changed file attachments. Each item is a 3-tuple containing the
caption
,filename
, and thepk
of the file attachment in the database.- Returns
The HTML representation of the change entry.
- Return type
- get_attachment_js_model_attrs(attachment, draft=False)[source]¶
Return attributes for the RB.FileAttachment JavaScript model.
This will determine the right attributes to pass to an instance of
RB.FileAttachment()
, based on the provided file attachment.- Parameters
attachment (reviewboard.attachments.models.FileAttachment) – The file attachment to return attributes for.
draft (bool, optional) – Whether to return attributes for a draft version of the file attachment.
- Returns
The resulting model attributes.
- Return type
- class ScreenshotCaptionsField(review_request_details, data=None, *args, **kwargs)[source]¶
Renders caption changes for screenshots.
This is not shown as an actual displayable field on the review request itself. Instead, it is used only during the ChangeDescription rendering stage. It is not, however, used for populating entries in ChangeDescription.
- class ScreenshotsField(review_request_details, request=None)[source]¶
Renders removed or added screenshots.
This is not shown as an actual displayable field on the review request itself. Instead, it is used only during the ChangeDescription rendering stage. It is not, however, used for populating entries in ChangeDescription.
- class TargetGroupsField(*args, **kwargs)[source]¶
The Target Groups field on a review request.
- class TargetPeopleField(*args, **kwargs)[source]¶
The Target People field on a review request.
- model[source]¶
alias of
django.contrib.auth.models.User
- class CommitListField(review_request_details, data=None, *args, **kwargs)[source]¶
The list of commits for a review request.
- review_request_created_with_history[source]¶
Whether the associated review request was created with history.
- property should_render[source]¶
Whether or not the field should be rendered.
This field will only be rendered when the review request was created with history support. It is also hidden on the diff viewer page, because it substantially overlaps with the commit selector.
- property can_record_change_entry[source]¶
Whether or not the field can record a change entry.
The field can only record a change entry when the review request has been created with history.
- load_value(review_request_details)[source]¶
Load a value from the review request or draft.
- Parameters
review_request_details (review_request_details.base_review_request_details.BaseReviewRequestDetails) – The review request or draft.
- Returns
The DiffSet associated with the review request or draft.
- Return type
- save_value(value)[source]¶
Save a value to the review request.
This is intentionally a no-op.
- Parameters
value (reviewboard.diffviewer.models.diffset.DiffSet, unused) – The current DiffSet
- render_value(value)[source]¶
Render the field for the given value.
- Parameters
value (int) – The diffset primary key.
- Returns
The rendered value.
- Return type
- has_value_changed(old_value, new_value)[source]¶
Return whether or not the value has changed.
- Parameters
old_value (reviewboard.diffviewer.models.diffset.DiffSet) – The primary key of the
DiffSet
from the review_request.new_value (reviewboard.diffviewer.models.diffset.DiffSet) – The primary key of the
DiffSet
from the draft.
- Returns
Whether or not the value has changed.
- Return type
- record_change_entry(changedesc, old_value, new_value)[source]¶
Record the old and new values for this field into the changedesc.
- Parameters
changedesc (reviewboard.changedescs.models.ChangeDescription) – The change description to record the change into.
old_value (reviewboard.diffviewer.models.diffset.DiffSet) – The previous
DiffSet
from the review request.new_value (reviewboard.diffviewer.models.diffset.DiffSet) – The new
DiffSet
from the draft.
- render_change_entry_html(info)[source]¶
Render the change entry HTML for this field.
- Parameters
info (dict) – The change entry info for this field. See
record_change_entry()
for the format.- Returns
The rendered HTML.
- Return type
- serialize_change_entry(changedesc)[source]¶
Serialize the changed field entry for the web API.
- Parameters
changdesc (reviewboard.changedescs.models.ChangeDescription) – The change description being serialized.
- Returns
A JSON-serializable dictionary representing the change entry for this field.
- Return type