Splitattrs ncsave redo #5410

pp-mo · 2023-08-01T18:43:49Z

Closes #4986

Rework of #5404 with ...

new unified testcase setup + checking code for existing tests.
saver split-attributes control (but no testing yet)

STILL TO DO :

add additional TestSave testcases, specific to newstyle global+local cube attributes.
parametrise TestSave and TestRoundtrip to test with/without FUTURE.save_split_attrs enabled
- (and capture the differences)
add "matrix" testing for all combinations of (attribute class, test operation, with/without split-attrs-saving)
- against a captured results "snapshot" (to detect future changes)

… (cf. SciTools#5403).

codecov · 2023-08-01T18:55:32Z

Codecov Report

Attention: 6 lines in your changes are missing coverage. Please review.

Comparison is base (68eaa53) 89.41% compared to head (eea99d1) 89.42%.
Report is 1 commits behind head on FEATURE_split_attrs.

Additional details and impacted files

@@                   Coverage Diff                   @@
##           FEATURE_split_attrs    #5410      +/-   ##
=======================================================
+ Coverage                89.41%   89.42%   +0.01%     
=======================================================
  Files                       89       89              
  Lines                    22500    22543      +43     
  Branches                  5396     5410      +14     
=======================================================
+ Hits                     20119    20160      +41     
- Misses                    1636     1638       +2     
  Partials                   745      745

Files	Coverage Δ
lib/iris/cube.py	`90.98% <100.00%> (+0.01%)`	⬆️
lib/iris/__init__.py	`88.97% <50.00%> (+0.08%)`	⬆️
lib/iris/fileformats/netcdf/saver.py	`89.48% <93.84%> (+0.22%)`	⬆️

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

lib/iris/__init__.py

lib/iris/cube.py

lib/iris/fileformats/netcdf/saver.py

…ed).

trexfeathers

OK here are some more comments. I still need to look at the tests.

The changes here demonstrate how much better it is to now have the CubeAttrsDict managing things, allowing the user to see what is happening during their scripts, rather than a load of 'magic' happening during save.

lib/iris/fileformats/netcdf/saver.py

trexfeathers

OK I have read through the tests as they are currently and they make sense. I hope to spend some more time thinking about anything that needs to be added (different to just reading what is in front of me!)

lib/iris/tests/integration/test_netcdf__loadsaveattrs.py

…types.

…ing.

pp-mo · 2023-08-22T00:05:18Z

N.B. the pass for commit 8987a26 tests the new code against snapshotted behaviours from v3.6.1.
This shows that the new code does not introduce any behaviour changes to the programmed testcases, when reading cube attributes as a single dict and not enabling save-split-attrs.

However, the matrix testing does not currently cover all the "special-case" attributes which the loader and saver may treat differently, e.g. "Conventions" or "STASH".
If it is thought necessary, we could still add these to matrix testing (as further unique attribute "styles"), or we could add specific tests for (some usecases of) them .

pp-mo · 2023-08-22T00:15:48Z

The "matrix" testing obviously adds a lot of tests (~2000). And these are integrational tests all of which read+write test netcdf files. Which obviously raises some performance concerns,
However, the measured effects on performance are not seen to be that big. Perhaps they parallelise well ? ...

timings and counts of total tests :

/python	3.11	3.10	3.9	n-tests
commits
(PR)
`cbd7167`	07:46	04:50	04:25	9172
`8987a26`	08:12	05:51	05:44	9172
(main)
687f4a	10:19	06:30	07:16	6995
ff897e	08:10	05:55	06:01
368c2d	07:25	05:09	05:05
(v3.6.1)
d6c6c9	06:00	03:54	04:12	6981

lib/iris/tests/integration/test_netcdf__loadsaveattrs.py

trexfeathers

I've looked at the changes from fb343ae onwards and it looks good to me! I'm happy that you have written something that can capture any change in behaviour going forward, as well as demonstrating how behaviour has changed as part of this work. Great job!

lib/iris/tests/integration/test_netcdf__loadsaveattrs.py

trexfeathers · 2023-10-02T15:08:23Z

@pp-mo is there anything left outstanding that you want to do before I merge this?

pp-mo · 2023-10-04T11:04:57Z

@pp-mo is there anything left outstanding that you want to do before I merge this?

No nothing specific. If you're happy then we can bank it, which will be a relief !
I will then re-merge from latest main, and submit a proper PR for #5444 - which I think is the final piece of the jigsaw.

trexfeathers · 2023-10-10T11:05:51Z

Alright, that's merged. Ready for the next tranche you have mentioned 📭

pp-mo · 2023-10-10T12:14:25Z

@trexfeathers fantastic !
Coming right up ...

pp-mo added 2 commits July 28, 2023 13:56

Add docs and future switch, no function yet.

83eee13

Typing enables code completion for Cube.attributes.

ce5cdef

pp-mo changed the base branch from main to FEATURE_split_attrs August 1, 2023 18:44

Make roundtrip checking more precise + improve some tests accordingly…

4d660b6

