reviewboard.diffviewer.opcode_generator¶

The diff opcode generator.

class MoveRange(start: int, end: int, groups: list[tuple[DiffOpcodeWithMetadata, int]] | None = None)[source]¶

Bases: object

Stores information on a move range.

This will store the start and end of the range, and all groups that are a part of it.

__init__(start: int, end: int, groups: list[tuple[DiffOpcodeWithMetadata, int]] | None = None) → None[source]¶

Initialize the object.

Parameters:

start (int) – The start index of the range.
end (int) – The end index of the range.
groups (list of tuple, optional) – The opcodes in the range.

start: int¶

The start index of the range.

This indexes into the opcode generator’s groups list.

end: int¶

The end index of the range.

This indexes into the opcode generator’s groups list.

groups: list[tuple[DiffOpcodeWithMetadata, int]]¶

The opcodes in the range.

This is a list of tuples where the first element is the opcode, and the second is the index into the opcode generator’s groups list.

property last_group: tuple[DiffOpcodeWithMetadata, int][source]¶

The last group in the move range.

Raises:: IndexError – The move range was empty.

add_group(group: DiffOpcodeWithMetadata, group_index: int) → None[source]¶

Add a group to the range.

Parameters:

group (reviewboard.diffviewer.differ.DiffOpcode) – The opcode.
group_index (int) – The index of the group in the opcode generator’s groups list.

__repr__() → str[source]¶

Return a string representation of the object.

Returns:: A string representation of the object.
Return type:: str

class DiffOpcodeGenerator(differ: Differ, diff: bytes | None = None, interdiff: bytes | None = None, request: HttpRequest | None = None, *, diff_settings: DiffSettings | None = None, **kwargs)[source]¶

Bases: object

The diff opcode generator.

ALPHANUM_RE = re.compile('\\w')[source]¶

WHITESPACE_RE = re.compile('\\s')[source]¶

MOVE_PREFERRED_MIN_LINES = 2[source]¶

MOVE_MIN_LINE_LENGTH = 20[source]¶

TAB_SIZE = 8[source]¶: The default width for a tabstop.

groups: list[DiffOpcodeWithMetadata]¶: The generated opcodes.

inserts: list[DiffOpcodeWithMetadata]¶

A list of all opcodes involving inserted lines.

This will contain both pure inserts as well as replaces.

removes: dict[str, list[tuple[int, DiffOpcodeWithMetadata, int]]]¶

A mapping for working with removed lines.

This is a mapping from the line content of a removed line to a list of potential opcodes relating to that removal. The values in that list are tuples of the original line number, the opcode, and the index of that opcode in the groups list.

__init__(differ: Differ, diff: bytes | None = None, interdiff: bytes | None = None, request: HttpRequest | None = None, *, diff_settings: DiffSettings | None = None, **kwargs) → None[source]¶

Initialize the opcode generator.

Changed in version 7.0.4: Added the diff_settings parameter.

Changed in version 3.0.18: Added the request and **kwargs parameters.

Parameters:

differ (reviewboard.diffviewer.differ.Differ) – The differ being used to generate the diff.
diff (bytes, optional) – The raw contents for the diff.
interdiff (bytes, optional) – The raw contents for the diff on the other end of an interdiff range, if generating an interdiff.
request (django.http.HttpRequest) – The HTTP request from the client.
diff_settings (reviewboard.diffviewer.settings.DiffSettings, optional) –
The diff settings object.

New in version 7.0.4.
**kwargs (dict) – Additional keyword arguments, for future expansion.

differ: Differ¶: The differ being used to generate the diff.

diff: bytes | None¶: The raw contents for the diff.

interdiff: bytes | None¶: The raw contents of the interdiff range diff.

request: HttpRequest | None¶: The HTTP request from the client.

diff_settings: DiffSettings¶: The diff settings object.

New in version 7.0.4.

__iter__() → Iterator[DiffOpcodeWithMetadata][source]¶

Yield opcodes from the differ with extra metadata.

This is a wrapper around a differ’s get_opcodes function, which returns extra metadata along with each range. That metadata includes information on moved blocks of code and whitespace-only lines.