Skip to content

tests

Modules

collections

Modules

test_dict_deep_update

Tests of the deep_update() function

Functions:
test_add_top_level_keys 
test_add_top_level_keys()
Source code in tests/collections/test_dict_deep_update.py 
19
20
def test_add_top_level_keys():
    assert deep_update({"a": 1}, {"b": 2, "c": 3}) == {"a": 1, "b": 2, "c": 3}
test_empty_dict 
test_empty_dict()
Source code in tests/collections/test_dict_deep_update.py 
6
7
8
9
def test_empty_dict():
    assert deep_update({}, {}) == {}
    assert deep_update({"a": 1}, {}) == {"a": 1}
    assert deep_update({}, {"a": 1}) == {"a": 1}
test_inplace_update 
test_inplace_update()
Source code in tests/collections/test_dict_deep_update.py 
33
34
35
36
def test_inplace_update():
    t = {"a": {"k": 1}}
    deep_update(t, {"a": {"k": 2, "l": 0}})
    assert t == {"a": {"k": 2, "l": 0}}
test_replace_nested_keys 
test_replace_nested_keys()
Source code in tests/collections/test_dict_deep_update.py 
23
24
25
26
27
28
29
30
def test_replace_nested_keys():
    assert deep_update({"a": {"k": 1}}, {"a": {"k": 2}}) == {"a": {"k": 2}}
    assert deep_update({"a": {"k": 1, "l": 0}}, {"a": {"k": 2}}) == {
        "a": {"k": 2, "l": 0}
    }
    assert deep_update({"a": {"k": 1}}, {"a": {"k": 2, "l": 0}}) == {
        "a": {"k": 2, "l": 0}
    }
test_replace_top_level_keys 
test_replace_top_level_keys()
Source code in tests/collections/test_dict_deep_update.py 
12
13
14
15
16
def test_replace_top_level_keys():
    assert deep_update({"a": 1}, {"a": 1}) == {"a": 1}
    assert deep_update({"a": 1}, {"a": 113}) == {"a": 113}
    assert deep_update({"a": {}}, {"a": 113}) == {"a": 113}
    assert deep_update({"a": 1}, {"a": {}}) == {"a": {}}

test_card_file

Functions:

all_datatypes 
all_datatypes()
Source code in tests/test_card_file.py 
14
15
16
@pytest.fixture
def all_datatypes():
    return _load_file("all_datatypes.card")
config 
config()
Source code in tests/test_card_file.py 
60
61
62
@pytest.fixture
def config():
    return _load_file("config.card.r7417")
dynamico 
dynamico()
Source code in tests/test_card_file.py 
130
131
132
@pytest.fixture
def dynamico():
    return _load_file("dynamico.card.r7417")
lmdz 
lmdz()
Source code in tests/test_card_file.py 
207
208
209
@pytest.fixture
def lmdz():
    return _load_file("lmdz.card.r7417")
orchidee 
orchidee()
Source code in tests/test_card_file.py 
363
364
365
@pytest.fixture
def orchidee():
    return _load_file("orchidee.card.r7417")
test_card 
test_card()
Source code in tests/test_card_file.py 
587
588
589
@pytest.fixture
def test_card():
    return _load_file("TestFile.card")
test_dumps_loads_all_datatypes 
test_dumps_loads_all_datatypes(all_datatypes)
Source code in tests/test_card_file.py 
56
57
def test_dumps_loads_all_datatypes(all_datatypes):
    assert all_datatypes == loads(dumps(all_datatypes))
test_dumps_loads_config 
test_dumps_loads_config(config)
Source code in tests/test_card_file.py 
126
127
def test_dumps_loads_config(config):
    assert config == loads(dumps(config))
test_dumps_loads_dynamico 
test_dumps_loads_dynamico(dynamico)
Source code in tests/test_card_file.py 
203
204
def test_dumps_loads_dynamico(dynamico):
    assert dynamico == loads(dumps(dynamico))
test_dumps_loads_lmdz 
test_dumps_loads_lmdz(lmdz)
Source code in tests/test_card_file.py 
359
360
def test_dumps_loads_lmdz(lmdz):
    assert lmdz == loads(dumps(lmdz))
test_dumps_loads_orchidee 
test_dumps_loads_orchidee(orchidee)
Source code in tests/test_card_file.py 
583
584
def test_dumps_loads_orchidee(orchidee):
    assert orchidee == loads(dumps(orchidee))
test_dumps_loads_test_card 
test_dumps_loads_test_card(test_card)
Source code in tests/test_card_file.py 
615
616
def test_dumps_loads_test_card(test_card):
    assert test_card == loads(dumps(test_card))
test_dumps_loads_xios 
test_dumps_loads_xios(xios)
Source code in tests/test_card_file.py 
640
641
def test_dumps_loads_xios(xios):
    assert xios == loads(dumps(xios))
test_empty_content 
test_empty_content()
Source code in tests/test_card_file.py 
644
645
646
def test_empty_content():
    assert loads("") == {}
    assert loads(dumps({})) == {}
test_empty_content_with_ws 
test_empty_content_with_ws()
Source code in tests/test_card_file.py 
649
650
def test_empty_content_with_ws():
    assert loads("\t\n\t   \n  \t") == {}
test_empty_section 
test_empty_section()
Source code in tests/test_card_file.py 
661
662
663
664
def test_empty_section():
    empty_section = {"section1": {}}
    assert loads("[section1]") == empty_section
    assert loads(dumps(empty_section)) == empty_section
test_empty_with_comment 
test_empty_with_comment()
Source code in tests/test_card_file.py 
653
654
def test_empty_with_comment():
    assert loads("# This is just a comment") == {}
test_empty_with_comments 
test_empty_with_comments()
Source code in tests/test_card_file.py 
657
658
def test_empty_with_comments():
    assert loads("# This is just a comment\n# And another one!") == {}
test_invalid_missing_section 
test_invalid_missing_section()
Source code in tests/test_card_file.py 
672
673
674
def test_invalid_missing_section():
    with pytest.raises(ValueError, match="must contain .* key-value pairs inside a section"):
        loads("k=3")
test_load_all_datatypes 
test_load_all_datatypes(all_datatypes)
Source code in tests/test_card_file.py 
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
def test_load_all_datatypes(all_datatypes):
    assert all_datatypes == {
        "empty_section": {},
        "logical": {
            "y1": True,
            "y2": True,
            "y3": True,
            "y4": True,
            "n1": False,
            "n2": False,
            "n3": False,
            "n4": False,
        },
        "list": {
            "l1": [],
            "l2": [[], []],
            "l3": [[], [], []],
            "l4": [1],
            "l5": [[], [1]],
            "l6": [[], [1], []],
            "l7": [1, True, False, "text", '"text2"'],
            "l8": ["${SUBMIT_DIR}/PARAM/XIOS/iodef.xml", "."],
            "l9": ["${SUBMIT_DIR}/PARAM/XIOS/iodef.xml", ".", (1, 10, 100)],
        },
        "date": {"begin": "2024-06-01", "end": "2024-06-30"},
        "path": {
            "file1": "${SUBMIT_DIR}/../${year}/some_file.ext",
            "file2": '"${SUBMIT_DIR}/../${year}/some_file.ext"',
            "file3": ".",
        },
        "empty": {"e1": None, "e2": None, "e3": None},
        "empty_section2": {},
        "string": {"n1": "OFF", "n2": '"(text)"'},
        "special": {"integer_range": (100, 1, 200)},
    }
test_load_config 
test_load_config(config)
Source code in tests/test_card_file.py 
 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
def test_load_config(config):
    assert config == {
        "Compatibility": {"libIGCM": 1.0},
        "UserChoices": {
            "JobName": "CREATE-AMIP.01",
            "LongName": '"create_etat0_limit for interannuel amip run"',
            "TagName": "ICOLMDZOR",
            "SpaceName": "DEVT",
            "ExperimentName": "CE0L",
            "ExpType": "ICOLMDZOR/LAM/CREATE_amip",
            "CalendarType": "leap",
            "DateBegin": "2000-06-01",
            "DateEnd": "2000-06-05",
            "PeriodLength": "5D",
            "CompressionLevel": 2,
            "EnvFile": "${SUBMIT_DIR}/../ARCH/arch.env",
            "OptMode": "prod",
        },
        "ListOfComponents": {
            "ICO": ["dynamico", "DYNAMICO"],
            "ATM": ["lmdz", "LMDZ6"],
            "IOS": ["xios", "XIOS3"],
        },
        "Executable": {
            "ICO": ["icosa_lmdz_orch22_${OptMode}.exe", "icosa_lmdz.exe", "640MPI"],
            "ATM": ['""', '""'],
            "IOS": ["xios_server_${OptMode}.exe", "xios.x", "2MPI"],
        },
        "Restarts": {
            "OverRule": False,
            "RestartDate": None,
            "RestartJobName": None,
            "RestartPath": None,
        },
        "ICO": {
            "Restart": False,
            "RestartDate": None,
            "RestartJobName": None,
            "RestartPath": None,
        },
        "ATM": {
            "Restart": False,
            "RestartDate": None,
            "RestartJobName": None,
            "RestartPath": None,
        },
        "IOS": {
            "Restart": False,
            "RestartDate": None,
            "RestartJobName": None,
            "RestartPath": None,
        },
        "Post": {
            "MetricsPCMDI": False,
            "PackFrequency": None,
            "SeasonalFrequency": None,
            "TimeSeriesFrequency": None,
        },
    }
test_load_dynamico 
test_load_dynamico(dynamico)
Source code in tests/test_card_file.py 
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
def test_load_dynamico(dynamico):
    assert dynamico == {
        "Compatibility": {"libIGCM": 1.0},
        "UserChoices": {
            "RESOL_NBP": 80,
            "RESOL_ATM_Z": 79,
            "etat0": "database",
            "create_etat0_limit": True,
            "iflag_phys": 1,
        },
        "InitialStateFiles": {"List": []},
        "BoundaryFiles": {"List": [], "ListNonDel": []},
        "SmoothFiles": {"List": []},
        "ParametersFiles": {
            "List": [
                ["${SUBMIT_DIR}/PARAM/DYNAMICO/earth_const.def", "."],
                [
                    "${SUBMIT_DIR}/PARAM/DYNAMICO/LAM/run_dynamico_global_France.def",
                    "run_dynamico.def",
                ],
                [
                    "${MODIPSL}/modeles/DYNAMICO/xml/DYNAMICO_XML/sponge_dynamico.xml",
                    ".",
                ],
                [
                    "${MODIPSL}/modeles/DYNAMICO/xml/DYNAMICO_XML/context_dynamico.xml",
                    ".",
                ],
                [
                    "${MODIPSL}/modeles/DYNAMICO/xml/DYNAMICO_XML/context_input_dynamico.xml",
                    ".",
                ],
                [
                    "${MODIPSL}/modeles/DYNAMICO/xml/DYNAMICO_XML/field_def_dynamico.xml",
                    ".",
                ],
                ["${MODIPSL}/modeles/ICOSA_LMDZ/xml/XML_XIOS3/param_gw.xml", "."],
                [
                    "${MODIPSL}/modeles/DYNAMICO/xml/DYNAMICO_XML/file_def_dynamico.xml",
                    ".",
                ],
            ]
        },
        "RestartFiles": {"List": [None]},
        "OutputText": {
            "List": [
                "run_dynamico.def",
                "earth_const.def",
                "iodef.xml",
                "context_dynamico.xml",
                "context_input_dynamico.xml",
                "field_def_dynamico.xml",
                "file_def_dynamico.xml",
                "out_icosa_lmdz.exe.out*",
                "out_icosa_lmdz.exe.err*",
                "xios_client_*",
            ]
        },
        "OutputFiles": {
            "List": [
                "start0.nc",
                "${R_OUT_ICO_O}/Restart/${config_UserChoices_JobName}_${year}_start.nc",
                None,
            ]
        },
    }
test_load_lmdz 
test_load_lmdz(lmdz)
Source code in tests/test_card_file.py 
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
def test_load_lmdz(lmdz):
    assert lmdz == {
        "Compatibility": {"libIGCM": 1.0},
        "UserChoices": {
            "LMDZ_Physics": "NPv6.2",
            "flag_aerosol": 0,
            "ok_ade": False,
            "ok_aie": False,
            "aerosol_couple": False,
            "read_climoz": 0,
            "ok_cdnc": False,
            "flag_aerosol_strat": 0,
        },
        "InitialStateFiles": {"List": []},
        "BoundaryFiles": {
            "List": [
                [
                    "${R_IN}/ATM/LIMIT/AMIP.v20180427/original/360x180.v2/BCS/amipbc_sst_360x180_${year}.nc",
                    "amipbc_sst_1x1.nc",
                ],
                [
                    "${R_IN}/ATM/LIMIT/AMIP.v20180427/original/360x180.v2/BCS/amipbc_sic_360x180_${year}.nc",
                    "amipbc_sic_1x1.nc",
                ],
                [
                    "${R_IN}/ATM/OZONE/UReading/historical.v20160711.v2/original/144x96x66/tro3_${year}.nc",
                    "climoz.nc",
                ],
            ],
            "ListNonDel": [
                ["${R_IN}/ATM/INPUT_CE0L/Albedo4_deg.nc", "Albedo.nc"],
                ["${R_IN}/ATM/INPUT_CE0L/ECDYN4.nc", "ECDYN.nc"],
                ["${R_IN}/ATM/INPUT_CE0L/ECDYN4.nc", "ECPHY.nc"],
                [
                    "${R_IN}/ATM/INPUT_CE0L/Relief_GMTED2010_15n015_00625deg_plus_GA.nc",
                    "Relief.nc",
                ],
                ["${R_IN}/ATM/INPUT_CE0L/landiceref_GA_HR.new.nc", "landiceref.nc"],
                ["${R_IN}/ATM/INPUT_CE0L/Rugos4_deg.nc", "Rugos.nc"],
                [
                    "${R_IN}/ATM/INPUT_CE0L/OROGRAPHY/orography_nbp${RESOL_NBP}.nc",
                    "orography.nc",
                ],
                [
                    "${R_IN}/ATM/START/LAND_WATER_FRACTION/land_water_0.25.nc",
                    "land_water.nc",
                ],
                [
                    "${MODIPSL}/modeles/LMDZ/DefLists/context_lmdz_xios3.xml",
                    "context_lmdz.xml",
                ],
                [
                    "${MODIPSL}/modeles/LMDZ/DefLists/context_input_lmdz_xios3.xml",
                    "context_input_lmdz.xml",
                ],
                ["${MODIPSL}/modeles/LMDZ/DefLists/field_def_lmdz.xml", "."],
                ["${MODIPSL}/modeles/LMDZ/DefLists/field_def_cosp1.xml", "."],
                ["${MODIPSL}/modeles/LMDZ/DefLists/file_def_histmth_lmdz.xml", "."],
                ["${MODIPSL}/modeles/LMDZ/DefLists/file_def_histmthCOSP_lmdz.xml", "."],
                ["${MODIPSL}/modeles/LMDZ/DefLists/file_def_histmthNMC_lmdz.xml", "."],
                ["${MODIPSL}/modeles/LMDZ/DefLists/file_def_histday_lmdz.xml", "."],
                ["${MODIPSL}/modeles/LMDZ/DefLists/file_def_histdayCOSP_lmdz.xml", "."],
                ["${MODIPSL}/modeles/LMDZ/DefLists/file_def_histdayNMC_lmdz.xml", "."],
                ["${MODIPSL}/modeles/LMDZ/DefLists/file_def_histhf_lmdz.xml", "."],
                ["${MODIPSL}/modeles/LMDZ/DefLists/file_def_histhfCOSP_lmdz.xml", "."],
                ["${MODIPSL}/modeles/LMDZ/DefLists/file_def_histhfNMC_lmdz.xml", "."],
                ["${MODIPSL}/modeles/LMDZ/DefLists/file_def_histstn_lmdz.xml", "."],
                ["${MODIPSL}/modeles/LMDZ/DefLists/file_def_histins_lmdz.xml", "."],
                [
                    "${MODIPSL}/modeles/LMDZ/DefLists/file_def_histstrataer_lmdz.xml",
                    ".",
                ],
                [
                    "${MODIPSL}/modeles/LMDZ/DefLists/file_def_histdaystrataer_lmdz.xml",
                    ".",
                ],
                ["${MODIPSL}/modeles/LMDZ/DefLists/file_def_histLES_lmdz.xml", "."],
                [
                    "${R_IN}/ATM/AEROSOLS/CMIP6/v1/144x142/L${RESOL_ATM_Z}/aerosols1850_from_inca.nc",
                    "aerosols.nat.nc",
                ],
                [
                    "${R_IN}/ATM/AEROSOLS/CMIP6/v1/144x142/L${RESOL_ATM_Z}/aerosols1995_from_inca.nc",
                    "aerosols1980.nc",
                ],
                [
                    "${R_IN}/ATM/STRATAERO/CMIP6/v3/144x142/L${RESOL_ATM_Z}/taulwstrat.2D.ave.nc",
                    "taulwstrat.2D.nc",
                ],
                [
                    "${R_IN}/ATM/STRATAERO/CMIP6/v3/144x142/L${RESOL_ATM_Z}/tauswstrat.2D.ave.nc",
                    "tauswstrat.2D.nc",
                ],
            ],
        },
        "ParametersFiles": {
            "List": [
                ["${SUBMIT_DIR}/PARAM/LMDZ/physiq.def_${LMDZ_Physics}", "physiq.def"],
                ["${SUBMIT_DIR}/PARAM/LMDZ/vert.def_L${RESOL_ATM_Z}", "vert.def"],
                ["${SUBMIT_DIR}/PARAM/LMDZ/config.def_actuel", "config.def"],
                ["${SUBMIT_DIR}/PARAM/LMDZ/run.def", "."],
                ["${SUBMIT_DIR}/PARAM/LMDZ/tracer.def", "."],
            ]
        },
        "RestartFiles": {"List": [None]},
        "OutputText": {
            "List": [
                "physiq.def",
                "gcm.def",
                "vert.def",
                "run.def",
                "config.def",
                "tracer.def",
                "guide.def",
                "context_lmdz.xml",
                "context_input_lmdz.xml",
                "field_def_lmdz.xml",
                "file_def_*lmdz.xml",
            ]
        },
        "OutputFiles": {
            "List": [
                [
                    "limit.nc",
                    "${R_OUT_ATM_O}/Boundary/${config_UserChoices_JobName}_${year}_limit.nc",
                    None,
                ],
                [
                    "climoz_LMDZ.nc",
                    "${R_OUT_ATM_O}/Boundary/${config_UserChoices_JobName}_${year}_climoz_LMDZ.nc",
                    None,
                ],
                [
                    "startphy.nc",
                    "${R_OUT_ATM_O}/Restart/${config_UserChoices_JobName}_${year}_startphy.nc",
                    None,
                ],
                [
                    "grid_atm.nc",
                    "${R_OUT_ATM_O}/Grid/${config_UserChoices_JobName}_${year}_grid_atm.nc",
                    None,
                ],
            ]
        },
    }