… (cf. SciTools#5403).

pp-mo force-pushed the splitattrs_ncsave_redo branch from d0a330a to 068bd48 Compare August 1, 2023 18:45

pp-mo force-pushed the splitattrs_ncsave_redo branch 2 times, most recently from 5d82b1f to 8ddc88d Compare August 2, 2023 23:02

pp-mo mentioned this pull request Aug 2, 2023

Splitattrs ncsave #5404

Closed

pp-mo added 3 commits August 3, 2023 00:31

Rework all tests to use common setup + results-checking code.

9a80cd2

Saver supports split-attributes saving (no tests yet).

4ecef96

Tiny docs fix.

78aaebb

pp-mo force-pushed the splitattrs_ncsave_redo branch from ed17fb5 to 78aaebb Compare August 2, 2023 23:31

pp-mo mentioned this pull request Aug 2, 2023

split-attrs: netcdf saver #4986

Closed

trexfeathers self-requested a review August 3, 2023 13:38

trexfeathers self-assigned this Aug 3, 2023

trexfeathers reviewed Aug 3, 2023

View reviewed changes

lib/iris/__init__.py Outdated Show resolved Hide resolved

trexfeathers reviewed Aug 3, 2023

View reviewed changes

lib/iris/cube.py Show resolved Hide resolved

trexfeathers reviewed Aug 3, 2023

View reviewed changes

lib/iris/fileformats/netcdf/saver.py Outdated Show resolved Hide resolved

Explain test routines better.

54f344c

pp-mo force-pushed the splitattrs_ncsave_redo branch from b07af3f to 54f344c Compare August 3, 2023 16:24

pp-mo added 4 commits August 3, 2023 17:32

Fix init of FUTURE object.

edc9899

Remove spurious re-test of FUTURE.save_split_attrs.

d242506

Don't create Cube attrs of 'None' (n.b. but no effect as currently us…

8d7ad2a

…ed).

Remove/repair refs to obsolete routines.

8aa5311

trexfeathers requested changes Aug 4, 2023

View reviewed changes

pp-mo added 3 commits August 5, 2023 00:03

Check all warnings from save operations.

f87550b

Remove TestSave test numbers.

30d62c2

More save cases: no match with missing, and different cube attribute …

fb13770

…types.

pp-mo added 3 commits August 18, 2023 16:54

Working with iris 3.6.1, no errors TestSave or TestRoundtrip.

e5d5ff9

Interim save (incomplete?).

42fce92

Different results form for split tests; working for roundtrip.

19a2956

pp-mo force-pushed the splitattrs_ncsave_redo branch from d305f30 to 19a2956 Compare August 21, 2023 10:55

pp-mo added 9 commits August 21, 2023 12:12

Check that all param lists are sorted.

59d05dc

Check matrix result-files compatibility; add test_save_matrix.

1770d97

test_load_matrix added; two types of load result.

b67f510

Finalise special-case attributes.

2576826

Small docs tweaks.

e201a8e

Add some more testcases,

4602f06

Ensure valid sort-order for globals of possibly different types.

2377c89

Initialise matrix results with legacy values from v3.6.1 -- all match…

8987a26

…ing.

Add full current matrix results, i.e. snapshot current behaviours.

cbd7167

pp-mo marked this pull request as ready for review August 22, 2023 09:48

pp-mo linked an issue Aug 22, 2023 that may be closed by this pull request

split-attrs: netcdf saver #4986

Closed

This was referenced Aug 22, 2023

Common metadata operations on split-attributes #5444

Closed

Define common-metadata operations on split attribute dictionaries. pp-mo/iris#77

Closed

pp-mo commented Sep 7, 2023

View reviewed changes

lib/iris/tests/integration/test_netcdf__loadsaveattrs.py Show resolved Hide resolved

pp-mo commented Sep 7, 2023

View reviewed changes

lib/iris/tests/integration/test_netcdf__loadsaveattrs.py Show resolved Hide resolved

trexfeathers approved these changes Oct 2, 2023

View reviewed changes

lib/iris/tests/integration/test_netcdf__loadsaveattrs.py Outdated Show resolved Hide resolved

Review changes : rename some matrix testcases, for clarity.

eea99d1

trexfeathers merged commit fa7962e into SciTools:FEATURE_split_attrs Oct 10, 2023

pp-mo deleted the splitattrs_ncsave_redo branch July 9, 2025 11:28

Splitattrs ncsave redo #5410

Splitattrs ncsave redo #5410

Uh oh!

Conversation

pp-mo commented Aug 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Aug 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

trexfeathers left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

trexfeathers left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pp-mo commented Aug 22, 2023

Uh oh!

pp-mo commented Aug 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

trexfeathers left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

trexfeathers commented Oct 2, 2023

Uh oh!

pp-mo commented Oct 4, 2023

Uh oh!

trexfeathers commented Oct 10, 2023

Uh oh!

pp-mo commented Oct 10, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

pp-mo commented Aug 1, 2023 •

edited

Loading

codecov bot commented Aug 1, 2023 •

edited

Loading

pp-mo commented Aug 22, 2023 •

edited

Loading