l.r.i.w.IPillarNameSet(Interface) : interface documentation

Part of lp.registry.interfaces.webservice View In Hierarchy

An object for searching across projects, project groups, and distros.

Projects, project groups, and distributions are collectively known as "pillars". This object lets you do a combined search across all types of pillars. It also gives you access to pillars that have been flagged by administrators as "featured" pillars.

Method __contains__ True if the given name is an active Pillar or an alias to one.
Method __getitem__ Get an active pillar by its name or any of its aliases.
Method getByName Return the pillar whose name or alias matches the given name.
Method count_search_matches Return the total number of Pillars matching :text:
Method search Return Projects/Project groups/Distros matching :text:.
Method add_featured_project Add a project to the featured project list.
Method remove_featured_project Remove a project from the featured project list.
def __contains__(name):
True if the given name is an active Pillar or an alias to one.
def __getitem__(name):
Get an active pillar by its name or any of its aliases.

If there's no pillar with the given name or there is one but it's inactive, raise NotFoundError.

def getByName(name, ignore_inactive=False):
Return the pillar whose name or alias matches the given name.

If ignore_inactive is True, then only active pillars are considered.

If no pillar is found, return None.

def count_search_matches(user, text):
Return the total number of Pillars matching :text:
@call_with(REQUEST_USER)
@operation_parameters(TextLine(u'Search text'), Int(u'Maximum number of items to return. This is a hard limit: any pagination you request will happen within this limit.', False))
@operation_returns_collection_of(IPillar)
@export_read_operation()
def search(user, text, limit):
Return Projects/Project groups/Distros matching :text:.

If :limit: is None, the default batch size will be used.

The results are ordered descending by rank.

def add_featured_project(project):
Add a project to the featured project list.
def remove_featured_project(project):
Remove a project from the featured project list.
API Documentation for Launchpad, generated by pydoctor at 2019-11-11 00:00:24.