bzrlib.shelf_ui.Shelver : API documentation

Method	__init__	Constructor.
Class Method	from_args	Create a shelver from commandline arguments.
Method	run	Interactively shelve the changes.
Method	finalize	Undocumented
Method	get_parsed_patch	Return a parsed version of a file's patch.
Method	prompt	Undocumented
Method	prompt_bool	Prompt the user with a yes/no question.
Method	handle_modify_text	Handle modified text, by using hunk selection or file editing.
Method	_select_hunks	Provide diff hunk selection for modified text.
Method	_edit_file
Static Method	_count_changed_regions	Undocumented

def __init__(self, work_tree, target_tree, diff_writer=None, auto=False, auto_apply=False, file_list=None, message=None, destroy=False, manager=None, reporter=None):

overridden in bzrlib.tests.test_shelf_ui.ExpectShelver

Constructor.

Parameters	work_tree	The working tree to shelve changes from.
	target_tree	The "unchanged" / old tree to compare the work_tree to.
	auto	If True, shelve each possible change.
	auto_apply	If True, shelve changes with no final prompt.
	file_list	If supplied, only files in this list may be shelved.
	message	The message to associate with the shelved changes.
	destroy	Change the working tree without storing the shelved changes.
	manager	The shelf manager to use.
	reporter	Object for reporting changes to user.

@classmethod
def from_args(klass, diff_writer, revision=None, all=False, file_list=None, message=None, directory=None, destroy=False):

Create a shelver from commandline arguments.

The returned shelver wil have a work_tree that is locked and should be unlocked.

Parameters	revision	RevisionSpec of the revision to compare to.
	all	If True, shelve all changes without prompting.
	file_list	If supplied, only files in this list may be shelved.
	message	The message to associate with the shelved changes.
	directory	The directory containing the working tree.
	destroy	Change the working tree without storing the shelved changes.

def run(self):

Interactively shelve the changes.

def finalize(self):

Undocumented

def get_parsed_patch(self, file_id, invert=False):

Return a parsed version of a file's patch.

Parameters	file_id	The id of the file to generate a patch for.
	invert	If True, provide an inverted patch (insertions displayed as removals, removals displayed as insertions).
Returns	A patches.Patch.

def prompt(self, message, choices, default):

overridden in bzrlib.tests.test_shelf_ui.ExpectShelver

Undocumented

def prompt_bool(self, question, allow_editor=False):

Prompt the user with a yes/no question.

This may be overridden by self.auto. It may also set self.auto. It may also raise UserAbort. :param question: The question to ask the user. :return: True or False

def handle_modify_text(self, creator, file_id):

Handle modified text, by using hunk selection or file editing.

Parameters	creator	A ShelfCreator.
	file_id	The id of the file that was modified.
Returns	The number of changes.

def _select_hunks(self, creator, file_id, work_tree_lines):

Provide diff hunk selection for modified text.

If self.reporter.invert_diff is True, the diff is inverted so that insertions are displayed as removals and vice versa.

Parameters	creator	a ShelfCreator
	file_id	The id of the file to shelve.
	work_tree_lines	Line contents of the file in the working tree.
Returns	number of shelved hunks.

def _edit_file(self, file_id, work_tree_lines):

Parameters	file_id	id of the file to edit.
	work_tree_lines	Line contents of the file in the working tree.
Returns	(lines, change_region_count), where lines is the new line content of the file, and change_region_count is the number of changed regions.

b.s.Shelver(object) : class documentation