bzrlib.versionedfile._PlanMergeVersionedFile : API documentation

A VersionedFile for uncommitted and committed texts.

It is intended to allow merges to be planned with working tree texts. It implements only the small part of the VersionedFiles interface used by PlanMerge. It falls back to multiple versionedfiles for data not stored in _PlanMergeVersionedFile itself.

Instance Variables fallback_versionedfiles a list of VersionedFiles objects that can be queried for missing texts.

Method	__init__	Create a _PlanMergeVersionedFile.
Method	plan_merge	See VersionedFile.plan_merge
Method	plan_lca_merge	Undocumented
Method	add_lines	See VersionedFiles.add_lines
Method	get_record_stream	Get a stream of records for keys.
Method	get_parent_map	See VersionedFiles.get_parent_map

Inherited from VersionedFiles:

Method	add_mpdiffs	Add mpdiffs to this VersionedFile.
Method	annotate	Return a list of (version-key, line) tuples for the text of key.
Method	check	Check this object for integrity.
Static Method	check_not_reserved_id	Undocumented
Method	clear_cache	Clear whatever caches this VersionedFile holds.
Method	get_known_graph_ancestry	Get a KnownGraph instance with the ancestry of keys.
Method	get_sha1s	Get the sha1's of the texts for the given keys.
Method	get_missing_compression_parent_keys	Return an iterable of keys of missing compression parents.
Method	insert_record_stream	Insert a record stream into this container.
Method	iter_lines_added_or_present_in_keys	Iterate over the lines in the versioned files from keys.
Method	keys	Return a iterable of the keys for all the contained texts.
Method	make_mpdiffs	Create multiparent diffs for specified keys.
Method	get_annotator	Undocumented
Method	_add_text	Add a text to the store.
Method	_check_lines_not_unicode	Check that lines being added to a versioned file are not unicode.
Method	_check_lines_are_lines	Check that the lines really are full lines without inline EOL.
Method	_extract_blocks	Undocumented
Method	_transitive_fallbacks	Return the whole stack of fallback versionedfiles.

def add_lines(self, key, parents, lines):

overrides bzrlib.versionedfile.VersionedFiles.add_lines

See VersionedFiles.add_lines

Lines are added locally, not to fallback versionedfiles. Also, ghosts are permitted. Only reserved ids are permitted.

def get_record_stream(self, keys, ordering, include_delta_closure):

overrides bzrlib.versionedfile.VersionedFiles.get_record_stream

Get a stream of records for keys.

Parameters	keys	The keys to include.
	ordering	Either 'unordered' or 'topological'. A topologically sorted stream has compression parents strictly before their children.
	include_delta_closure	If True then the closure across any compression parents will be included (in the opaque data).
Returns	An iterator of ContentFactory objects, each of which is only valid until the iterator is advanced.

b.v._PlanMergeVersionedFile(VersionedFiles) : class documentation