File: test_atts.py

package info (click to toggle)
netcdf4-python 1.7.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,604 kB
  • sloc: python: 6,057; ansic: 854; makefile: 15; sh: 2
file content (227 lines) | stat: -rw-r--r-- 9,882 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
import math
import subprocess
import sys
import unittest
import os
import tempfile
import warnings
import pathlib

import numpy as np
from collections import OrderedDict
from numpy.random.mtrand import uniform

import netCDF4

# test attribute creation.
#FILE_NAME = tempfile.NamedTemporaryFile(suffix='.nc', delete=False).name
FILE_NAME = 'tst_atts.nc'
VAR_NAME="dummy_var"
GROUP_NAME = "dummy_group"
DIM1_NAME="x"
DIM1_LEN=2
DIM2_NAME="y"
DIM2_LEN=3
DIM3_NAME="z"
DIM3_LEN=25
STRATT = 'string attribute'
EMPTYSTRATT = ''
INTATT = 1
FLOATATT = math.pi
SEQATT = np.arange(10)
STRINGSEQATT = ['mary ','','had ','a ','little ','lamb',]
#ATTDICT = {'stratt':STRATT,'floatatt':FLOATATT,'seqatt':SEQATT,
#           'stringseqatt':''.join(STRINGSEQATT), # changed in issue #770
#           'emptystratt':EMPTYSTRATT,'intatt':INTATT}
ATTDICT = {'stratt':STRATT,'floatatt':FLOATATT,'seqatt':SEQATT,
           'stringseqatt':STRINGSEQATT,
           'emptystratt':EMPTYSTRATT,'intatt':INTATT}

