Skip to content

Deprecate usage of ndsl.Namelist#276

Merged
FlorianDeconinck merged 1 commit into
NOAA-GFDL:developfrom
romanc:romanc/deprecate-ndsl-namelist
Oct 23, 2025
Merged

Deprecate usage of ndsl.Namelist#276
FlorianDeconinck merged 1 commit into
NOAA-GFDL:developfrom
romanc:romanc/deprecate-ndsl-namelist

Conversation

@romanc
Copy link
Copy Markdown
Collaborator

@romanc romanc commented Oct 23, 2025

Description

This PR deprecates usage of ndsl.Namelist. I also tried to deprecate ndsl.NamelistDefaults but since we don't use it as a class (i.e. it's not a dataclass and we just have it as class to group things), there's no static constructor to (easily) intercept.

Context for the deprecation is issue #64 and @jjuyeonkim continued work in pyFV3, pySHiELD, and pace to get rid of the class. If we deprecate now (before the "M2 release"), we can remove the class as soon as it is not needed anymore in any of the downstream repositories.

How has this been tested?

New unit test checking for the deprecation message.

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
    N/A
  • I have made corresponding changes to the documentation (e.g. add new modules to docs/docstrings/)
    N/A
  • My changes generate no new warnings
    No, but that's the point here.
  • Any dependent changes have been merged and published in downstream modules
    N/A
  • New check tests, if applicable, are included

This PR deprecates usage of `ndsl.Namelist`. I also tried to deprecate
`ndsl.NamelistDefaults` but since we don't use it as a class (i.e. it's
not a dataclass and we just have it as class to group things), there's
no static constructor to (easily) intercept.
@romanc
Copy link
Copy Markdown
Collaborator Author

romanc commented Oct 23, 2025

/cc @twicki as discussed today.

@romanc romanc added the Scheduled for next Release To be merged before the next release label Oct 23, 2025
Copy link
Copy Markdown
Collaborator

@jjuyeonkim jjuyeonkim left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@FlorianDeconinck FlorianDeconinck added this pull request to the merge queue Oct 23, 2025
Merged via the queue into NOAA-GFDL:develop with commit 3c94b47 Oct 23, 2025
6 checks passed
@romanc romanc deleted the romanc/deprecate-ndsl-namelist branch October 24, 2025 07:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Scheduled for next Release To be merged before the next release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants