l.r.v.SourcePackageNameIterator(BatchedCountableIterator) : class documentation

Part of lp.registry.vocabularies View In Hierarchy

A custom iterator for SourcePackageNameVocabulary.

Used to iterate over vocabulary items and provide full descriptions.

Note that the reason we use special iterators is to ensure that we only do the search for descriptions across source package names that we actually are attempting to list, taking advantage of the resultset slicing that BatchNavigator does.

Method getTermsWithDescriptions Return SimpleTerms with their titles properly fabricated.

Inherited from BatchedCountableIterator:

Method __iter__ See CountableIterator
Method __getitem__ See CountableIterator

Inherited from CountableIterator (via BatchedCountableIterator):

Method __init__ Construct a CountableIterator instance.
Method count Return the number of items in the iterator.
Method __len__ Undocumented
def getTermsWithDescriptions(self, results):
Return SimpleTerms with their titles properly fabricated.

This is a hook method that allows subclasses to implement their own [complex] calculations for what the term's title might be. It takes an iterable set of results based on that searchForTerms of the corresponding vocabulary does.

API Documentation for Launchpad, generated by pydoctor at 2022-06-16 00:00:12.