standardize logging.getLogger() to use __name__ (Issue #5369)#5376
standardize logging.getLogger() to use __name__ (Issue #5369)#5376Jatin-Khiyani wants to merge 2 commits into
Conversation
Replace hardcoded logger name strings with __name__ across analysis, coordinates, topology, converters, core and guesser modules. Some modules had mismatched names (e.g. coordinates/TRJ.py used "AMBER", coordinates/PDB.py had typo "PBD") — these are now corrected as a side effect of this change.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #5376 +/- ##
========================================
Coverage 93.85% 93.85%
========================================
Files 182 182
Lines 22509 22509
Branches 3202 3202
========================================
+ Hits 21125 21126 +1
Misses 922 922
+ Partials 462 461 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
There is only one concern with this change. It does consolidate all the loggers under a single I would say so since it would follow standard library guidelines. Also, the fact that the none of the existing tests blew up at this change shows that the "separate logger instance" behavior wasn't really considered in the original iteration of the code. |
orbeckst
left a comment
orbeckst
left a comment
There was a problem hiding this comment.
Overall looking good, please see comments.
|
|
||
| import logging | ||
|
|
||
| logger = logging.getLogger("MDAnalysis.coordinates.GROMOS11") |
| from . import base | ||
| from ..lib import util | ||
| from ..lib.util import store_init_arguments | ||
| logger = logging.getLogger("MDAnalysis.coordinates.AMBER") |
|
The docs build failure is not your fault, I raised #5410 for it. |
3 participants
Fixes #5369
Changes made in this Pull Request
logging.getLogger("MDAnalysis.x.y")with
logging.getLogger(__name__)across analysis, coordinates,topology, converters, core and guesser modules as per issue logging.getLogger() should follow a standardized syntax. #5369 request.
LLM / AI generated code disclosure
LLMs or other AI-powered tools (beyond simple IDE use cases) were used
in this contribution: yes
Used to understand the codebase and the existing logging patterns.
All code changes were made manually following the guidance in the issue.
PR Checklist
package/CHANGELOGfile updated?package/AUTHORS?Developers Certificate of Origin
I certify that I can submit this code contribution as described in the
Developer Certificate of Origin,
under the MDAnalysis LICENSE.
📚 Documentation preview 📚: https://mdanalysis--5376.org.readthedocs.build/en/5376/