API docs for “bzrlib.pack”

Container format for Bazaar data.

"Containers" and "records" are described in doc/developers/container-format.txt.

Line #	Kind	Name	Docs
62	Class	ContainerSerialiser	A helper class for serialising containers.
108	Class	ContainerWriter	A class for writing containers to a file.
161	Class	ReadVFile	Adapt a readv result iterator to a file like protocol.
192	Function	make_readv_reader	Create a ContainerReader that will read selected records only.
207	Class	BaseReader	No class docstring; 1/3 methods documented
227	Class	ContainerReader	A class for reading Bazaar's container format.
325	Class	BytesRecordReader	No class docstring; 2/3 methods documented
385	Class	ContainerPushParser	A "push" parser for container format 1.
494	Function	iter_records_from_file	Undocumented
35	Function	_check_name	Do some basic checking of 'name'.
48	Function	_check_name_encoding	Check that 'name' is valid UTF-8.

def _check_name(name):

Do some basic checking of 'name'.

At the moment, this just checks that there are no whitespace characters in a name.

Raises	InvalidRecordError	if name is not valid.
See Also	_check_name_encoding

def _check_name_encoding(name):

Check that 'name' is valid UTF-8.

This is separate from _check_name because UTF-8 decoding is relatively expensive, and we usually want to avoid it.

Raises InvalidRecordError if name is not valid UTF-8.

def make_readv_reader(transport, filename, requested_records):

Create a ContainerReader that will read selected records only.

Parameters	transport	The transport the pack file is located on.
	filename	The filename of the pack file.
	requested_records	The record offset, length tuples as returned by add_bytes_record for the desired records.

Module b.pack