b.status : module documentation

Part of bzrlib

No module docstring
Function report_changes Display summary of changes.
Function show_tree_status Display summary of changes.
Function show_pending_merges Write out a display of pending merges in a working tree.
Class StatusHooks A dictionary mapping hook name to a list of callables for status hooks.
Class StatusHookParams Object holding parameters passed to post_status hooks.
Function _get_sorted_revisions Get an iterator which will return the revisions in merge sorted order.
Function _filter_nonexistent Convert orig_paths to two sorted lists and return them.
Function _show_shelve_summary post_status hook to display a summary of shelves.
def report_changes(to_file, old, new, specific_files, show_short_reporter, show_long_callback, short=False, want_unchanged=False, want_unversioned=False, show_ids=False, classify=True):
Display summary of changes.

This compares two trees with regards to a list of files, and delegates the display to underlying elements.

For short output, it creates an iterator on all changes, and lets a given reporter display these changes.

For stantard output, it creates a delta of the changes, and forwards it to a callback

Parametersto_fileIf set, write to this file (default stdout.)
oldStart tree for the comparison
endEnd tree for the comparison
specific_filesIf set, a list of filenames whose status should be shown. It is an error to give a filename that is not in the working tree, or in the working inventory or in the basis inventory.
show_short_reporterReporter in charge of display for short output
show_long_callbackCallback in charge of display for normal output
shortIf True, gives short SVN-style status lines.
want_unchangedDeprecated parameter. If set, includes unchanged files.
show_idsIf set, includes each file's id.
want_unversionedIf False, only shows versioned files.
classifyAdd special symbols to indicate file kind.
def show_tree_status(wt, show_unchanged=None, specific_files=None, show_ids=False, to_file=None, show_pending=True, revision=None, short=False, verbose=False, versioned=False, classify=True, show_long_callback=_mod_delta.report_delta):
Display summary of changes.

By default this compares the working tree to a previous revision. If the revision argument is given, summarizes changes between the working tree and another, or between two revisions.

The result is written out as Unicode and to_file should be able to encode that.

If showing the status of a working tree, extra information is included about unknown files, conflicts, and pending merges.

Parametersshow_unchangedDeprecated parameter. If set, includes unchanged files.
specific_filesIf set, a list of filenames whose status should be shown. It is an error to give a filename that is not in the working tree, or in the working inventory or in the basis inventory.
show_idsIf set, includes each file's id.
to_fileIf set, write to this file (default stdout.)
show_pendingIf set, write pending merges.
revisionIf None, compare latest revision with working tree If not None, it must be a RevisionSpec list. If one revision, compare with working tree. If two revisions, show status between first and second.
shortIf True, gives short SVN-style status lines.
verboseIf True, show all merged revisions, not just the merge tips
versionedIf True, only shows versioned files.
classifyAdd special symbols to indicate file kind.
show_long_callbackA callback: message = show_long_callback(to_file, delta, show_ids, show_unchanged, indent, filter), only used with the long output
def _get_sorted_revisions(tip_revision, revision_ids, parent_map):
Get an iterator which will return the revisions in merge sorted order.

This will build up a list of all nodes, such that only nodes in the list are referenced. It then uses MergeSorter to return them in 'merge-sorted' order.

Parametersrevision_idsA set of revision_ids
parent_mapThe parent information for each node. Revisions which are considered ghosts should not be present in the map.
Returnsiterator from MergeSorter.iter_topo_order()
def show_pending_merges(new, to_file, short=False, verbose=False):
Write out a display of pending merges in a working tree.
def _filter_nonexistent(orig_paths, old_tree, new_tree):
Convert orig_paths to two sorted lists and return them.

The first is orig_paths paths minus the items in the second list, and the second list is paths that are not in either inventory or tree (they don't qualify if they exist in the tree's inventory, or if they exist in the tree but are not versioned.)

If either of the two lists is empty, return it as an empty list.

This can be used by operations such as bzr status that can accept unknown or ignored files.

def _show_shelve_summary(params):
post_status hook to display a summary of shelves.
ParametersparamsStatusHookParams.
API Documentation for Bazaar, generated by pydoctor at 2014-09-02 00:02:07.