test_load_orchidee 
test_load_orchidee(orchidee)
Source code in tests/test_card_file.py 
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
def test_load_orchidee(orchidee):
    assert orchidee == {
        "Compatibility": {"libIGCM": 1.0},
        "UserChoices": {
            "AtmCo2": 369.12,
            "DefSuffix": "15pft.1ac",
            "VEGET_UPDATE_at_start": False,
            "VEGET_UPDATE": "0Y",
            "ROUTING": "interp_topo",
            "output_level_sechiba_history": 5,
            "output_level_sechiba_out_2": None,
            "output_level_sechiba_history_4dim": None,
            "output_level_diag_routing": 1,
            "output_level_diag_routing_r": 1,
            "output_level_forcing_by_ORCHIDEE": None,
            "output_freq_sechiba_history": "1mo",
            "output_freq_sechiba_out_2": "1d",
            "output_freq_sechiba_history_4dim": "1mo",
        },
        "InitialStateFiles": {
            "List": [
                ["${R_IN}/SRF/SOIL/soil_bulk_and_ph.nc", "."],
                [
                    "${R_IN}/SRF/SOIL/soils_param_usda_with_clay_oxisol_coord.nc",
                    "soils_param.nc",
                ],
                ["${R_IN}/SRF/SOIL/soils_param_zobler_coord.nc", "soilcolor.nc"],
                ["${R_IN}/SRF/cartepente2d_15min4.nc", "cartepente2d_15min.nc"],
                ["${R_IN}/SRF/reftemp4.nc", "reftemp.nc"],
                ["${R_IN}/SRF/albedo/alb_bg_optv4c_nonsmoothedvis.nc", "alb_bg.nc"],
                [
                    "${R_IN}/SRF/PFTMAPS/CMIP6/ESA-LUH2v2/historical/15PFT.v2023.1/PFTmap_2000.nc",
                    "PFTmap.nc",
                ],
            ]
        },
        "BoundaryFiles": {
            "List": [],
            "ListNonDel": ["${R_IN}/SRF/ROUTING/routing_simple.nc", "routing.nc"],
        },
        "SmoothFiles": {"List": []},
        "ParametersFiles": {
            "List": [
                ["${SUBMIT_DIR}/PARAM/ORCHIDEE/orchidee.def_v4", "orchidee.def"],
                [
                    "${SUBMIT_DIR}/PARAM/ORCHIDEE/orchidee_pft.def_${DefSuffix}_v4",
                    "orchidee_pft.def",
                ],
                ["${MODIPSL}/modeles/ORCHIDEE_4/src_xml/file_def_orchidee.xml", "."],
                [
                    "${MODIPSL}/modeles/ORCHIDEE_4/src_xml/context_input_orchidee.xml",
                    ".",
                ],
                ["${MODIPSL}/modeles/ORCHIDEE_4/src_xml/context_orchidee.xml", "."],
                [
                    "${MODIPSL}/modeles/ORCHIDEE_4/src_xml/context_routing_interp_topo_v0_orchidee_xios3.xml",
                    "context_routing_interp_topo_v0_orchidee.xml",
                ],
                [
                    "${MODIPSL}/modeles/ORCHIDEE_4/src_xml/context_routing_interp_topo_orchidee_xios3.xml",
                    "context_routing_interp_topo_orchidee.xml",
                ],
                [
                    "${MODIPSL}/modeles/ORCHIDEE_4/src_xml/context_init_routing_interp_topo_orchidee.xml",
                    ".",
                ],
                ["${MODIPSL}/modeles/ORCHIDEE_4/src_xml/field_def_orchidee.xml", "."],
            ]
        },
        "RestartFiles": {
            "List": [
                ["sechiba_rest_out.nc", "sechiba_rest.nc", "sechiba_rest_in.nc"],
                ["routing_restart.nc", "routing_restart.nc", "routing_start.nc"],
            ]
        },
        "OutputText": {
            "List": [
                "out_orchidee*",
                "orchidee.def",
                "orchidee_pft.def",
                "used_orchidee.def",
                "used_orchidee_pft.def",
                "iodef.xml",
                "context_orchidee.xml",
                "context_input_orchidee.xml",
                "context_routing_interp_topo_v0_orchidee.xml",
                "context_routing_interp_topo_orchidee.xml",
                "context_init_routing_interp_topo_orchidee.xml",
                "field_def_orchidee.xml",
                "file_def_orchidee.xml",
                "river_desc.nc",
            ]
        },
        "OutputFiles": {
            "List": [
                [
                    "sechiba_history.nc",
                    "${R_OUT_SRF_O_M}/${PREFIX}_1M_sechiba_history.nc",
                    "Post_1M_sechiba_history",
                ],
                [
                    "sechiba_history_4dim.nc",
                    "${R_OUT_SRF_O_M}/${PREFIX}_1M_sechiba_history_4dim.nc",
                    None,
                ],
                [
                    "sechiba_out_2.nc",
                    "${R_OUT_SRF_O_H}/${PREFIX}_HF_sechiba_out_2.nc",
                    None,
                ],
                [
                    "ORCHIDEE_interp_diag.nc",
                    "${R_OUT_SRF_O_D}/${PREFIX}_ORCHIDEE_interp_diag.nc",
                    None,
                ],
                [
                    "forcing_by_ORCHIDEE.nc",
                    "${R_OUT_SRF_O_H}/${PREFIX}_forcing_by_ORCHIDEE.nc",
                    None,
                ],
                [
                    "diag_routing.nc",
                    "${R_OUT_SRF_O_D}/${PREFIX}_1D_sechiba_routing.nc",
                    None,
                ],
                [
                    "diag_routing_r.nc",
                    "${R_OUT_SRF_O_D}/${PREFIX}_1D_sechiba_routing_r.nc",
                    None,
                ],
            ]
        },
        "Post_1M_sechiba_history": {
            "Patches": [],
            "GatherWithInternal": [
                "lon",
                "lat",
                "time_counter",
                "Areas",
                "Contfrac",
                "time_centered",
                "time_centered_bounds",
            ],
            "TimeSeriesVars2D": [
                "nobiofrac",
                "alb_nir",
                "alb_vis",
                "evap",
                "fluxlat",
                "fluxsens",
                "rain",
                "runoff",
                "snow",
                "snowf",
                "frac_snow",
                "subli",
                "tair",
                "temp_sol",
                "drainage",
                "humtot_top",
                "mrso",
                "TWBR",
                "riverflow",
                "coastalflow",
                "DelSoilMoist_daily",
                "DelIntercept_daily",
                "DelSWE_daily",
                "delstock_routing_daily",
                "LAImean",
                "transpir",
                "evapnu",
                "lwdown",
                "swdown",
                "gppCrop",
                "rhCrop",
                "Ca",
            ],
            "ChunckJob2D": None,
            "TimeSeriesVars3D": [
                "lai",
                "maxvegetfrac",
                "vegetfrac",
                "nee",
                "gpp",
                "growth_resp",
                "hetero_resp",
                "humrel",
                "inter",
                "maint_resp",
                "npp",
                "precisol",
            ],
            "ChunckJob3D": None,
            "Seasonal": "ON",
        },
        "Post_HF_sechiba_out_2": {
            "Patches": [],
            "GatherWithInternal": [
                "lon",
                "lat",
                "time_counter",
                "Areas",
                "Contfrac",
                "time_centered",
                "time_centered_bounds",
            ],
            "TimeSeriesVars2D": [],
            "ChunckJob2D": None,
            "TimeSeriesVars3D": ["snowdz", "snowtemp", "snowrho"],
            "ChunckJob3D": None,
            "Seasonal": "OFF",
        },
    }
test_load_test_card 
test_load_test_card(test_card)
Source code in tests/test_card_file.py 
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
def test_load_test_card(test_card):
    assert test_card == {
        "Messages": {
            "Option1": '"Hello Earth"',
            "Option2": '"Hello Mars"',
            "ListVal1": [],
            "ListVal2": [],
            "ListVal3": [],
        },
        "Recipes": {"Cake": '"file1.doc"', "Starter": '"file2.doc"'},
        "ColorValues": {"Red": 120, "Blue": 230, "Green": 178, "AnotherRed": 234},
        "Couples": {
            "List1": [
                ["up", "down"],
                ["humid", "dry"],
                ["hot", "cold"],
                ["far", "close"],
            ],
            "List2": ["ice", "fire", "air", "water"],
        },
    }
test_load_xios 
test_load_xios(xios)
Source code in tests/test_card_file.py 
624
625
626
627
628
629
630
631
632
633
634
635
636
637
def test_load_xios(xios):
    assert xios == {
        "Compatibility": {"libIGCM": 1.0},
        "UserChoices": {},
        "InitialStateFiles": {"List": []},
        "BoundaryFiles": {"List": [], "ListNonDel": []},
        "SmoothFiles": {"List": []},
        "ParametersFiles": {"List": ["${SUBMIT_DIR}/PARAM/XIOS/iodef.xml", "."]},
        "RestartFiles": {"List": [None]},
        "OutputText": {
            "List": ["xios_client_*", "out_xios.x.err.*", "out_xios.x.out.*"]
        },
        "OutputFiles": {"List": []},
    }
test_two_empty_sections 
test_two_empty_sections()
Source code in tests/test_card_file.py 
667
668
669
670
def test_two_empty_sections():
    empty_sections = {"section1": {}, "section2": {}}
    assert loads("[section2]\n[section1]") == empty_sections
    assert loads(dumps(empty_sections)) == empty_sections
xios 
xios()
Source code in tests/test_card_file.py 
619
620
621
@pytest.fixture
def xios():
    return _load_file("xios.card.r7417")

test_card_file_decoder

Unit tests of CardFileDecoder

Functions:

decoder 
decoder()

Initialize classical decoder

Source code in tests/test_card_file_decoder.py 
 9
10
11
12
@pytest.fixture
def decoder():
    """Initialize classical decoder"""
    return CardFileDecoder()
test_float 
test_float(decoder)

Test decoding float numbers

Source code in tests/test_card_file_decoder.py 
84
85
86
87
88
89
90
91
def test_float(decoder):
    """Test decoding float numbers"""
    assert decoder.decode("a=3.1415") == {"a": 3.1415}
    assert decoder.decode("a=3.14e2") == {"a": 314}
    assert decoder.decode("a=3.14e-2") == {"a": 0.0314}
    assert decoder.decode("a=-3.1415") == {"a": -3.1415}
    assert decoder.decode("a=-3.14e2") == {"a": -314}
    assert decoder.decode("a=-3.14e-2") == {"a": -0.0314}
test_integer 
test_integer(decoder)

Test decoding integer numbers

Source code in tests/test_card_file_decoder.py 
75
76
77
78
79
80
81
def test_integer(decoder):
    """Test decoding integer numbers"""
    assert decoder.decode("a=1") == {"a": 1}
    assert decoder.decode("a=-1") == {"a": -1}
    assert decoder.decode("a=-0") == {"a": 0}
    assert decoder.decode("a=+0") == {"a": 0}
    assert decoder.decode("a=6123") == {"a": 6123}
test_invalid 
test_invalid(decoder)

Test decoding invalid files

Source code in tests/test_card_file_decoder.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
def test_invalid(decoder):
    """Test decoding invalid files"""
    # Unnamed section
    with pytest.raises(UnexpectedCharacters):
        decoder.decode("[]")
    # Missing key and value
    with pytest.raises(UnexpectedCharacters):
        decoder.decode("=")
    # Missing value
    with pytest.raises(UnexpectedCharacters):
        decoder.decode("=1")
    # Literal without a key
    with pytest.raises(UnexpectedCharacters):
        decoder.decode("1")
    with pytest.raises(UnexpectedCharacters):
        decoder.decode("'1'")
    # Missing `,` in the nested list
    with pytest.raises(UnexpectedCharacters):
        decoder.decode("a=()\\()")
    # Missing `\` in the nested list
    with pytest.raises(UnexpectedCharacters):
        decoder.decode("a=(),()")
test_list 
test_list(decoder)

Test decoding of lists

Source code in tests/test_card_file_decoder.py 
41
42
43
44
45
46
def test_list(decoder):
    """Test decoding of lists"""
    assert decoder.decode("a = ()") == {"a": []}
    assert decoder.decode("a = (1,2)") == {"a": [1, 2]}
    assert decoder.decode("a = (1,2,3)") == {"a": [1, 2, 3]}
    assert decoder.decode("a = (a, 2, y)") == {"a": ["a", 2, True]}
test_literal 
test_literal(decoder)

Test decoding standard key-value entries

Source code in tests/test_card_file_decoder.py 
30
31
32
33
34
35
36
37
38
def test_literal(decoder):
    """Test decoding standard key-value entries"""
    assert decoder.decode("a=") == {"a": None}
    assert decoder.decode("a=3") == {"a": 3}
    assert decoder.decode("a=text\nb='text'\nc=\"text\"") == {
        "a": "text",
        "b": "'text'",
        "c": '"text"',
    }
test_logical 
test_logical(decoder)

Test decoding logical values

Source code in tests/test_card_file_decoder.py 
 94
 95
 96
 97
 98
 99
100
101
def test_logical(decoder):
    """Test decoding logical values"""
    assert decoder.decode("a = true\nb=y\nc=TRUE") == {"a": True, "b": True, "c": True}
    assert decoder.decode("a = false\nb=n\nc=FALSE") == {
        "a": False,
        "b": False,
        "c": False,
    }
test_nested_list 
test_nested_list(decoder)

Test decoding of nested lists (lists of lists)

Source code in tests/test_card_file_decoder.py 
49
50
51
52
53
54
55
56
def test_nested_list(decoder):
    """Test decoding of nested lists (lists of lists)"""
    assert decoder.decode("a = (),\\()") == {"a": [[], []]}
    assert decoder.decode("a = (1,2),\\(3,4)") == {"a": [[1, 2], [3, 4]]}
    assert decoder.decode("a = (1,2,3), \\(a,b)") == {"a": [[1, 2, 3], ["a", "b"]]}
    assert decoder.decode("a = (y),\\(n),\\(y),\\(n)") == {
        "a": [[True], [False], [True], [False]]
    }
test_range 
test_range(decoder)

Test decoding of ranges in the form START:STEP:END

Source code in tests/test_card_file_decoder.py 
59
60
61
62
def test_range(decoder):
    """Test decoding of ranges in the form START:STEP:END"""
    assert decoder.decode("a=1:2:3") == {"a": (1, 2, 3)}
    assert decoder.decode("a=-100:-5:-200") == {"a": (-100, -5, -200)}
test_section 
test_section(decoder)

Test decoding sections

Source code in tests/test_card_file_decoder.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
def test_section(decoder):
    """Test decoding sections"""
    assert decoder.decode("[section1][section2]") == {"section1": {}, "section2": {}}
    assert decoder.decode("[section1]\n[section2]") == {"section1": {}, "section2": {}}
    assert decoder.decode("[section1]\na=3\nb=(1,2,3)[section2]c='some text'") == {
        "section1": {"a": 3, "b": [1, 2, 3]},
        "section2": {"c": "'some text'"},
    }
    assert decoder.decode("a=1\n[section1]b=1\n[section2]\nc=3") == {
        "a": 1,
        "section1": {"b": 1},
        "section2": {"c": 3},
    }
test_string 
test_string(decoder)

Test decoding strings (quoted and unqoted)

Source code in tests/test_card_file_decoder.py 
65
66
67
68
69
70
71
72
def test_string(decoder):
    """Test decoding strings (quoted and unqoted)"""
    assert decoder.decode("a=text") == {"a": "text"}
    assert decoder.decode("a='text'") == {"a": "'text'"}
    assert decoder.decode('a="text"') == {"a": '"text"'}
    assert decoder.decode("file1=${SUBMIT_DIR}/../${year}/some_file.ext") == {
        "file1": "${SUBMIT_DIR}/../${year}/some_file.ext"
    }

test_card_file_decoder_positions

Unit tests of CardFileDecoder positions decoding

Functions:

decoder 
decoder()

Initialize decoder with value position parsing

Source code in tests/test_card_file_decoder_positions.py 
 8
 9
10
11
@pytest.fixture
def decoder():
    """Initialize decoder with value position parsing"""
    return CardFileDecoder(include_positions=True)
test_compound_positions 
test_compound_positions(decoder)

Test decoding of various positions

Source code in tests/test_card_file_decoder_positions.py 
74
75
76
77
78
79
80
81
82
83
84
85
def test_compound_positions(decoder):
    """Test decoding of various positions"""
    assert decoder.decode("a=1\nb='text'\nc=3.14") == {
        "a": {"value": 1, "key_start_pos": 0, "start_pos": 2, "end_pos": 3},
        "b": {"value": "'text'", "key_start_pos": 4, "start_pos": 6, "end_pos": 12},
        "c": {
            "value": 3.14,
            "key_start_pos": 13,
            "start_pos": 15,
            "end_pos": 19,
        },
    }
test_float_positions 
test_float_positions(decoder)

Test decoded positions of float numbers

Source code in tests/test_card_file_decoder_positions.py 
308
309
310
311
312
313
314
315
def test_float_positions(decoder):
    """Test decoded positions of float numbers"""
    assert decoder.decode("a=3.14e-2") == {
        "a": {"value": 0.0314, "start_pos": 2, "end_pos": 9, "key_start_pos": 0}
    }
    assert decoder.decode("a=-3.14e-2") == {
        "a": {"value": -0.0314, "start_pos": 2, "end_pos": 10, "key_start_pos": 0}
    }
test_integer_positions 
test_integer_positions(decoder)

Test decoded positions of integer numbers

Source code in tests/test_card_file_decoder_positions.py 
298
299
300
301
302
303
304
305
def test_integer_positions(decoder):
    """Test decoded positions of integer numbers"""
    assert decoder.decode("a=-1") == {
        "a": {"value": -1, "start_pos": 2, "end_pos": 4, "key_start_pos": 0}
    }
    assert decoder.decode("a=6123") == {
        "a": {"value": 6123, "start_pos": 2, "end_pos": 6, "key_start_pos": 0}
    }
test_list_positions 
test_list_positions(decoder)

Test decoded positions of various lists

Source code in tests/test_card_file_decoder_positions.py 
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
def test_list_positions(decoder):
    """Test decoded positions of various lists"""
    assert decoder.decode("a= ()") == {
        "a": {"value": [], "start_pos": 3, "end_pos": 5, "key_start_pos": 0}
    }
    assert decoder.decode("a = (1,2)") == {
        "a": {
            "value": [
                {"value": 1, "start_pos": 5, "end_pos": 6},
                {"value": 2, "start_pos": 7, "end_pos": 8},
            ],
            "start_pos": 4,
            "end_pos": 9,
            "key_start_pos": 0,
        }
    }
    assert decoder.decode("a = (1,2,3)") == {
        "a": {
            "value": [
                {"value": 1, "start_pos": 5, "end_pos": 6},
                {"value": 2, "start_pos": 7, "end_pos": 8},
                {"value": 3, "start_pos": 9, "end_pos": 10},
            ],
            "start_pos": 4,
            "end_pos": 11,
            "key_start_pos": 0,
        }
    }

    assert decoder.decode("a = (a, 2, y)") == {
        "a": {
            "value": [
                {"value": "a", "start_pos": 5, "end_pos": 6},
                {"value": 2, "start_pos": 8, "end_pos": 9},
                {"value": True, "start_pos": 11, "end_pos": 12},
            ],
            "start_pos": 4,
            "end_pos": 13,
            "key_start_pos": 0,
        }
    }
test_literal_positions 
test_literal_positions(decoder)

Test decoded positions of all literals

Source code in tests/test_card_file_decoder_positions.py 
88
89
90
91
92
93
94
95
96
97
98
def test_literal_positions(decoder):
    """Test decoded positions of all literals"""
    assert decoder.decode("k=") == {
        "k": {"value": None, "start_pos": 2, "end_pos": 2, "key_start_pos": 0}
    }
    assert decoder.decode("k=y") == {
        "k": {"value": True, "start_pos": 2, "end_pos": 3, "key_start_pos": 0}
    }
    assert decoder.decode("k=false") == {
        "k": {"value": False, "start_pos": 2, "end_pos": 7, "key_start_pos": 0}
    }
test_logical_positions 
test_logical_positions(decoder)

Test decoded positions of logical values

Source code in tests/test_card_file_decoder_positions.py 
318
319
320
321
322
323
324
def test_logical_positions(decoder):
    """Test decoded positions of logical values"""
    assert decoder.decode("a = true\nb=y\nc=TRUE") == {
        "a": {"value": True, "start_pos": 4, "end_pos": 8, "key_start_pos": 0},
        "b": {"value": True, "start_pos": 11, "end_pos": 12, "key_start_pos": 9},
        "c": {"value": True, "start_pos": 15, "end_pos": 19, "key_start_pos": 13},
    }
test_nested_list_positions 
test_nested_list_positions(decoder)

Test decoding of nested lists (lists of lists)

