DM-31722: Migrate utility code from other packages #100
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #100 +/- ##
==========================================
+ Coverage 88.59% 90.87% +2.28%
==========================================
Files 24 36 +12
Lines 1420 2083 +663
==========================================
+ Hits 1258 1893 +635
- Misses 162 190 +28
Continue to review full report at Codecov.
|
2 tasks
timj
force-pushed
the
tickets/DM-31722
branch
from
8ca6dd6
to
851eb71
Compare
2 tasks
timj
commented
Oct 5, 2021
timj
commented
Oct 5, 2021
Uses a special subclass of logging.Logger to allow some period of migration for usage in existing Tasks.
LoggingAdapter can apply to the root logger so allows for more consistency in usage.
We may end up always using this special logger.
Caller code should be fixed to configure logging or lsst.log as needed.
* verbose and trace are generally useful and may indicate we should always be using this log adapter. * Trap large log levels and assume they are lsst.log constants. * Add more Logger compatibility forwarding.
Python does not provide fatal() method on LoggingAdapter even though it does provide warn().
For verbose/trace/infof etc the messages were being reported from the wrong line. Setting stacklevel allows the log to report the correct line.
For now, we attach these constants to the log adapter so that it is easier to access the VERBOSE and TRACE constants. Do not deprecated any of them since python logging does not deprecated any (including WARN or FATAL). Getting the constants directly from the logger ensures self consistency for the Task user and hides the specific logging system from the Task.
For now assume that the log adapter for Task is going to exist as more than a transition class for the migration from lsst.log.
Since python itself does not deprecate it.
This makes the intent more explicit.
* iterable * chunk_iterable * isplit
This is a better fit. A deprecated version remains in the original location.
doImport can return Module or Type and this leads to mypy insisting on many additional checks in any code that uses doImport.
TallJimbo
approved these changes
Oct 6, 2021
This makes its purpose more obvious.
timj
commented
Oct 7, 2021
| """ | ||
| stacklevel = 1 # the default for `Logger.log` | ||
| stack = traceback.extract_stack() | ||
| for i, s in enumerate(reversed(stack)): |
There was a problem hiding this comment.
@ktlim this is what I did to ensure that the log message is reported from the caller code. Simple testing demonstrates that it works.
Co-authored-by: Jim Bosch <jbosch@astro.princeton.edu>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Code is coming from pipe_base and daf_butler.
Checklist
doc/changes