lp.code.interfaces.branchhosting.IBranchHostingClient : API documentation

def getDiff(branch_id, new, old=None, context_lines=None, logger=None):

Get the diff between two revisions.

Parameters	branch_id	The ID of the branch.
	new	The new revno or revision ID.
	old	The old revno or revision ID. Defaults to the parent revision of `new`.
	context_lines	Include this number of lines of context around each hunk.
	logger	An optional logger.
Returns	The diff between `old` and `new` as a byte string.
Raises	ValueError	if `old` or `new` is ill-formed.
	BranchHostingFault	if the API returned an error.

def getInventory(branch_id, dirname, rev=None, logger=None):

Get information on files in a directory.

Parameters	branch_id	The ID of the branch.
	dirname	The name of the directory, relative to the root of the branch.
	rev	An optional revno or revision ID. Defaults to 'head:'.
	logger	An optional logger.
Returns	The directory inventory as a dict: see `loggerhead.controllers.inventory_ui` for details.
Raises	ValueError	if `rev` is ill-formed.
	BranchFileNotFound	if the directory does not exist.
	BranchHostingFault	if the API returned some other error.

def getBlob(branch_id, file_id, rev=None, logger=None):

Get a blob by file name from a branch.

Parameters	branch_id	The ID of the branch.
	file_id	The file ID of the file. (`getInventory` may be useful to retrieve this.)
	rev	An optional revno or revision ID. Defaults to 'head:'.
	logger	An optional logger.
Returns	The blob content as a byte string.
Raises	ValueError	if `rev` is ill-formed.
	BranchFileNotFound	if the directory does not exist.
	BranchHostingFault	if the API returned some other error.

Method	getDiff	Get the diff between two revisions.
Method	getInventory	Get information on files in a directory.
Method	getBlob	Get a blob by file name from a branch.

l.c.i.b.IBranchHostingClient(Interface) : interface documentation