Source code in tests/test_card_file_decoder_positions.py 
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
def test_nested_list_positions(decoder):
    """Test decoding of nested lists (lists of lists)"""
    assert decoder.decode("a = (),\\()") == {
        "a": {
            "start_pos": 4,
            "end_pos": 10,
            "key_start_pos": 0,
            "value": [
                {
                    "value": [],
                    "start_pos": 4,
                    "end_pos": 6,
                },
                {
                    "value": [],
                    "start_pos": 8,
                    "end_pos": 10,
                },
            ],
        }
    }
    assert decoder.decode("a = (1,2),\\(3,4)") == {
        "a": {
            "start_pos": 4,
            "end_pos": 16,
            "key_start_pos": 0,
            "value": [
                {
                    "value": [
                        {
                            "value": 1,
                            "start_pos": 5,
                            "end_pos": 6,
                        },
                        {
                            "value": 2,
                            "start_pos": 7,
                            "end_pos": 8,
                        },
                    ],
                    "start_pos": 4,
                    "end_pos": 9,
                },
                {
                    "value": [
                        {
                            "value": 3,
                            "start_pos": 12,
                            "end_pos": 13,
                        },
                        {
                            "value": 4,
                            "start_pos": 14,
                            "end_pos": 15,
                        },
                    ],
                    "start_pos": 11,
                    "end_pos": 16,
                },
            ],
        }
    }
    assert decoder.decode("a=(1,2,3),\\(a,b),\\(y)") == {
        "a": {
            "start_pos": 2,
            "end_pos": 21,
            "key_start_pos": 0,
            "value": [
                {
                    "value": [
                        {
                            "value": 1,
                            "start_pos": 3,
                            "end_pos": 4,
                        },
                        {
                            "value": 2,
                            "start_pos": 5,
                            "end_pos": 6,
                        },
                        {
                            "value": 3,
                            "start_pos": 7,
                            "end_pos": 8,
                        },
                    ],
                    "start_pos": 2,
                    "end_pos": 9,
                },
                {
                    "value": [
                        {
                            "value": "a",
                            "start_pos": 12,
                            "end_pos": 13,
                        },
                        {
                            "value": "b",
                            "start_pos": 14,
                            "end_pos": 15,
                        },
                    ],
                    "start_pos": 11,
                    "end_pos": 16,
                },
                {
                    "value": [
                        {
                            "value": True,
                            "start_pos": 19,
                            "end_pos": 20,
                        }
                    ],
                    "start_pos": 18,
                    "end_pos": 21,
                },
            ],
        }
    }
test_range_positions 
test_range_positions(decoder)

Test decoded positions of ranges in the form START:STEP:END

Source code in tests/test_card_file_decoder_positions.py 
265
266
267
268
269
270
271
272
273
274
275
276
277
def test_range_positions(decoder):
    """Test decoded positions of ranges in the form START:STEP:END"""
    assert decoder.decode("a=1:2:3") == {
        "a": {"value": (1, 2, 3), "start_pos": 2, "end_pos": 7, "key_start_pos": 0}
    }
    assert decoder.decode("a=-100:-5:-200") == {
        "a": {
            "value": (-100, -5, -200),
            "start_pos": 2,
            "end_pos": 14,
            "key_start_pos": 0,
        }
    }
test_section_positions 
test_section_positions(decoder)

Test decoded positions of sections

Source code in tests/test_card_file_decoder_positions.py 
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
def test_section_positions(decoder):
    """Test decoded positions of sections"""
    assert decoder.decode("[section1][section2]") == {
        "section1": {"value": {}, "section_start_pos": 0, "section_end_pos": 10},
        "section2": {"value": {}, "section_start_pos": 10, "section_end_pos": 20},
    }
    assert decoder.decode("[section1]\n[section2]") == {
        "section1": {"value": {}, "section_start_pos": 0, "section_end_pos": 10},
        "section2": {"value": {}, "section_start_pos": 11, "section_end_pos": 21},
    }
    assert decoder.decode("[section1]\na=3\nb=(1,2,3)[section2]c='some text'") == {
        "section1": {
            "section_start_pos": 0,
            "section_end_pos": 24,
            "value": {
                "a": {"value": 3, "key_start_pos": 11, "start_pos": 13, "end_pos": 14},
                "b": {
                    "value": [
                        {"value": 1, "start_pos": 18, "end_pos": 19},
                        {"value": 2, "start_pos": 20, "end_pos": 21},
                        {"value": 3, "start_pos": 22, "end_pos": 23},
                    ],
                    "key_start_pos": 15,
                    "start_pos": 17,
                    "end_pos": 24,
                },
            },
        },
        "section2": {
            "section_start_pos": 24,
            "section_end_pos": 47,
            "value": {
                "c": {
                    "value": "'some text'",
                    "key_start_pos": 34,
                    "start_pos": 36,
                    "end_pos": 47,
                }
            },
        },
    }
    assert decoder.decode("a=1\n[section1]b=1\n[section2]\nc=3") == {
        "a": {"value": 1, "key_start_pos": 0, "start_pos": 2, "end_pos": 3},
        "section1": {
            "section_start_pos": 4,
            "section_end_pos": 17,
            "value": {
                "b": {"value": 1, "key_start_pos": 14, "start_pos": 16, "end_pos": 17}
            },
        },
        "section2": {
            "section_start_pos": 18,
            "section_end_pos": 32,
            "value": {
                "c": {"value": 3, "key_start_pos": 29, "start_pos": 31, "end_pos": 32}
            },
        },
    }
test_string_positions 
test_string_positions(decoder)

Test decoded positions of strings (quoted and unqoted)

Source code in tests/test_card_file_decoder_positions.py 
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
def test_string_positions(decoder):
    """Test decoded positions of strings (quoted and unqoted)"""
    assert decoder.decode("key='text'") == {
        "key": {"value": "'text'", "start_pos": 4, "end_pos": 10, "key_start_pos": 0}
    }
    assert decoder.decode('a="text"') == {
        "a": {"value": '"text"', "start_pos": 2, "end_pos": 8, "key_start_pos": 0}
    }
    assert decoder.decode("file1=${SUBMIT_DIR}/../${year}/some_file.ext") == {
        "file1": {
            "value": "${SUBMIT_DIR}/../${year}/some_file.ext",
            "start_pos": 6,
            "end_pos": 44,
            "key_start_pos": 0,
        }
    }

test_card_file_encoder

Functions:

encoder 
encoder()
Source code in tests/test_card_file_encoder.py 
6
7
8
@pytest.fixture
def encoder():
    return CardFileEncoder()
encoder_bool_labels 
encoder_bool_labels()
Source code in tests/test_card_file_encoder.py 
11
12
13
@pytest.fixture
def encoder_bool_labels():
    return CardFileEncoder(truthy_value="y", falsey_value="n")
encoder_explicit_kv_none 
encoder_explicit_kv_none()
Source code in tests/test_card_file_encoder.py 
16
17
18
@pytest.fixture
def encoder_explicit_kv_none():
    return CardFileEncoder(encode_none_in_kv=True)
test_bool 
test_bool(encoder)
Source code in tests/test_card_file_encoder.py 
81
82
83
def test_bool(encoder):
    assert encoder.encode(True) == "true"
    assert encoder.encode(False) == "false"
test_bool_labels 
test_bool_labels(encoder_bool_labels)
Source code in tests/test_card_file_encoder.py 
86
87
88
def test_bool_labels(encoder_bool_labels):
    assert encoder_bool_labels.encode(True) == "y"
    assert encoder_bool_labels.encode(False) == "n"
test_float 
test_float(encoder)
Source code in tests/test_card_file_encoder.py 
91
92
93
94
95
96
def test_float(encoder):
    assert encoder.encode(-1.0) == "-1.0"
    assert encoder.encode(+1.0) == "1.0"
    assert encoder.encode(5e4) == "50000.0"
    assert encoder.encode(3.14e2) == "314.0"
    assert encoder.encode(3.14e-2) == "0.0314"
test_int 
test_int(encoder)
Source code in tests/test_card_file_encoder.py 
 99
100
101
102
def test_int(encoder):
    assert encoder.encode(-1) == "-1"
    assert encoder.encode(+1) == "1"
    assert encoder.encode(int(5e4)) == "50000"
test_invalid 
test_invalid(encoder)
Source code in tests/test_card_file_encoder.py 
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
def test_invalid(encoder):
    with pytest.raises(ValueError, match="Section name can't be empty"):
        encoder.encode({"": {}})
    with pytest.raises(ValueError, match="can't contain double-nested dicts"):
        encoder.encode({"section": {"k": {}}})
    with pytest.raises(ValueError, match="can't contain dicts"):
        encoder.encode([1, {}])
    with pytest.raises(ValueError, match="Single nested list .* is prohibited"):
        encoder.encode([[]])
    with pytest.raises(ValueError, match="Range must contain 3 values"):
        encoder.encode(tuple())
    with pytest.raises(ValueError, match="Range must contain 3 values"):
        encoder.encode((1,))
    with pytest.raises(ValueError, match="Range must contain 3 values"):
        encoder.encode((1, 2))
    with pytest.raises(ValueError, match="Range must contain 3 values"):
        encoder.encode((1, 2, 3, 4))
    with pytest.raises(ValueError, match="Range must contain 3 ints"):
        encoder.encode((1, 2, 3.14))
    with pytest.raises(ValueError, match="Range must contain 3 ints"):
        encoder.encode((True, "text", 3.14))
test_kv 
test_kv(encoder)
Source code in tests/test_card_file_encoder.py 
54
55
56
57
def test_kv(encoder):
    assert encoder.encode({"p": 1}) == "p=1"
    assert encoder.encode({"p": 1, "q": 2}) == "p=1\nq=2"
    assert encoder.encode({"p": True, "q": 2.12}) == "p=true\nq=2.12"
test_list 
test_list(encoder)
Source code in tests/test_card_file_encoder.py 
60
61
62
63
64
65
66
67
def test_list(encoder):
    assert encoder.encode({"a": []}) == "a=()"
    assert encoder.encode({"a": [True]}) == "a=(true)"
    assert encoder.encode({"a": [1, 2, 3]}) == "a=(1, 2, 3)"
    assert (
        encoder.encode({"a": [3.14, False, "text", "'more text'"]})
        == "a=(3.14, false, text, 'more text')"
    )
test_nested_list 
test_nested_list(encoder)
Source code in tests/test_card_file_encoder.py 
70
71
72
73
def test_nested_list(encoder):
    assert encoder.encode({"a": [[], []]}) == "a=(), \\\n  ()"
    assert encoder.encode({"a": [[1], []]}) == "a=(1), \\\n  ()"
    assert encoder.encode({"a": [[1, 2, 3], ["text"]]}) == "a=(1, 2, 3), \\\n  (text)"
test_none 
test_none(encoder, encoder_explicit_kv_none)
Source code in tests/test_card_file_encoder.py 
43
44
45
46
47
48
49
50
51
def test_none(encoder, encoder_explicit_kv_none):
    assert encoder.encode({"p": None}) == "p="
    assert encoder.encode({"p": []}) == "p=()"
    assert encoder.encode({"p": [None]}) == "p=(NONE)"
    assert encoder.encode({"p": [None, None]}) == "p=(NONE, NONE)"
    assert encoder_explicit_kv_none.encode({"p": None}) == "p=NONE"
    assert encoder_explicit_kv_none.encode({"p": []}) == "p=()"
    assert encoder_explicit_kv_none.encode({"p": [None]}) == "p=(NONE)"
    assert encoder_explicit_kv_none.encode({"p": [None, None]}) == "p=(NONE, NONE)"
test_range 
test_range(encoder)
Source code in tests/test_card_file_encoder.py 
76
77
78
def test_range(encoder):
    assert encoder.encode((1, 2, 3)) == "1:2:3"
    assert encoder.encode((-100, -5, 300)) == "-100:-5:300"
test_section 
test_section(encoder)
Source code in tests/test_card_file_encoder.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
def test_section(encoder):
    assert encoder.encode({"section1": {}}) == "[section1]"
    assert encoder.encode({"section1": {}, "section2": {}}) == "[section1]\n[section2]"
    assert (
        encoder.encode({"section1": {"a": 1}, "section2": {}})
        == "[section1]\na=1\n[section2]"
    )
    assert (
        encoder.encode({"section1": {}, "section2": {"a": 1}})
        == "[section1]\n[section2]\na=1"
    )
    assert (
        encoder.encode({"section1": {"a": 1}, "section2": {"a": 1}})
        == "[section1]\na=1\n[section2]\na=1"
    )
    # Top-level kv are placed before any section
    assert (
        encoder.encode({"section1": {}, "a": 1, "section2": {}})
        == "a=1\n[section1]\n[section2]"
    )

test_card_file_modify

Functions:

all_datatypes_dict 
all_datatypes_dict() -> dict
Source code in tests/test_card_file_modify.py 
21
22
23
@pytest.fixture
def all_datatypes_dict() -> dict:
    return _decode_file("all_datatypes.card")
all_datatypes_modified_str 
all_datatypes_modified_str() -> str
Source code in tests/test_card_file_modify.py 
31
32
33
@pytest.fixture
def all_datatypes_modified_str() -> str:
    return _read_file("all_datatypes.card.modified")
all_datatypes_str 
all_datatypes_str() -> str
Source code in tests/test_card_file_modify.py 
26
27
28
@pytest.fixture
def all_datatypes_str() -> str:
    return _read_file("all_datatypes.card")
test_append_kv 
test_append_kv(three_kv_str, three_kv_dict)

Test appending new key-value pair at the section end

Source code in tests/test_card_file_modify.py 
135
136
137
138
def test_append_kv(three_kv_str, three_kv_dict):
    """Test appending new key-value pair at the section end"""
    three_kv_dict["d"] = 42
    assert modifys(three_kv_str, three_kv_dict) == "[null]\na=1\nb=2\nc=3\nd=42"
test_append_kv_header 
test_append_kv_header(three_kv_str, three_kv_dict)

Test appending new key-value pair with a header at the section end

Source code in tests/test_card_file_modify.py 
141
142
143
144
145
146
147
def test_append_kv_header(three_kv_str, three_kv_dict):
    """Test appending new key-value pair with a header at the section end"""
    three_kv_dict["d"] = 42
    assert (
        modifys(three_kv_str, three_kv_dict, insert_header="New values")
        == "[null]\na=1\nb=2\nc=3\n# New values\nd=42"
    )
test_append_section 
test_append_section(
    three_section_kv_str, three_section_kv_dict
)

Test appending new sections

Source code in tests/test_card_file_modify.py 
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
def test_append_section(three_section_kv_str, three_section_kv_dict):
    """Test appending new sections"""
    append_with_header = three_section_kv_dict.copy()
    append_with_header["s4"] = {"k1": 33, "k2": 42}
    assert (
        modifys(three_section_kv_str, append_with_header)
        == "[s1]\na=1\n[s2]\nb=2\n[s3]\nc=3\n[s4]\nk1=33\nk2=42"
    )
    append_two = three_section_kv_dict.copy()
    append_two["s4"] = {}
    append_two["s5"] = {"k1": 33, "k2": 42}
    assert (
        modifys(three_section_kv_str, append_two)
        == "[s1]\na=1\n[s2]\nb=2\n[s3]\nc=3\n[s4]\n[s5]\nk1=33\nk2=42"
    )
    append_with_header = three_section_kv_dict.copy()
    append_with_header["s4"] = {"k1": 33, "k2": 42}
    assert (
        modifys(three_section_kv_str, append_with_header, insert_header="New sections")
        == "[s1]\na=1\n[s2]\nb=2\n[s3]\nc=3\n# New sections\n[s4]\nk1=33\nk2=42"
    )
test_modify_first_kv 
test_modify_first_kv(three_kv_str, three_kv_dict)

Test modifying first key-value pair

Source code in tests/test_card_file_modify.py 
117
118
119
120
def test_modify_first_kv(three_kv_str, three_kv_dict):
    """Test modifying first key-value pair"""
    three_kv_dict["null"]["a"] = 42
    assert modifys(three_kv_str, three_kv_dict) == "[null]\na=42\nb=2\nc=3"
test_modify_last_kv 
test_modify_last_kv(three_kv_str, three_kv_dict)

Test modifying last key-value pair

Source code in tests/test_card_file_modify.py 
129
130
131
132
def test_modify_last_kv(three_kv_str, three_kv_dict):
    """Test modifying last key-value pair"""
    three_kv_dict["null"]["c"] = 42
    assert modifys(three_kv_str, three_kv_dict) == "[null]\na=1\nb=2\nc=42"
test_modify_middle_kv 
test_modify_middle_kv(three_kv_str, three_kv_dict)

Test modifying middle key-value pair

Source code in tests/test_card_file_modify.py 
123
124
125
126
def test_modify_middle_kv(three_kv_str, three_kv_dict):
    """Test modifying middle key-value pair"""
    three_kv_dict["null"]["b"] = 42
    assert modifys(three_kv_str, three_kv_dict) == "[null]\na=1\nb=42\nc=3"
test_modify_section 
test_modify_section(
    three_section_kv_str, three_section_kv_dict
)

Test modifying whole sections

Source code in tests/test_card_file_modify.py 
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
def test_modify_section(three_section_kv_str, three_section_kv_dict):
    """Test modifying whole sections"""
    modify_first = three_section_kv_dict.copy()
    modify_first["s1"] = {"k1": 33, "a": 1}
    assert (
        modifys(three_section_kv_str, modify_first)
        == "[s1]\na=1\nk1=33\n[s2]\nb=2\n[s3]\nc=3"
    )
    modfiy_mid = three_section_kv_dict.copy()
    modfiy_mid["s2"] = {"k1": 43, "k2": 44}
    assert (
        modifys(three_section_kv_str, modfiy_mid)
        == "[s1]\na=1\n[s2]\nk1=43\nk2=44\n[s3]\nc=3"
    )
    modify_last = three_section_kv_dict.copy()
    modify_last["s3"] = {"c": 3, "k1": 53}
    assert (
        modifys(three_section_kv_str, modify_last)
        == "[s1]\na=1\n[s2]\nb=2\n[s3]\nc=3\nk1=53"
    )
test_modify_values 
test_modify_values(
    all_datatypes_dict,
    all_datatypes_str,
    all_datatypes_modified_str,
)
Source code in tests/test_card_file_modify.py 
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
def test_modify_values(
    all_datatypes_dict, all_datatypes_str, all_datatypes_modified_str
):
    modified_dict = all_datatypes_dict
    # Remove existing keys
    modified_dict["logical"].pop("y2")
    modified_dict["date"].pop("end")
    modified_dict["empty"].pop("e1")
    # Modify existing keys
    modified_dict["logical"]["y1"] = False
    modified_dict["logical"]["n3"] = True
    modified_dict["logical"]["n4"] = True
    modified_dict["list"]["l1"] = [1, 2, 3]
    modified_dict["list"]["l5"] = [[1, 2], ["a", "b"]]
    modified_dict["list"]["l7"] = [42, False, True, "new_text", '"quotes"']
    modified_dict["date"]["begin"] = "2025-01-01"
    modified_dict["empty"]["e2"] = None
    modified_dict["string"]["n1"] = None
    # Add new keys
    modified_dict["date"]["new_end"] = "2025-12-01"
    modified_dict["path"]["file4"] = "/usr/lib"
    modified_dict["empty"]["e4"] = None
    modified_dict["empty_section2"]["number"] = 3.14
    modified_dict["empty_section3"] = {"number": 1012}
    assert (
        modifys(
            all_datatypes_str,
            modified_dict,
            insert_header="These subsequent sections were inserted by us!",
        )
        # TODO: There is something wrong and the test file has always the LF (or newline) character(s) at the end
        == all_datatypes_modified_str.rstrip("\n")
    )
test_null_modify 
test_null_modify(all_datatypes_dict, all_datatypes_str)

Test modification with no modifications!

Source code in tests/test_card_file_modify.py 
36
37
38
39
40
41
def test_null_modify(all_datatypes_dict, all_datatypes_str):
    """Test modification with no modifications!"""
    assert modifys(
        all_datatypes_str,
        all_datatypes_dict,
    ) == all_datatypes_str.rstrip("\n")
