Draft: POC #607
Draft: POC #607
Conversation
There was a problem hiding this comment.
Thank you for your work, it's great.
-
Could you also provide a detailed description in your PR to summarize your work so that other reviewers can quickly get the information about your PR?
-
The idea would be to separate your test commits from the code modifications more clearly in the future.
-
I still think that modifying an example to demonstrate the use of logging could be relevant.
| @@ -74,7 +74,7 @@ def test_init(self) -> None: | |||
| if "NaNs found in dDEM" not in str(exception): | |||
| raise exception | |||
|
|
|||
| # print(cumulative_dh) | |||
| # logging.info(cumulative_dh) | |||
There was a problem hiding this comment.
@rhugonnet, @adehecq : How should we handle this line that appears to be debugging?
There was a problem hiding this comment.
Can leave as is or simply delete!
The DEMCollection is an old module from the start of the package, that we are discussing about removing or re-factoring from scratch, so it's not very important.
| @@ -189,12 +188,10 @@ def _iterate_method( | |||
|
|
|||
| # Print final results | |||
| # TODO: Allow to pass a string to _iterate_method on how to print/describe exactly the iterating input | |||
| if verbose: | |||
| pbar.write(f" Iteration #{i + 1:d} - Offset: {new_inputs}; Magnitude: {new_statistic}") | |||
| logging.debug(" Iteration #%d - Offset: %s; Magnitude: %s", i + 1, new_inputs, new_statistic) | |||
There was a problem hiding this comment.
Is pbar.write really just a simple print?
doc/source/logging.md
Outdated
| name: xdem | ||
| --- | ||
| # Logging configuration | ||
| TO configure logging for xDEM, you can utilize Python's built-in `logging` module. Begin by setting up the logging |
There was a problem hiding this comment.
The first "TO" has an extra capital letter, doesn't it?
doc/source/logging.md
Outdated
| ]) | ||
| ``` | ||
| This configuration will log messages with a severity level of `INFO` and above, including timestamps, logger names, and | ||
| log levels in the output. You can change the logging level to `DEBUG`, `WARNING`, `ERROR` or `CRITICAL` as needed. |
There was a problem hiding this comment.
Did you manage to build the documentation?
|
NB: Do not merge this branch; it serves as a base for a POC branch. |
# Conflicts: # doc/source/logging.md # tests/test_coreg/test_affine.py # tests/test_coreg/test_base.py # tests/test_coreg/test_biascorr.py # tests/test_spatialstats.py # xdem/coreg/affine.py # xdem/coreg/base.py # xdem/coreg/workflows.py # xdem/spatialstats.py # xdem/volume.py
|
Copy of MR #610 |
Replace
printstatements withloggingResolves #565
Summary
This pull request addresses the transition from using
print()statements to the Pythonloggingmodule. The update improves flexibility for managing output messages.Changes made:
printwith appropriate logging levels (debug,info,warning,error)verboseflag in favor of log levelsf-stringswith%formatting in logging statements to comply withpylintrequirementsDocumentation
Updated the documentation to include instructions on how users can configure logging verbosity.