Banner Builder

The BannerBuilder class is responsible for creating the banners that are displayed when using the command line interface to Watch Do.

Headers and footers are created in a format defined within this class that make use of the metadata that is passed into the build_header() and build_footer() methods.

As an example, the following code would return a header populated with the required metadata.

>>> BannerBuilder.build_header(
...     {'file1', 'file2'}, ModificationTime)
class watch_do.banner_builder.BannerBuilder[source]

This class creates the headers and footers (banners) containing metrics that are used predominantly by the command line interface.

Build the footer from the provided metadata.

This interpolates the metadata provided by the parameters into a predefined string that can be used as information to display after a change has occurred.

Parameters:
  • trigger_time (int) – A timestamp of when the doers were triggered.
  • trigger_cause (list) – A list of items that caused the doers to run. This list is joined with ‘, ‘ and the second to last and last item joined with ‘ and ‘.
  • doer_run_time (double) – The duration of time the doers took to run.
  • files (set) – A set containing the files that are currently being watched.
  • watch_method (Watcher) – A reference to the class that is being used to watch the files.
Returns:

A string containing the generated footer.
Return type:

str
static build_header(files, watch_method)[source]

Build a header from the provided metadata.

This interpolates the metadata provided by the parameters into a predefined string that can be used as information to display before a change has occurred.

Parameters:
  • files (set) – A set containing the files that are currently being watched.
  • watch_method (Watcher) – A reference to the class that is being used to watch the files.
Returns:

A string containing the generated header.
Return type:

str