Do not use f-strings in log calls. #131
Conversation
It is in general bad practice; in particular if one want a structured logging handler that store the template string and the values separately, using f-strings makes it not possible. I belive there is also a question of actually calling the formatter on the interpolated values which is not done if the loging level is low enough. WHile it might not be too critical for micropip, I belive it is good practive to show the example.
|
I guess in a couple of places, |
|
See among other all the https://docs.astral.sh/ruff/rules/#flake8-logging-format-g |
|
Actually, if there is a ruff lint, why not add it. |
There was a problem hiding this comment.
Thanks @Carreau! I added all those logging stuff, and to be honest, I don't know much about the good logging practice. So please feel free to make suggestions if you found any issues with logging!
|
I think this is perfectly fine for a project like micropip, but I like to show good practice. Just think that for really huge webapp, like facebook level, you want to store the template string and the values separately (potentially you store the template string only once), and not ins a log file but with mysql with 1 column per value. So that you can ask "show me all the identical messages", and/or if one of the value is say a float like in And with that all those "don't use f-string" in logs will make sens. I don't personally do use those kind of infra, but just knowing the above made it make sens to me. |
|
The failing test isn't related to this PR (timeout in the chrome browser). Let me go ahead and merge. |
Thanks, I keep seeing those timeout, and don't know what to do about those. |
It is in general bad practice; in particular if one want a structured logging handler that store the template string and the values separately, using f-strings makes it not possible.
I believe there is also a question of actually calling the formatter on the interpolated values which is not done if the loging level is low enough.
While it might not be too critical for micropip, I belive it is good practive to show the example.