test_remove_first_kv 
test_remove_first_kv(three_kv_str, three_kv_dict)

Test removing first key-value pair

Source code in tests/test_card_file_modify.py 
 99
100
101
102
def test_remove_first_kv(three_kv_str, three_kv_dict):
    """Test removing first key-value pair"""
    del three_kv_dict["null"]["a"]
    assert modifys(three_kv_str, three_kv_dict) == "[null]\nb=2\nc=3"
test_remove_last_kv 
test_remove_last_kv(three_kv_str, three_kv_dict)

Test removing last key-value pair

Source code in tests/test_card_file_modify.py 
111
112
113
114
def test_remove_last_kv(three_kv_str, three_kv_dict):
    """Test removing last key-value pair"""
    del three_kv_dict["null"]["c"]
    assert modifys(three_kv_str, three_kv_dict) == "[null]\na=1\nb=2"
test_remove_middle_kv 
test_remove_middle_kv(three_kv_str, three_kv_dict)

Test removing middle key-value pair

Source code in tests/test_card_file_modify.py 
105
106
107
108
def test_remove_middle_kv(three_kv_str, three_kv_dict):
    """Test removing middle key-value pair"""
    del three_kv_dict["null"]["b"]
    assert modifys(three_kv_str, three_kv_dict) == "[null]\na=1\nc=3"
test_remove_section 
test_remove_section(
    three_section_kv_str, three_section_kv_dict
)

Test removing whole sections

Source code in tests/test_card_file_modify.py 
150
151
152
153
154
155
156
157
158
159
160
def test_remove_section(three_section_kv_str, three_section_kv_dict):
    """Test removing whole sections"""
    remove_first = three_section_kv_dict.copy()
    del remove_first["s1"]
    assert modifys(three_section_kv_str, remove_first) == "[s2]\nb=2\n[s3]\nc=3"
    remove_mid = three_section_kv_dict.copy()
    del remove_mid["s2"]
    assert modifys(three_section_kv_str, remove_mid) == "[s1]\na=1\n[s3]\nc=3"
    remove_last = three_section_kv_dict.copy()
    del remove_last["s3"]
    assert modifys(three_section_kv_str, remove_last) == "[s1]\na=1\n[s2]\nb=2"
three_kv_dict 
three_kv_dict(three_kv_str) -> dict
Source code in tests/test_card_file_modify.py 
84
85
86
@pytest.fixture
def three_kv_dict(three_kv_str) -> dict:
    return loads(three_kv_str)
three_kv_str 
three_kv_str() -> str
Source code in tests/test_card_file_modify.py 
79
80
81
@pytest.fixture
def three_kv_str() -> str:
    return "[null]\na=1\nb=2\nc=3"
three_section_kv_dict 
three_section_kv_dict(three_section_kv_str) -> dict
Source code in tests/test_card_file_modify.py 
94
95
96
@pytest.fixture
def three_section_kv_dict(three_section_kv_str) -> dict:
    return loads(three_section_kv_str)
three_section_kv_str 
three_section_kv_str() -> str
Source code in tests/test_card_file_modify.py 
89
90
91
@pytest.fixture
def three_section_kv_str() -> str:
    return "[s1]\na=1\n[s2]\nb=2\n[s3]\nc=3"

test_def_file

Functions:

all_datatypes 
all_datatypes()
Source code in tests/test_def_file.py 
25
26
27
@pytest.fixture
def all_datatypes():
    return _load_file("all_datatypes.def")
all_datatypes_dump 
all_datatypes_dump()
Source code in tests/test_def_file.py 
30
31
32
@pytest.fixture
def all_datatypes_dump():
    return _open_file("all_datatypes.def.dump")
all_datatypes_with_positions 
all_datatypes_with_positions()
Source code in tests/test_def_file.py 
35
36
37
@pytest.fixture
def all_datatypes_with_positions():
    return _load_file("all_datatypes.def", include_positions=True)
config_actuel 
config_actuel()
Source code in tests/test_def_file.py 
40
41
42
@pytest.fixture
def config_actuel():
    return _load_file("config.def_actuel.r7417")
duplicated 
duplicated()
Source code in tests/test_def_file.py 
20
21
22
@pytest.fixture
def duplicated():
    return _load_file("duplicated.def")
earth_const 
earth_const()
Source code in tests/test_def_file.py 
45
46
47
@pytest.fixture
def earth_const():
    return _load_file("earth_const.def.r7417")
earth_const_dump 
earth_const_dump()
Source code in tests/test_def_file.py 
50
51
52
@pytest.fixture
def earth_const_dump():
    return _open_file("earth_const.def.r7417.dump")
earth_const_with_positions 
earth_const_with_positions()
Source code in tests/test_def_file.py 
55
56
57
@pytest.fixture
def earth_const_with_positions():
    return _load_file("earth_const.def.r7417", include_positions=True)
gcm_144x142_NPv63 
gcm_144x142_NPv63()
Source code in tests/test_def_file.py 
60
61
62
@pytest.fixture
def gcm_144x142_NPv63():
    return _load_file("gcm.def_144x142_NPv6.3.r7417")
orchidee_v22 
orchidee_v22()
Source code in tests/test_def_file.py 
65
66
67
@pytest.fixture
def orchidee_v22():
    return _load_file("orchidee.def_v22.r7417")
orchidee_v4 
orchidee_v4()
Source code in tests/test_def_file.py 
70
71
72
@pytest.fixture
def orchidee_v4():
    return _load_file("orchidee.def_v4.r7445")
physiq_NPv650 
physiq_NPv650()
Source code in tests/test_def_file.py 
75
76
77
@pytest.fixture
def physiq_NPv650():
    return _load_file("physiq.def_NPv6.5.0.r7417")
run_dynamico_lam_ERA5_France 
run_dynamico_lam_ERA5_France()
Source code in tests/test_def_file.py 
90
91
92
@pytest.fixture
def run_dynamico_lam_ERA5_France():
    return _load_file("run_dynamico_lam_ERA5_France.def.r7417")
run_dynamico_nbp60 
run_dynamico_nbp60()
Source code in tests/test_def_file.py 
85
86
87
@pytest.fixture
def run_dynamico_nbp60():
    return _load_file("run_dynamico.def_nbp60.r7417")
run_lmdz 
run_lmdz()
Source code in tests/test_def_file.py 
80
81
82
@pytest.fixture
def run_lmdz():
    return _load_file("run.def.r7417")
test_all_datatypes_dumps 
test_all_datatypes_dumps(all_datatypes, all_datatypes_dump)
Source code in tests/test_def_file.py 
380
381
def test_all_datatypes_dumps(all_datatypes, all_datatypes_dump):
    assert dumps(all_datatypes) == all_datatypes_dump
test_all_datatypes_dumps_loads 
test_all_datatypes_dumps_loads(all_datatypes)
Source code in tests/test_def_file.py 
384
385
def test_all_datatypes_dumps_loads(all_datatypes):
    assert all_datatypes == loads(dumps(all_datatypes))
test_all_datatypes_load 
test_all_datatypes_load(all_datatypes)
Source code in tests/test_def_file.py 
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
def test_all_datatypes_load(all_datatypes):
    assert all_datatypes == {
        "INCLUDEDEF": ["module1", "module2.def", '"module3.def"'],
        "array_floats": [3.3, 4.4, 1.3, 3.1],
        "array_integers": [1, 2, 3, 4],
        "array_mixed": [1, 10000000000.0, 13.31, "test1", "'test2'", '"test2"'],
        "array_strings": ["test1", "test2", "test3"],
        "auto": ("_AUTO_", None),
        "auto_default_float": ("_AUTO_", 0.25),
        "auto_default_integer": ("_AUTO_", 23),
        "auto_default_quoted_string": ("_AUTO_", '"some string"'),
        "auto_default_string": ("_AUTO_", "somestring"),
        "autoblocker": ("_AUTOBLOCKER_", None),
        "autoblocker_default": ("_AUTOBLOCKER_", 3.33),
        "float": 0.25,
        "float_negative": -0.25,
        "float_positive": 0.25,
        "float_scientific": 1476.48,
        "float_scientific_negative": -1476.48,
        "float_scientific_zero": 0.0,
        "integer": 23,
        "integer_negative": -23,
        "integer_positive": 23,
        "integer_zero": 0,
        "logical_false1": False,
        "logical_false2": False,
        "logical_false3": False,
        "logical_false4": False,
        "logical_false5": False,
        "logical_true1": True,
        "logical_true2": True,
        "logical_true3": True,
        "logical_true4": True,
        "logical_true5": True,
        "string": "somestring",
        "string_double_quotes": '"some string"',
        "string_single_quotes": "'some string'",
        "string_special": "_somestring123__",
    }
test_all_datatypes_load_with_positions 
test_all_datatypes_load_with_positions(
    all_datatypes_with_positions,
)
Source code in tests/test_def_file.py 
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
def test_all_datatypes_load_with_positions(all_datatypes_with_positions):
    assert all_datatypes_with_positions == {
        "logical_true1": {
            "value": True,
            "key_start_pos": 138,
            "start_pos": 152,
            "end_pos": 153,
        },
        "logical_true2": {
            "value": True,
            "key_start_pos": 154,
            "start_pos": 168,
            "end_pos": 169,
        },
        "logical_true3": {
            "value": True,
            "key_start_pos": 170,
            "start_pos": 184,
            "end_pos": 188,
        },
        "logical_true4": {
            "value": True,
            "key_start_pos": 189,
            "start_pos": 203,
            "end_pos": 207,
        },
        "logical_true5": {
            "value": True,
            "key_start_pos": 208,
            "start_pos": 222,
            "end_pos": 226,
        },
        "logical_false1": {
            "value": False,
            "key_start_pos": 228,
            "start_pos": 243,
            "end_pos": 244,
        },
        "logical_false2": {
            "value": False,
            "key_start_pos": 245,
            "start_pos": 260,
            "end_pos": 261,
        },
        "logical_false3": {
            "value": False,
            "key_start_pos": 262,
            "start_pos": 277,
            "end_pos": 282,
        },
        "logical_false4": {
            "value": False,
            "key_start_pos": 283,
            "start_pos": 298,
            "end_pos": 303,
        },
        "logical_false5": {
            "value": False,
            "key_start_pos": 304,
            "start_pos": 319,
            "end_pos": 324,
        },
        "integer": {
            "value": 23,
            "key_start_pos": 326,
            "start_pos": 334,
            "end_pos": 336,
        },
        "integer_negative": {
            "value": -23,
            "key_start_pos": 337,
            "start_pos": 354,
            "end_pos": 357,
        },
        "integer_positive": {
            "value": 23,
            "key_start_pos": 358,
            "start_pos": 375,
            "end_pos": 378,
        },
        "integer_zero": {
            "value": 0,
            "key_start_pos": 379,
            "start_pos": 392,
            "end_pos": 393,
        },
        "float": {
            "value": 0.25,
            "key_start_pos": 395,
            "start_pos": 401,
            "end_pos": 405,
        },
        "float_negative": {
            "value": -0.25,
            "key_start_pos": 406,
            "start_pos": 421,
            "end_pos": 426,
        },
        "float_positive": {
            "value": 0.25,
            "key_start_pos": 427,
            "start_pos": 442,
            "end_pos": 447,
        },
        "float_scientific": {
            "value": 1476.48,
            "key_start_pos": 449,
            "start_pos": 466,
            "end_pos": 477,
        },
        "float_scientific_negative": {
            "value": -1476.48,
            "key_start_pos": 478,
            "start_pos": 504,
            "end_pos": 516,
        },
        "float_scientific_zero": {
            "value": 0.0,
            "key_start_pos": 517,
            "start_pos": 539,
            "end_pos": 546,
        },
        "string": {
            "value": "somestring",
            "key_start_pos": 548,
            "start_pos": 555,
            "end_pos": 565,
        },
        "string_special": {
            "value": "_somestring123__",
            "key_start_pos": 566,
            "start_pos": 581,
            "end_pos": 597,
        },
        "string_single_quotes": {
            "value": "'some string'",
            "key_start_pos": 640,
            "start_pos": 661,
            "end_pos": 674,
        },
        "string_double_quotes": {
            "value": '"some string"',
            "key_start_pos": 675,
            "start_pos": 696,
            "end_pos": 709,
        },
        "array_integers": {
            "value": [1, 2, 3, 4],
            "key_start_pos": 711,
            "start_pos": 728,
            "end_pos": 738,
        },
        "array_floats": {
            "value": [3.3, 4.4, 1.3, 3.1],
            "key_start_pos": 739,
            "start_pos": 754,
            "end_pos": 772,
        },
        "array_strings": {
            "value": ["test1", "test2", "test3"],
            "key_start_pos": 773,
            "start_pos": 789,
            "end_pos": 808,
        },
        "array_mixed": {
            "value": [1, 10000000000.0, 13.31, "test1", "'test2'", '"test2"'],
            "key_start_pos": 809,
            "start_pos": 823,
            "end_pos": 862,
        },
        "auto": {
            "value": ("_AUTO_", None),
            "key_start_pos": 864,
            "start_pos": 869,
            "end_pos": 875,
        },
        "auto_default_integer": {
            "value": ("_AUTO_", 23),
            "key_start_pos": 876,
            "start_pos": 897,
            "end_pos": 916,
        },
        "auto_default_float": {
            "value": ("_AUTO_", 0.25),
            "key_start_pos": 917,
            "start_pos": 936,
            "end_pos": 957,
        },
        "auto_default_string": {
            "value": ("_AUTO_", "somestring"),
            "key_start_pos": 958,
            "start_pos": 978,
            "end_pos": 1005,
        },
        "auto_default_quoted_string": {
            "value": ("_AUTO_", '"some string"'),
            "key_start_pos": 1006,
            "start_pos": 1033,
            "end_pos": 1063,
        },
        "autoblocker": {
            "value": ("_AUTOBLOCKER_", None),
            "key_start_pos": 1065,
            "start_pos": 1077,
            "end_pos": 1090,
        },
        "autoblocker_default": {
            "value": ("_AUTOBLOCKER_", 3.33),
            "key_start_pos": 1091,
            "start_pos": 1111,
            "end_pos": 1137,
        },
        "INCLUDEDEF": [
            {"value": "module1", "key_start_pos": 0, "start_pos": 11, "end_pos": 18},
            {
                "value": "module2.def",
                "key_start_pos": 19,
                "start_pos": 30,
                "end_pos": 41,
            },
            {
                "value": '"module3.def"',
                "key_start_pos": 42,
                "start_pos": 53,
                "end_pos": 66,
            },
        ],
    }
test_duplicated_load 
test_duplicated_load(duplicated)
Source code in tests/test_def_file.py 
100
101
102
103
104
105
106
def test_duplicated_load(duplicated):
    assert duplicated == {
        "INCLUDEDEF": ['"module3.def"'],
        "integer": 13,
        "logical_true": False,
        "string": '"halo?"',
    }
test_dynamico_earth_const_dumps 
test_dynamico_earth_const_dumps(
    earth_const, earth_const_dump
)
Source code in tests/test_def_file.py 
449
450
def test_dynamico_earth_const_dumps(earth_const, earth_const_dump):
    assert dumps(earth_const) == earth_const_dump
test_dynamico_earth_const_dumps_loads 
test_dynamico_earth_const_dumps_loads(earth_const)
Source code in tests/test_def_file.py 
453
454
def test_dynamico_earth_const_dumps_loads(earth_const):
    assert earth_const == loads(dumps(earth_const))
test_dynamico_earth_const_load 
test_dynamico_earth_const_load(earth_const)
Source code in tests/test_def_file.py 
388
389
390
391
392
393
394
395
396
397
398
def test_dynamico_earth_const_load(earth_const):
    assert earth_const == {
        "radius": 6.371229e6,
        "g": 9.80665,
        "omega": 7.292e-05,
        "kappa": 0.2857143,
        "cpp": 1004.70885783307,
        "preff": 101325.0,
        "scale_factor": 1.0,
        "netcdf_prec": "double",
    }
test_dynamico_earth_const_load_with_positions 
test_dynamico_earth_const_load_with_positions(
    earth_const_with_positions,
)
Source code in tests/test_def_file.py 
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
def test_dynamico_earth_const_load_with_positions(earth_const_with_positions):
    assert earth_const_with_positions == {
        "radius": {
            "value": 6371229.0,
            "key_start_pos": 43,
            "start_pos": 50,
            "end_pos": 60,
        },
        "g": {"value": 9.80665, "key_start_pos": 97, "start_pos": 99, "end_pos": 106},
        "omega": {
            "value": 7.292e-05,
            "key_start_pos": 152,
            "start_pos": 158,
            "end_pos": 166,
        },
        "kappa": {
            "value": 0.2857143,
            "key_start_pos": 203,
            "start_pos": 209,
            "end_pos": 218,
        },
        "cpp": {
            "value": 1004.70885783307,
            "key_start_pos": 319,
            "start_pos": 324,
            "end_pos": 340,
        },
        "preff": {
            "value": 101325.0,
            "key_start_pos": 388,
            "start_pos": 394,
            "end_pos": 401,
        },
        "scale_factor": {
            "value": 1.0,
            "key_start_pos": 466,
            "start_pos": 479,
            "end_pos": 481,
        },
        "netcdf_prec": {
            "value": "double",
            "key_start_pos": 512,
            "start_pos": 526,
            "end_pos": 532,
        },
    }
test_empty_content 
test_empty_content()
Source code in tests/test_def_file.py 
1268
1269
def test_empty_content():
    assert loads("") == {}
test_empty_content_with_ws 
test_empty_content_with_ws()
Source code in tests/test_def_file.py 
1272
1273
def test_empty_content_with_ws():
    assert loads("\t\n\t   \n  \t") == {}
test_empty_with_comment 
test_empty_with_comment()
Source code in tests/test_def_file.py 
1276
1277
def test_empty_with_comment():
    assert loads("# This is just a comment") == {}
test_empty_with_comments 
test_empty_with_comments()
Source code in tests/test_def_file.py 
1280
1281
def test_empty_with_comments():
    assert loads("# This is just a comment\n# And another one!") == {}
test_lmdz_config_actuel_dumps_loads 
test_lmdz_config_actuel_dumps_loads(config_actuel)
Source code in tests/test_def_file.py 
645
646
def test_lmdz_config_actuel_dumps_loads(config_actuel):
    assert config_actuel == loads(dumps(config_actuel))
test_lmdz_config_actuel_load 
test_lmdz_config_actuel_load(config_actuel)
Source code in tests/test_def_file.py 
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
def test_lmdz_config_actuel_load(config_actuel):
    assert config_actuel == {
        "level_coupling_esm": ("_AUTO_", 0),
        "carbon_cycle_cpl": ("_AUTO_", False),
        "carbon_cycle_tr": ("_AUTO_", False),
        "carbon_cycle_rad": ("_AUTO_", False),
        "read_fco2_ocean_cor": ("_AUTO_", False),
        "var_fco2_ocean_cor": ("_AUTO_", 0.2576),
        "read_fco2_land_cor": ("_AUTO_", False),
        "var_fco2_land_cor": ("_AUTO_", -0.2036),
        "iflag_cycle_diurne": 1,
        "soil_model": True,
        "t_coupl": ("_AUTO_", None),
        "nbapp_rad": 16,
        "pmagic": ("_AUTO_", 0.0),
        "R_ecc": ("_AUTO_", 0.016715),
        "R_peri": ("_AUTO_", 102.7),
        "R_incl": ("_AUTO_", 23.441),
        "solaire": ("_AUTO_", 1361.20),
        "ok_suntime_rrtm": True,
        "co2_ppm": ("_AUTO_", 3.6912e02),
        "co2_ppm0": ("_AUTO_", 2.8432e02),
        "co2_ppm_per": ("_AUTO_", 14.7648e02),
        "CH4_ppb": ("_AUTO_", 1.7780e03),
        "N2O_ppb": ("_AUTO_", 3.1576e02),
        "CFC11_ppt": ("_AUTO_", 6.3990e01),
        "CFC12_ppt": ("_AUTO_", 1.0511e03),
        "ok_ade": ("_AUTO_", None),
        "ok_aie": ("_AUTO_", None),
        "aer_type": "actuel",
        "aerosol_couple": ("_AUTO_", None),
        "chemistry_couple": ("_AUTO_", None),
        "flag_aerosol": ("_AUTO_", None),
        "ok_cdnc": ("_AUTO_", None),
        "ok_alw": True,
        "read_climoz": ("_AUTO_", None),
        "flag_aerosol_strat": ("_AUTO_", 2),
        "ok_volcan": False,
        "ok_cosp": ("_AUTO_", None),
    }
