Skip to content

Comments

Add stacklevel to warnings.warn() calls#476

Merged
martin-springer merged 65 commits intodevelopmentfrom
add-stacklevel-to-warnings
Feb 11, 2026
Merged

Add stacklevel to warnings.warn() calls#476
martin-springer merged 65 commits intodevelopmentfrom
add-stacklevel-to-warnings

Conversation

@martin-springer
Copy link
Collaborator

@martin-springer martin-springer commented Feb 4, 2026

Specify stacklevel parameter in all warnings.warn() calls to ensure warning messages point to user code rather than rdtools internals:

  • stacklevel=2: For public functions/methods called directly by users
  • stacklevel=3: For private helper methods called by public methods

Closes #327

Files updated:

  • analysis_chains.py: 6 warnings
  • filtering.py: 2 warnings
  • soiling.py: 4 warnings
  • plotting.py: 3 warnings
  • normalization.py: 1 warning
  • availability.py: 1 warning
  • clearsky_temperature.py: 2 warnings

Checklist

  • [ ] Code changes are covered by tests
  • [ ] Code changes have been evaluated for compatibility/integration with TrendAnalysis
  • [ ] New functions added to __init__.py
  • [ ] API.rst is up to date, along with other sphinx docs pages
  • Example notebooks are rerun and differences in results scrutinized
  • Updated changelog

Specify stacklevel parameter in all warnings.warn() calls to ensure
warning messages point to user code rather than rdtools internals:

- stacklevel=2: For public functions/methods called directly by users
- stacklevel=3: For private helper methods called by public methods

Files updated:
- analysis_chains.py: 6 warnings
- filtering.py: 2 warnings
- soiling.py: 4 warnings
- plotting.py: 3 warnings
- normalization.py: 1 warning
- availability.py: 1 warning
- clearsky_temperature.py: 2 warnings
@codecov-commenter
Copy link

codecov-commenter commented Feb 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.14%. Comparing base (674e384) to head (1ca9998).
⚠️ Report is 1 commits behind head on development.

Additional details and impacted files
@@               Coverage Diff               @@
##           development     #476      +/-   ##
===============================================
+ Coverage        95.96%   96.14%   +0.17%     
===============================================
  Files               12       12              
  Lines             2280     2280              
===============================================
+ Hits              2188     2192       +4     
+ Misses              92       88       -4     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

The stacklevel parameter changes which line of code is shown in warning
tracebacks. Add regex rule to sanitize these lines so tests pass regardless
of stacklevel values.
@martin-springer martin-springer changed the base branch from fix-numpy-and-pandas-compatibility to development February 4, 2026 22:06
@martin-springer martin-springer changed the base branch from development to fix-numpy-and-pandas-compatibility February 4, 2026 22:06
@martin-springer martin-springer changed the base branch from fix-numpy-and-pandas-compatibility to development February 4, 2026 22:08
@martin-springer martin-springer changed the base branch from development to fix-numpy-and-pandas-compatibility February 4, 2026 22:08
Base automatically changed from fix-numpy-and-pandas-compatibility to development February 11, 2026 20:15
@martin-springer martin-springer merged commit 9d09f90 into development Feb 11, 2026
18 checks passed
@martin-springer martin-springer deleted the add-stacklevel-to-warnings branch February 11, 2026 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants