diff options
author | Angelos Evripiotis <jevripiotis@bloomberg.net> | 2019-07-04 17:40:42 +0100 |
---|---|---|
committer | bst-marge-bot <marge-bot@buildstream.build> | 2019-07-05 09:44:45 +0000 |
commit | 68e5e5c1b7d4434a2310044a8e636ed3f23ff3cb (patch) | |
tree | 9a670bec10ae0cce46c6243ee5fae2a725ed0ba6 | |
parent | 7b94cd24ca00351cd7ece856ca815bc27038f091 (diff) | |
download | buildstream-aevri/messenger.tar.gz |
_messenger: clarify silent_nested behaviouraevri/messenger
Change the argument name on the 'silence' context manager, to avoid the
interpretation that non-nested messages may be silenced, or that it can
'un-silence' (it can't).
Be more specific about what 'important' means w.r.t. messages.
Require 'actually_silence' to be specified as a keyword, so that
callsites are easier to understand.
-rw-r--r-- | src/buildstream/_messenger.py | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/src/buildstream/_messenger.py b/src/buildstream/_messenger.py index 8764c0288..7dec93994 100644 --- a/src/buildstream/_messenger.py +++ b/src/buildstream/_messenger.py @@ -83,12 +83,17 @@ class Messenger(): # # A context manager to silence messages, this behaves in # the same way as the `silent_nested` argument of the - # timed_activity() context manager: especially - # important messages will not be silenced. + # timed_activity() context manager: all but + # _message.unconditional_messages will be silenced. + # + # Args: + # actually_silence (bool): Whether to actually do the silencing, if + # False then this context manager does not + # affect anything. # @contextmanager - def silence(self, silent_nested=True): - if not silent_nested: + def silence(self, *, actually_silence=True): + if not actually_silence: yield return @@ -108,7 +113,7 @@ class Messenger(): # context (Context): The invocation context object # unique_id (int): Optionally, the unique id of the plugin related to the message # detail (str): An optional detailed message, can be multiline output - # silent_nested (bool): If specified, nested messages will be silenced + # silent_nested (bool): If True, all but _message.unconditional_messages are silenced # @contextmanager def timed_activity(self, activity_name, *, unique_id=None, detail=None, silent_nested=False): @@ -131,7 +136,7 @@ class Messenger(): # Push activity depth for status messages message = Message(unique_id, MessageType.START, activity_name, detail=detail) self.message(message) - with self.silence(silent_nested): + with self.silence(actually_silence=silent_nested): yield except BstError: |