test_lmdz_gcm_144x142_NPv63_dumps_loads 
test_lmdz_gcm_144x142_NPv63_dumps_loads(gcm_144x142_NPv63)
Source code in tests/test_def_file.py 
679
680
def test_lmdz_gcm_144x142_NPv63_dumps_loads(gcm_144x142_NPv63):
    assert gcm_144x142_NPv63 == loads(dumps(gcm_144x142_NPv63))
test_lmdz_gcm_144x142_NPv63_load 
test_lmdz_gcm_144x142_NPv63_load(gcm_144x142_NPv63)
Source code in tests/test_def_file.py 
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
def test_lmdz_gcm_144x142_NPv63_load(gcm_144x142_NPv63):
    assert gcm_144x142_NPv63 == {
        "day_step": 672,
        "iperiod": 7,
        "lstardis": True,
        "nitergdiv": 1,
        "nitergrot": 2,
        "niterh": 2,
        "tetagdiv": 3600.0,
        "tetagrot": 21600.0,
        "tetatemp": 10800.0,
        "coefdis": 0.0,
        "purmats": False,
        "iflag_phys": 1,
        "read_start": True,
        "iphysiq": 7,
        "clon": 0.0,
        "clat": 0.0,
        "grossismx": 1.0,
        "grossismy": 1.0,
        "fxyhypb": True,
        "dzoomx": 0.0,
        "dzoomy": 0.0,
        "taux": 3.0,
        "tauy": 3.0,
        "ysinus": True,
        "ngroup": 4,
    }
test_lmdz_physiq_NPv650_dumps_loads 
test_lmdz_physiq_NPv650_dumps_loads(physiq_NPv650)
Source code in tests/test_def_file.py 
866
867
def test_lmdz_physiq_NPv650_dumps_loads(physiq_NPv650):
    assert physiq_NPv650 == loads(dumps(physiq_NPv650))
test_lmdz_physiq_NPv650_load 
test_lmdz_physiq_NPv650_load(physiq_NPv650)
Source code in tests/test_def_file.py 
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
def test_lmdz_physiq_NPv650_load(physiq_NPv650):
    assert physiq_NPv650 == {
        "ok_limitvrai": False,
        "f_cdrag_stable": 1,
        "f_cdrag_ter": 1,
        "min_wind_speed": 0.1,
        "ifl_pbltree": 1,
        "Cd_frein": 0.016,
        "f_cdrag_oce": 1,
        "iflag_z0_oce": 1,
        "f_z0qh_oce": 1.55,
        "iflag_gusts": 2,
        "f_gust_bl": 0.845,
        "f_gust_wk": 0.2,
        "f_qsat_oce": 0.98,
        "cdmmax": 0.2,
        "cdhmax": 0.2,
        "new_yamada4": True,
        "yamada4_num": 5,
        "iflag_corr_sta": 4,
        "f_ri_cd_min": 0.01,
        "yamada4_ric": 0.18,
        "lmixmin": 0,
        "iflag_pbl": 12,
        "ksta_ter": 1e-07,
        "ksta": 1e-10,
        "ok_kzmin": False,
        "addtkeoro": 2,
        "alphatkeoro": 1,
        "smallscales_tkeoro": True,
        "nm_oro_t": 0,
        "zstd_orodr_t": 0,
        "zpmm_orodr_t": 0,
        "zpmm_orolf_t": 0,
        "ok_orodr": True,
        "ok_orolf": True,
        "f_rugoro": 0,
        "sso_gfrcri": 0.7,
        "sso_gkdrag": 0.6,
        "sso_gkwake": 0.4,
        "sso_gklift": 0.1,
        "ok_gwd_rando": True,
        "gwd_rando_ruwmax": 0.5,
        "gwd_rando_sat": 0.6,
        "gwd_front_ruwmax": 3,
        "iflag_rrtm": 1,
        "NSW": 6,
        "alb_vis_sno_lic": 0.96,
        "alb_nir_sno_lic": 0.68,
        "inertie_sno": 350,
        "iflag_sic": 1,
        "inertie_lic": 2000,
        "inertie_sic": 2000,
        "tau_gl": ("_AUTO_", 5.0),
        "iflag_albedo": 1,
        "nbapp_cv": 48,
        "ok_bad_ecmwf_thermo": False,
        "cld_lc_lsc": 0.001,
        "cld_lc_con": 0.001,
        "cld_tau_lsc": 900,
        "cld_tau_con": 900,
        "ffallv_lsc": 0.8,
        "ffallv_con": 0.8,
        "coef_eva": 0.0001,
        "iflag_evap_prec": 2,
        "t_glace_min": 243.15,
        "t_glace_max": 273.15,
        "exposant_glace": 0.5,
        "iflag_t_glace": 3,
        "iflag_ice_thermo": 1,
        "reevap_ice": False,
        "iflag_bergeron": 2,
        "iflag_fisrtilp_qsat": 4,
        "iflag_cld_th": 6,
        "fact_cldcon": 1,
        "facttemps": 0,
        "iflag_pdf": 1,
        "ok_newmicro": True,
        "iflag_ratqs": 4,
        "ratqsp0": 45000,
        "ratqsdp": 10000,
        "ratqsbas": 0.002,
        "ratqshaut": 0.4,
        "rad_froid": 35,
        "rad_chau1": 12,
        "rad_chau2": 11,
        "bl95_b0": 1.3,
        "bl95_b1": 0.2,
        "new_oliq": True,
        "oliqmax": 0.0015,
        "oicemax": 0.0015,
        "rei_min": 16,
        "rei_max": 61.29,
        "iflag_cloudth_vert": 3,
        "cloudth_vert_alpha": 0.5,
        "cloudth_vert_alpha_th": 0.5,
        "cdnc_min": 10,
        "iflag_con": 3,
        "if_ebil": 0,
        "epmax": 0.999,
        "ok_adj_ema": False,
        "iflag_clw": 0,
        "iflag_clos": 2,
        "iflag_mix": 1,
        "qqa1": 1,
        "qqa2": 0,
        "cvl_corr": 1,
        "Fmax": 0.65,
        "dpbase": -40,
        "sigdz": 0.003,
        "spfac": 0.15,
        "tau": 8000,
        "tau": 8000,
        "flag_wb": 50,
        "wbmax": 2.8,
        "ok_convstop": False,
        "tau_stop": 15000,
        "ok_intermittent": False,
        "iflag_mix_adiab": 0,
        "coef_peel": 0.25,
        "flag_epKEorig": 1,
        "elcrit": 0.0003,
        "tlcrit": -55,
        "pbcrit": 150,
        "ptcrit": 500,
        "flag_wk_check_trgl": False,
        "iflag_wk_check_trgl": 2,
        "iflag_alp_wk_cond": 1,
        "cv_flag_feed": 2,
        "ok_optim_yield": True,
        "iflag_cld_cv": 0,
        "ok_bug_cv_trac": ("_AUTO_", False),
        "ok_bug_ajs_cv": False,
        "keepbug_ice_frac": False,
        "iflag_pbl_split": 10,
        "alp_bl_k": 0.5,
        "alp_offset": 0,
        "t_top_max": 1000,
        "iflag_trig_bl": 1,
        "s_trig": 12000000,
        "tau_trig_shallow": 1200,
        "tau_trig_deep": 1200,
        "random_notrig_max": 0.99,
        "tmax_fonte_cv": 278.15,
        "iflag_clos_bl": 1,
        "stark": 0.33,
        "alpk": 0.25,
        "iflag_thermals": 18,
        "nsplit_thermals": 1,
        "tau_thermals": 0,
        "iflag_thermals_ed": 8,
        "thermals_afact": 0.666667,
        "thermals_fact_epsilon": 0.002,
        "thermals_betalpha": 0.9,
        "thermals_detr_q_coef": 0.012,
        "cloudth_sigma1s_factor": 1.1,
        "cloudth_sigma2s_factor": 0.09,
        "fact_thermals_ed_dz": 0.07,
        "iflag_thermals_optflux": 0,
        "iflag_coupl": 5,
        "seuil_inversion": -0.08,
        "iflag_thermals_closure": 2,
        "iflag_wake": 1,
        "coefgw": 4,
        "wdens_ref_o": 1e-09,
        "wdens_ref_l": 8e-12,
        "ok_adjwk": True,
        "ok_bug_gfl": False,
        "iflag_wk_profile": 1,
        "wk_pupper": 3.5,
        "wk_frac_int_delta_t": 0.75,
        "wk_delta_t_min": 0,
        "iflag_wk_new_ptop": 2,
        "ok_bug_zg_wk_pbl": False,
        "ok_bug_split_th": False,
        "iflag_ener_conserv": 10,
        "ok_conserv_q": True,
        "fl_cor_ebil": 1,
        "ok_lic_cond": True,
        "adjust_tropopause": True,
    }
test_lmdz_vert_L95_dumps_loads 
test_lmdz_vert_L95_dumps_loads(vert_L95)
Source code in tests/test_def_file.py 
898
899
def test_lmdz_vert_L95_dumps_loads(vert_L95):
    assert vert_L95 == loads(dumps(vert_L95))
test_lmdz_vert_L95_load 
test_lmdz_vert_L95_load(vert_L95)
Source code in tests/test_def_file.py 
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
def test_lmdz_vert_L95_load(vert_L95):
    assert vert_L95 == {
        "vert_sampling": "strato_custom",
        "iflag_top_bound": 2,
        "tau_top_bound": 0.0005,
        "mode_top_bound": 3,
        "llm": 95,
        "disvert": "strato_custom",
        "iflag_sponge": 2,
        "tau_sponge": 5e-4,
        "mode_sponge": 1,
        "vert_scale": 7.0,
        "vert_dzmin": 0.017,
        "vert_dzlow": 0.009,
        "vert_z0low": 2.0,
        "vert_dzmid": 1.1,
        "vert_z0mid": 6,
        "vert_h_mid": 17,
        "vert_dzhig": 10,
        "vert_z0hig": 75.0,
        "vert_h_hig": 20.0,
        "vert_prof_dissip": 1,
        "dissip_zref": 50,
        "ok_strato": True,
        "ok_hines": False,
    }
test_orchidee_v22_dumps_loads 
test_orchidee_v22_dumps_loads(orchidee_v22)
Source code in tests/test_def_file.py 
1196
1197
def test_orchidee_v22_dumps_loads(orchidee_v22):
    assert orchidee_v22 == loads(dumps(orchidee_v22))
test_orchidee_v22_load 
test_orchidee_v22_load(orchidee_v22)
Source code in tests/test_def_file.py 
 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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
def test_orchidee_v22_load(orchidee_v22):
    assert orchidee_v22 == {
        "ALB_BG_FILE": "alb_bg.nc",
        "ALB_BG_MODIS": True,
        "ALB_LEAF_NIR": [
            0.0,
            0.23,
            0.18,
            0.18,
            0.2,
            0.24,
            0.15,
            0.26,
            0.2,
            0.24,
            0.27,
            0.28,
            0.26,
            0.24,
            0.24,
        ],
        "ALB_LEAF_VIS": [
            0.0,
            0.04,
            0.04,
            0.04,
            0.04,
            0.03,
            0.03,
            0.03,
            0.03,
            0.06,
            0.06,
            0.06,
            0.06,
            0.06,
            0.06,
        ],
        "ALWAYS_INIT": [
            True,
            True,
            True,
            True,
            True,
            True,
            True,
            True,
            True,
            True,
            False,
            True,
            True,
            False,
            True,
        ],
        "ATM_CO2": ("_AUTO_", 284.32),
        "CARBON_TAU_IPASSIVE": 300,
        "CARBON_TAU_ISLOW": 7,
        "CDRAG_from_GCM": True,
        "CHEMISTRY_BVOC": ("_AUTO_", False),
        "CO2_FOR_BVOC_POSSELL": False,
        "CO2_FOR_BVOC_WILKINSON": False,
        "CWRR_AKS_A0": 0.0,
        "CWRR_AKS_POWER": 0.0,
        "CWRR_NKS_A0": 0.0,
        "CWRR_NKS_POWER": 0.0,
        "DEPTH_MAX_T": 90,
        "DOWNREGULATION_CO2_BASELEVEL": 380.0,
        "DOWNREGULATION_CO2_NEW": True,
        "DO_RSOIL": False,
        "DO_WOOD_HARVEST": ("_AUTO_", True),
        "FIRE_DISABLE": True,
        "FORCE_CO2_VEG": ("_AUTO_", False),
        "FRAC_GROWTHRESP__02": 0.35,
        "FRAC_GROWTHRESP__03": 0.35,
        "FRAC_GROWTHRESP__04": 0.28,
        "FRAC_GROWTHRESP__05": 0.28,
        "FRAC_GROWTHRESP__06": 0.28,
        "FRAC_GROWTHRESP__07": 0.35,
        "FRAC_GROWTHRESP__08": 0.35,
        "FRAC_GROWTHRESP__09": 0.35,
        "FRAC_GROWTHRESP__10": 0.28,
        "FRAC_GROWTHRESP__11": 0.28,
        "FRAC_GROWTHRESP__12": 0.28,
        "FRAC_GROWTHRESP__13": 0.28,
        "FRAC_GROWTHRESP__14": 0.35,
        "FRAC_GROWTHRESP__15": 0.35,
        "HYDROL_CWRR": True,
        "LAI_MAP": ("_AUTO_", False),
        "LAI_MAX__02": 7.0,
        "LAI_MAX__03": 5.0,
        "LAI_MAX__04": 5.0,
        "LAI_MAX__05": 4.0,
        "LAI_MAX__06": 5.0,
        "LAI_MAX__07": 3.5,
        "LAI_MAX__08": 4.0,
        "LAI_MAX__09": 3.0,
        "LAI_MAX__10": 2.5,
        "LAI_MAX__11": 2.0,
        "LAI_MAX__12": 5.0,
        "LAI_MAX__13": 5.0,
        "LAI_MAX__14": 2.5,
        "LAI_MAX__15": 2.0,
        "MAINT_RESP_SLOPE_C__02": 0.12,
        "MAINT_RESP_SLOPE_C__03": 0.12,
        "MAINT_RESP_SLOPE_C__04": 0.16,
        "MAINT_RESP_SLOPE_C__05": 0.16,
        "MAINT_RESP_SLOPE_C__06": 0.16,
        "MAINT_RESP_SLOPE_C__07": 0.25,
        "MAINT_RESP_SLOPE_C__08": 0.25,
        "MAINT_RESP_SLOPE_C__09": 0.25,
        "MAINT_RESP_SLOPE_C__10": 0.16,
        "MAINT_RESP_SLOPE_C__11": 0.12,
        "MAINT_RESP_SLOPE_C__12": 0.16,
        "MAINT_RESP_SLOPE_C__13": 0.12,
        "MAINT_RESP_SLOPE_C__14": 0.12,
        "MAINT_RESP_SLOPE_C__15": 0.25,
        "NVM": 15,
        "OK_EXPLICITSNOW": True,
        "OK_FREEZE": True,
        "PFT_NAME__10": "'temperate C3           grass      '",
        "PFT_NAME__14": "'tropical  C3           grass      '",
        "PFT_NAME__15": "'boreal    C3           grass      '",
        "PFT_TO_MTC": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 10, 10],
        "PRINTLEV": 1,
        "READ_REFTEMP": True,
        "RIVER_DESC": ("_AUTO_", None),
        "RIVER_ROUTING": ("_AUTO_", None),
        "ROUGH_DYN": True,
        "ROUTING_METHOD": ("_AUTO_", None),
        "SECHIBA_QSINT": 0.02,
        "SECHIBA_reset_time": True,
        "SECHIBA_restart_in": ("_AUTOBLOCKER_", None),
        "SNOWA_AGED_NIR": [
            0.5,
            0,
            0,
            0.1,
            0.37,
            0.08,
            0.16,
            0.17,
            0.27,
            0.44,
            0.44,
            0.44,
            0.44,
            0.44,
            0.44,
        ],
        "SNOWA_AGED_VIS": [
            0.74,
            0,
            0,
            0.08,
            0.24,
            0.07,
            0.18,
            0.18,
            0.33,
            0.57,
            0.57,
            0.57,
            0.57,
            0.57,
            0.57,
        ],
        "SNOWA_DEC_NIR": [
            0.13,
            0,
            0,
            0.1,
            0.1,
            0.16,
            0.04,
            0.07,
            0.08,
            0.12,
            0.12,
            0.12,
            0.12,
            0.12,
            0.12,
        ],
        "SNOWA_DEC_VIS": [
            0.21,
            0,
            0,
            0.14,
            0.08,
            0.17,
            0.05,
            0.06,
            0.09,
            0.15,
            0.15,
            0.15,
            0.15,
            0.15,
            0.15,
        ],
        "SOILALB_FILE": "soilcolor.nc",
        "SOILCLASS_FILE": "soils_param.nc",
        "SOILTYPE_CLASSIF": "zobler",
        "STOMATE_OK_CO2": True,
        "STOMATE_OK_STOMATE": ("_AUTOBLOCKER_", None),
        "STOMATE_RESTART_FILEIN": ("_AUTOBLOCKER_", None),
        "STRESS_GM": [
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
        ],
        "STRESS_GS": [
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
        ],
        "STRESS_VCMAX": [
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
            1.0,
        ],
        "TCST_SNOWA": 10.0,
        "VCMAX25__02": 45.0,
        "VCMAX25__03": 45.0,
        "VCMAX25__04": 35.0,
        "VCMAX25__05": 40.0,
        "VCMAX25__06": 50.0,
        "VCMAX25__07": 45.0,
        "VCMAX25__08": 35.0,
        "VCMAX25__09": 35.0,
        "VCMAX25__10": 50.0,
        "VCMAX25__11": 50.0,
        "VCMAX25__12": 60.0,
        "VCMAX25__13": 60.0,
        "VCMAX25__14": 50.0,
        "VCMAX25__15": 40.0,
        "VEGET_UPDATE": ("_AUTO_", None),
        "WETNESS_TRANSPIR_MAX": [
            0.8,
            0.8,
            0.8,
            0.8,
            0.8,
            0.8,
            0.8,
            0.8,
            0.8,
            0.8,
            0.8,
            0.8,
            0.8,
        ],
        "WRITE_STEP": 0,
        "XIOS_ORCHIDEE_OK": True,
    }
test_orchidee_v4_dumps_loads 
test_orchidee_v4_dumps_loads(orchidee_v4)
Source code in tests/test_def_file.py 
1264
1265
def test_orchidee_v4_dumps_loads(orchidee_v4):
    assert orchidee_v4 == loads(dumps(orchidee_v4))
