bzrlib.annotate : API documentation

Function	annotate_file	Annotate file_id at revision rev_id in branch.
Function	annotate_file_tree	Annotate file_id in a tree.
Function	reannotate	Create a new annotated version from new lines and parent annotations.
Function	_print_annotations	Print annotations to to_file.
Function	_show_id_annotations	Undocumented
Function	_expand_annotations	Expand a file's annotations into command line UI ready tuples.
Function	_reannotate	Undocumented
Function	_get_matching_blocks	Undocumented
Function	_old_break_annotation_tie	Chose an attribution between several possible ones.
Function	_find_matching_unannotated_lines	Find lines in plain_right_lines that match the existing lines.
Function	_reannotate_annotated	Update the annotations for a node based on another parent.

@deprecated_function(deprecated_in((2, 4, 0)))
def annotate_file(branch, rev_id, file_id, verbose=False, full=False, to_file=None, show_ids=False):

Annotate file_id at revision rev_id in branch.

The branch should already be read_locked() when annotate_file is called.

Parameters	branch	The branch to look for revision numbers and history from.
	rev_id	The revision id to annotate.
	file_id	The file_id to annotate.
	verbose	Show all details rather than truncating to ensure reasonable text width.
	full	XXXX Not sure what this does.
	to_file	The file to output the annotation to; if None stdout is used.
	show_ids	Show revision ids in the annotation output.

def annotate_file_tree(tree, file_id, to_file, verbose=False, full=False, show_ids=False, branch=None):

Annotate file_id in a tree.

The tree should already be read_locked() when annotate_file_tree is called.

Parameters	tree	The tree to look for revision numbers and history from.
	file_id	The file_id to annotate.
	to_file	The file to output the annotation to.
	verbose	Show all details rather than truncating to ensure reasonable text width.
	full	XXXX Not sure what this does.
	show_ids	Show revision ids in the annotation output.
	branch	Branch to use for revision revno lookups

def _print_annotations(annotation, verbose, to_file, full):

Print annotations to to_file.

Parameters	to_file	The file to output the annotation to.
	verbose	Show all details rather than truncating to ensure reasonable text width.
	full	XXXX Not sure what this does.

def _show_id_annotations(annotations, to_file, full):

Undocumented

def _expand_annotations(annotations, branch, current_rev=None):

Expand a file's annotations into command line UI ready tuples.

Each tuple includes detailed information, such as the author name, and date string for the commit, rather than just the revision id.

Parameters	annotations	The annotations to expand.
	revision_id_to_revno	A map from id to revision numbers.
	branch	A locked branch to query for revision details.

def reannotate(parents_lines, new_lines, new_revision_id, _left_matching_blocks=None, heads_provider=None):

Create a new annotated version from new lines and parent annotations.

Parameters	parents_lines	List of annotated lines for all parents
	new_lines	The un-annotated new lines
	new_revision_id	The revision-id to associate with new lines (will often be CURRENT_REVISION)
	left_matching_blocks	a hint about which areas are common between the text and its left-hand-parent. The format is the SequenceMatcher.get_matching_blocks format (start_left, start_right, length_of_match).
	heads_provider	An object which provides a .heads() call to resolve if any revision ids are children of others. If None, then any ancestry disputes will be resolved with new_revision_id

def _reannotate(parent_lines, new_lines, new_revision_id, matching_blocks=None):

Undocumented

def _get_matching_blocks(old, new):

Undocumented

def _old_break_annotation_tie(annotated_lines):

Chose an attribution between several possible ones.

Parameters

annotated_lines

A list of tuples ((file_id, rev_id), line) where: the lines are identical but the revids different while no parent relation exist between them
:return : The "winning" line. This must be one with a revid that: guarantees that further criss-cross merges will converge. Failing to do so have performance implications.

def _find_matching_unannotated_lines(output_lines, plain_child_lines, child_lines, start_child, end_child, right_lines, start_right, end_right, heads_provider, revision_id):

Find lines in plain_right_lines that match the existing lines.

Parameters	output_lines	Append final annotated lines to this list
	plain_child_lines	The unannotated new lines for the child text
	child_lines	Lines for the child text which have been annotated for the left parent
	start_child	Position in plain_child_lines and child_lines to start the match searching
	end_child	Last position in plain_child_lines and child_lines to search for a match
	right_lines	The annotated lines for the whole text for the right parent
	start_right	Position in right_lines to start the match
	end_right	Last position in right_lines to search for a match
	heads_provider	When parents disagree on the lineage of a line, we need to check if one side supersedes the other
	revision_id	The label to give if a line should be labeled 'tip'

def _reannotate_annotated(right_parent_lines, new_lines, new_revision_id, annotated_lines, heads_provider):

Update the annotations for a node based on another parent.

Parameters	right_parent_lines	A list of annotated lines for the right-hand parent.
	new_lines	The unannotated new lines.
	new_revision_id	The revision_id to attribute to lines which are not present in either parent.
	annotated_lines	A list of annotated lines. This should be the annotation of new_lines based on parents seen so far.
	heads_provider	When parents disagree on the lineage of a line, we need to check if one side supersedes the other.

b.annotate : module documentation