PR #20802 CLI: resolve jsonargparse deprecation warning

CLI: resolve jsonargparse deprecation warning #20802

Borda merged 2 commits into Lightning-AI:master from adamjstewart:fixes/jsonargparse-deprecation

adamjstewart34 days ago (edited 34 days ago)

What does this PR do?

The latest jsonargparse release deprecates set_config_read_mode in favor of set_parsing_settings. This results in the following warning message during testing:

../../../../../opt/hostedtoolcache/Python/3.13.3/x64/lib/python3.13/site-packages/lightning/pytorch/cli.py:52
  /opt/hostedtoolcache/Python/3.13.3/x64/lib/python3.13/site-packages/lightning/pytorch/cli.py:52: 
      By default only one JsonargparseDeprecationWarning per type is shown. To see all warnings set environment
      variable JSONARGPARSE_DEPRECATION_WARNINGS=all and to disable the warnings set
      JSONARGPARSE_DEPRECATION_WARNINGS=off.

../../../../../opt/hostedtoolcache/Python/3.13.3/x64/lib/python3.13/site-packages/lightning/pytorch/cli.py:52
  /opt/hostedtoolcache/Python/3.13.3/x64/lib/python3.13/site-packages/lightning/pytorch/cli.py:52: 
      set_config_read_mode was deprecated in v4.39.0 and will be removed in v5.0.0. Optional config read modes
      should now be set using function set_parsing_settings.

This PR defaults to the new function when available and falls back to the old function for older versions. This makes the code more futureproof and compatible with jsonargparse v5 once it is released. Let me know if you would rather replace the try-except with a version check.

Before submitting

Was this discussed/agreed via a GitHub issue? (not for typos and docs)
Did you read the contributor guideline, Pull Request section?
Did you make sure your PR does only one thing, instead of bundling different changes together?
Did you make sure to update the documentation with your changes? (if necessary)
Did you write any new necessary tests? (not for typos and docs)
Did you verify new and existing tests pass locally with your changes?
Did you list all the breaking changes introduced by this pull request?
Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

Reviewer checklist

Is this pull request ready for review? (if not, please submit in draft mode)
Check that all items from Before submitting are resolved
Make sure the title is self-explanatory and the description concisely explains the PR
Add labels and milestones (and optionally projects) to the PR so it can be classified

📚 Documentation preview 📚: https://pytorch-lightning--20802.org.readthedocs.build/en/20802/

CLI: resolve jsonargparse deprecation warning

d861366f

adamjstewart requested a review from