test_orchidee_v4_load 
test_orchidee_v4_load(orchidee_v4)
Source code in tests/test_def_file.py 
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
def test_orchidee_v4_load(orchidee_v4):
    assert orchidee_v4 == {
        "ALB_BG_FILE": "alb_bg.nc",
        "ALB_BG_MODIS": True,
        "ATM_CO2": ("_AUTO_", 284.32),
        "CHEMISTRY_BVOC": ("_AUTO_", False),
        "CNLEAF_VAR": "CN_LEAF",
        "CO2_FOR_BVOC_POSSELL": False,
        "CO2_FOR_BVOC_WILKINSON": False,
        "ENERGY_CONTROL": 2,
        "ERR_ACT": 1,
        "FORCE_CO2_VEG": ("_AUTO_", False),
        "FR_CENTER_C": -1.0,
        "HACK_KB_M1": True,
        "HACK_PWC_H": True,
        "IMPOSE_VEG": False,
        "NCIRC": 3,
        "NINPUT_UPDATE": ("_AUTO_", None),
        "NSNOW": 12,
        "Nammonium_FILE": "Nammonium.nc",
        "Nammonium_VAR": "nhx",
        "Nbnf_FILE": "bnf.nc",
        "Nbnf_VAR": "BNF_MGN_PERM2_PERYR",
        "Nfert_ammo_cropland_FILE": "Nfert_ammo_cropland.nc",
        "Nfert_ammo_cropland_VAR": "nfer_crop_nh4",
        "Nfert_ammo_pasture_FILE": "Nfert_ammo_pasture.nc",
        "Nfert_ammo_pasture_VAR": "nfer_pas_nh4",
        "Nfert_nitr_cropland_FILE": "Nfert_nitr_cropland.nc",
        "Nfert_nitr_cropland_VAR": "nfer_crop_no3",
        "Nfert_nitr_pasture_FILE": "Nfert_nitr_pasture.nc",
        "Nfert_nitr_pasture_VAR": "nfer_pas_no3",
        "Nnitrate_FILE": "Nnitrate.nc",
        "Nnitrate_VAR": "noy",
        "OK_EXPLICITSNOW": True,
        "OK_FREEZE": True,
        "OK_READ_FM_MAP": True,
        "PRINTLEV": 1,
        "RATIO_Z0M_Z0H": 10.0,
        "RIVER_DESC": ("_AUTO_", None),
        "RIVER_ROUTING": ("_AUTO_", None),
        "ROUGH_DYN": True,
        "ROUTING_METHOD": ("_AUTO_", None),
        "RSOIL_SCALE": 1.0,
        "SECHIBA_restart_in": ("_AUTOBLOCKER_", None),
        "SOILALB_FILE": "soilcolor.nc",
        "SOILTYPE_CLASSIF": "usda",
        "SPINUP_ANALYTIC": False,
        "SPINUP_PERIOD": 10,
        "STOMATE_IMPOSE_CN": ("_AUTO_", None),
        "STOMATE_OK_STOMATE": ("_AUTOBLOCKER_", None),
        "STOMATE_READ_CN": False,
        "STOMATE_RESTART_FILEIN": ("_AUTOBLOCKER_", None),
        "TCST_SNOWA": 15.0,
        "TEST_ALB_RT_BGSNOWBARE": True,
        "TEST_GRID": 1,
        "TEST_PFT": 2,
        "USE_RATIO_Z0M_Z0H": True,
        "USE_SOILC_INSULATION": True,
        "VEGETMAP_RESET": ("_AUTO_", None),
        "VEGET_UPDATE": ("_AUTO_", None),
        "XIOS_ORCHIDEE_OK": True,
    }
test_run_dynamico_lam_ERA5_France_dumps_loads 
test_run_dynamico_lam_ERA5_France_dumps_loads(
    run_dynamico_lam_ERA5_France,
)
Source code in tests/test_def_file.py 
599
600
def test_run_dynamico_lam_ERA5_France_dumps_loads(run_dynamico_lam_ERA5_France):
    assert run_dynamico_lam_ERA5_France == loads(dumps(run_dynamico_lam_ERA5_France))
test_run_dynamico_lam_ERA5_France_load 
test_run_dynamico_lam_ERA5_France_load(
    run_dynamico_lam_ERA5_France,
)
Source code in tests/test_def_file.py 
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
def test_run_dynamico_lam_ERA5_France_load(run_dynamico_lam_ERA5_France):
    assert run_dynamico_lam_ERA5_France == {
        "mpi_threading_mode": "funneled",
        "metric_type": "icosa_area",
        "area_center_lon": 3,
        "area_center_lat": 47,
        "area_radius": 800,
        "PS_relax_out": 3600,
        "T_relax_out": 3600,
        "U_relax_out": 3600,
        "Q_relax_out": 3600,
        "nudging_vertical_levels": "pressure",
        "guided_type": ("_AUTO_", None),
        "itau_nudging": 120,
        "nudging_zone": "area",
        "nudging_stiffness": 8,
        "nbp": 40,
        "nsplit_i": 4,
        "nsplit_j": 4,
        "omp_level_size": ("_AUTOBLOCKER_", None),
        "read_metric": False,
        "optim_it": 0,
        "dt": 30.0,
        "itau_adv": 1,
        "run_length": ("_AUTOBLOCKER_", None),
        "etat0_start_iteration_reset": ("_AUTOBLOCKER_", None),
        "write_period": 10800,
        "itau_check_conserv": 100,
        "nqtot": ("_AUTO_", 4),
        "out_pression_level": 85000,
        "start_file_name": "start",
        "restart_file_name": "restart",
        "using_oasis": ("_AUTOBLOCKER_", None),
        "tau_graddiv": 3600,
        "nitergdiv": 1,
        "tau_gradrot": 21600,
        "nitergrot": 2,
        "tau_divgrad": 10800,
        "niterdivgrad": 2,
        "physics": "phys_external",
        "itau_physics": 30,
        "create_etat0_limit": ("_AUTO_", None),
        "etat0": ("_AUTO_", None),
        "etat0_database_type": "ERA5_forcing",
        "iflag_phys": ("_AUTO_", None),
        "param_gw_method": "legacy",
        "heldsz_p0": 101080,
    }
test_run_dynamico_nbp60_dumps_loads 
test_run_dynamico_nbp60_dumps_loads(run_dynamico_nbp60)
Source code in tests/test_def_file.py 
545
546
def test_run_dynamico_nbp60_dumps_loads(run_dynamico_nbp60):
    assert run_dynamico_nbp60 == loads(dumps(run_dynamico_nbp60))
test_run_dynamico_nbp60_load 
test_run_dynamico_nbp60_load(run_dynamico_nbp60)
Source code in tests/test_def_file.py 
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
def test_run_dynamico_nbp60_load(run_dynamico_nbp60):
    assert run_dynamico_nbp60 == {
        "metric_type": "icosa_global",
        "guided_type": ("_AUTO_", None),
        "itau_nudging": 48,
        "nudging_zone": "global",
        "U_relax_in": 21600,
        "PS_relax_in": 1e30,
        "T_relax_in": 1e30,
        "Q_relax_in": 1e30,
        "guide_U": True,
        "mpi_threading_mode": "funneled",
        "nbp": 60,
        "nsplit_i": 6,
        "nsplit_j": 6,
        "omp_level_size": ("_AUTOBLOCKER_", None),
        "read_metric": ("_AUTO_", None),
        "optim_it": ("_AUTO_", None),
        "dt": 150.0,
        "itau_adv": 1,
        "run_length": ("_AUTOBLOCKER_", None),
        "etat0_start_iteration_reset": ("_AUTOBLOCKER_", None),
        "write_period": 86400,
        "itau_check_conserv": 100,
        "nqtot": ("_AUTO_", 4),
        "out_pression_level": 85000,
        "start_file_name": "start",
        "restart_file_name": "restart",
        "using_oasis": ("_AUTOBLOCKER_", None),
        "tau_graddiv": 2400,
        "nitergdiv": 1,
        "tau_gradrot": 14400,
        "nitergrot": 2,
        "tau_divgrad": 7200,
        "niterdivgrad": 2,
        "physics": "phys_external",
        "itau_physics": 6,
        "create_etat0_limit": ("_AUTO_", None),
        "etat0": ("_AUTO_", None),
        "iflag_phys": ("_AUTO_", None),
        "param_gw_method": "legacy",
        "heldsz_p0": 101080,
    }
test_run_lmdz_dumps_loads 
test_run_lmdz_dumps_loads(run_lmdz)
Source code in tests/test_def_file.py 
496
497
def test_run_lmdz_dumps_loads(run_lmdz):
    assert run_lmdz == loads(dumps(run_lmdz))
test_run_lmdz_load 
test_run_lmdz_load(run_lmdz)
Source code in tests/test_def_file.py 
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
def test_run_lmdz_load(run_lmdz):
    assert run_lmdz == {
        "INCLUDEDEF": [
            "run_dynamico.def",
            "earth_const.def",
            "physiq.def",
            "gcm.def",
            "vert.def",
            "orchidee.def",
            "orchidee_pft.def",
            "config.def",
            "reprobus.def",
            "guide.def",
            "inca.def",
        ],
        "VEGET": ("_AUTOBLOCKER_", None),
        "adjust": False,
        "anneeref": ("_AUTOBLOCKER_", None),
        "calend": ("_AUTOBLOCKER_", None),
        "config_inca": ("_AUTOBLOCKER_", None),
        "cpl_current": True,
        "cpl_old_calving": ("_AUTO_", None),
        "dayref": ("_AUTOBLOCKER_", None),
        "iconser": 240,
        "iecri": 1,
        "iflag_phytrac": ("_AUTOBLOCKER_", 0),
        "nday": ("_AUTOBLOCKER_", None),
        "no_ter_antartique": True,
        "ok_all_xml": True,
        "ok_dynzon": False,
        "prt_level": 0,
        "raz_date": ("_AUTOBLOCKER_", None),
        "type_ocean": ("_AUTOBLOCKER_", None),
        "type_trac": ("_AUTOBLOCKER_", None),
        "use_filtre_fft": True,
        "version_ocean": "nemo",
    }
vert_L95 
vert_L95()
Source code in tests/test_def_file.py 
95
96
97
@pytest.fixture
def vert_L95():
    return _load_file("vert.def_L95.r7417")

test_def_file_decoder

Unit tests of DefFileDecoder

Functions:

decoder 
decoder()

Initialize classical decoder

Source code in tests/test_def_file_decoder.py 
 8
 9
10
11
@pytest.fixture
def decoder():
    """Initialize classical decoder"""
    return DefFileDecoder()
test_array 
test_array(decoder)

Test decoding of arrays

Source code in tests/test_def_file_decoder.py 
58
59
60
61
62
def test_array(decoder):
    """Test decoding of arrays"""
    assert decoder.decode("a = 1,2") == {"a": [1, 2]}
    assert decoder.decode("a = 1,2,3") == {"a": [1, 2, 3]}
    assert decoder.decode("a = a, 2, y") == {"a": ["a", 2, True]}
test_auto 
test_auto(decoder)

Test decoding of auto values

Source code in tests/test_def_file_decoder.py 
65
66
67
68
69
70
71
72
def test_auto(decoder):
    """Test decoding of auto values"""
    assert decoder.decode("a=_AUTO_") == {"a": ("_AUTO_", None)}
    assert decoder.decode("a=_AUTO_:DEFAULT=3.14") == {"a": ("_AUTO_", 3.14)}
    assert decoder.decode("a=_AUTOBLOCKER_") == {"a": ("_AUTOBLOCKER_", None)}
    assert decoder.decode("a=_AUTOBLOCKER_:DEFAULT='text'") == {
        "a": ("_AUTOBLOCKER_", "'text'")
    }
test_float 
test_float(decoder)

Test decoding float numbers

Source code in tests/test_def_file_decoder.py 
32
33
34
35
36
37
38
39
def test_float(decoder):
    """Test decoding float numbers"""
    assert decoder.decode("a=3.1415") == {"a": 3.1415}
    assert decoder.decode("a=3.14e2") == {"a": 314}
    assert decoder.decode("a=3.14e-2") == {"a": 0.0314}
    assert decoder.decode("a=-3.1415") == {"a": -3.1415}
    assert decoder.decode("a=-3.14e2") == {"a": -314}
    assert decoder.decode("a=-3.14e-2") == {"a": -0.0314}
test_include 
test_include(decoder)

Test decoding of INCLUDEDEF statements

Source code in tests/test_def_file_decoder.py 
14
15
16
17
18
19
def test_include(decoder):
    """Test decoding of INCLUDEDEF statements"""
    assert decoder.decode("INCLUDEDEF=module1") == {"INCLUDEDEF": ["module1"]}
    assert decoder.decode("INCLUDEDEF=module1\nINCLUDEDEF=module2") == {
        "INCLUDEDEF": ["module1", "module2"]
    }
test_integer 
test_integer(decoder)

Test decoding integer numbers

Source code in tests/test_def_file_decoder.py 
42
43
44
45
46
47
48
def test_integer(decoder):
    """Test decoding integer numbers"""
    assert decoder.decode("a=1") == {"a": 1}
    assert decoder.decode("a=-1") == {"a": -1}
    assert decoder.decode("a=-0") == {"a": 0}
    assert decoder.decode("a=+0") == {"a": 0}
    assert decoder.decode("a=6123") == {"a": 6123}
test_logical 
test_logical(decoder)

Test decoding logical values

Source code in tests/test_def_file_decoder.py 
22
23
24
25
26
27
28
29
def test_logical(decoder):
    """Test decoding logical values"""
    assert decoder.decode("a = true\nb=y\nc=TRUE") == {"a": True, "b": True, "c": True}
    assert decoder.decode("a = false\nb=n\nc=FALSE") == {
        "a": False,
        "b": False,
        "c": False,
    }
test_string 
test_string(decoder)

Test decoding strings (quoted and unqoted)

Source code in tests/test_def_file_decoder.py 
51
52
53
54
55
def test_string(decoder):
    """Test decoding strings (quoted and unqoted)"""
    assert decoder.decode("a=text") == {"a": "text"}
    assert decoder.decode("a='text'") == {"a": "'text'"}
    assert decoder.decode('a="text"') == {"a": '"text"'}

test_def_file_decoder_positions

Unit tests of DefFileDecoder key-value positions

Functions:

decoder 
decoder()

Initialize decoder with value position parsing

Source code in tests/test_def_file_decoder_positions.py 
 8
 9
10
11
@pytest.fixture
def decoder():
    """Initialize decoder with value position parsing"""
    return DefFileDecoder(include_positions=True)
test_array_positions 
test_array_positions(decoder)

Test positions of decoded arrays

Source code in tests/test_def_file_decoder_positions.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
def test_array_positions(decoder):
    """Test positions of decoded arrays"""
    assert decoder.decode("a = 1,2") == {
        "a": {"value": [1, 2], "key_start_pos": 0, "start_pos": 4, "end_pos": 7}
    }

    assert decoder.decode("a = 1,2,3") == {
        "a": {"value": [1, 2, 3], "key_start_pos": 0, "start_pos": 4, "end_pos": 9}
    }

    assert decoder.decode("a = a, 2, y") == {
        "a": {
            "value": ["a", 2, True],
            "key_start_pos": 0,
            "start_pos": 4,
            "end_pos": 11,
        }
    }
test_auto_positions 
test_auto_positions(decoder)

Test positions of decoded auto values

Source code in tests/test_def_file_decoder_positions.py 
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
def test_auto_positions(decoder):
    """Test positions of decoded auto values"""
    assert decoder.decode("a=_AUTO_") == {
        "a": {
            "value": ("_AUTO_", None),
            "key_start_pos": 0,
            "start_pos": 2,
            "end_pos": 8,
        }
    }
    assert decoder.decode("a=_AUTO_:DEFAULT=3.14") == {
        "a": {
            "value": ("_AUTO_", 3.14),
            "key_start_pos": 0,
            "start_pos": 2,
            "end_pos": 21,
        }
    }
    assert decoder.decode("a=_AUTOBLOCKER_") == {
        "a": {
            "value": ("_AUTOBLOCKER_", None),
            "key_start_pos": 0,
            "start_pos": 2,
            "end_pos": 15,
        }
    }
    assert decoder.decode("a=_AUTOBLOCKER_:DEFAULT='text'") == {
        "a": {
            "value": ("_AUTOBLOCKER_", "'text'"),
            "key_start_pos": 0,
            "start_pos": 2,
            "end_pos": 30,
        }
    }
test_compound_positions 
test_compound_positions(decoder)

Test decoding of various positions

Source code in tests/test_def_file_decoder_positions.py 
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
def test_compound_positions(decoder):
    """Test decoding of various positions"""
    assert decoder.decode("a=1\nb='text'\nc=_AUTO_:DEFAULT=3.14") == {
        "a": {"value": 1, "key_start_pos": 0, "start_pos": 2, "end_pos": 3},
        "b": {"value": "'text'", "key_start_pos": 4, "start_pos": 6, "end_pos": 12},
        "c": {
            "value": ("_AUTO_", 3.14),
            "key_start_pos": 13,
            "start_pos": 15,
            "end_pos": 34,
        },
    }
    # TODO: consider keeping start/end positions for each array element
    assert decoder.decode("a=1,2,3") == {
        "a": {"end_pos": 7, "key_start_pos": 0, "start_pos": 2, "value": [1, 2, 3]}
    }
test_float_positions 
test_float_positions(decoder)

Test positions of decoded float numbers

Source code in tests/test_def_file_decoder_positions.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
def test_float_positions(decoder):
    """Test positions of decoded float numbers"""
    assert decoder.decode(" a=3.1415") == {
        "a": {"value": 3.1415, "key_start_pos": 1, "start_pos": 3, "end_pos": 9}
    }
    assert decoder.decode("  a=3.14e-2") == {
        "a": {"value": 0.0314, "key_start_pos": 2, "start_pos": 4, "end_pos": 11}
    }
    assert decoder.decode("a =-3.1415") == {
        "a": {"value": -3.1415, "key_start_pos": 0, "start_pos": 3, "end_pos": 10}
    }
    assert decoder.decode("a= -3.14e-2") == {
        "a": {"value": -0.0314, "key_start_pos": 0, "start_pos": 3, "end_pos": 11}
    }
test_include_positions 
test_include_positions(decoder)

Test positions of decoded INCLUDEDEF statements

Source code in tests/test_def_file_decoder_positions.py 
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
def test_include_positions(decoder):
    """Test positions of decoded INCLUDEDEF statements"""
    assert decoder.decode("INCLUDEDEF=module1") == {
        "INCLUDEDEF": [
            {
                "value": "module1",
                "key_start_pos": 0,
                "start_pos": 11,
                "end_pos": 18,
            }
        ]
    }
    assert decoder.decode("INCLUDEDEF=module1\nINCLUDEDEF=module2") == {
        "INCLUDEDEF": [
            {
                "value": "module1",
                "key_start_pos": 0,
                "start_pos": 11,
                "end_pos": 18,
            },
            {
                "value": "module2",
                "key_start_pos": 19,
                "start_pos": 30,
                "end_pos": 37,
            },
        ]
    }
test_integer_positions 
test_integer_positions(decoder)

Test position of decoded integer numbers

Source code in tests/test_def_file_decoder_positions.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
def test_integer_positions(decoder):
    """Test position of decoded integer numbers"""
    assert decoder.decode("a=1") == {
        "a": {"value": 1, "key_start_pos": 0, "start_pos": 2, "end_pos": 3}
    }

    assert decoder.decode("a=-1") == {
        "a": {"value": -1, "key_start_pos": 0, "start_pos": 2, "end_pos": 4}
    }

    assert decoder.decode("a=6123") == {
        "a": {"value": 6123, "key_start_pos": 0, "start_pos": 2, "end_pos": 6}
    }
test_logical_positions 
test_logical_positions(decoder)

Test positions of decoded logical values

Source code in tests/test_def_file_decoder_positions.py 
44
45
46
47
48
49
50
51
52
53
54
55
def test_logical_positions(decoder):
    """Test positions of decoded logical values"""
    assert decoder.decode("a = true\nb=y\nc=TRUE") == {
        "a": {"value": True, "key_start_pos": 0, "start_pos": 4, "end_pos": 8},
        "b": {"value": True, "key_start_pos": 9, "start_pos": 11, "end_pos": 12},
        "c": {"value": True, "key_start_pos": 13, "start_pos": 15, "end_pos": 19},
    }
    assert decoder.decode("a = false\nb=n\nc=FALSE") == {
        "a": {"value": False, "key_start_pos": 0, "start_pos": 4, "end_pos": 9},
        "b": {"value": False, "key_start_pos": 10, "start_pos": 12, "end_pos": 13},
        "c": {"value": False, "key_start_pos": 14, "start_pos": 16, "end_pos": 21},
    }
