bzrlib : package documentation

All of bzr.

Developer documentation is available at http://doc.bazaar.canonical.com/bzr.dev/developers/

The project website is at http://bazaar.canonical.com/

Some particularly interesting things in bzrlib are:

We hope you enjoy this library.

Module add Helper functions for adding files to working trees.
Module annotate File annotate based on weave storage
Module api Library API versioning support.
Module atomicfile No module docstring; 1/1 classes documented
Module bencode Wrapper around the bencode pyrex and python implementation
Module bisect_multi Bisection lookup multiple keys.
Module branch No module docstring; 29/30 classes documented
Module branchbuilder Utility for create branches with particular contents.
Module breakin No module docstring; 1/3 functions documented
Module btree_index B+Tree indices
Module bugtracker No module docstring; 7/7 classes, 2/2 functions documented
Module builtins builtin bzr commands
Package bundle No package docstring; 3/3 modules, 0/1 packages documented
Module bzr_distutils build_mo command for setup.py
Module bzrdir BzrDir logic. The BzrDir is the basic control directory used by bzr.
Module cache_utf8 Some functions to enable caching the conversion between unicode to utf8
Module cethread No module docstring; 1/1 classes documented
Module check Checking of bzr objects.
Module chk_map Persistent maps from tuple_of_strings->string using CHK stores.
Module chk_serializer Serializer object for CHK based inventory storage.
Module chunk_writer ChunkWriter: write compressed data out with a fixed upper bound.
Module clean_tree No module docstring; 4/5 functions documented
Module cleanup Helpers for managing cleanup functions and the errors they might raise.
Module cmd_test_script Front-end command for shell-like test scripts.
Module cmd_version_info Commands for generating snapshot information about a bzr tree.
Module cmdline Unicode-compatible command-line splitter for all platforms.
Module commands No module docstring; 7/7 classes, 21/30 functions documented
Module commit No module docstring; 2/3 classes documented
Module commit_signature_commands Command which looks for unsigned commits by the current user, and signs them.
Module config Configuration that affects the behaviour of Bazaar.
Module conflicts No module docstring; 14/17 classes, 3/3 functions documented
Module controldir ControlDir is the basic control directory class.
Module counted_lock Counted lock class
Module crash Handling and reporting crashes.
Module debug Set of flags that enable different debug behaviour.
Module decorators No module docstring; 0/2 classes, 9/9 functions documented
Module delta No module docstring; 2/2 classes, 3/3 functions documented
Module diff No module docstring; 5/9 classes, 5/8 functions documented
Module directory_service Directory service registration and usage.
Module dirstate DirState objects record the state of a directory and its bzr metadata.
Package doc Documentation for bzrlib.
Package doc_generate No package docstring; 3/4 modules, 0/2 packages documented
Module email_message A convenience class around email.Message and email.MIMEMultipart.
Module errors Exceptions for bzr, and reporting of them.
Module estimate_compressed_size Code to estimate the entropy of content
Package export Export trees to tarballs, non-controlled directories, zipfiles, etc.
Module export_pot Extract docstrings from Bazaar commands.
Module externalcommand No module docstring; 1/1 classes documented
Module fetch Copying of history from one branch to another.
Module fifo_cache A simple first-in-first-out (FIFO) cache.
Module filter_tree Content-filtered view of any tree.
Package filters Working tree content filtering support.
Module foreign Foreign branch utilities.
Module generate_ids Common code for generating file or revision ids.
Module globbing Tools for converting globs to regular expressions.
Module gpg GPG signing and checking logic.
Module graph No module docstring; 17/17 classes, 6/6 functions documented
Module groupcompress Core compression logic for compressing streams of related files.
Module hashcache No module docstring; 1/1 classes documented
Module help No module docstring; 1/1 classes, 3/3 functions documented
Package help_topics A collection of extra help information for using bzr.
Module hooks Support for plugin hooking logic.
Module i18n i18n and l10n support for Bazaar.
Module identitymap This module provides an IdentityMap.
Module ignores Lists of ignore files, etc.
Module index Indexing facilities.
Module info No module docstring; 1/2 classes, 14/17 functions documented
Module inspect_for_copy A version of inspect that includes what 'copy' needs.
Module inter Inter-object utility class.
Module intset No module docstring; 1/1 classes documented
Module inventory No module docstring; 8/9 classes, 9/10 functions documented
Module inventory_delta Inventory delta serialisation.
Module iterablefile No module docstring; 2/2 classes documented
Module knit Knit versionedfile implementation.
Module lazy_import Functionality to create lazy evaluation objects.
Module lazy_regex Lazily compiled regex objects.
Module library_state The core state needed to make use of bzr is managed here.
Module lock Locking using OS file locks or file existence.
Module lockable_files No module docstring; 2/2 classes documented
Module lockdir On-disk mutex protecting a resource
Module log Code to show logs of changes.
Module lru_cache A simple least-recently-used (LRU) cache.
Module lsprof No module docstring; 3/3 classes, 1/2 functions documented
Module mail_client No module docstring; 1/14 classes documented
Module memorytree MemoryTree object.
Module merge No module docstring; 13/18 classes, 2/4 functions documented
Module merge3 No module docstring; 1/1 classes, 2/3 functions documented
Module merge_directive No module docstring; 4/6 classes documented
Module mergetools Utility functions for managing external merge tools such as kdiff3.
Module missing Display what revisions are missing in 'other' from 'this' and vice versa.
Module msgeditor Commit message editor support.
Module multiparent No module docstring; 7/7 classes, 0/4 functions documented
Module mutabletree MutableTree object.
Module option No module docstring; 5/6 classes, 8/11 functions documented
Module osutils No module docstring; 3/3 classes, 81/121 functions documented
Module pack Container format for Bazaar data.
Module patch No module docstring; 2/3 functions documented
Module patches No module docstring; 0/13 classes, 9/12 functions documented
Module patiencediff No module docstring; 1/1 classes, 2/3 functions documented
Module plugin bzr python plugin support.
Package plugins Null placeholder plugin
Module progress Progress indicators.
Module push UI helper for the push command.
Module pyutils General Python convenience functions.
Module reconcile Reconcilers are able to fix some potential data errors in a branch.
Module reconfigure Reconfigure a controldir into a new tree/branch/repository layout.
Module recordcounter Record counting support for showing progress of revision fetch.
Module registry Classes to provide name-to-object registry-like support.
Module remote No module docstring; 11/13 classes, 4/4 functions documented
Module rename_map No module docstring; 1/1 classes documented
Package repofmt Repository formats
Module repository No module docstring; 10/11 classes, 2/2 functions documented
Module revision No module docstring; 1/1 classes, 4/7 functions documented
Module revisionspec No module docstring; 13/16 classes, 0/1 functions documented
Module revisiontree RevisionTree - a Tree implementation backed by repository data for a revision.
Module rio No module docstring; 2/3 classes, 5/8 functions documented
Module rules Rule-based definition of preferences for selected files in selected branches.
Module send Undocumented
Module serializer Inventory/revision serialization.
Module shelf No module docstring; 3/3 classes documented
Module shelf_ui No module docstring; 3/5 classes documented
Module shellcomplete No module docstring; 1/4 functions documented
Package smart Smart-server protocol, client and server.
Module smtp_connection A convenience class around smtplib.
Module static_tuple Interface thunk for a StaticTuple implementation.
Module status No module docstring; 2/2 classes, 6/6 functions documented
Package store Stores are the main data-storage mechanism for Bazaar.
Module strace Support for running strace against the current process.
Module switch No module docstring; 5/6 functions documented
Module symbol_versioning Symbol versioning
Module tag Tag strategies.
Module testament Testament - a summary of a revision for signing.
Package tests Testing framework extensions
Module textfile Utilities for distinguishing binary files from text files
Module textinv No module docstring; 3/4 functions documented
Module textmerge No module docstring; 2/2 classes documented
Module timestamp No module docstring; 4/4 functions documented
Module trace Messages and logging.
Module transactions This module provides a transactional facility.
Module transform No module docstring; 7/10 classes, 14/24 functions documented
Package transport Transport is an abstraction layer to handle file access.
Module tree Tree classes, representing directory at point in time.
Module treebuilder TreeBuilder helper class.
Module tsort Topological sorting routines.
Module tuned_gzip Bzrlib specific gzip tunings. We plan to feed these to the upstream gzip.
Package ui Abstraction for interacting with the user.
Module uncommit Remove the last revision from the history of the current branch.
Module upgrade bzr upgrade logic.
Module urlutils A collection of function for handling URL operations.
Module utextwrap No module docstring; 1/1 classes, 2/2 functions documented
Package util No package docstring; 1/2 modules, 0/4 packages documented
Module version Report on version of bzrlib
Package version_info_formats Routines for extracting all version information from a bzr branch.
Module versionedfile Versioned text file storage api.
Module vf_repository Repository formats built around versioned files.
Module views View management.
Module weave Weave - storage of related text file versions
Module weavefile Store and retrieve weaves in files.
Module win32utils Win32-specific helper functions
Module workingtree WorkingTree object and friends.
Module workingtree_3 WorkingTree3 format and implementation.
Module workingtree_4 WorkingTree4 format and implementation.
Module xml5 No module docstring; 1/1 classes documented
Module xml6 No module docstring; 1/1 classes documented
Module xml7 No module docstring; 1/1 classes documented
Module xml8 No module docstring; 1/1 classes, 7/8 functions documented
Module xml_serializer XML externalization support.
Module _annotator_py Functionality for doing annotations in the 'optimal' way
Module _btree_serializer_py B+Tree index parsing.
Module _chk_map_py Python implementation of _search_key functions, etc.
Module _chunks_to_lines_py The python implementation of chunks_to_lines
Module _dirstate_helpers_py Python implementations of Dirstate Helper functions.
Module _groupcompress_py Python version of compiled extensions for doing compression.
Module _knit_load_data_py No module docstring; 1/1 functions documented
Module _known_graph_py Implementation of Graph algorithms when we have already loaded everything.
Module _patiencediff_py No module docstring; 3/4 functions documented
Module _readdir_py Python implementation of readdir interface.
Module _rio_py Python implementation of _read_stanza_*.
Module _static_tuple_py The pure-python implementation of the StaticTuple type.

