gfw.common.decorators#

Module that contains simple function decorators.

Functions

counter

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

timing

Decorator to measure execution time of a function.
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]

timing(f, quiet=False, logger=<Logger gfw.common.decorators (WARNING)>, decimals=4)[source]#

Decorator to measure execution time of a function.

Parameters:

  • f (Callable[[...], Any]) – The function to time.

  • quiet (bool) – If true, doesn’t log the elapsed time.

  • logger (Logger) – The logger to use.

  • decimals (int) – How many decimals to use when rounding. Only used for logging.

Returns:

A wrapper around the original callable that returns a 2D tuple with:

  • Whatever the original callable returns.

  • The elapsed time.

Return type:

Callable