b.b.serializer : package documentation

Part of bzrlib.bundle

Serializer factory for reading and writing bundles.
Module v08 Serializer factory for reading and writing bundles.
Module v09 No module docstring; 3/3 classes documented
Module v4 No module docstring; 7/7 classes documented

From the __init__.py module:

Class BundleSerializer The base class for Serializers.
Function binary_diff Undocumented
Function get_serializer Undocumented
Function read_bundle Read in a bundle from a filelike object.
Function register Register a BundleSerializer version.
Function register_lazy Register lazy-loaded bundle serializer.
Function write Serialize a list of bundles to a filelike object.
Function write_bundle Write a bundle of revisions.
Function _get_bundle_header Undocumented
Function _get_filename Undocumented
def _get_bundle_header(version):
Undocumented
def _get_filename(f):
Undocumented
def read_bundle(f):
Read in a bundle from a filelike object.
ParametersfA file-like object
ReturnsA list of Bundle objects
def get_serializer(version):
Undocumented
def write(source, revision_ids, f, version=None, forced_bases={}):
Serialize a list of bundles to a filelike object.
ParameterssourceA source for revision information
revision_idsThe list of revision ids to serialize
fThe file to output to
version[optional] target serialization version
def write_bundle(repository, revision_id, base_revision_id, out, format=None):
Write a bundle of revisions.
ParametersrepositoryRepository containing revisions to serialize.
revision_idHead revision_id of the bundle.
base_revision_idRevision assumed to be present in repositories applying the bundle.
outOutput file.
def register(version, klass, overwrite=False):
Register a BundleSerializer version.
ParametersversionThe version associated with this format
klassThe class to instantiate, which must take a version argument
def register_lazy(version, module, classname, overwrite=False):
Register lazy-loaded bundle serializer.
ParametersversionThe version associated with this reader
moduleString indicating what module should be loaded
classnameName of the class that will be instantiated
overwriteShould this version override a default
def binary_diff(old_filename, old_lines, new_filename, new_lines, to_file):
Undocumented
API Documentation for Bazaar, generated by pydoctor at 2014-10-31 00:01:21.