Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Overhaul logging system #119

Merged
merged 12 commits into from
Mar 17, 2024
Merged

Overhaul logging system #119

merged 12 commits into from
Mar 17, 2024

Conversation

rkingsbury
Copy link
Member

@rkingsbury rkingsbury commented Mar 13, 2024

Summary

The warning / logging system in pyEQL has been intentionally verbose and a bit haphazard, prompting confusion on the part of users (see #52 ). This PR overhauls the logging system by

  1. Changing the loggers to conform more closely to python best practices
  2. Adding a log_level kwarg to Solution.__init__ that allows users to control the level of verbosity of the messages they will see in stdout
  3. Using logging levels (INFO/CRITICAL/ERROR/WARNING/DEBUG) rather than warnings in most cases

Closes #52

@rkingsbury rkingsbury added enhancement release:minor will issue a minor release labels Mar 13, 2024
Copy link

codecov bot commented Mar 13, 2024

Codecov Report

Attention: Patch coverage is 70.23810% with 25 lines in your changes are missing coverage. Please review.

Project coverage is 82.08%. Comparing base (296be67) to head (9612d19).
Report is 9 commits behind head on main.

Files Patch % Lines
src/pyEQL/solution.py 62.50% 17 Missing and 1 partial ⚠️
src/pyEQL/engines.py 76.92% 3 Missing ⚠️
src/pyEQL/equilibrium.py 50.00% 3 Missing ⚠️
src/pyEQL/activity_correction.py 85.71% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #119      +/-   ##
==========================================
- Coverage   82.22%   82.08%   -0.15%     
==========================================
  Files          10        9       -1     
  Lines        1463     1457       -6     
  Branches      294      294              
==========================================
- Hits         1203     1196       -7     
  Misses        221      221              
- Partials       39       40       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rkingsbury rkingsbury removed the release:minor will issue a minor release label Mar 17, 2024
@rkingsbury rkingsbury merged commit f92de70 into main Mar 17, 2024
11 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Quiet and deduplicate logging messages
1 participant