test_string_positions 
test_string_positions(decoder)

Test positions of decoded strings (quoted and unqoted)

Source code in tests/test_def_file_decoder_positions.py 
89
90
91
92
93
94
95
96
97
98
99
def test_string_positions(decoder):
    """Test positions of decoded strings (quoted and unqoted)"""
    assert decoder.decode("a=text") == {
        "a": {"value": "text", "key_start_pos": 0, "start_pos": 2, "end_pos": 6}
    }
    assert decoder.decode("a='text'") == {
        "a": {"value": "'text'", "key_start_pos": 0, "start_pos": 2, "end_pos": 8}
    }
    assert decoder.decode('a="text"') == {
        "a": {"value": '"text"', "key_start_pos": 0, "start_pos": 2, "end_pos": 8}
    }

test_def_file_encoder

Functions:

encoder 
encoder()
Source code in tests/test_def_file_encoder.py 
6
7
8
@pytest.fixture
def encoder():
    return DefFileEncoder()
encoder_bool_labels 
encoder_bool_labels()
Source code in tests/test_def_file_encoder.py 
11
12
13
@pytest.fixture
def encoder_bool_labels():
    return DefFileEncoder(truthy_value="y", falsey_value="n")
test_bool 
test_bool(encoder)
Source code in tests/test_def_file_encoder.py 
16
17
18
def test_bool(encoder):
    assert encoder.encode(True) == "true"
    assert encoder.encode(False) == "false"
test_bool_labels 
test_bool_labels(encoder_bool_labels)
Source code in tests/test_def_file_encoder.py 
21
22
23
24
25
26
27
def test_bool_labels(encoder_bool_labels):
    # Test other labels for true/false values
    # These changes are local to this test, and will not affect other tests
    encoder_bool_labels._truthy_value = "y"
    encoder_bool_labels._falsey_value = "n"
    assert encoder_bool_labels.encode(True) == "y"
    assert encoder_bool_labels.encode(False) == "n"
test_dict 
test_dict(encoder)
Source code in tests/test_def_file_encoder.py 
30
31
32
33
34
35
36
37
38
def test_dict(encoder):
    assert encoder.encode({"p": 1}) == "p = 1"
    assert encoder.encode({"p": 1, "q": 2}) == "p = 1\nq = 2"
    assert (
        encoder.encode({"INCLUDEDEF": ["m1", "m2"], "p": 1})
        == "INCLUDEDEF = m1\nINCLUDEDEF = m2\np = 1"
    )
    with pytest.raises(TypeError, match="cannot be of type: dict"):
        encoder.encode({"p": {"q": 2}})
test_float 
test_float(encoder)
Source code in tests/test_def_file_encoder.py 
41
42
43
44
45
46
def test_float(encoder):
    assert encoder.encode(-1.0) == "-1.0"
    assert encoder.encode(+1.0) == "1.0"
    assert encoder.encode(5e4) == "50000.0"
    assert encoder.encode(3.14e2) == "314.0"
    assert encoder.encode(3.14e-2) == "0.0314"
test_int 
test_int(encoder)
Source code in tests/test_def_file_encoder.py 
49
50
51
52
def test_int(encoder):
    assert encoder.encode(-1) == "-1"
    assert encoder.encode(+1) == "1"
    assert encoder.encode(int(5e4)) == "50000"
test_list 
test_list(encoder)
Source code in tests/test_def_file_encoder.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def test_list(encoder):
    assert encoder.encode([1, 2]) == "1, 2"
    assert encoder.encode([1, 2, "a"]) == "1, 2, a"
    with pytest.raises(ValueError, match="at least two elements"):
        assert encoder.encode([])
    with pytest.raises(ValueError, match="at least two elements"):
        assert encoder.encode([1])
    with pytest.raises(TypeError, match="must be simple scalars"):
        assert encoder.encode([1, {}])
    with pytest.raises(TypeError, match="must be simple scalars"):
        assert encoder.encode([1, {"p": 2}])
    with pytest.raises(TypeError, match="must be simple scalars"):
        assert encoder.encode([1, ()])
    with pytest.raises(TypeError, match="must be simple scalars"):
        assert encoder.encode([1, (2, 3)])
    with pytest.raises(TypeError, match="must be simple scalars"):
        assert encoder.encode([1, []])
    with pytest.raises(TypeError, match="must be simple scalars"):
        assert encoder.encode([1, [2, 3]])
test_tuple 
test_tuple(encoder)
Source code in tests/test_def_file_encoder.py 
 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
def test_tuple(encoder):
    assert encoder.encode(("_AUTO_", None)) == "_AUTO_"
    assert encoder.encode(("_AUTOBLOCKER_", None)) == "_AUTOBLOCKER_"
    assert encoder.encode(("_AUTO_", True)) == "_AUTO_: DEFAULT=true"
    assert encoder.encode(("_AUTO_", 3)) == "_AUTO_: DEFAULT=3"
    assert encoder.encode(("_AUTO_", 3.14)) == "_AUTO_: DEFAULT=3.14"
    assert encoder.encode(("_AUTO_", "text")) == "_AUTO_: DEFAULT=text"
    assert encoder.encode(("_AUTO_", "'text'")) == "_AUTO_: DEFAULT='text'"
    assert encoder.encode(("_AUTO_", '"text"')) == '_AUTO_: DEFAULT="text"'
    with pytest.raises(ValueError, match="len=2"):
        assert encoder.encode(())
    with pytest.raises(ValueError, match="len=2"):
        assert encoder.encode(("_AUTO_",))
    with pytest.raises(ValueError, match="len=2"):
        assert encoder.encode(("_AUTO_", None, None))
    with pytest.raises(ValueError, match="First element"):
        assert encoder.encode(("AUTO", None))
    with pytest.raises(ValueError, match="First element"):
        assert encoder.encode((None, None))
    with pytest.raises(TypeError, match="Second element"):
        assert encoder.encode(("_AUTO_", ()))
    with pytest.raises(TypeError, match="Second element"):
        assert encoder.encode(("_AUTO_", (1, 2, 3)))
    with pytest.raises(TypeError, match="Second element"):
        assert encoder.encode(("_AUTO_", {}))
    with pytest.raises(TypeError, match="Second element"):
        assert encoder.encode(("_AUTO_", {"k1": 1, "k2": 2, "k3": 3}))
    with pytest.raises(TypeError, match="Second element"):
        assert encoder.encode(("_AUTO_", []))
    with pytest.raises(TypeError, match="Second element"):
        assert encoder.encode(("_AUTO_", [1, 2, 3]))

test_def_file_modify

Functions:

all_datatypes_dict 
all_datatypes_dict() -> dict
Source code in tests/test_def_file_modify.py 
21
22
23
@pytest.fixture
def all_datatypes_dict() -> dict:
    return _decode_file("all_datatypes.def")
all_datatypes_modified 
all_datatypes_modified() -> str
Source code in tests/test_def_file_modify.py 
31
32
33
@pytest.fixture
def all_datatypes_modified() -> str:
    return _read_file("all_datatypes.def.modified")
all_datatypes_str 
all_datatypes_str() -> str
Source code in tests/test_def_file_modify.py 
26
27
28
@pytest.fixture
def all_datatypes_str() -> str:
    return _read_file("all_datatypes.def")
includedef_add_str 
includedef_add_str() -> str
Source code in tests/test_def_file_modify.py 
41
42
43
@pytest.fixture
def includedef_add_str() -> str:
    return _read_file("includedef/add.def")
includedef_everything_str 
includedef_everything_str() -> str
Source code in tests/test_def_file_modify.py 
46
47
48
@pytest.fixture
def includedef_everything_str() -> str:
    return _read_file("includedef/everything.def")
includedef_ref 
includedef_ref() -> dict
Source code in tests/test_def_file_modify.py 
36
37
38
@pytest.fixture
def includedef_ref() -> dict:
    return _decode_file("includedef/reference.def")
includedef_ref_str 
includedef_ref_str() -> str
Source code in tests/test_def_file_modify.py 
51
52
53
@pytest.fixture
def includedef_ref_str() -> str:
    return _read_file("includedef/reference.def")
includedef_remove_str 
includedef_remove_str() -> str
Source code in tests/test_def_file_modify.py 
56
57
58
@pytest.fixture
def includedef_remove_str() -> str:
    return _read_file("includedef/remove.def")
test_append_kv 
test_append_kv(three_kv_str, three_kv_dict)

Test appending of key-value pairs at the end

Source code in tests/test_def_file_modify.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
def test_append_kv(three_kv_str, three_kv_dict):
    """Test appending of key-value pairs at the end"""
    append_one = three_kv_dict.copy()
    append_one["d"] = 42
    assert modifys(three_kv_str, append_one) == "a=1\nb=2\nc=3\nd = 42"
    append_two = three_kv_dict.copy()
    append_two["d"] = 42
    append_two["e"] = 43
    assert modifys(three_kv_str, append_two) == "a=1\nb=2\nc=3\nd = 42\ne = 43"
    append_with_header = three_kv_dict.copy()
    append_with_header["d"] = 42
    assert (
        modifys(three_kv_str, append_with_header, "New values")
        == "a=1\nb=2\nc=3\n# New values\nd = 42"
    )
test_modify_single_kv 
test_modify_single_kv(three_kv_str, three_kv_dict)

Test modifications of key-value pairs at different positions

Source code in tests/test_def_file_modify.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
def test_modify_single_kv(three_kv_str, three_kv_dict):
    """Test modifications of key-value pairs at different positions"""
    modify_first = three_kv_dict.copy()
    modify_first["a"] = 42
    assert modifys(three_kv_str, modify_first) == "a=42\nb=2\nc=3"
    modify_mid = three_kv_dict.copy()
    modify_mid["b"] = 42
    assert modifys(three_kv_str, modify_mid) == "a=1\nb=42\nc=3"
    modify_last = three_kv_dict.copy()
    modify_last["c"] = 42
    assert modifys(three_kv_str, modify_last) == "a=1\nb=2\nc=42"
test_modify_values_str 
test_modify_values_str(
    all_datatypes_dict,
    all_datatypes_str,
    all_datatypes_modified,
)
Source code in tests/test_def_file_modify.py 
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
def test_modify_values_str(
    all_datatypes_dict, all_datatypes_str, all_datatypes_modified
):
    modified_dict = all_datatypes_dict
    # Remove existing keys
    modified_dict.pop("logical_true2")
    modified_dict.pop("string_single_quotes")
    modified_dict.pop("array_mixed")
    # Modify existing values
    modified_dict["logical_true1"] = False
    modified_dict["logical_true5"] = False
    modified_dict["logical_false3"] = True
    modified_dict["logical_false4"] = True
    modified_dict["integer"] = 3.14
    modified_dict["integer_zero"] = -100
    modified_dict["string"] = "halo?"
    modified_dict["string_double_quotes"] = '"halo?"'
    modified_dict["array_floats"] = [True, False, True]
    modified_dict["auto_default_float"] = ("_AUTOBLOCKER_", 100)
    # Add new keys
    modified_dict["new_string"] = "halo?halo?"
    modified_dict["new_integer"] = 333
    modified_dict["new_auto"] = ("_AUTO_", None)
    modified_dict["new_auto_default"] = ("_AUTO_", 3.14)
    # Modify INCLUDEDEF
    modified_dict["INCLUDEDEF"] = ["module1", "module3.def"]
    assert (
        modifys(
            all_datatypes_str,
            modified_dict,
            insert_header="These subsequent keys were inserted by us!",
        )
        # TODO: There is something wrong and the test file has always the LF (or newline) character(s) at the end
        == all_datatypes_modified.rstrip("\n")
    )
test_modifys_includedef_add 
test_modifys_includedef_add(
    includedef_ref, includedef_ref_str, includedef_add_str
)
Source code in tests/test_def_file_modify.py 
168
169
170
171
def test_modifys_includedef_add(includedef_ref, includedef_ref_str, includedef_add_str):
    includedef_ref["INCLUDEDEF"].insert(1, "module1A")
    includedef_ref["INCLUDEDEF"].insert(4, '"module3A.def"')
    assert modifys(includedef_ref_str, includedef_ref) == includedef_add_str
test_modifys_includedef_empty 
test_modifys_includedef_empty(
    includedef_ref,
    includedef_ref_str,
    includedef_remove_str,
)
Source code in tests/test_def_file_modify.py 
182
183
184
185
186
def test_modifys_includedef_empty(
    includedef_ref, includedef_ref_str, includedef_remove_str
):
    includedef_ref["INCLUDEDEF"] = []
    assert modifys(includedef_ref_str, includedef_ref) == ""
test_modifys_includedef_everything 
test_modifys_includedef_everything(
    includedef_ref,
    includedef_ref_str,
    includedef_everything_str,
)
Source code in tests/test_def_file_modify.py 
189
190
191
192
193
194
195
196
def test_modifys_includedef_everything(
    includedef_ref, includedef_ref_str, includedef_everything_str
):
    includedef_ref["INCLUDEDEF"].pop(1)
    includedef_ref["INCLUDEDEF"].pop(1)
    includedef_ref["INCLUDEDEF"].insert(0, "module1A")
    includedef_ref["INCLUDEDEF"].append("'module4A.def'")
    assert modifys(includedef_ref_str, includedef_ref) == includedef_everything_str
test_modifys_includedef_ref 
test_modifys_includedef_ref(
    includedef_ref, includedef_ref_str
)

Test if making no changes doesn't change the input text!

Source code in tests/test_def_file_modify.py 
163
164
165
def test_modifys_includedef_ref(includedef_ref, includedef_ref_str):
    """Test if making no changes doesn't change the input text!"""
    assert modifys(includedef_ref_str, includedef_ref) == includedef_ref_str
test_modifys_includedef_remove 
test_modifys_includedef_remove(
    includedef_ref,
    includedef_ref_str,
    includedef_remove_str,
)
Source code in tests/test_def_file_modify.py 
174
175
176
177
178
179
def test_modifys_includedef_remove(
    includedef_ref, includedef_ref_str, includedef_remove_str
):
    includedef_ref["INCLUDEDEF"].pop(2)
    includedef_ref["INCLUDEDEF"].pop(0)
    assert modifys(includedef_ref_str, includedef_ref) == includedef_remove_str
test_null_modify 
test_null_modify(all_datatypes_dict, all_datatypes_str)

Test modification with no modifications!

Source code in tests/test_def_file_modify.py 
71
72
73
74
75
76
77
78
79
def test_null_modify(all_datatypes_dict, all_datatypes_str):
    """Test modification with no modifications!"""
    assert (
        modifys(
            all_datatypes_str,
            all_datatypes_dict,
        )
        == all_datatypes_str
    )
test_remove_single_kv 
test_remove_single_kv(three_kv_str, three_kv_dict)

Test removal of key-value pairs at different positions

Source code in tests/test_def_file_modify.py 
82
83
84
85
86
87
88
89
90
91
92
93
def test_remove_single_kv(three_kv_str, three_kv_dict):
    """Test removal of key-value pairs at different positions"""
    remove_first = three_kv_dict.copy()
    del remove_first["a"]
    assert modifys(three_kv_str, remove_first) == "b=2\nc=3"
    remove_mid = three_kv_dict.copy()
    del remove_mid["b"]
    assert modifys(three_kv_str, remove_mid) == "a=1\nc=3"
    remove_last = three_kv_dict.copy()
    del remove_last["c"]
    # TODO: when removing the last item, the preceeding newline is not removed
    assert modifys(three_kv_str, remove_last) == "a=1\nb=2\n"
three_kv_dict 
three_kv_dict() -> dict
Source code in tests/test_def_file_modify.py 
66
67
68
@pytest.fixture
def three_kv_dict() -> dict:
    return loads("a=1\nb=2\nc=3")
three_kv_str 
three_kv_str() -> str
Source code in tests/test_def_file_modify.py 
61
62
63
@pytest.fixture
def three_kv_str() -> str:
    return "a=1\nb=2\nc=3"

test_envmodules

Functions:

test_on_spirit 
test_on_spirit()
Source code in tests/test_envmodules.py 
 7
 8
 9
10
11
12
13
14
15
16
@pytest.mark.skipif(
    not is_espri_spiritx(), reason="This test can be run only on ESPRI/SpiritX"
)
def test_on_spirit():
    modules = EnvModules()
    assert modules.list_loaded() == []
    assert "gcc/13.2.0" in modules.list_available()
    assert modules.purge()
    assert modules.load("gcc/13.2.0", "cdo/2.3.0")
    assert modules.list_loaded() == ["cdo/2.3.0", "gcc/13.2.0"]

test_flatten_key_dict_view

Testing of the FlattenKeyDictView class

Functions:

fd 
fd(test_dict)

Test dictionary converted to a flatten form

Source code in tests/test_flatten_key_dict_view.py 
14
15
16
17
@pytest.fixture
def fd(test_dict):
    """Test dictionary converted to a flatten form"""
    return FlattenKeyDictView(test_dict)
fd_sep_at 
fd_sep_at(test_dict)

Test dictionary converted to a flatten form with custom flat key separator @

Source code in tests/test_flatten_key_dict_view.py 
20
21
22
23
@pytest.fixture
def fd_sep_at(test_dict):
    """Test dictionary converted to a flatten form with custom flat key separator @"""
    return FlattenKeyDictView(test_dict, flat_key_separator="@")
test_contains 
test_contains(fd)

Test the in operator

Source code in tests/test_flatten_key_dict_view.py 
26
27
28
29
30
31
32
33
34
def test_contains(fd):
    """Test the `in` operator"""
    assert "a1" in fd
    assert "b" in fd
    assert "b.k1" in fd
    assert "b.k2" in fd
    assert "c" in fd
    assert "c.k1" in fd
    assert "c.k1.k11" in fd
test_custom_key_separator 
test_custom_key_separator(fd_sep_at)

Test using @ as the custom key separator

Source code in tests/test_flatten_key_dict_view.py 
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
def test_custom_key_separator(fd_sep_at):
    """Test using @ as the custom key separator"""
    # Test contains
    assert "b@k1" in fd_sep_at
    assert "b@k2" in fd_sep_at
    assert "c@k1" in fd_sep_at
    assert "c@k1@k11" in fd_sep_at
    # Test getitem
    assert fd_sep_at["b@k1"] == 3
    assert fd_sep_at["b@k2"] == 4
    assert fd_sep_at["c@k1"] == {"k11": True}
    assert fd_sep_at["c@k1@k11"]
    # Test setitem
    fd_sep_at["b@k1"] = 34
    assert fd_sep_at["b@k1"] == 34
    assert fd_sep_at["b"] == {"k1": 34, "k2": 4}
    fd_sep_at["d@k1"] = 44
    assert fd_sep_at["d"] == {"k1": 44}
    assert fd_sep_at["d@k1"] == 44
    # Test delitem
    del fd_sep_at["a1"]
    assert "a1" not in fd_sep_at
    del fd_sep_at["b@k1"]
    assert fd_sep_at["b"] == {"k2": 4}
    del fd_sep_at["c@k1@k11"]
    assert fd_sep_at["c@k1"] == {}
test_delitem 
test_delitem(fd)

Test removing keys from the dict

Source code in tests/test_flatten_key_dict_view.py 
63
64
65
66
67
68
69
70
def test_delitem(fd):
    """Test removing keys from the dict"""
    del fd["a1"]
    assert "a1" not in fd
    del fd["b.k1"]
    assert fd["b"] == {"k2": 4}
    del fd["c.k1.k11"]
    assert fd["c.k1"] == {}
test_dict 
test_dict()

Default simple nested dictionary

Source code in tests/test_flatten_key_dict_view.py 
 8
 9
10
11
@pytest.fixture
def test_dict():
    """Default simple nested dictionary"""
    return {"a1": 1, "b": {"k1": 3, "k2": 4}, "c": {"k1": {"k11": True}}}
test_getitem 
test_getitem(fd)

Test accessing dict keys

