b.t.t.SampleBranchFormat(_mod_branch.BranchFormat) : class documentation

Part of bzrlib.tests.test_branch View In Hierarchy

A sample format

this format is initializable, unsupported to aid in testing the open and open_downlevel routines.

Method get_format_string See BzrBranchFormat.get_format_string().
Method initialize Format 4 branches cannot be created.
Method is_supported Is this format supported?
Method open Return the branch object for controldir.

Inherited from BranchFormat:

Method __eq__ Undocumented
Method __ne__ Undocumented
Class Method find_format Return the format for the branch object in controldir.
Class Method get_default_format Return the current default format.
Class Method get_formats Get all the known formats.
Method get_reference Get the target reference of the branch in controldir.
Class Method set_reference Set the target reference of the branch in controldir.
Method get_format_description Return the short format description for this format.
Method make_tags Create a tags object for branch.
Method network_name A simple byte string uniquely identifying this format for RPC calls.
Class Method register_format Register a metadir format.
Class Method set_default_format Undocumented
Method supports_set_append_revisions_only True if this format supports set_append_revisions_only.
Method supports_stacking True if this format records a stacked-on branch.
Method supports_leaving_lock True if this format supports leaving locks in place.
Class Method unregister_format Undocumented
Method __str__ Undocumented
Method supports_tags True if this format supports tags stored in the branch
Method tags_are_versioned Whether the tag container for this branch versions tags.
Method supports_tags_referencing_ghosts True if tags can reference ghost revisions.
Method _run_post_branch_init_hooks Undocumented

Inherited from ControlComponentFormat (via BranchFormat):

Method check_support_status Give an error or warning on old formats.
def get_format_string(self):
See BzrBranchFormat.get_format_string().
def initialize(self, a_bzrdir, name=None, repository=None, append_revisions_only=None):
Format 4 branches cannot be created.
def is_supported(self):
Is this format supported?

Supported formats can be initialized and opened. Unsupported formats may not support initialization or committing or some other features depending on the reason for not being supported.

def open(self, transport, name=None, _found=False, ignore_fallbacks=False):
Return the branch object for controldir.
ParameterscontroldirA ControlDir that contains a branch.
nameName of colocated branch to open
_founda private parameter, do not use it. It is used to indicate if format probing has already be done.
ignore_fallbackswhen set, no fallback branches will be opened (if there are any). Default is to open fallbacks.
API Documentation for Bazaar, generated by pydoctor at 2021-10-27 00:27:45.