From the __init__.py module:

Function initialize Set up everything needed for normal use of bzrlib.
Function test_suite Undocumented
Function _format_version_tuple Turn a version number 2, 3 or 5-tuple into a short string.
def _format_version_tuple(version_info):

Turn a version number 2, 3 or 5-tuple into a short string.

This format matches <http://docs.python.org/dist/meta-data.html> and the typical presentation used in Python output.

This also checks that the version is reasonable: the sub-release must be zero for final releases.

>>> print _format_version_tuple((1, 0, 0, 'final', 0))
1.0.0
>>> print _format_version_tuple((1, 2, 0, 'dev', 0))
1.2.0dev
>>> print _format_version_tuple((1, 2, 0, 'dev', 1))
1.2.0dev1
>>> print _format_version_tuple((1, 1, 1, 'candidate', 2))
1.1.1rc2
>>> print _format_version_tuple((2, 1, 0, 'beta', 1))
2.1b1
>>> print _format_version_tuple((1, 4, 0))
1.4.0
>>> print _format_version_tuple((1, 4))
1.4
>>> print _format_version_tuple((2, 1, 0, 'final', 42))
2.1.0.42
>>> print _format_version_tuple((1, 4, 0, 'wibble', 0))
1.4.0.wibble.0
def initialize(setup_ui=True, stdin=None, stdout=None, stderr=None):
Set up everything needed for normal use of bzrlib.

Most applications that embed bzrlib, including bzr itself, should call this function to initialize various subsystems.

More options may be added in future so callers should use named arguments.

The object returned by this function can be used as a contex manager through the 'with' statement to automatically shut down when the process is finished with bzrlib. However (from bzr 2.4) it's not necessary to separately enter the context as well as starting bzr: bzrlib is ready to go when this function returns.

Parameterssetup_uiIf true (default) use a terminal UI; otherwise some other ui_factory must be assigned to bzrlib.ui.ui_factory by the caller.
stdin, stdout, stderrIf provided, use these for terminal IO; otherwise use the files in sys.
ReturnsA context manager for the use of bzrlib. The __exit__ should be called by the caller before exiting their process or otherwise stopping use of bzrlib. Advanced callers can use BzrLibraryState directly.
def test_suite():
Undocumented
API Documentation for Bazaar, generated by pydoctor at 2015-07-05 00:01:47.