Source code in tests/test_flatten_key_dict_view.py 
37
38
39
40
41
42
43
44
45
def test_getitem(fd):
    """Test accessing dict keys"""
    assert fd["a1"] == 1
    assert fd["b"] == {"k1": 3, "k2": 4}
    assert fd["b.k1"] == 3
    assert fd["b.k2"] == 4
    assert fd["c"] == {"k1": {"k11": True}}
    assert fd["c.k1"] == {"k11": True}
    assert fd["c.k1.k11"]
test_keys 
test_keys(fd)

Test returning of flatten keys

Source code in tests/test_flatten_key_dict_view.py 
101
102
103
104
def test_keys(fd):
    """Test returning of flatten keys"""
    assert fd.ordered_keys() == ["a1", "b", "b.k1", "b.k2", "c", "c.k1", "c.k1.k11"]
    assert fd.ordered_leaf_keys() == ["a1", "b.k1", "b.k2", "c.k1.k11"]
test_raise_exception 
test_raise_exception(fd)

Test corner cases with invalid or non-existing sub-keys

Source code in tests/test_flatten_key_dict_view.py 
107
108
109
110
111
112
113
114
def test_raise_exception(fd):
    """Test corner cases with invalid or non-existing sub-keys"""
    with pytest.raises(KeyError, match="Parent .* is not a dictionary"):
        # b.k1 is a value, it can't contain k2!
        fd["b.k1.k2"]
    with pytest.raises(KeyError, match="Parent .* doesn't exist"):
        # e doesn't exist at all
        fd["e.k1"]
test_setitem 
test_setitem(fd)

Test changing values of dict keys

Source code in tests/test_flatten_key_dict_view.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
def test_setitem(fd):
    """Test changing values of dict keys"""
    fd["a1"] = 43
    assert fd["a1"] == 43
    fd["b.k1"] = 34
    assert fd["b.k1"] == 34
    assert fd["b"] == {"k1": 34, "k2": 4}
    fd["d.k1"] = 44
    assert fd["d"] == {"k1": 44}
    assert fd["d.k1"] == 44
    # Add a non-exisiting long flat key with a value
    fd["e.k1.k11"] = 3.14
    assert fd["e.k1.k11"] == 3.14

test_mod_file

Functions:

configs 
configs(mod_file)
Source code in tests/test_mod_file.py 
20
21
22
@pytest.fixture
def configs(mod_file):
    return mod_file["configuration"]
grisli 
grisli(configs)
Source code in tests/test_mod_file.py 
35
36
37
@pytest.fixture
def grisli(configs):
    return configs["GRISLI"]
ioipsl 
ioipsl(configs)
Source code in tests/test_mod_file.py 
25
26
27
@pytest.fixture
def ioipsl(configs):
    return configs["IOIPSL_PLUS"]
ipslcm7 
ipslcm7(configs)
Source code in tests/test_mod_file.py 
30
31
32
@pytest.fixture
def ipslcm7(configs):
    return configs["IPSLCM7.0"]
mod_file 
mod_file()
Source code in tests/test_mod_file.py 
 8
 9
10
11
12
@pytest.fixture
def mod_file():
    root = Path(__file__).parent.resolve()
    with open(root / "examples" / "modipsl" / "moddef" / "mod.def.r7473") as f:
        return load(f)
nemo_v40 
nemo_v40(configs)
Source code in tests/test_mod_file.py 
40
41
42
@pytest.fixture
def nemo_v40(configs):
    return configs["NEMO_v4.0"]
repos 
repos(mod_file)
Source code in tests/test_mod_file.py 
15
16
17
@pytest.fixture
def repos(mod_file):
    return mod_file["repository"]
test_configuration 
test_configuration(configs)
Source code in tests/test_mod_file.py 
49
50
def test_configuration(configs):
    assert len(configs) == 62
test_git_path_repository 
test_git_path_repository(repos)
Source code in tests/test_mod_file.py 
69
70
71
72
73
74
def test_git_path_repository(repos):
    # Test local repo with a path
    assert repos[24] == {
        "type": "git",
        "clone_url": "/ccc/work/cont003/igcmg/igcmg/IGCM/LIC/ELMERICE/elmerfem",
    }
test_git_repository 
test_git_repository(repos)
Source code in tests/test_mod_file.py 
53
54
55
56
57
58
def test_git_repository(repos):
    # Test classic git repo
    assert repos[7] == {
        "type": "git",
        "clone_url": "https://gitlab.in2p3.fr/ipsl/projets/nemogcm/nemo.git",
    }
test_grisli_configuration 
test_grisli_configuration(grisli)
Source code in tests/test_mod_file.py 
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
def test_grisli_configuration(grisli):
    # GRISLI configuration is interesting to test, because it has
    # identical name of the second and the third components: GRISLI
    # This is the use case that forbids us from using dictionary to
    # store componets by their name ;(
    assert grisli == {
        "description": ["GRISLI stand-alone for Antarctica icesheets (prototype)"],
        "components": [
            {
                "name": "libIGCM",
                "variant": "trunk/libIGCM",
                "revision": "HEAD",
                "repository": 10,
                "modipsl_dir": ".",
            },
            {
                "name": "GRISLI",
                "variant": "branches/xios",
                "revision": "HEAD",
                "repository": 26,
                "modipsl_dir": "modeles",
            },
            {
                "name": "GRISLI",
                "variant": "CONFIG/GRISLI",
                "revision": "HEAD",
                "repository": 8,
                "modipsl_dir": "config",
            },
            {
                "name": "XIOS",
                "variant": "XIOS3_2902",
                "revision": "243e0b53",
                "repository": 12,
                "modipsl_dir": "modeles",
            },
        ],
    }
test_ioipsl_config 
test_ioipsl_config(ioipsl)
Source code in tests/test_mod_file.py 
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
def test_ioipsl_config(ioipsl):
    # Test parsing of the configuration description
    assert ioipsl == {
        "description": [
            "IOIPSL contains source for library and for rebuild",
            "IOIPSL last tagged public version",
        ],
        "components": [
            {
                "name": "IOIPSL",
                "variant": "IOIPSL/tags/v2_2_5",
                "revision": "HEAD",
                "repository": 8,
                "modipsl_dir": "modeles",
            }
        ],
    }
test_ipslcm7_config 
test_ipslcm7_config(ipslcm7)
Source code in tests/test_mod_file.py 
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
def test_ipslcm7_config(ipslcm7):
    # Test parsing of the configuration description
    assert ipslcm7 == {
        "description": [
            "IPSLCM7.0 1st coupled configuration in CM7 family",
            "With this configuration icosa grid or reg grid can be used (user choice)",
            "IPSLCM7 can be use in full coupled configuration or with forced subconfiguration",
            "Regular subconfiguration (without ocean) give same results than with IPSLCM6.2.4",
            "NEMO v4.2.2",
            "XIOS2 branches/XIOS2 07f8fdd9 (SVN : XIOS2/trunk revision 2626)",
            "IOIPSL tags v2_2_5",
            "DYNAMICO master 73d9b2d9",
            "ICOSA_LMDZ rev 4858",
            "LMDZ6 trunk revision 4938",
            "ORCHIDEE_2_2 default : branches/ORCHIDEE_2_2 revision 8572",
            "ORCHIDEE_4 optional  : trunk revision 8571",
            "INCA6 trunk revison  1151",
            "OASIS3-MCT 2.0_branch (rev 1818 Cerfacs server, rev 6331 IPSL server)",
            "CONFIG/IPSLCM7 rev 6881",
            "libIGCM trunk rev 1659",
        ],
        "components": [
            {
                "name": "DYNAMICO",
                "variant": "master",
                "revision": "73d9b2d9",
                "repository": 21,
                "modipsl_dir": "modeles",
            },
            {
                "name": "ICOSA_LMDZ",
                "variant": "ICOSA_LMDZ",
                "revision": "4897",
                "repository": 20,
                "modipsl_dir": "modeles",
            },
            {
                "name": "IOIPSL",
                "variant": "IOIPSL/tags/v2_2_5",
                "revision": "6644",
                "repository": 8,
                "modipsl_dir": "modeles",
            },
            {
                "name": "ORCHIDEE_2_2",
                "variant": "branches/ORCHIDEE_2_2/ORCHIDEE",
                "revision": "8572",
                "repository": 14,
                "modipsl_dir": "modeles",
            },
            {
                "name": "ORCHIDEE_4",
                "variant": "trunk/ORCHIDEE",
                "revision": "8571",
                "repository": 14,
                "modipsl_dir": "modeles",
            },
            {
                "name": "oasis3-mct",
                "variant": "CPL/oasis3-mct/branches/OASIS3-MCT_5.0_branch",
                "revision": "6331",
                "repository": 8,
                "modipsl_dir": ".",
            },
            {
                "name": "LMDZ",
                "variant": "LMDZ6/trunk",
                "revision": "4938",
                "repository": 20,
                "modipsl_dir": "modeles",
            },
            {
                "name": "IPSLCM7",
                "variant": "CONFIG/UNIFORM/v7/IPSLCM7",
                "revision": "6886",
                "repository": 8,
                "modipsl_dir": "config",
            },
            {
                "name": "ORCHIDEE_OL_2_2",
                "variant": "branches/ORCHIDEE_2_2/ORCHIDEE_OL",
                "revision": "8572",
                "repository": 14,
                "modipsl_dir": "config",
            },
            {
                "name": "ORCHIDEE_OL_4",
                "variant": "trunk/ORCHIDEE_OL",
                "revision": "8571",
                "repository": 14,
                "modipsl_dir": "config",
            },
            {
                "name": "libIGCM",
                "variant": "trunk/libIGCM",
                "revision": "1659",
                "repository": 10,
                "modipsl_dir": ".",
            },
            {
                "name": "NEMO",
                "variant": "4.2.2",
                "revision": "7f5d8137",
                "repository": 22,
                "modipsl_dir": "modeles",
            },
            {
                "name": "INCA",
                "variant": "INCA",
                "revision": "INCA6@1151",
                "repository": 9,
                "modipsl_dir": "modeles",
            },
            {
                "name": "XIOS",
                "variant": "XIOS2",
                "revision": "07f8fdd9",
                "repository": 12,
                "modipsl_dir": "modeles",
            },
        ],
    }
test_nemo_v40_confguration 
test_nemo_v40_confguration(nemo_v40)
Source code in tests/test_mod_file.py 
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
def test_nemo_v40_confguration(nemo_v40):
    # NEMO_v4.0 is interesting to test, because it doesn't contain
    # the last optional column which usually contains duplicated
    # names of components (we don't parse it anyway).
    assert nemo_v40 == {
        "description": [
            "NEMOGCM v4.0.7, first version of NEMOv4 ( Initially NEMO_v6.5 )",
            "libIGCM trunk rev 1534",
            "XIOS branches/XIOS2 4b547204 (SVN : XIOS/trunk revision 1866)",
        ],
        "components": [
            {
                "name": "libIGCM",
                "variant": "trunk/libIGCM",
                "revision": "1581",
                "repository": 10,
                "modipsl_dir": ".",
            },
            {
                "name": "NEMO",
                "variant": "r4.0.7",
                "revision": "baad91e5",
                "repository": 7,
                "modipsl_dir": "modeles",
            },
            {
                "name": "NEMO_v6",
                "variant": "CONFIG/UNIFORM/v6/NEMO_v6.5",
                "revision": "6400",
                "repository": 8,
                "modipsl_dir": "config",
            },
            {
                "name": "XIOS",
                "variant": "XIOS2",
                "revision": "4b547204",
                "repository": 12,
                "modipsl_dir": "modeles",
            },
        ],
    }
test_repository 
test_repository(repos)
Source code in tests/test_mod_file.py 
45
46
def test_repository(repos):
    assert len(repos) == 19
test_svn_repository 
test_svn_repository(repos)
Source code in tests/test_mod_file.py 
61
62
63
64
65
66
def test_svn_repository(repos):
    # Test classic svn repo with --username flag
    assert repos[10] == {
        "type": "svn",
        "clone_url": "--username icmc_users https://forge.ipsl.fr/libigcm/svn",
    }
test_svn_ssh_repository 
test_svn_ssh_repository(repos)
Source code in tests/test_mod_file.py 
77
78
79
80
81
82
def test_svn_ssh_repository(repos):
    # Test repo over svn+ssh protocol
    assert repos[26] == {
        "type": "svn",
        "clone_url": "svn+ssh://<login>@forge.ipsl.fr/ipsl/forge/projets/grisli/svn/",
    }

test_slurm_labelled_logs

Functions:

empty_log 
empty_log()
Source code in tests/test_slurm_labelled_logs.py 
 8
 9
10
@pytest.fixture
def empty_log():
    return StringIO("")
mixed_log 
mixed_log()
Source code in tests/test_slurm_labelled_logs.py 
25
26
27
28
29
30
31
@pytest.fixture
def mixed_log():
    return StringIO("""16: libc.so.6          000014E08CBB15D0  Unknown               Unknown  Unknown
srun: Force Terminated StepId=1513744.0
Command exited with non-zero status 137
0.14user 0.40system 1:34.04elapsed 0%CPU (0avgtext+0avgdata 8320maxresident)k
""")
process_log 
process_log()
Source code in tests/test_slurm_labelled_logs.py 
13
14
15
16
17
18
19
20
21
22
@pytest.fixture
def process_log():
    return StringIO("""22:  USING DEFAULTS : area_radius1 =   3360.00000000000
26:  USING DEFAULTS : area_radius1 =   3360.00000000000   
26:            
 0:  USING DEFAULTS : area_radius1 =   3360.00000000000
 0:  GETIN area_radius1 =    3360.00000000000
12:  USING DEFAULTS : area_rotation_pre =  0.000000000000000E+000
12:  USING DEFAULTS : area_rotation =  0.000000000000000E+000
""")
test_empty_log 
test_empty_log(empty_log)
Source code in tests/test_slurm_labelled_logs.py 
34
35
def test_empty_log(empty_log):
    assert separate_labelled_log(empty_log) == {}
test_mixed_log 
test_mixed_log(mixed_log)
Source code in tests/test_slurm_labelled_logs.py 
106
107
108
109
110
111
112
113
114
115
116
def test_mixed_log(mixed_log):
    assert separate_labelled_log(mixed_log) == {
        16: [
            " libc.so.6          000014E08CBB15D0  Unknown               Unknown  Unknown"
        ],
        "slurm": [
            "srun: Force Terminated StepId=1513744.0",
            "Command exited with non-zero status 137",
            "0.14user 0.40system 1:34.04elapsed 0%CPU (0avgtext+0avgdata 8320maxresident)k",
        ],
    }
test_mixed_log_to_files 
test_mixed_log_to_files(mixed_log, tmp_path)
Source code in tests/test_slurm_labelled_logs.py 
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
def test_mixed_log_to_files(mixed_log, tmp_path):
    separate_labelled_log_to_files(mixed_log, tmp_path, "mixed_{process_id}")

    output_16 = tmp_path / "mixed_16"
    output_slurm = tmp_path / "mixed_slurm"

    assert (
        output_16.read_text()
        == """ libc.so.6          000014E08CBB15D0  Unknown               Unknown  Unknown
"""
    )
    assert (
        output_slurm.read_text()
        == """srun: Force Terminated StepId=1513744.0
Command exited with non-zero status 137
0.14user 0.40system 1:34.04elapsed 0%CPU (0avgtext+0avgdata 8320maxresident)k
"""
    )
test_only_process_log 
test_only_process_log(process_log)
Source code in tests/test_slurm_labelled_logs.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
def test_only_process_log(process_log):
    assert separate_labelled_log(process_log) == {
        0: [
            "  USING DEFAULTS : area_radius1 =   3360.00000000000",
            "  GETIN area_radius1 =    3360.00000000000",
        ],
        12: [
            "  USING DEFAULTS : area_rotation_pre =  0.000000000000000E+000",
            "  USING DEFAULTS : area_rotation =  0.000000000000000E+000",
        ],
        22: ["  USING DEFAULTS : area_radius1 =   3360.00000000000"],
        26: ["  USING DEFAULTS : area_radius1 =   3360.00000000000   ", "            "],
    }
test_only_process_log_to_files 
test_only_process_log_to_files(process_log, tmp_path)
Source code in tests/test_slurm_labelled_logs.py 
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
def test_only_process_log_to_files(process_log, tmp_path):
    separate_labelled_log_to_files(process_log, tmp_path, "output_{process_id}.log")
    output_0 = tmp_path / "output_0.log"
    output_12 = tmp_path / "output_12.log"
    output_22 = tmp_path / "output_22.log"
    output_26 = tmp_path / "output_26.log"
    assert output_0.exists()
    assert output_12.exists()
    assert output_22.exists()
    assert output_26.exists()

    assert (
        output_0.read_text()
        == """  USING DEFAULTS : area_radius1 =   3360.00000000000
  GETIN area_radius1 =    3360.00000000000
"""
    )
    assert (
        output_12.read_text()
        == """  USING DEFAULTS : area_rotation_pre =  0.000000000000000E+000
  USING DEFAULTS : area_rotation =  0.000000000000000E+000
"""
    )
    assert (
        output_22.read_text()
        == """  USING DEFAULTS : area_radius1 =   3360.00000000000
"""
    )
    assert (
        output_26.read_text()
        == """  USING DEFAULTS : area_radius1 =   3360.00000000000   

"""
    )
test_only_process_log_to_files_remove_ws 
test_only_process_log_to_files_remove_ws(
    process_log, tmp_path
)
Source code in tests/test_slurm_labelled_logs.py 
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
def test_only_process_log_to_files_remove_ws(process_log, tmp_path):
    separate_labelled_log_to_files(
        process_log,
        tmp_path,
        "output_{process_id}.log",
        remove_trailing_whitespaces=True,
    )
    output_26 = tmp_path / "output_26.log"
    assert output_26.exists()

    assert (
        output_26.read_text()
        == """  USING DEFAULTS : area_radius1 =   3360.00000000000
"""
    )

test_str

Functions:

long_hello_world 
long_hello_world()
Source code in tests/test_str.py 
6
7
8
@pytest.fixture
def long_hello_world():
    return "hello world\nanother hello world\nyet again hello world"
test_replace_text_inject 
test_replace_text_inject(long_hello_world)
Source code in tests/test_str.py 
11
12
13
14
15
16
17
18
19
20
def test_replace_text_inject(long_hello_world):
    assert replace_text("", [(0, 0, "test")]) == "test"
    assert replace_text("hello world", [(11, 11, "!")]) == "hello world!"
    assert (
        replace_text(
            long_hello_world,
            [(0, 0, "!"), (12, 12, "oops! ")],
        )
        == "!hello world\noops! another hello world\nyet again hello world"
    )
test_replace_text_modify 
test_replace_text_modify(long_hello_world)
Source code in tests/test_str.py 
29
30
31
32
33
34
35
36
37
def test_replace_text_modify(long_hello_world):
    assert replace_text("hello world", [(6, 11, "everybody")]) == "hello everybody"
    assert (
        replace_text(
            long_hello_world,
            [(0, 11, "simple"), (12, 31, "very simple"), (32, 53, "very very simple")],
        )
        == "simple\nvery simple\nvery very simple"
    )
test_replace_text_remove 
test_replace_text_remove()
Source code in tests/test_str.py 
23
24
25
26
def test_replace_text_remove():
    assert replace_text("", [(0, 0, "")]) == ""
    assert replace_text("hello world", [(5, 11, "")]) == "hello"
    assert replace_text("hello world", [(0, 11, "")]) == ""
test_replace_text_replacements_sort 
test_replace_text_replacements_sort(long_hello_world)
Source code in tests/test_str.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
def test_replace_text_replacements_sort(long_hello_world):
    assert (
        replace_text(
            long_hello_world,
            [(12, 12, "oops! "), (0, 0, "!")],
            sort_replacements=True,
        )
        == "!hello world\noops! another hello world\nyet again hello world"
    )
    with pytest.raises(ValueError):
        replace_text(
            long_hello_world,
            [(12, 12, "oops! "), (0, 0, "!")],
            sort_replacements=False,
        )