gfw.common.decorators.counter#

counter(items, logger=<Logger gfw.common.decorators (WARNING)>, message='{count}')[source]#

Decorator generator function to log the number of items that are being iterated.

This is particularly useful when you have a generator, you want to know its size but you don’t control the function that is going to iterate it.

Parameters:

  • items (Generator[Any, None, None]) – Items to be iterated.

  • logger (Logger) – The logger to use.

  • message (str) – The string template to use as message. Must include an entry for a “count” variable.

Return type:

Generator[Any, None, None]