voussoir/voussoirkit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Improve operatornotify module docstring.

Browse source
This commit is contained in:
voussoir 2021-07-02 02:59:34 -07:00
parent 26040d4372
commit 2971d7e4d6
No known key found for this signature in database
GPG key ID: 5F7554F8C26DACCB
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
voussoirkit/operatornotify.py
View file

@ -5,7 +5,7 @@ operatornotify
This module is designed to notify the program operator of important events. This module is designed to notify the program operator of important events.
By default, it just logs at the WARNING level, but if you create your own By default, it just logs at the WARNING level, but if you create your own
file my_operatornotify.py somewhere on your PYTHONPATH with a function file my_operatornotify.py somewhere on your PYTHONPATH with a function
notify(subject, body=''), all calls to this module will go there. notify(subject, body=''), all calls to operatornotify.notify will go there.
For example, you might define your own file that sends emails, texts, or MQTT. For example, you might define your own file that sends emails, texts, or MQTT.
This allows the same calling code to behave differently on your dev / prod This allows the same calling code to behave differently on your dev / prod
environments, or other use cases you can imagine. environments, or other use cases you can imagine.
@ -26,9 +26,10 @@ This module should ONLY be called by application code, not library code.
Ideally, the application should provide a flag --operatornotify for the user Ideally, the application should provide a flag --operatornotify for the user
to opt-in to the use of operatornotify so that it does not surprise them. to opt-in to the use of operatornotify so that it does not surprise them.
If your application already uses the logging module, consider adding an If your application already uses the logging module, consider these options:
instance of operatornotify.LogHandler to your logger, or wrapping your whole - add an instance of operatornotify.LogHandler to your logger,
main call in a LogHandlerContext. - wrap your whole main call in a LogHandlerContext, or
- add @operatornotify.main_decorator to your main function.
Commandline usage: Commandline usage: