Part of bzrlib.branch View In Hierarchy
Known subclasses: bzrlib.branch.BzrBranch8, bzrlib.branch.FullHistoryBzrBranch
Note that it's "local" in the context of the filesystem; it doesn't really matter if it's on an nfs/smb/afs/coda/... share, as long as it's writable, and can be accessed via the normal filesystem API.
| Instance Variables | _transport | Transport for file operations on this branch's control files, typically pointing to the .bzr/branch directory. |
| repository | Repository for this branch. | |
| base | The url of the base directory for this branch; the one containing the .bzr directory. | |
| name | Optional colocated branch name as it exists in the control directory. |
| Method | __init__ | Create new branch object at a particular location. |
| Method | __str__ | Undocumented |
| Method | is_locked | Undocumented |
| Method | lock_write | Lock the branch for write operations. |
| Method | lock_read | Lock the branch for read operations. |
| Method | unlock | Undocumented |
| Method | peek_lock_mode | Return lock mode for the Branch: 'r', 'w' or None |
| Method | get_physical_lock_status | Undocumented |
| Method | print_file | See Branch.print_file. |
| Method | set_last_revision_info | Set the last revision of this branch. |
| Method | basis_tree | See Branch.basis_tree. |
| Method | get_stacked_on_url | Get the URL this branch is stacked against. |
| Method | set_push_location | See Branch.set_push_location. |
| Method | unbind | If bound, unbind |
| Method | bind | Bind this branch to the branch other. |
| Method | get_bound_location | Return the URL of the branch we are bound to. |
| Method | get_master_branch | Return the branch we are bound to. |
| Method | set_bound_location | Set the target where this branch is bound to. |
| Method | update | Synchronise this branch with the master branch if any. |
| Method | _get_base | Returns the directory containing the control directory. |
| Method | _get_config | Get the concrete config for just the config in this branch. |
| Method | _get_parent_location | Undocumented |
| Method | _set_parent_location | Undocumented |
| Method | _get_master_branch | Undocumented |
| Method | _read_last_revision_info | Undocumented |
| Method | _write_last_revision_info | Simply write out the revision id, with no checks. |
Inherited from Branch:
| Method | control_transport | Undocumented |
| Method | user_transport | Undocumented |
| Method | break_lock | Break a lock if one is present from another instance. |
| Static Method | open | Open the branch rooted at base. |
| Static Method | open_from_transport | Open the branch rooted at transport |
| Static Method | open_containing | Open an existing branch which contains url. |
| Method | get_config | Get a bzrlib.config.BranchConfig for this Branch. |
| Method | get_config_stack | Get a bzrlib.config.BranchStack for this Branch. |
| Method | dotted_revno_to_revision_id | Return the revision_id for a dotted revno. |
| Method | revision_id_to_dotted_revno | Given a revision id, return its dotted revno. |
| Method | get_revision_id_to_revno_map | Return the revision_id => dotted revno map. |
| Method | iter_merge_sorted_revisions | Walk the revisions for a branch in merge sorted order. |
| Method | leave_lock_in_place | Tell this branch object not to release the physical lock when this |
| Method | dont_leave_lock_in_place | Tell this branch object to release the physical lock when this |
| Method | get_append_revisions_only | Whether it is only possible to append revisions to the history. |
| Method | set_append_revisions_only | Undocumented |
| Method | set_reference_info | Set the branch location to use for a tree reference. |
| Method | get_reference_info | Get the tree_path and branch_location for a tree reference. |
| Method | fetch | Copy revisions from from_branch into this branch. |
| Method | get_old_bound_location | Return the URL of the branch we used to be bound to |
| Method | get_commit_builder | Obtain a CommitBuilder for this branch. |
| Method | get_revision_delta | Return the delta for one revision. |
| Method | set_revision_history | See Branch.set_revision_history. |
| Method | generate_revision_history | See Branch.generate_revision_history |
| Method | set_parent | See Branch.set_parent. |
| Method | set_stacked_on_url | Set the URL this branch is stacked against. |
| Method | revision_history | Return sequence of revision ids on this branch. |
| Method | revno | Return current revision number for this branch. |
| Method | last_revision | Return last revision id, or NULL_REVISION. |
| Method | last_revision_info | Return information about the last revision. |
| Method | import_last_revision_info | Set the last revision info, importing from another repo if necessary. |
| Method | import_last_revision_info_and_tags | Set the last revision info, importing from another repo if necessary. |
| Method | revision_id_to_revno | Given a revision id, return its revno |
| Method | get_rev_id | Find the revision id of the specified revno. |
| Method | pull | Mirror source into this branch. |
| Method | push | Mirror this branch into target. |
| Method | get_parent | Return the parent location of the branch. |
| Method | get_child_submit_format | Return the preferred format of submissions to this branch. |
| Method | get_submit_branch | Return the submit location of the branch. |
| Method | set_submit_branch | Return the submit location of the branch. |
| Method | get_public_branch | Return the public location of the branch. |
| Method | set_public_branch | Return the submit location of the branch. |
| Method | get_push_location | Return the None or the location to push this branch to. |
| Method | check_revno | Check whether a revno corresponds to any revision. |
| Method | check_real_revno | Check whether a revno corresponds to a real revision. |
| Method | clone | Clone this branch into to_bzrdir preserving all semantic values. |
| Method | sprout | Create a new line of development from the branch, into to_bzrdir. |
| Method | copy_content_into | Copy the content of self into destination. |
| Method | update_references | Undocumented |
| Method | check | Check consistency of the branch. |
| Method | create_clone_on_transport | Create a clone of this branch and its bzrdir. |
| Method | create_checkout | Create a checkout of a branch. |
| Method | reconcile | Make sure the data stored in this branch is consistent. |
| Method | reference_parent | Return the parent branch for a tree-reference file_id |
| Method | supports_tags | Undocumented |
| Method | automatic_tag_name | Try to automatically find the tag name for a revision. |
| Method | heads_to_fetch | Return the heads that must and that should be fetched to copy this |
| Method | _open_hook | Called by init to allow simpler extension of the base class. |
| Method | _activate_fallback_location | Activate the branch/repository from url as a fallback repository. |
| Method | _check_stackable_repo | Undocumented |
| Method | _extend_partial_history | Extend the partial history to include a given index |
| Method | _get_check_refs | Get the references needed for check(). |
| Method | _push_should_merge_tags | Should _basic_push merge this branch's tags into the target? |
| Method | _get_fallback_repository | Get the repository we fallback to at url. |
| Method | _get_tags_bytes | Get the bytes of a serialised tags dict. |
| Method | _get_nick | Undocumented |
| Method | _set_nick | Undocumented |
| Method | _lefthand_history | Undocumented |
| Method | _do_dotted_revno_to_revision_id | Worker function for dotted_revno_to_revision_id. |
| Method | _do_revision_id_to_dotted_revno | Worker function for revision_id_to_revno. |
| Method | _gen_revno_map | Create a new mapping from revision ids to dotted revnos. |
| Method | _filter_merge_sorted_revisions | Iterate over an inclusive range of sorted revisions. |
| Method | _filter_start_non_ancestors | Undocumented |
| Method | _set_revision_history | Undocumented |
| Method | _unstack | Change a branch to be unstacked, copying data as needed. |
| Method | _set_tags_bytes | Mirror method for _get_tags_bytes. |
| Method | _set_tags_bytes_locked | Undocumented |
| Method | _cache_revision_history | Set the cached revision history to rev_history. |
| Method | _cache_revision_id_to_revno | Set the cached revision_id => revno map to revision_id_to_revno. |
| Method | _clear_cached_state | Clear any cached data on this branch, e.g. cached revision history. |
| Method | _gen_revision_history | Return sequence of revision hashes on to this branch. |
| Method | _revision_history | Undocumented |
| Method | _set_config_location | Undocumented |
| Method | _get_config_location | Undocumented |
| Method | _run_post_change_branch_tip_hooks | Run the post_change_branch_tip hooks. |
| Method | _run_pre_change_branch_tip_hooks | Run the pre_change_branch_tip hooks. |
| Method | _synchronize_history | Synchronize last revision and revision history between branches. |
| Method | _get_checkout_format | Return the most suitable metadir for a checkout of this branch. |
| Method | _check_if_descendant_or_diverged | Ensure that revision_b is a descendant of revision_a. |
| Method | _revision_relations | Determine the relationship between two revisions. |
Inherited from ControlComponent (via Branch):
| Method | control_url | Undocumented |
| Method | user_url | Undocumented |
Inherited from _RelockDebugMixin:
| Method | _note_lock | Undocumented |
This is not intended for client use; see Branch.get_config for the public API.
Added in 1.14.
| Returns | An object supporting get_option and set_option. | |
| Parameters | token | A token to permit reacquiring a previously held and preserved lock. |
| Returns | A BranchWriteLockResult. | |
| Returns | A bzrlib.lock.LogicalLockResult. | |
The caller is responsible for checking that the revno is correct for this revision id.
It may be possible to set the branch last revision to an id not present in the repository. However, branches can also be configured to check constraints on history, in which case this may not be permitted.
| Raises | NotStacked | If the branch is not stacked. |
| UnstackableBranchFormat | If the branch does not support stacking. |
This does not push or pull data between the branches, though it does check for divergence to raise an error when the branches are not either the same, or one a prefix of the other. That behaviour may not be useful, so that check may be removed in future.
| Parameters | other | The branch to bind to (type: Branch) |
Older format branches cannot bind, please be sure to use a metadir branch.
| Returns | Either a Branch, or None | |
| Parameters | location | URL to the target branch |
| Returns | None or the last_revision that was pivoted out during the update. | |