bzrlib.shelf_ui.Unshelver : API documentation

@classmethod
def from_args(klass, shelf_id=None, action='apply', directory='.', write_diff_to=None):

Create an unshelver from commandline arguments.

The returned shelver will have a tree that is locked and should be unlocked.

Parameters	shelf_id	Integer id of the shelf, as a string.
	action	action to perform. May be 'apply', 'dry-run', 'delete', 'preview'.
	directory	The directory to unshelve changes into.
	write_diff_to	See Unshelver.__init__().

def __init__(self, tree, manager, shelf_id, apply_changes=True, delete_shelf=True, read_shelf=True, show_diff=False, write_diff_to=None):

Constructor.

Parameters	tree	The working tree to unshelve into.
	manager	The ShelveManager containing the shelved changes.
	shelf_id
	apply_changes	If True, apply the shelved changes to the working tree.
	delete_shelf	If True, delete the changes from the shelf.
	read_shelf	If True, read the changes from the shelf.
	show_diff	If True, show the diff that would result from unshelving the changes.
	write_diff_to	A file-like object where the diff will be written to. If None, ui.ui_factory.make_output_stream() will be used.

def run(self):

Perform the unshelving operation.

def write_diff(self, merger):

Write this operation's diff to self.write_diff_to.

def show_changes(self, merger):

Show the changes that this operation specifies.

Class Method	from_args	Create an unshelver from commandline arguments.
Method	__init__	Constructor.
Method	run	Perform the unshelving operation.
Method	write_diff	Write this operation's diff to self.write_diff_to.
Method	show_changes	Show the changes that this operation specifies.

b.s.Unshelver(object) : class documentation