class VariablesTestCase(unittest.TestCase):

    def setUp(self):
        self.file = FILE_NAME
        with netCDF4.Dataset(self.file,'w') as f:
            # try to set a dataset attribute with one of the reserved names.
            f.setncattr('file_format','netcdf4_format')
            # test attribute renaming
            f.stratt_tmp = STRATT
            f.renameAttribute('stratt_tmp','stratt')
            f.emptystratt = EMPTYSTRATT
            f.intatt = INTATT
            f.floatatt = FLOATATT
            f.seqatt = SEQATT
            # sequences of strings converted to a single string.
            f.stringseqatt = STRINGSEQATT
            f.setncattr_string('stringseqatt_array',STRINGSEQATT) # array of NC_STRING
            g = f.createGroup(GROUP_NAME)
            f.createDimension(DIM1_NAME, DIM1_LEN)
            f.createDimension(DIM2_NAME, DIM2_LEN)
            f.createDimension(DIM3_NAME, DIM3_LEN)
            g.createDimension(DIM1_NAME, DIM1_LEN)
            g.createDimension(DIM2_NAME, DIM2_LEN)
            g.createDimension(DIM3_NAME, DIM3_LEN)
            g.stratt_tmp = STRATT
            g.renameAttribute('stratt_tmp','stratt')
            g.emptystratt = EMPTYSTRATT
            g.intatt = INTATT
            g.floatatt = FLOATATT
            g.seqatt = SEQATT
            g.stringseqatt = STRINGSEQATT
            if netCDF4.__version__ > "1.4.2":
                with self.assertRaises(ValueError):
                    g.arrayatt = [[1, 2], [3, 4]] # issue #841
            g.setncattr_string('stringseqatt_array',STRINGSEQATT) # array of NC_STRING
            v = f.createVariable(VAR_NAME, 'f8',(DIM1_NAME,DIM2_NAME,DIM3_NAME))
            # try to set a variable attribute with one of the reserved names.
            v.setncattr('ndim','three')
            v.setncatts({'foo': 1})
            v.setncatts(OrderedDict(bar=2))
            v.stratt_tmp = STRATT
            v.renameAttribute('stratt_tmp','stratt')
            v.emptystratt = EMPTYSTRATT
            v.intatt = INTATT
            v.floatatt = FLOATATT
            v.seqatt = SEQATT
            v.stringseqatt = STRINGSEQATT
            v.setncattr_string('stringseqatt_array',STRINGSEQATT) # array of NC_STRING
            v1 = g.createVariable(VAR_NAME, 'f8',(DIM1_NAME,DIM2_NAME,DIM3_NAME))
            v1.stratt = STRATT
            v1.emptystratt = EMPTYSTRATT
            v1.intatt = INTATT
            v1.floatatt = FLOATATT
            v1.seqatt = SEQATT
            v1.stringseqatt = STRINGSEQATT
            v1.setncattr_string('stringseqatt_array',STRINGSEQATT) # array of NC_STRING
            # issue #959: should not be able to set _FillValue after var creation
            try:
                v1._FillValue(-999.)
            except AttributeError:
                pass
            else:
                raise ValueError('This test should have failed.')
            try:
                v1.setncattr('_FillValue',-999.)
            except AttributeError:
                pass
            else:
                raise ValueError('This test should have failed.')
            # issue #485 (triggers segfault in C lib
            # with version 1.2.1 without pull request #486)
            f.foo = np.array('bar','S')
            f.foo = np.array('bar','U')
            # issue #529 write string attribute as NC_CHAR unless
            # it can't be decoded to ascii.  Add setncattr_string
            # method to force NC_STRING.
            f.charatt = 'foo' # will be written as NC_CHAR
            f.setncattr_string('stringatt','bar') # NC_STRING
            f.cafe = 'caf\xe9' # NC_STRING
            f.batt = 'caf\xe9'.encode() #NC_CHAR
            v.setncattr_string('stringatt','bar') # NC_STRING
            # issue #882 - provide an option to always string attribute
            # as NC_STRINGs. Testing various approaches to setting text attributes...
            f.set_ncstring_attrs(True)
            f.stringatt_ncstr = 'foo' # will now be written as NC_STRING
            f.setncattr_string('stringatt_ncstr','bar') # NC_STRING anyway
            f.caf_ncstr = 'caf\xe9' # NC_STRING anyway
            f.bat_ncstr = 'caf\xe9'.encode() # now NC_STRING
            g.stratt_ncstr = STRATT # now NC_STRING
            #g.renameAttribute('stratt_tmp','stratt_ncstr')
            v.setncattr_string('stringatt_ncstr','bar') # NC_STRING anyway
            v.stratt_ncstr = STRATT
            v1.emptystratt_ncstr = EMPTYSTRATT

    def tearDown(self):
        # Remove the temporary files
        #pass
        os.remove(self.file)

    def runTest(self):
        """testing attributes"""
        with netCDF4.Dataset(self.file, 'r') as f:
            v = f.variables[VAR_NAME]
            g = f.groups[GROUP_NAME]
            v1 = g.variables[VAR_NAME]
            # check attributes in root group.
            # global attributes.
            # check __dict__ method for accessing all netCDF attributes.
            for key,val in ATTDICT.items():
                if type(val) == np.ndarray:
                    assert f.__dict__[key].tolist() == val.tolist()
                else:
                    assert f.__dict__[key] == val
            # check accessing individual attributes.
            assert f.intatt == INTATT
            assert f.floatatt == FLOATATT
            assert f.stratt == STRATT
            assert f.emptystratt == EMPTYSTRATT
            assert f.seqatt.tolist() == SEQATT.tolist()
            #assert f.stringseqatt == ''.join(STRINGSEQATT) # issue 770
            assert f.stringseqatt == STRINGSEQATT
            assert f.stringseqatt_array == STRINGSEQATT
            assert f.getncattr('file_format') == 'netcdf4_format'
            # variable attributes.
            # check __dict__ method for accessing all netCDF attributes.
            for key,val in ATTDICT.items():
                if type(val) == np.ndarray:
                    assert v.__dict__[key].tolist() == val.tolist()
                else:
                    assert v.__dict__[key] == val
            # check accessing individual attributes.
            assert v.intatt == INTATT
            assert v.floatatt == FLOATATT
            assert v.stratt == STRATT
            assert v.seqatt.tolist() == SEQATT.tolist()
            #assert v.stringseqatt == ''.join(STRINGSEQATT) # issue 770
            assert v.stringseqatt == STRINGSEQATT
            assert v.stringseqatt_array == STRINGSEQATT
            assert v.getncattr('ndim') == 'three'
            assert v.getncattr('foo') == 1
            assert v.getncattr('bar') == 2
            # check type of attributes using ncdump (issue #529)
            if not os.getenv('NO_CDL'):
                ncdump_output = f.tocdl()
                for line in ncdump_output:
                    line = line.strip('\t\n\r')
                    line = line.strip()# Must be done another time for group variables
                    if "stringatt" in line: assert line.startswith('string')
                    if "charatt" in line: assert line.startswith(':')
                    if "cafe" in line: assert line.startswith('string')
                    if "batt" in line: assert line.startswith(':')
                    if "_ncstr" in line: assert line.startswith('string')
            # check attributes in subgroup.
            # global attributes.
            for key,val in ATTDICT.items():
                if type(val) == np.ndarray:
                    assert g.__dict__[key].tolist() == val.tolist()
                else:
                    assert g.__dict__[key] == val
            assert g.intatt == INTATT
            assert g.floatatt == FLOATATT
            assert g.stratt == STRATT
            assert g.emptystratt == EMPTYSTRATT
            assert g.seqatt.tolist() == SEQATT.tolist()
            #assert g.stringseqatt == ''.join(STRINGSEQATT) # issue 770
            assert g.stringseqatt == STRINGSEQATT
            assert g.stringseqatt_array == STRINGSEQATT
            for key,val in ATTDICT.items():
                if type(val) == np.ndarray:
                    assert v1.__dict__[key].tolist() == val.tolist()
                else:
                    assert v1.__dict__[key] == val
            assert v1.intatt == INTATT
            assert v1.floatatt == FLOATATT
            assert v1.stratt == STRATT
            assert v1.emptystratt == EMPTYSTRATT
            assert v1.seqatt.tolist() == SEQATT.tolist()
            #assert v1.stringseqatt == ''.join(STRINGSEQATT) # issue 770
            assert v1.stringseqatt == STRINGSEQATT
            assert v1.stringseqatt_array == STRINGSEQATT
            assert getattr(v1,'nonexistantatt',None) == None

        # issue 915 empty string attribute (ncdump reports 'NIL')
        with netCDF4.Dataset(pathlib.Path(__file__).parent / "test_gold.nc") as f:
            assert f['RADIANCE'].VAR_NOTES == ""

if __name__ == '__main__':
    unittest.main()