l.s.w.v.BatchedCountableIterator(CountableIterator) : class documentation

Part of lp.services.webapp.vocabulary View In Hierarchy

Known subclasses: lp.registry.vocabularies.SourcePackageNameIterator, lp.soyuz.model.binaryandsourcepackagename.BinaryAndSourcePackageNameIterator

A wrapping iterator with hook to create descriptions for its terms.
Method __iter__ See CountableIterator
Method __getitem__ See CountableIterator
Method getTermsWithDescriptions Return SimpleTerms with their titles properly fabricated.

Inherited from CountableIterator:

Method __init__ Construct a CountableIterator instance.
Method count Return the number of items in the iterator.
Method __len__ Undocumented
def __iter__(self):
overrides lp.services.webapp.vocabulary.CountableIterator.__iter__
See CountableIterator
def __getitem__(self, arg):
overrides lp.services.webapp.vocabulary.CountableIterator.__getitem__
See CountableIterator
def getTermsWithDescriptions(self, results):
overridden in lp.registry.vocabularies.SourcePackageNameIterator, lp.soyuz.model.binaryandsourcepackagename.BinaryAndSourcePackageNameIterator
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.