Skip to content

compare_namelists.py: allow comparing multiple namelist groups with same name #4989

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.

Sign up for GitHub

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

Open
jimmielin wants to merge 2 commits into
base: master
Choose a base branch
from
+59 −9
Open

compare_namelists.py: allow comparing multiple namelist groups with same name #4989

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
129ab10
compare_namelists: allow comparing multiple nl groups with same name …
jimmielin Jun 2, 2026
bf4d19b
Prettify display name
jimmielin Jun 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 59 additions & 9 deletions CIME/compare_namelists.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,18 @@ def _parse_namelists(namelist_lines, filename):
... /'''
>>> _parse_namelists(teststr.splitlines(), 'foo')
{'nml': {'val': ["'a brown cow'", "'a red hen'"]}}

>>> teststr = '''&nml
... val = 1
... /
... &nml
... val = 2
... /
... &nml
... val = 3
... /'''
>>> _parse_namelists(teststr.splitlines(), 'foo')
{'nml': {'val': '1'}, 'nml__2': {'val': '2'}, 'nml__3': {'val': '3'}}
"""

comment_re = re.compile(r"^[#!]")
Expand Down Expand Up @@ -272,12 +284,14 @@ def _parse_namelists(namelist_lines, filename):
)

current_namelist = namelist_re.match(line).groups()[0]
expect(
current_namelist not in rv,
"In file '{}', Duplicate namelist '{}'".format(
filename, current_namelist
),
)
# The Fortran standard allows multiple namelist groups with the
# same name (read sequentially). Use positional suffixes to
# distinguish them while preserving order for comparison.
if current_namelist in rv:
count = 2
while "{}__{}".format(current_namelist, count) in rv:
count += 1
current_namelist = "{}__{}".format(current_namelist, count)

rv[current_namelist] = {}

Expand Down Expand Up @@ -636,11 +650,45 @@ def _compare_namelists(gold_namelists, comp_namelists, case):
BASE: csw_specifier dict item DMS = 1.0*value.nc
COMP: csw_specifier dict item DMS = 1.0*other.nc
<BLANKLINE>

>>> gold = '''&nml
... val = 1
... /
... &nml
... val = 2
... /
... &nml
... val = 3
... /'''
>>> comp = '''&nml
... val = 1
... /
... &nml
... val = 20
... /'''
>>> comments = _compare_namelists(_parse_namelists(gold.splitlines(), 'g'),\
_parse_namelists(comp.splitlines(), 'c'), None)
>>> print(comments)
BASE: val = 2
COMP: val = 20
Missing namelist: nml (occurrence 3)
<BLANKLINE>
"""

def _display_name(namelist):
"""Translate internal 'nml__3' to 'nml (occurrence 3)'."""
if "__" in namelist:
parts = namelist.rsplit("__", 1)
if parts[1].isdigit():
return "{} (occurrence {})".format(parts[0], parts[1])
return namelist

different_namelists = {}
for namelist, gold_names in gold_namelists.items():
if namelist not in comp_namelists:
different_namelists[namelist] = ["Missing namelist: {}\n".format(namelist)]
different_namelists[namelist] = [
"Missing namelist: {}\n".format(_display_name(namelist))
]
else:
comp_names = comp_namelists[namelist]
for name, gold_value in gold_names.items():
Expand All @@ -663,15 +711,17 @@ def _compare_namelists(gold_namelists, comp_namelists, case):
for namelist in comp_namelists:
if namelist not in gold_namelists:
different_namelists[namelist] = [
"Found extra namelist: {}\n".format(namelist)
"Found extra namelist: {}\n".format(_display_name(namelist))
]

comments = ""
for namelist, nlcomment in different_namelists.items():
if len(nlcomment) == 1:
comments += nlcomment[0]
else:
comments += "Differences in namelist '{}':\n".format(namelist)
comments += "Differences in namelist '{}':\n".format(
_display_name(namelist)
)
comments += "".join(nlcomment)

return comments
Expand Down