b.b.InterBranch(InterObject) : class documentation

Part of bzrlib.branch View In Hierarchy

Known subclasses: bzrlib.branch.GenericInterBranch

This class represents operations taking place between two branches.

Its instances have methods like pull() and push() and contain references to the source and target repositories these operations can be carried out on.

Method pull Mirror source into target branch.
Method push Mirror the source branch into the target branch.
Method copy_content_into Copy the content of source into target
Method fetch Fetch revisions.
Class Method _get_branch_formats_to_test Return an iterable of format tuples for testing.

Inherited from InterObject:

Method __init__ Construct a default InterObject instance. Please use 'get'.
Class Method get Retrieve a Inter worker object for these objects.
Method lock_read Take out a logical read lock.
Method lock_write Take out a logical write lock.
Class Method register_optimiser Register an InterObject optimiser.
Method unlock Release the locks on source and target.
Class Method unregister_optimiser Unregister an InterObject optimiser.
Method _double_lock Take out two locks, rolling back the first if the second throws.
@classmethod
def _get_branch_formats_to_test(klass):
Return an iterable of format tuples for testing.
ReturnsAn iterable of (from_format, to_format) to use when testing this InterBranch class. Each InterBranch class should define this method itself.
@needs_write_lock
def pull(self, overwrite=False, stop_revision=None, possible_transports=None, local=False):
Mirror source into target branch.

The target branch is considered to be 'local', having low latency.

ReturnsPullResult instance
@needs_write_lock
def push(self, overwrite=False, stop_revision=None, lossy=False, _override_hook_source_branch=None):
Mirror the source branch into the target branch.

The source branch is considered to be 'local', having low latency.

@needs_write_lock
def copy_content_into(self, revision_id=None):

Copy the content of source into target

revision_id: if not None, the revision history in the new branch will
be truncated to end with revision_id.
@needs_write_lock
def fetch(self, stop_revision=None, limit=None):
Fetch revisions.
Parametersstop_revisionLast revision to fetch
limitOptional rough limit of revisions to fetch
API Documentation for Bazaar, generated by pydoctor at 2019-07-17 00:29:20.