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

Can mark Parameters as obsolete in fillDescriptions #47642

Merged
merged 1 commit into from
Mar 25, 2025

Conversation

Dr15Jones
Copy link
Contributor

PR description:

  • Obsolete parameters will cause a warning to be issued and then skipped in the validation.
  • The _cfi.py files will get a cms.obsolete parameter added which allows one to still set the parameter in python but will not be passed to the C++.

PR validation:

Framework unit tests pass and newly added tests also pass.

resolves cms-sw/framework-team#1317

@cmsbuild
Copy link
Contributor

cmsbuild commented Mar 20, 2025

cms-bot internal usage

@cmsbuild
Copy link
Contributor

-code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-47642/44180

Code check has found code style and quality issues which could be resolved by applying following patch(s)

@Dr15Jones
Copy link
Contributor Author

please test

@cmsbuild
Copy link
Contributor

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-47642/44182

@cmsbuild
Copy link
Contributor

A new Pull Request was created by @Dr15Jones for master.

It involves the following packages:

  • FWCore/ParameterSet (core)

@Dr15Jones, @makortel, @smuzaffar can you please review it and eventually sign? Thanks.
@makortel, @missirol, @wddgit this is something you requested to watch as well.
@antoniovilela, @mandrenguyen, @rappoccio, @sextonkennedy you are the release manager for this.

cms-bot commands are listed here

Comment on lines +142 to +143
ParameterDescriptionBase* addObsolete(U const& iLabel) {
if constexpr (std::is_same_v<T, edm::ParameterSetDescription>) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering if a short comment here (and below for the untracked) explaining why ParameterSetDescription needs a different treatment would be useful for a future reader?

@cmsbuild
Copy link
Contributor

+1

Size: This PR adds an extra 72KB to repository
Summary: https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-83502d/45113/summary.html
COMMIT: 3b46cbe
CMSSW: CMSSW_15_1_X_2025-03-20-1100/el8_amd64_gcc12
User test area: For local testing, you can use /cvmfs/cms-ci.cern.ch/week1/cms-sw/cmssw/47642/45113/install.sh to create a dev area with all the needed externals and cmssw changes.

Comparison Summary

Summary:

- Obsolete parameters will cause a warning to be issued and then skipped in the validation.
- The _cfi.py files will get a cms.obsolete parameter added which allows one to still set the parameter in python but will not be passed to the C++.
@cmsbuild
Copy link
Contributor

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-47642/44184

@cmsbuild
Copy link
Contributor

Pull request #47642 was updated. @Dr15Jones, @cmsbuild, @makortel, @smuzaffar can you please check and sign again.

@Dr15Jones
Copy link
Contributor Author

NOTE: I made a quick attempt at removing the obsolete parameter if it appeared in the ParameterSet being validated. That didn't work in my attempt (the code threw an exception saying an unnamed parameter was present). I'd like to put such behavior off until a later PR to give more time to understand exactly the behavior.

@Dr15Jones
Copy link
Contributor Author

please test

@cmsbuild
Copy link
Contributor

+1

Size: This PR adds an extra 72KB to repository
Summary: https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-83502d/45120/summary.html
COMMIT: 190f693
CMSSW: CMSSW_15_1_X_2025-03-20-1100/el8_amd64_gcc12
User test area: For local testing, you can use /cvmfs/cms-ci.cern.ch/week1/cms-sw/cmssw/47642/45120/install.sh to create a dev area with all the needed externals and cmssw changes.

Comparison Summary

Summary:

  • You potentially removed 1 lines from the logs
  • Reco comparison results: 6 differences found in the comparisons
  • DQMHistoTests: Total files compared: 50
  • DQMHistoTests: Total histograms compared: 3929449
  • DQMHistoTests: Total failures: 64
  • DQMHistoTests: Total nulls: 0
  • DQMHistoTests: Total successes: 3929365
  • DQMHistoTests: Total skipped: 20
  • DQMHistoTests: Total Missing objects: 0
  • DQMHistoSizes: Histogram memory added: 0.0 KiB( 49 files compared)
  • Checked 215 log files, 184 edm output root files, 50 DQM output files
  • TriggerResults: no differences found

@makortel
Copy link
Contributor

Comparison differences are related to #47071

@makortel
Copy link
Contributor

+core

@cmsbuild
Copy link
Contributor

This pull request is fully signed and it will be integrated in one of the next master IBs (tests are also fine). This pull request will now be reviewed by the release team before it's merged. @sextonkennedy, @antoniovilela, @mandrenguyen, @rappoccio (and backports should be raised in the release meeting by the corresponding L2)

@mandrenguyen
Copy link
Contributor

+1

@cmsbuild cmsbuild merged commit 5d817fc into cms-sw:master Mar 25, 2025
11 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.

Extend ParameterSet validation system to handle obsolete parameters
4 participants