b.c.Prober(object) : class documentation

Part of bzrlib.controldir View In Hierarchy

Known subclasses: bzrlib.bzrdir.BzrProber, bzrlib.bzrdir.RemoteBzrProber, bzrlib.tests.test_controldir.NotBzrDirProber, bzrlib.tests.test_foreign.DummyForeignProber

Abstract class that can be used to detect a particular kind of control directory.

At the moment this just contains a single method to probe a particular transport, but it may be extended in the future to e.g. avoid multiple levels of probing for Subversion repositories.

See BzrProber and RemoteBzrProber in bzrlib.bzrdir for the probers that detect .bzr/ directories and Bazaar smart servers, respectively.

Probers should be registered using the register_server_prober or register_prober methods on ControlDirFormat.

Method probe_transport Return the controldir style format present in a directory.
Class Method known_formats Return the control dir formats known by this prober.
def probe_transport(self, transport):
Return the controldir style format present in a directory.
ReturnsA ControlDirFormat instance.
RaisesUnknownFormatErrorIf a control dir was found but is in an unknown format.
NotBranchErrorIf no control directory was found.
@classmethod
def known_formats(klass):
Return the control dir formats known by this prober.

Multiple probers can return the same formats, so this should return a set.

ReturnsA set of known formats.
API Documentation for Bazaar, generated by pydoctor at 2019-06-26 00:19:43.