Jump to >

reviewboard.diffviewer.models

Model re-exports for reviewboard.diffviewer.*.

class DiffCommit(*args, **kwargs)[source]

A representation of a commit from a version control system.

A DiffSet on a Review Request that represents a commit history will have one or more DiffCommits. Each DiffCommit will have one or more associated FileDiffs (which also belong to the parent DiffSet).

The information stored herein is intended to fully represent the state of a single commit in that history. The series of DiffCommits can be used to re-create the original series of commits posted for review.

NAME_MAX_LENGTH = 256[source]

The maximum length of the author_name and committer_name fields.

EMAIL_MAX_LENGTH = 256[source]

The maximum length of the author_email and committer_email fields.

ISO_DATE_FORMAT = '%Y-%m-%d %H:%M:%S%z'[source]

The date format that this model uses.

last_modified[source]

A timestamp used for generating HTTP caching headers.

property author[source]

The author’s name and e-mail address.

This is formatted as author_name <author_email>.

property author_date[source]

The author date in its original timezone.

property committer[source]

The committer’s name and e-mail address (if applicable).

This will be formatted as committer_name <committer_email> if both committer_name and committer_email are set. Otherwise, it be whichever is defined. If neither are defined, this will be None.

property committer_date[source]

The committer date in its original timezone.

If the commit has no committer, this will be None.

summary[source]

The first line of the commit message.

summary_truncated[source]

The first line of the commit message, truncated to 80 characters.

serialize()[source]

Serialize to a dictionary.

Returns

A dictionary representing this commit.

Return type

dict

get_total_line_counts()[source]

Return the total line counts of all child FileDiffs.

Returns

A dictionary with the following keys:

  • raw_insert_count

  • raw_delete_count

  • insert_count

  • delete_count

  • replace_count

  • equal_count

  • total_line_count

Each entry maps to the sum of that line count type for all child FileDiffs.

Return type

dict

class DiffSet(*args, **kwargs)[source]

A revisioned collection of FileDiffs.

property is_commit_series_finalized[source]

Whether the commit series represented by this DiffSet is finalized.

When a commit series is finalized, no more DiffCommits can be added to it.

finalize_commit_series(cumulative_diff, validation_info, parent_diff=None, request=None, validate=True, save=False)[source]

Finalize the commit series represented by this DiffSet.

Parameters
  • cumulative_diff (bytes) – The cumulative diff of the entire commit series.

  • validation_info (dict) – The parsed validation information.

  • parent_diff (bytes, optional) – The parent diff of the cumulative diff, if any.

  • request (django.http.HttpRequest, optional) – The HTTP request from the client, if any.

  • validate (bool, optional) – Whether or not the cumulative diff (and optional parent diff) should be validated, up to and including file existence checks.

  • save (bool, optional) –

    Whether to save the model after finalization. Defaults to False.

    If True, only the extra_data field will be updated.

    If False, the caller must save this model.

Returns

The list of created FileDiffs.

Return type

list of reviewboard.diffviewer.models.filediff.FileDiff

Raises

django.core.exceptions.ValidationError – The commit series failed validation.

get_total_line_counts()[source]

Return the total line counts of all child FileDiffs.

Returns

A dictionary with the following keys:

  • raw_insert_count

  • raw_delete_count

  • insert_count

  • delete_count

  • replace_count

  • equal_count

  • total_line_count

Each entry maps to the sum of that line count type for all child FileDiffs.

Return type

dict

property per_commit_files[source]

The files limited to per-commit diffs.

This will cache the results for future lookups. If the set of all files has already been fetched with prefetch_related(), no queries will be performed.

property cumulative_files[source]

The files limited to the cumulative diff.

This will cache the results for future lookups. If the set of all files has been already been fetched with prefetch_related(), no queries will be incurred.

update_revision_from_history(diffset_history)[source]

Update the revision of this diffset based on a diffset history.

This will determine the appropriate revision to use for the diffset, based on how many other diffsets there are in the history. If there aren’t any, the revision will be set to 1.

Parameters

diffset_history (reviewboard.diffviewer.models.diffset_history.DiffSetHistory) – The diffset history used to compute the new revision.

Raises

ValueError – The revision already has a valid value set, and cannot be updated.

save(**kwargs)[source]

Save this diffset.

This will set an initial revision of 1 if this is the first diffset in the history, and will set it to on more than the most recent diffset otherwise.

Parameters

**kwargs (dict) – Extra arguments for the save call.

class DiffSetHistory(*args, **kwargs)[source]

A collection of diffsets.

This gives us a way to store and keep track of multiple revisions of diffsets belonging to an object.

class FileDiff(*args, **kwargs)[source]

A diff of a single file.

This contains the patch and information needed to produce original and patched versions of a single file in a repository.

property source_file_display[source]

The displayed filename for the source/original file.

This may be different than source_file, as the associated SCMTool may normalize it for display.

Type:

unicode

property dest_file_display[source]

The displayed filename for the destination/modified file.

This may be different than dest_file, as the associated SCMTool may normalize it for display.

Type:

unicode

property modified[source]

Whether this file is a modification to an existing file.

Whether this file represents a symlink.

This represents the value of the is_symlink key in extra_data.

New in version 4.0.6.

Type:

bool

The old target for the symlink.

This represents the value of the old_symlink_target key in extra_data.

New in version 4.0.6.

Type:

unicode

The new target for the symlink.

This represents the value of the new_symlink_target key in extra_data.

New in version 4.0.6.

Type:

