/
properties.py
414 lines (301 loc) · 10.4 KB
/
properties.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
from ..functions import deepcopy
from .container import Container
class Properties(Container):
"""Mixin class for an object with descriptive properties.
.. versionadded:: (cfdm) 1.7.0
"""
def __init__(self, properties=None, source=None, copy=True):
"""**Initialisation**
:Parameters:
{{init properties: `dict`, optional}}
*Parameter example:*
``properties={'standard_name': 'altitude'}``
source: optional
Initialise the properties from those of *source*.
{{init source}}
{{init copy: `bool`, optional}}
"""
super().__init__(source=source, copy=copy)
if source is not None:
try:
properties = source.properties()
except AttributeError:
properties = None
self._set_component("properties", {}, copy=False)
if properties is not None:
self.set_properties(properties, copy=copy)
# ----------------------------------------------------------------
# Methods
# ----------------------------------------------------------------
def clear_properties(self):
"""Remove all properties.
.. versionadded:: (cfdm) 1.7.0
.. seealso:: `del_property` `properties`, `set_properties`
:Returns:
`dict`
The properties that have been removed.
**Examples:**
>>> f = {{package}}.{{class}}()
>>> f.properties()
{}
>>> f.set_properties({'standard_name': 'air_pressure',
... 'long_name': 'Air Pressure'})
>>> f.properties()
{'standard_name': 'air_pressure',
'long_name': 'Air Pressure'}
>>> f.set_properties({'standard_name': 'air_pressure', 'foo': 'bar'})
>>> f.properties()
{'standard_name': 'air_pressure',
'long_name': 'Air Pressure',
'foo': 'bar'}
>>> f.clear_properties()
{'standard_name': 'air_pressure',
'long_name': 'Air Pressure',
'foo': 'bar'}
>>> f.properties()
{}
"""
out = self._get_component("properties")
self._set_component("properties", {}, copy=False)
return out
def del_property(self, prop, default=ValueError()):
"""Remove a property.
.. versionadded:: (cfdm) 1.7.0
.. seealso:: `clear_properties`, `get_property`, `has_property`,
`properties`, `set_property`
:Parameters:
prop: `str`
The name of the property to be removed.
*Parameter example:*
``prop='long_name'``
default: optional
Return the value of the *default* parameter if the
property has not been set.
{{default Exception}}
:Returns:
The removed property value.
**Examples:**
>>> f = {{package}}.{{class}}()
>>> f.set_property('project', 'CMIP7')
>>> f.has_property('project')
True
>>> f.get_property('project')
'CMIP7'
>>> f.del_property('project')
'CMIP7'
>>> f.has_property('project')
False
>>> print(f.del_property('project', None))
None
>>> print(f.get_property('project', None))
None
"""
try:
return self._get_component("properties").pop(prop)
except KeyError:
if default is None:
return
return self._default(
default,
f"{self.__class__.__name__!r} has no {prop!r} property",
)
def get_property(self, prop, default=ValueError()):
"""Return a property.
.. versionadded:: (cfdm) 1.7.0
.. seealso:: `del_property`, `has_property`, `properties`,
`set_property`
:Parameters:
prop: `str`
The name of the property to be returned.
*Parameter example:*
``prop='standard_name'``
default: optional
Return the value of the *default* parameter if the
property has not been set.
{{default Exception}}
:Returns:
The value of the property.
**Examples:**
>>> f = {{package}}.{{class}}()
>>> f.set_property('project', 'CMIP7')
>>> f.has_property('project')
True
>>> f.get_property('project')
'CMIP7'
>>> f.del_property('project')
'CMIP7'
>>> f.has_property('project')
False
>>> print(f.del_property('project', None))
None
>>> print(f.get_property('project', None))
None
"""
try:
return self._get_component("properties")[prop]
except KeyError:
if default is None:
return
return self._default(
default,
f"{self.__class__.__name__!r} has no {prop!r} property",
)
def has_bounds(self):
"""Whether or not there are cell bounds.
This is always False.
.. versionadded:: (cfdm) 1.9.0.0
.. seealso:: `has_data`
:Returns:
`False`
**Examples:**
>>> f = {{package}}.{{class}}()
>>> f.has_bounds()
False
"""
return False
def has_data(self):
"""Whether or not the construct has data.
`{{class}}` instances never have data.
.. versionadded:: (cfdm) 1.9.0.0
:Returns:
`False`
**Examples:**
>>> f = {{package}}.{{class}}()
>>> f.has_data()
False
"""
return False
def has_property(self, prop):
"""Whether a property has been set.
.. versionadded:: (cfdm) 1.7.0
.. seealso:: `del_property`, `get_property`, `properties`,
`set_property`
:Parameters:
prop: `str`
The name of the property.
*Parameter example:*
``prop='long_name'``
:Returns:
`bool`
True if the property has been set, otherwise False.
**Examples:**
>>> f = {{package}}.{{class}}()
>>> f.set_property('project', 'CMIP7')
>>> f.has_property('project')
True
>>> f.get_property('project')
'CMIP7'
>>> f.del_property('project')
'CMIP7'
>>> f.has_property('project')
False
>>> print(f.del_property('project', None))
None
>>> print(f.get_property('project', None))
None
"""
return prop in self._get_component("properties")
def properties(self):
"""Return all properties.
.. versionadded:: (cfdm) 1.7.0
.. seealso:: `clear_properties`, `get_property`, `has_property`
`set_properties`
:Returns:
`dict`
The properties.
**Examples:**
>>> f = {{package}}.{{class}}()
>>> f.properties()
{}
>>> f.set_properties({'standard_name': 'air_pressure',
... 'long_name': 'Air Pressure'})
>>> f.properties()
{'standard_name': 'air_pressure',
'long_name': 'Air Pressure'}
>>> f.set_properties({'standard_name': 'air_pressure', 'foo': 'bar'})
>>> f.properties()
{'standard_name': 'air_pressure',
'long_name': 'Air Pressure',
'foo': 'bar'}
>>> f.clear_properties()
{'standard_name': 'air_pressure',
'long_name': 'Air Pressure',
'foo': 'bar'}
>>> f.properties()
{}
"""
return self._get_component("properties").copy()
def set_properties(self, properties, copy=True):
"""Set properties.
.. versionadded:: (cfdm) 1.7.0
.. seealso:: `clear_properties`, `properties`, `set_property`
:Parameters:
properties: `dict`
Store the properties from the dictionary supplied.
*Parameter example:*
``properties={'standard_name': 'altitude', 'foo': 'bar'}``
copy: `bool`, optional
If False then any property values provided by the
*properties* parameter are not copied before insertion. By
default they are deep copied.
:Returns:
`None`
**Examples:**
>>> f = {{package}}.{{class}}()
>>> f.properties()
{}
>>> f.set_properties({'standard_name': 'air_pressure',
... 'long_name': 'Air Pressure'})
>>> f.properties()
{'standard_name': 'air_pressure',
'long_name': 'Air Pressure'}
>>> f.set_properties({'standard_name': 'air_pressure', 'foo': 'bar'})
>>> f.properties()
{'standard_name': 'air_pressure',
'long_name': 'Air Pressure',
'foo': 'bar'}
>>> f.clear_properties()
{'standard_name': 'air_pressure',
'long_name': 'Air Pressure',
'foo': 'bar'}
>>> f.properties()
{}
"""
if copy:
properties = deepcopy(properties)
# else:
# properties = properties.copy()
self._get_component("properties").update(properties)
def set_property(self, prop, value, copy=True):
"""Set a property.
.. versionadded:: (cfdm) 1.7.0
.. seealso:: `del_property`, `get_property`, `has_property`,
`properties`, `set_properties`
:Parameters:
prop: `str`
The name of the property to be set.
value:
The value for the property.
copy: `bool`, optional
If True then set a deep copy of *value*.
:Returns:
`None`
**Examples:**
>>> f = {{package}}.{{class}}()
>>> f.set_property('project', 'CMIP7')
>>> f.has_property('project')
True
>>> f.get_property('project')
'CMIP7'
>>> f.del_property('project')
'CMIP7'
>>> f.has_property('project')
False
>>> print(f.del_property('project', None))
None
>>> print(f.get_property('project', None))
None
"""
if copy:
value = deepcopy(value)
self._get_component("properties")[prop] = value