creates project specific logger #233
Conversation
| @@ -3,7 +3,8 @@ name = "test_town" | |||
| time_periods = 24 | |||
| scale_factor = 0.0001 | |||
| crs = "EPSG:27700" | |||
| verbose = false | |||
| debug = false | |||
| verbose = true | |||
There was a problem hiding this comment.
In the fixed code, Will debug = false verbose = true in the config be equivalent to debug = false by setting level to debug?
There was a problem hiding this comment.
yes, I treat verbose as synonymous with debug (perhaps more like "debug mode"). So verbose = false same as debug = false and vice versa.
There was a problem hiding this comment.
I change to "debug" because the expectation is that you would set this to false unless you are actually debugging. Whereas "verbose" sounded more casual.
Basically i expect this to nearly always be false.
There was a problem hiding this comment.
Nice job!
I am wondering if it will be easy to use the existing function here to set different logging levels without introducing two parameters?
For example, verbose=info representing the loggings will be on INFO level
verbose=debug representing the loggings will be on DEBUG level
There was a problem hiding this comment.
The logging config change looks fine, although it would be nice to see more evidence of how you tested it locally and what happened.
On a different note - this is a user-facing change. If I'm understanding correctly, it's backwards compatible rather than breaking, but it's still a change that affects the user. As such, I think this is a minor version bump. Just looking at the current version: __version__ = "0.0.0". I think this moves it to "0.1.0".
Now might be a good time to create a CHANGELOG.md too (see here for a template), and to create a GitHub release.
well spotted! I changed the docs to push people to use either true or false. but it will also support specific levels. But I don't think really need to expose this to anyone. |
I tested by creating a "verbose" example config then checked to see if the "eroneous" logging is removed in the new branch. I say "locally" because as noted in the #150 behaviour does seem to vary my environment, most likely due to loose dependancies or sketch dev installs 🦡 . So happy if others want to check. This PR will silently make all existing state machine configs "quiet", which means we might be hiding weird behaviour on box. But the expectation is that no one will be running debug on a box in any case. Certainly not "unsupervised". I have added Change log but then removed release note - I do not want the duplication on a project that is entering retirement. |
|
Since also tested on our infra. Merging |
fixes #150 by changing to a "project specific logger" in main, rather than calling the default. This prevents setting the underlying dependancy loggers to debug. I have tested locally.
I've also changed the config key from
verbosetodebug. I feel this more accurately reflects the option. Old configs withverbose = truewill still work but elara will silently revert to debug = false. Normally i would think this is dodgy, but in this case I think it is appropriate.Docs and examples updated.