unicode

property old_unix_mode[source]

The old UNIX permissions mode for the file.

This represents the value of the old_unix_mode key in extra_data. It is stored as a string representing an octal.

New in version 4.0.6.

Type:

unicode

property new_unix_mode[source]

The new UNIX permissions mode for the file.

This represents the value of the new_unix_mode key in extra_data. It is stored as a string representing an octal.

New in version 4.0.6.

Type:

unicode

property status_string[source]

The FileDiff’s status as a human-readable string.

property is_diff_empty[source]

Whether or not the diff is empty.

is_parent_diff_empty(cache_only=False)[source]

Return whether or not the parent diff is empty.

Parameters

cache_only (bool, optional) – Whether or not to only use cached results.

Returns

Whether or not the parent diff is empty. This is true if either there is no parent diff or if the parent diff has no insertions and no deletions.

Return type

bool

property orig_sha1[source]

The computed SHA1 hash of the original file.

This may be None, in which case it will be populated when the diff is next viewed.

property patched_sha1[source]

The computed SHA1 hash of the patched file.

This may be None, in which case it will be populated when the diff is next viewed.

property orig_sha256[source]

The computed SHA256 hash of the original file.

This may be None, in which case it will be populated when the diff is next viewed.

New in version 4.0.

property patched_sha256[source]

The computed SHA256 hash of the patched file.

This may be None, in which case it will be populated when the diff is next viewed.

New in version 4.0.

property encoding[source]

The encoding of the source and patched file.

This will check the encoding key in extra_data. If not available, then this will be None.

New in version 4.0.

get_line_counts()[source]

Return the stored line counts for the diff.

This will return all the types of line counts that can be set.

Returns

A dictionary with the following keys:

  • raw_insert_count

  • raw_delete_count

  • insert_count

  • delete_count

  • replace_count

  • equal_count

  • total_line_count

These are not all guaranteed to have values set, and may instead be None. Only raw_insert_count, raw_delete_count insert_count, and delete_count are guaranteed to have values set.

If there isn’t a processed number of inserts or deletes stored, then insert_count and delete_count will be equal to the raw versions.

Return type

dict

set_line_counts(raw_insert_count=None, raw_delete_count=None, insert_count=None, delete_count=None, replace_count=None, equal_count=None, total_line_count=None)[source]

Set the line counts on the FileDiff.

There are many types of useful line counts that can be set.

Parameters
  • raw_insert_count (int, optional) –

    The insert count on the original patch.

    This will be set on the reviewboard.diffviewer.models.raw_file_diff_data.RawFileDiffData as well.

  • raw_delete_count (int, optional) –

    The delete count in the original patch.

    This will be set on the reviewboard.diffviewer.models.raw_file_diff_data.RawFileDiffData as well.

  • insert_count (int, optional) – The number of lines that were inserted in the diff.

  • delete_count (int, optional) – The number of lines that were deleted in the diff.

  • replace_count (int, optional) – The number of lines that were replaced in the diff.

  • equal_count (int, optional) – The number of lines that were identical in the diff.

  • total_line_count (int, optional) – The total line count.

get_ancestors(minimal, filediffs=None, update=True)[source]

Return the ancestors of this FileDiff.

This will update the ancestors of this FileDiff and all its ancestors if they are not already cached.

Parameters
  • minimal (bool) –

    Whether or not the minimal set of ancestors are returned.

    The minimal set of ancestors does not include ancestors where the file was deleted. In other words, if a file is deleted and then re-created, the deletion will not appear in the re-created file’s ancestor list.

  • filediffs (iterable of FileDiff, optional) – An optional list of FileDiffs to check for ancestors so that a query does not have to be performed.

  • update (bool, optional) –

    Whether or not to cache the results in the database.

    If True and the results have not already been cached, this FileDiff and its ancestors will all be updated.

Returns

The ancestor FileDiffs, in application order.

Return type

list of FileDiff

get_repository()[source]

Return the repository this diff applies to.

New in version 4.0.

Returns

The repository used for any operations for this FileDiff.

Return type

reviewboard.scmtools.models.Repository

get_base_filediff(base_commit, ancestors=None)[source]

Return the base FileDiff within a commit range.

This looks through the FileDiff’s ancestors, looking for the most recent one that equals or precedes base_commit.

Parameters
  • base_commit (reviewboard.diffviewer.models.diffcommit.DiffCommit) – The newest commit that the resulting base FileDiff can be associated with.

  • ancestors (list of FileDiff, optional) – A pre-fetched list of FileDiff ancestors. If not provided, a list will be fetched.

Returns

The base FileDiff, if one could be found. None will be returned if no base could be found.

Return type

FileDiff

class LegacyFileDiffData(*args, **kwargs)[source]

Deprecated, legacy class for base64-encoded diff data.

This is no longer populated, and exists solely to store legacy data that has not been migrated to RawFileDiffData.

class RawFileDiffData(*args, **kwargs)[source]

Stores raw diff data as binary content in the database.

This is the class used in Review Board 2.5+ to store diff content. Unlike in previous versions, the content is not base64-encoded. Instead, it is stored either as bzip2-compressed data (if the resulting compressed data is smaller than the raw data), or as the raw data itself.

property content[source]

Return the content of the diff.

The content will be uncompressed (if necessary) and returned as the raw set of bytes originally uploaded.

recalculate_line_counts(tool)[source]

Recalculates the insert_count and delete_count values.

This will attempt to re-parse the stored diff and fetch the line counts through the parser.