l.c.i.g.IGitTraverser(Interface) : interface documentation

Part of lp.code.interfaces.gitlookup View In Hierarchy

Utility for traversing to an object that can have a Git repository.
Method traverse Traverse to the object referred to by a prefix of the 'segments'
Method traverse_path Traverse to the object referred to by 'path'.
def traverse(segments, owner=None):
Traverse to the object referred to by a prefix of the 'segments' iterable, starting from 'owner' if given.
ReturnsA tuple of:: * an IPerson, or None; * an IHasGitRepositories; * an IGitRepository, or None; * a trailing path segment, or None.
RaisesInvalidNamespaceIf the path cannot be parsed as a repository namespace.
InvalidProductNameIf the project component of the path is not a valid name.
NoSuchGitRepositoryIf there is a '+git' segment, but the following segment doesn't match an existing Git repository.
NoSuchPersonIf the first segment of the path begins with a '~', but we can't find a person matching the remainder.
NoSuchProductIf we can't find a project that matches the project component of the path.
NoSuchSourcePackageNameIf the source package referred to does not exist.
def traverse_path(path):
Traverse to the object referred to by 'path'.

All segments of 'path' must be consumed.

ReturnsA tuple of:: * an IPerson, or None; * an IHasGitRepositories; * an IGitRepository, or None.
RaisesInvalidNamespaceIf the path cannot be parsed as a repository namespace.
InvalidProductNameIf the project component of the path is not a valid name.
NoSuchGitRepositoryIf there is a '+git' segment, but the following segment doesn't match an existing Git repository.
NoSuchPersonIf the first segment of the path begins with a '~', but we can't find a person matching the remainder.
NoSuchProductIf we can't find a project that matches the project component of the path.
NoSuchSourcePackageNameIf the source package referred to does not exist.
API Documentation for Launchpad, generated by pydoctor at 2022-06-16 00:00:12.