Use loguru #303
Use loguru #303
Conversation
|
@orbeckst Do you mind have a check to see if you are happy with the new logger? How it works with other section of your code. I'm working on the doc now, where I plan to add a new miscellaneous section to the top level doc and a second level logging. Then in other places, I will just refer to this section. |
Codecov Report
@@ Coverage Diff @@
## master #303 +/- ##
==========================================
- Coverage 98.75% 98.75% -0.01%
==========================================
Files 27 27
Lines 1773 1762 -11
Branches 388 388
==========================================
- Hits 1751 1740 -11
Misses 2 2
Partials 20 20
|
docs/miscellaneous/logging.rst
Outdated
| ======= | ||
|
|
||
| In **alchemlyb**, we use :mod:`loguru` for logging. By default, the | ||
| :mod:`loguru` will print the logging information into the `stderr`. |
There was a problem hiding this comment.
Can you link to sys.stderr in the Python docs?
| from loguru import logger | ||
| logger.remove() | ||
|
|
||
| Then add other custom sink :: |
There was a problem hiding this comment.
Link to a page that explains what the format does, filter etc — basically the docs for logger.add
src/alchemlyb/estimators/mbar_.py
Outdated
| :func:`scipy.optimize.root`. | ||
|
|
||
| verbose : bool, optional | ||
| Set to ``True`` if verbose debug output from :mod:`pymbar` is desired. | ||
| Output from alchemlyb is logged via :mod:`logging`. | ||
| Output from alchemlyb is logged via :mod:`loguru`. |
There was a problem hiding this comment.
remove as no logging done here?
docs/miscellaneous.rst
Outdated
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| :caption: Miscellaneous |
There was a problem hiding this comment.
I'd remove the TOC caption — looks superfluous as it is repeated, see https://alchemlyb--303.org.readthedocs.build/en/303/miscellaneous.html
There was a problem hiding this comment.
Sorry, what do you mean by this? I could change the :maxdepth: 2 to 1, if Print to the stderr and Save to a file is superfluous?
|
@orbeckst Thanks for the review. I have addressed the changes. |
xiki-tempula
force-pushed
the
301-using-loguru
branch
from
ebf6b52 to
40c6611
Compare
Switch to use loguru for logging
Fix #301