-
Notifications
You must be signed in to change notification settings - Fork 283
/
test_CubeMetadata.py
1167 lines (1008 loc) · 43.5 KB
/
test_CubeMetadata.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright Iris contributors
#
# This file is part of Iris and is released under the LGPL license.
# See COPYING and COPYING.LESSER in the root of the repository for full
# licensing details.
"""
Unit tests for the :class:`iris.common.metadata.CubeMetadata`.
"""
# Import iris.tests first so that some things can be initialised before
# importing anything else.
import iris.tests as tests # isort:skip
from copy import deepcopy
import unittest.mock as mock
from unittest.mock import sentinel
import pytest
from iris.common.lenient import _LENIENT, _qualname
from iris.common.metadata import BaseMetadata, CubeMetadata
from iris.cube import CubeAttrsDict
from iris.tests.integration.test_netcdf__loadsaveattrs import (
decode_matrix_input,
encode_matrix_result,
)
def _make_metadata(
standard_name=None,
long_name=None,
var_name=None,
attributes=None,
force_mapping=True,
):
if force_mapping:
if attributes is None:
attributes = {}
else:
attributes = dict(STASH=attributes)
return CubeMetadata(
standard_name=standard_name,
long_name=long_name,
var_name=var_name,
units=None,
attributes=attributes,
cell_methods=None,
)
class Test(tests.IrisTest):
def setUp(self):
self.standard_name = mock.sentinel.standard_name
self.long_name = mock.sentinel.long_name
self.var_name = mock.sentinel.var_name
self.units = mock.sentinel.units
self.attributes = mock.sentinel.attributes
self.cell_methods = mock.sentinel.cell_methods
self.cls = CubeMetadata
def test_repr(self):
metadata = self.cls(
standard_name=self.standard_name,
long_name=self.long_name,
var_name=self.var_name,
units=self.units,
attributes=self.attributes,
cell_methods=self.cell_methods,
)
fmt = (
"CubeMetadata(standard_name={!r}, long_name={!r}, var_name={!r}, "
"units={!r}, attributes={!r}, cell_methods={!r})"
)
expected = fmt.format(
self.standard_name,
self.long_name,
self.var_name,
self.units,
self.attributes,
self.cell_methods,
)
self.assertEqual(expected, repr(metadata))
def test__fields(self):
expected = (
"standard_name",
"long_name",
"var_name",
"units",
"attributes",
"cell_methods",
)
self.assertEqual(self.cls._fields, expected)
def test_bases(self):
self.assertTrue(issubclass(self.cls, BaseMetadata))
@pytest.fixture(params=CubeMetadata._fields)
def fieldname(request):
return request.param
@pytest.fixture(params=["strict", "lenient"])
def op_leniency(request):
return request.param
# Global data defining the individual split attributes "testcases".
# Each testcase specifies two inputs, with different global+local attribute settings.
# The same cases are tested for 3 different metadata operations : 'combine',
# 'difference' and 'equal'.
_ATTRS_TESTCASE_INPUTS = {
"same": "GaLb:GaLb",
"extra_global": "GaL-:G-L-",
"extra_local": "G-La:G-L-",
"same_global_local": "GaL-:G-La",
"diff_global_local": "GaL-:G-Lb",
"diffglobal_nolocal": "GaL-:GbL-",
"diffglobal_samelocal": "GaLc:GbLc",
"difflocal_noglobal": "G-La:G-Lb",
"difflocal_sameglobal": "GaLc:GaLd",
"diff_local_and_global": "GaLc:GbLd",
}
_ATTRS_TESTCASE_NAMES = list(_ATTRS_TESTCASE_INPUTS)
def check_splitattrs_op(
check_testcase: str, check_lenient: bool, op: str, cases: dict
):
"""
Test a common metadata operation, specifically the split-attributes handling.
Parameters
----------
check_testcase : str
One of those listed in _ATTRS_TESTCASE_INPUTS. These keys are coded strings,
as used in `iris.tests.integration.test_netcdf_loadsaveattrs`.
check_lenient : bool
Whether the test operation is performed 'lenient' or 'strict'.
op : {'combine', 'difference', 'equal'}
The operation under test
cases : dict
The "expected" result-code values for each testcase. Values are either two
results for 'strict' and 'lenient' cases, when those are different, or a single
result if strict and lenient results are the same.
NOTE: this arg defines expected results for *all* testcases, even though each
call only tests a single testcase. This just makes parameterisation easier.
Notes
-----
Sequence of operation :
1. construct 2 inputs from _ATTRS_TESTCASE_INPUTS[check_testcase]
2. perform ``result = op(*inputs, lenient=check_lenient)``
3. (except for equality) convert the result to a "result-code string",
again as in test_netcdf_loadsaveattrs.
4 assert that the (encoded) results match the expected
"""
# cases.keys() are the testcase names -- these should always match the master table
assert cases.keys() == _ATTRS_TESTCASE_INPUTS.keys()
# Each case is recorded as testcase: (<input>, [*output-codes])
# The "input"s are only for readability, and should match those in the master table.
assert all(
cases[key][0] == _ATTRS_TESTCASE_INPUTS[key]
for key in _ATTRS_TESTCASE_INPUTS
)
# Fetch input test-values from the common dictionary.
input_spec, result_specs = cases[check_testcase]
input_spec = input_spec.split(
":"
) # make a list from the two sides of the ":"
assert len(input_spec) == 2
# convert to a list of (global, *locals) value sets
input_values = decode_matrix_input(input_spec)
# form 2 inputs to the operation
def attrsdict(value):
if value is None:
result = {}
else:
result = {"_testattr_": value}
return result
input_attributes = (
CubeAttrsDict(
globals=attrsdict(values[0]), locals=attrsdict(values[1])
)
for values in input_values
)
input_l, input_r = [
CubeMetadata(
**{
field: attrs if field == "attributes" else None
for field in CubeMetadata._fields
}
)
for attrs in input_attributes
]
# Run the actual operation
result = getattr(input_l, op)(input_r, lenient=check_lenient)
# Get the expected result, the strict/lenient one as required
if len(result_specs) == 1:
expected_spec = result_specs[0]
else:
expected_spec = result_specs[1 if check_lenient else 0]
# Convert the operation result to the form of the recorded "expected" output.
# N.B. the expected-result format depends on the operation under test.
assert op in ("combine", "difference", "equal")
if op == "combine":
# "combine" results are CubeMetadata objects
# convert global+local values to a result-code string
values = [
result.attributes.globals.get("_testattr_", None),
result.attributes.locals.get("_testattr_", None),
]
# N.B. encode_matrix_result returns a list of results (always 1 in this case).
(result,) = encode_matrix_result(values)
elif op == "difference":
# "difference" op results are CubeMetadata : its values are difference-pairs.
if result is None:
# Use a unique string to indicate a null result
result = "-"
else:
# result is a CubeMetadata whose .attributes is a pair of CubeAttrsDict
assert isinstance(result, CubeMetadata)
assert isinstance(result.attributes, tuple)
assert len(result.attributes) == 2
assert all(
isinstance(dic, CubeAttrsDict) for dic in result.attributes
)
# calculate value-pairs in each section, where present
global_local_valuepairs = [
[
val.globals.get("_testattr_", None)
for val in result.attributes
],
[
val.locals.get("_testattr_", None)
for val in result.attributes
],
]
# E.G. [[None, "a"], [None, None]], or [["a", "b"], [None, "c"]]
# convert these difference-value-pairs to coded strings, which we will
# treat as "global and local values" for conversion into a spec string
# E.G. ["a", "b"] --> "ab""
# E.G. [None, "a"] --> "-a"
# E.G. [None, None] --> "--"
def valrep_single(val):
return "-" if val is None else val
def valrep_pair(val):
assert len(val) == 2
return valrep_single(val[0]) + valrep_single(val[1])
global_local_valuecodes = [
valrep_pair(val) for val in global_local_valuepairs
]
# Encode those "value-codes" as a result-code string
# E.G. converting
# (value-pairs) == [[None, "a"], [None, None]]
# --> (value-codes) ["-a", "--"]
# --> (result) "G-aL--"
# N.B. encode_matrix_result returns a list of results (1 in this case).
(result,) = encode_matrix_result(global_local_valuecodes)
else:
# "equal" op result is a boolean : needs no further conversion
assert op == "equal"
# Check that the coded result matches the expectation.
assert result == expected_spec
class Test___eq__:
@pytest.fixture(autouse=True)
def setup(self):
self.lvalues = dict(
standard_name=sentinel.standard_name,
long_name=sentinel.long_name,
var_name=sentinel.var_name,
units=sentinel.units,
# Must be a mapping.
attributes=dict(),
cell_methods=sentinel.cell_methods,
)
# Setup another values tuple with all-distinct content objects.
self.rvalues = deepcopy(self.lvalues)
self.dummy = sentinel.dummy
self.cls = CubeMetadata
def test_wraps_docstring(self):
assert self.cls.__eq__.__doc__ == BaseMetadata.__eq__.__doc__
def test_lenient_service(self):
qualname___eq__ = _qualname(self.cls.__eq__)
assert qualname___eq__ in _LENIENT
assert _LENIENT[qualname___eq__]
assert _LENIENT[self.cls.__eq__]
def test_call(self):
other = sentinel.other
return_value = sentinel.return_value
metadata = self.cls(*(None,) * len(self.cls._fields))
with mock.patch.object(
BaseMetadata, "__eq__", return_value=return_value
) as mocker:
result = metadata.__eq__(other)
assert return_value == result
assert mocker.call_args_list == [mock.call(other)]
def test_op_same(self, op_leniency):
# Check op all-same content, but all-new data.
# NOTE: test for both strict/lenient, should both work the same.
is_lenient = op_leniency == "lenient"
lmetadata = self.cls(**self.lvalues)
rmetadata = self.cls(**self.rvalues)
with mock.patch(
"iris.common.metadata._LENIENT", return_value=is_lenient
):
# Check equality both l==r and r==l.
assert lmetadata.__eq__(rmetadata)
assert rmetadata.__eq__(lmetadata)
def test_op_different__none(self, fieldname, op_leniency):
# One side has field=value, and the other field=None, both strict + lenient.
if fieldname == "attributes":
# Must be a dict, cannot be None.
pytest.skip()
else:
is_lenient = op_leniency == "lenient"
lmetadata = self.cls(**self.lvalues)
self.rvalues.update({fieldname: None})
rmetadata = self.cls(**self.rvalues)
if fieldname in ("cell_methods", "standard_name", "units"):
# These ones are compared strictly
expect_success = False
elif fieldname in ("var_name", "long_name"):
# For other 'normal' fields : lenient succeeds, strict does not.
expect_success = is_lenient
else:
# Ensure we are handling all the different field cases
raise ValueError(
f"{self.__name__} unhandled fieldname : {fieldname}"
)
with mock.patch(
"iris.common.metadata._LENIENT", return_value=is_lenient
):
# Check equality both l==r and r==l.
assert lmetadata.__eq__(rmetadata) == expect_success
assert rmetadata.__eq__(lmetadata) == expect_success
def test_op_different__value(self, fieldname, op_leniency):
# Compare when a given field value is changed, both strict + lenient.
if fieldname == "attributes":
# Dicts have more possibilities: handled separately.
pytest.skip()
else:
is_lenient = op_leniency == "lenient"
lmetadata = self.cls(**self.lvalues)
self.rvalues.update({fieldname: self.dummy})
rmetadata = self.cls(**self.rvalues)
if fieldname in (
"cell_methods",
"standard_name",
"units",
"long_name",
):
# These ones are compared strictly
expect_success = False
elif fieldname == "var_name":
# For other 'normal' fields : lenient succeeds, strict does not.
expect_success = is_lenient
else:
# Ensure we are handling all the different field cases
raise ValueError(
f"{self.__name__} unhandled fieldname : {fieldname}"
)
with mock.patch(
"iris.common.metadata._LENIENT", return_value=is_lenient
):
# Check equality both l==r and r==l.
assert lmetadata.__eq__(rmetadata) == expect_success
assert rmetadata.__eq__(lmetadata) == expect_success
def test_op_different__attribute_extra(self, op_leniency):
# Check when one set of attributes has an extra entry.
is_lenient = op_leniency == "lenient"
lmetadata = self.cls(**self.lvalues)
self.rvalues["attributes"]["_extra_"] = 1
rmetadata = self.cls(**self.rvalues)
# This counts as equal *only* in the lenient case.
expect_success = is_lenient
with mock.patch(
"iris.common.metadata._LENIENT", return_value=is_lenient
):
# Check equality both l==r and r==l.
assert lmetadata.__eq__(rmetadata) == expect_success
assert rmetadata.__eq__(lmetadata) == expect_success
def test_op_different__attribute_value(self, op_leniency):
# lhs and rhs have different values for an attribute, both strict + lenient.
is_lenient = op_leniency == "lenient"
self.lvalues["attributes"]["_extra_"] = mock.sentinel.value1
self.rvalues["attributes"]["_extra_"] = mock.sentinel.value2
lmetadata = self.cls(**self.lvalues)
rmetadata = self.cls(**self.rvalues)
with mock.patch(
"iris.common.metadata._LENIENT", return_value=is_lenient
):
# This should ALWAYS fail.
assert not lmetadata.__eq__(rmetadata)
assert not rmetadata.__eq__(lmetadata)
@pytest.mark.parametrize("testcase", _ATTRS_TESTCASE_NAMES)
def test_op__splitattributes_cases(self, op_leniency, testcase):
# Check results for various global/local values of the same attribute.
# N.B. 'cases' dict specifies the expected results for each testcase.
check_splitattrs_op(
check_testcase=testcase,
check_lenient=op_leniency == "lenient",
op="equal",
cases={
"same": ("GaLb:GaLb", [True]),
"extra_global": ("GaL-:G-L-", [False, True]),
"extra_local": ("G-La:G-L-", [False, True]),
"same_global_local": ("GaL-:G-La", [False, True]),
"diff_global_local": ("GaL-:G-Lb", [False, True]),
"diffglobal_nolocal": ("GaL-:GbL-", [False]),
"diffglobal_samelocal": ("GaLc:GbLc", [False]),
"difflocal_noglobal": ("G-La:G-Lb", [False]),
"difflocal_sameglobal": ("GaLc:GaLd", [False]),
"diff_local_and_global": ("GaLc:GbLd", [False]),
},
)
class Test___lt__(tests.IrisTest):
def setUp(self):
self.cls = CubeMetadata
self.one = self.cls(1, 1, 1, 1, 1, 1)
self.two = self.cls(1, 1, 1, 2, 1, 1)
self.none = self.cls(1, 1, 1, None, 1, 1)
self.attributes_cm = self.cls(1, 1, 1, 1, 10, 10)
def test__ascending_lt(self):
result = self.one < self.two
self.assertTrue(result)
def test__descending_lt(self):
result = self.two < self.one
self.assertFalse(result)
def test__none_rhs_operand(self):
result = self.one < self.none
self.assertFalse(result)
def test__none_lhs_operand(self):
result = self.none < self.one
self.assertTrue(result)
def test__ignore_attributes_cell_methods(self):
result = self.one < self.attributes_cm
self.assertFalse(result)
result = self.attributes_cm < self.one
self.assertFalse(result)
class Test_combine:
@pytest.fixture(autouse=True)
def setup(self):
self.lvalues = dict(
standard_name=sentinel.standard_name,
long_name=sentinel.long_name,
var_name=sentinel.var_name,
units=sentinel.units,
attributes=sentinel.attributes,
cell_methods=sentinel.cell_methods,
)
# Get a second copy with all-new objects.
self.rvalues = deepcopy(self.lvalues)
self.dummy = sentinel.dummy
self.cls = CubeMetadata
self.none = self.cls(*(None,) * len(self.cls._fields))
def test_wraps_docstring(self):
assert self.cls.combine.__doc__ == BaseMetadata.combine.__doc__
def test_lenient_service(self):
qualname_combine = _qualname(self.cls.combine)
assert qualname_combine in _LENIENT
assert _LENIENT[qualname_combine]
assert _LENIENT[self.cls.combine]
def test_lenient_default(self):
other = sentinel.other
return_value = sentinel.return_value
with mock.patch.object(
BaseMetadata, "combine", return_value=return_value
) as mocker:
result = self.none.combine(other)
assert return_value == result
assert mocker.call_args_list == [mock.call(other, lenient=None)]
def test_lenient(self):
other = sentinel.other
lenient = sentinel.lenient
return_value = sentinel.return_value
with mock.patch.object(
BaseMetadata, "combine", return_value=return_value
) as mocker:
result = self.none.combine(other, lenient=lenient)
assert return_value == result
assert mocker.call_args_list == [mock.call(other, lenient=lenient)]
def test_op_same(self, op_leniency):
# Result is same as either input, both strict + lenient.
is_lenient = op_leniency == "lenient"
lmetadata = self.cls(**self.lvalues)
rmetadata = self.cls(**self.rvalues)
expected = self.lvalues
with mock.patch(
"iris.common.metadata._LENIENT", return_value=is_lenient
):
# Check both l+r and r+l
assert lmetadata.combine(rmetadata)._asdict() == expected
assert rmetadata.combine(lmetadata)._asdict() == expected
def test_op_different__none(self, fieldname, op_leniency):
# One side has field=value, and the other field=None, both strict + lenient.
if fieldname == "attributes":
# Can't be None : Tested separately
pytest.skip()
is_lenient = op_leniency == "lenient"
lmetadata = self.cls(**self.lvalues)
# Cancel one setting in the rhs argument.
self.rvalues[fieldname] = None
rmetadata = self.cls(**self.rvalues)
if fieldname in ("cell_methods", "units"):
# NB cell-methods and units *always* strict behaviour.
# strict form : take only those which both have set
strict_result = True
elif fieldname in ("standard_name", "long_name", "var_name"):
strict_result = not is_lenient
else:
# Ensure we are handling all the different field cases
raise ValueError(
f"{self.__name__} unhandled fieldname : {fieldname}"
)
if strict_result:
# include only those which both have
expected = self.rvalues
else:
# also include those which only 1 has
expected = self.lvalues
with mock.patch(
"iris.common.metadata._LENIENT", return_value=is_lenient
):
# Check both l+r and r+l
assert lmetadata.combine(rmetadata)._asdict() == expected
assert rmetadata.combine(lmetadata)._asdict() == expected
def test_op_different__value(self, fieldname, op_leniency):
# One field has different value for lhs/rhs, both strict + lenient.
if fieldname == "attributes":
# Attribute behaviours are tested separately
pytest.skip()
is_lenient = op_leniency == "lenient"
self.lvalues[fieldname] = mock.sentinel.value1
self.rvalues[fieldname] = mock.sentinel.value2
lmetadata = self.cls(**self.lvalues)
rmetadata = self.cls(**self.rvalues)
# In all cases, this field should be None in the result : leniency has no effect
expected = self.lvalues.copy()
expected[fieldname] = None
with mock.patch(
"iris.common.metadata._LENIENT", return_value=is_lenient
):
# Check both l+r and r+l
assert lmetadata.combine(rmetadata)._asdict() == expected
assert rmetadata.combine(lmetadata)._asdict() == expected
def test_op_different__attribute_extra(self, op_leniency):
# One field has an extra attribute, both strict + lenient.
is_lenient = op_leniency == "lenient"
self.lvalues["attributes"] = {"_a_common_": mock.sentinel.dummy}
self.rvalues["attributes"] = self.lvalues["attributes"].copy()
self.rvalues["attributes"]["_extra_"] = mock.sentinel.testvalue
lmetadata = self.cls(**self.lvalues)
rmetadata = self.cls(**self.rvalues)
if is_lenient:
# the extra attribute should appear in the result ..
expected = self.rvalues
else:
# .. it should not
expected = self.lvalues
with mock.patch(
"iris.common.metadata._LENIENT", return_value=is_lenient
):
# Check both l+r and r+l
assert lmetadata.combine(rmetadata)._asdict() == expected
assert rmetadata.combine(lmetadata)._asdict() == expected
def test_op_different__attribute_value(self, op_leniency):
# lhs and rhs have different values for an attribute, both strict + lenient.
is_lenient = op_leniency == "lenient"
self.lvalues["attributes"] = {
"_a_common_": self.dummy,
"_b_common_": mock.sentinel.value1,
}
self.lvalues["attributes"] = {
"_a_common_": self.dummy,
"_b_common_": mock.sentinel.value2,
}
lmetadata = self.cls(**self.lvalues)
rmetadata = self.cls(**self.rvalues)
# Result has entirely EMPTY attributes (whether strict or lenient).
# TODO: is this maybe a mistake of the existing implementation ?
expected = self.lvalues.copy()
expected["attributes"] = None
with mock.patch(
"iris.common.metadata._LENIENT", return_value=is_lenient
):
# Check both l+r and r+l
assert lmetadata.combine(rmetadata)._asdict() == expected
assert rmetadata.combine(lmetadata)._asdict() == expected
def test_op_different__attribute_extra_global(self, op_leniency):
# One input has an additional attribute, specifically set as a *GLOBAL* one.
is_lenient = op_leniency == "lenient"
self.lvalues["attributes"] = CubeAttrsDict(
globals={"_a_common_": mock.sentinel.dummy_a},
locals={"_b_common_": mock.sentinel.dummy_b},
)
self.rvalues["attributes"] = self.lvalues["attributes"].copy()
self.rvalues["attributes"].globals["_extra_"] = mock.sentinel.testvalue
lmetadata = self.cls(**self.lvalues)
rmetadata = self.cls(**self.rvalues)
if is_lenient:
# the extra attribute should appear in the result ..
expected = self.rvalues
else:
# .. it should not
expected = self.lvalues
with mock.patch(
"iris.common.metadata._LENIENT", return_value=is_lenient
):
# Check both l+r and r+l
assert lmetadata.combine(rmetadata)._asdict() == expected
assert rmetadata.combine(lmetadata)._asdict() == expected
def test_op_different__attribute_extra_local(self, op_leniency):
# One input has an additional attribute, specifically set as a *LOCAL* one.
is_lenient = op_leniency == "lenient"
self.lvalues["attributes"] = CubeAttrsDict(
globals={"_a_common_": mock.sentinel.dummy_a},
locals={"_b_common_": mock.sentinel.dummy_b},
)
self.rvalues["attributes"] = self.lvalues["attributes"].copy()
self.rvalues["attributes"].locals["_extra_"] = mock.sentinel.testvalue
lmetadata = self.cls(**self.lvalues)
rmetadata = self.cls(**self.rvalues)
if is_lenient:
# the extra attribute should appear in the result ..
expected = self.rvalues
else:
# .. it should not
expected = self.lvalues
with mock.patch(
"iris.common.metadata._LENIENT", return_value=is_lenient
):
# Check both l+r and r+l
assert lmetadata.combine(rmetadata)._asdict() == expected
assert rmetadata.combine(lmetadata)._asdict() == expected
def test_op_different__attribute_same_global_local(self, op_leniency):
# One field has an extra specifically *LOCAL* attribute, and the other a
# corresponding *GLOBAL* one -- both with distinct values.
is_lenient = op_leniency == "lenient"
common_attrs = CubeAttrsDict(
globals={"_a_common_": mock.sentinel.dummy_a},
locals={"_b_common_": mock.sentinel.dummy_b},
)
self.lvalues["attributes"] = deepcopy(common_attrs)
self.rvalues["attributes"] = deepcopy(common_attrs)
basis_metadata = self.cls(**deepcopy(self.lvalues))
self.lvalues["attributes"].globals["_extra_"] = mock.sentinel.v1
self.rvalues["attributes"].locals["_extra_"] = mock.sentinel.v2
lmetadata = self.cls(**self.lvalues)
rmetadata = self.cls(**self.rvalues)
expected = basis_metadata._asdict()
if is_lenient:
# BOTH extra attributes should appear in the result ..
expected["attributes"].globals.update(
self.lvalues["attributes"].globals
)
expected["attributes"].locals.update(
self.rvalues["attributes"].locals
)
else:
# strict operation : neither of the "extras" appears
pass
with mock.patch(
"iris.common.metadata._LENIENT", return_value=is_lenient
):
# Check both l+r and r+l
assert lmetadata.combine(rmetadata)._asdict() == expected
assert rmetadata.combine(lmetadata)._asdict() == expected
@pytest.mark.parametrize("testcase", _ATTRS_TESTCASE_NAMES)
def test_op__splitattributes_cases(self, op_leniency, testcase):
# Check results for various global/local values of the same attribute.
# N.B. 'cases' dict specifies the expected results for each testcase.
check_splitattrs_op(
check_testcase=testcase,
check_lenient=op_leniency == "lenient",
op="combine",
cases={
"same": ("GaLb:GaLb", ["GaLb"]),
"extra_global": ("GaL-:G-L-", ["G-L-", "GaL-"]),
"extra_local": ("G-La:G-L-", ["G-L-", "G-La"]),
"same_global_local": ("GaL-:G-La", ["G-L-", "GaLa"]),
"diff_global_local": ("GaL-:G-Lb", ["G-L-", "GaLb"]),
"diffglobal_nolocal": ("GaL-:GbL-", ["G-L-"]),
"diffglobal_samelocal": ("GaLc:GbLc", ["G-Lc"]),
"difflocal_noglobal": ("G-La:G-Lb", ["G-L-"]),
"difflocal_sameglobal": ("GaLc:GaLd", ["GaL-"]),
"diff_local_and_global": ("GaLc:GbLd", ["G-L-"]),
},
)
class Test_difference:
@pytest.fixture(autouse=True)
def setup(self):
self.lvalues = dict(
standard_name=sentinel.standard_name,
long_name=sentinel.long_name,
var_name=sentinel.var_name,
units=sentinel.units,
attributes=dict(), # MUST be a dict
cell_methods=sentinel.cell_methods,
)
# Make a copy with all-different objects in it.
self.rvalues = deepcopy(self.lvalues)
self.dummy = sentinel.dummy
self.cls = CubeMetadata
self.none = self.cls(*(None,) * len(self.cls._fields))
def test_wraps_docstring(self):
assert self.cls.difference.__doc__ == BaseMetadata.difference.__doc__
def test_lenient_service(self):
qualname_difference = _qualname(self.cls.difference)
assert qualname_difference in _LENIENT
assert _LENIENT[qualname_difference]
assert _LENIENT[self.cls.difference]
def test_lenient_default(self):
other = sentinel.other
return_value = sentinel.return_value
with mock.patch.object(
BaseMetadata, "difference", return_value=return_value
) as mocker:
result = self.none.difference(other)
assert return_value == result
assert mocker.call_args_list == [mock.call(other, lenient=None)]
def test_lenient(self):
other = sentinel.other
lenient = sentinel.lenient
return_value = sentinel.return_value
with mock.patch.object(
BaseMetadata, "difference", return_value=return_value
) as mocker:
result = self.none.difference(other, lenient=lenient)
assert return_value == result
assert mocker.call_args_list == [mock.call(other, lenient=lenient)]
def test_op_same(self, op_leniency):
is_lenient = op_leniency == "lenient"
lmetadata = self.cls(**self.lvalues)
rmetadata = self.cls(**self.rvalues)
with mock.patch(
"iris.common.metadata._LENIENT", return_value=is_lenient
):
assert lmetadata.difference(rmetadata) is None
assert rmetadata.difference(lmetadata) is None
def test_op_different__none(self, fieldname, op_leniency):
# One side has field=value, and the other field=None, both strict + lenient.
if fieldname in ("attributes",):
# These cannot properly be set to 'None'. Tested elsewhere.
pytest.skip()
is_lenient = op_leniency == "lenient"
lmetadata = self.cls(**self.lvalues)
self.rvalues[fieldname] = None
rmetadata = self.cls(**self.rvalues)
if fieldname in ("units", "cell_methods"):
# These ones are always "strict"
strict_result = True
elif fieldname in ("standard_name", "long_name", "var_name"):
strict_result = not is_lenient
else:
# Ensure we are handling all the different field cases
raise ValueError(
f"{self.__name__} unhandled fieldname : {fieldname}"
)
if strict_result:
diffentry = tuple(
[getattr(mm, fieldname) for mm in (lmetadata, rmetadata)]
)
# NOTE: in these cases, the difference metadata will fail an == operation,
# because of the 'None' entries.
# But we can use metadata._asdict() and test that.
lexpected = self.none._asdict()
lexpected[fieldname] = diffentry
rexpected = lexpected.copy()
rexpected[fieldname] = diffentry[::-1]
with mock.patch(
"iris.common.metadata._LENIENT", return_value=is_lenient
):
if strict_result:
assert lmetadata.difference(rmetadata)._asdict() == lexpected
assert rmetadata.difference(lmetadata)._asdict() == rexpected
else:
# Expect NO differences
assert lmetadata.difference(rmetadata) is None
assert rmetadata.difference(lmetadata) is None
def test_op_different__value(self, fieldname, op_leniency):
# One field has different value for lhs/rhs, both strict + lenient.
if fieldname == "attributes":
# Attribute behaviours are tested separately
pytest.skip()
self.lvalues[fieldname] = mock.sentinel.value1
self.rvalues[fieldname] = mock.sentinel.value2
lmetadata = self.cls(**self.lvalues)
rmetadata = self.cls(**self.rvalues)
# In all cases, this field should show a difference : leniency has no effect
ldiff_values = (mock.sentinel.value1, mock.sentinel.value2)
ldiff_metadata = self.none._asdict()
ldiff_metadata[fieldname] = ldiff_values
rdiff_metadata = self.none._asdict()
rdiff_metadata[fieldname] = ldiff_values[::-1]
# Check both l+r and r+l
assert lmetadata.difference(rmetadata)._asdict() == ldiff_metadata
assert rmetadata.difference(lmetadata)._asdict() == rdiff_metadata
def test_op_different__attribute_extra(self, op_leniency):
# One field has an extra attribute, both strict + lenient.
is_lenient = op_leniency == "lenient"
self.lvalues["attributes"] = {"_a_common_": self.dummy}
lmetadata = self.cls(**self.lvalues)
rvalues = deepcopy(self.lvalues)
rvalues["attributes"]["_b_extra_"] = mock.sentinel.extra
rmetadata = self.cls(**rvalues)
if not is_lenient:
# In this case, attributes returns a "difference dictionary"
diffentry = tuple([{}, {"_b_extra_": mock.sentinel.extra}])
lexpected = self.none._asdict()
lexpected["attributes"] = diffentry
rexpected = lexpected.copy()
rexpected["attributes"] = diffentry[::-1]
with mock.patch(
"iris.common.metadata._LENIENT", return_value=is_lenient
):
if is_lenient:
# It recognises no difference
assert lmetadata.difference(rmetadata) is None
assert rmetadata.difference(lmetadata) is None
else:
# As calculated above
assert lmetadata.difference(rmetadata)._asdict() == lexpected
assert rmetadata.difference(lmetadata)._asdict() == rexpected
def test_op_different__attribute_value(self, op_leniency):
# lhs and rhs have different values for an attribute, both strict + lenient.
is_lenient = op_leniency == "lenient"
self.lvalues["attributes"] = {
"_a_common_": self.dummy,
"_b_extra_": mock.sentinel.value1,
}
lmetadata = self.cls(**self.lvalues)
self.rvalues["attributes"] = {
"_a_common_": self.dummy,
"_b_extra_": mock.sentinel.value2,
}
rmetadata = self.cls(**self.rvalues)
# In this case, attributes returns a "difference dictionary"
diffentry = tuple(
[
{"_b_extra_": mock.sentinel.value1},
{"_b_extra_": mock.sentinel.value2},
]
)
lexpected = self.none._asdict()
lexpected["attributes"] = diffentry
rexpected = lexpected.copy()
rexpected["attributes"] = diffentry[::-1]
with mock.patch(
"iris.common.metadata._LENIENT", return_value=is_lenient
):
# As calculated above -- same for both strict + lenient
assert lmetadata.difference(rmetadata)._asdict() == lexpected
assert rmetadata.difference(lmetadata)._asdict() == rexpected
@pytest.mark.parametrize("testcase", _ATTRS_TESTCASE_NAMES)
def test_op__splitattributes_cases(self, op_leniency, testcase):
# Check results for various global/local values of the same attribute.
# N.B. 'cases' dict specifies the expected results for each testcase.
check_splitattrs_op(
check_testcase=testcase,
check_lenient=op_leniency == "lenient",
op="difference",
cases={
"same": ("GaLb:GaLb", ["-"]),
"extra_global": ("GaL-:G-L-", ["Ga-L--", "-"]),
"extra_local": ("G-La:G-L-", ["G--La-", "-"]),
"same_global_local": ("GaL-:G-La", ["Ga-L-a", "-"]),
"diff_global_local": ("GaL-:G-Lb", ["Ga-L-b", "-"]),
"diffglobal_nolocal": ("GaL-:GbL-", ["GabL--"]),
"diffglobal_samelocal": ("GaLc:GbLc", ["GabL--"]),
"difflocal_noglobal": ("G-La:G-Lb", ["G--Lab"]),
"difflocal_sameglobal": ("GaLc:GaLd", ["G--Lcd"]),
"diff_local_and_global": ("GaLc:GbLd", ["GabLcd"]),
},
)
class Test_equal(tests.IrisTest):
def setUp(self):
self.cls = CubeMetadata
self.none = self.cls(*(None,) * len(self.cls._fields))
def test_wraps_docstring(self):
self.assertEqual(BaseMetadata.equal.__doc__, self.cls.equal.__doc__)
def test_lenient_service(self):
qualname_equal = _qualname(self.cls.equal)
self.assertIn(qualname_equal, _LENIENT)
self.assertTrue(_LENIENT[qualname_equal])
self.assertTrue(_LENIENT[self.cls.equal])