b.r.RevisionSpec(object) : class documentation

Part of bzrlib.revisionspec View In Hierarchy

Known subclasses: bzrlib.revisionspec.RevisionIDSpec, bzrlib.revisionspec.RevisionSpec_ancestor, bzrlib.revisionspec.RevisionSpec_before, bzrlib.revisionspec.RevisionSpec_branch, bzrlib.revisionspec.RevisionSpec_date, bzrlib.revisionspec.RevisionSpec_dwim, bzrlib.revisionspec.RevisionSpec_last, bzrlib.revisionspec.RevisionSpec_revno, bzrlib.revisionspec.RevisionSpec_tag, bzrlib.tests.test_revisionspec.RevisionSpec_bork, bzrlib.tests.test_revisionspec.RevisionSpecMatchOnTrap

A parsed revision specification.
Static Method from_string Parse a revision spec string into a RevisionSpec object.
Method __init__ Create a RevisionSpec referring to the Null revision.
Method in_history Undocumented
Method as_revision_id Return just the revision_id for this revisions spec.
Method as_tree Return the tree object for this revisions spec.
Method __repr__ Undocumented
Method needs_branch Whether this revision spec needs a branch.
Method get_branch When the revision specifier contains a branch location, return it.
Method _match_on Undocumented
Method _match_on_and_check Undocumented
Method _as_revision_id Implementation of as_revision_id()
Method _as_tree Implementation of as_tree().
@staticmethod
def from_string(spec):
Parse a revision spec string into a RevisionSpec object.
ParametersspecA string specified by the user
ReturnsA RevisionSpec object that understands how to parse the supplied notation.
def __init__(self, spec, _internal=False):
Create a RevisionSpec referring to the Null revision.
ParametersspecThe original spec supplied by the user
_internalUsed to ensure that RevisionSpec is not being called directly. Only from RevisionSpec.from_string()
def _match_on(self, branch, revs):
Undocumented
def _match_on_and_check(self, branch, revs):
Undocumented
def in_history(self, branch):
Undocumented
def as_revision_id(self, context_branch):
Return just the revision_id for this revisions spec.

Some revision specs require a context_branch to be able to determine their value. Not all specs will make use of it.

def _as_revision_id(self, context_branch):
Implementation of as_revision_id()

Classes should override this function to provide appropriate functionality. The default is to just call '.in_history().rev_id'

def as_tree(self, context_branch):
Return the tree object for this revisions spec.

Some revision specs require a context_branch to be able to determine the revision id and access the repository. Not all specs will make use of it.

def _as_tree(self, context_branch):
Implementation of as_tree().

Classes should override this function to provide appropriate functionality. The default is to just call '.as_revision_id()' and get the revision tree from context_branch's repository.

def __repr__(self):
Undocumented
def needs_branch(self):
Whether this revision spec needs a branch.

Set this to False the branch argument of _match_on is not used.

def get_branch(self):
When the revision specifier contains a branch location, return it.

Otherwise, return None.

API Documentation for Bazaar, generated by pydoctor at 2019-07-20 00:30:16.