-
Notifications
You must be signed in to change notification settings - Fork 3.5k
/
definition.py
491 lines (386 loc) · 14.6 KB
/
definition.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#
import copy
from abc import abstractmethod
from collections import OrderedDict
from enum import Enum, EnumMeta
from six import with_metaclass
def _check_record_or_field(x):
if (type(x) is type and not issubclass(x, Record)) \
and not isinstance(x, Field):
raise Exception('Argument ' + x + ' is not a Record or a Field')
class RecordMeta(type):
def __new__(metacls, name, parents, dct):
if name != 'Record':
# Do not apply this logic to the base class itself
dct['_fields'] = RecordMeta._get_fields(dct)
dct['_required'] = False
return type.__new__(metacls, name, parents, dct)
@classmethod
def _get_fields(cls, dct):
# Build a set of valid fields for this record
fields = OrderedDict()
for name, value in dct.items():
if issubclass(type(value), EnumMeta):
# Wrap Python enums
value = _Enum(value)
elif type(value) == RecordMeta:
# We expect an instance of a record rather than the class itself
value = value()
if isinstance(value, Record) or isinstance(value, Field):
fields[name] = value
return fields
class Record(with_metaclass(RecordMeta, object)):
def __init__(self, default=None, required_default=False, required=False, *args, **kwargs):
self._required_default = required_default
self._default = default
self._required = required
for k, value in self._fields.items():
if k in kwargs:
if isinstance(value, Record) and isinstance(kwargs[k], dict):
# Use dict init Record object
copied = copy.copy(value)
copied.__init__(**kwargs[k])
self.__setattr__(k, copied)
elif isinstance(value, Array) and isinstance(kwargs[k], list) and len(kwargs[k]) > 0 \
and isinstance(value.array_type, Record) and isinstance(kwargs[k][0], dict):
arr = []
for item in kwargs[k]:
copied = copy.copy(value.array_type)
copied.__init__(**item)
arr.append(copied)
self.__setattr__(k, arr)
elif isinstance(value, Map) and isinstance(kwargs[k], dict) and len(kwargs[k]) > 0 \
and isinstance(value.value_type, Record) and isinstance(list(kwargs[k].values())[0], dict):
dic = {}
for mapKey, mapValue in kwargs[k].items():
copied = copy.copy(value.value_type)
copied.__init__(**mapValue)
dic[mapKey] = copied
self.__setattr__(k, dic)
else:
# Value was overridden at constructor
self.__setattr__(k, kwargs[k])
elif isinstance(value, Record):
# Value is a subrecord
self.__setattr__(k, value)
else:
# Set field to default value, without revalidating the default value type
super(Record, self).__setattr__(k, value.default())
@classmethod
def schema(cls):
return cls.schema_info(set())
@classmethod
def schema_info(cls, defined_names):
if cls.__name__ in defined_names:
return cls.__name__
defined_names.add(cls.__name__)
schema = {
'name': str(cls.__name__),
'type': 'record',
'fields': []
}
for name in sorted(cls._fields.keys()):
field = cls._fields[name]
field_type = field.schema_info(defined_names) \
if field._required else ['null', field.schema_info(defined_names)]
schema['fields'].append({
'name': name,
'type': field_type,
'default': field.default()
}) if field.required_default() else schema['fields'].append({
'name': name,
'type': field_type,
})
return schema
def __setattr__(self, key, value):
if key == '_default':
super(Record, self).__setattr__(key, value)
elif key == '_required_default':
super(Record, self).__setattr__(key, value)
elif key == '_required':
super(Record, self).__setattr__(key, value)
else:
if key not in self._fields:
raise AttributeError('Cannot set undeclared field ' + key + ' on record')
# Check that type of value matches the field type
field = self._fields[key]
value = field.validate_type(key, value)
super(Record, self).__setattr__(key, value)
def __eq__(self, other):
for field in self._fields:
if self.__getattribute__(field) != other.__getattribute__(field):
return False
return True
def __ne__(self, other):
return not self.__eq__(other)
def __str__(self):
return str(self.__dict__)
def type(self):
return str(self.__class__.__name__)
def python_type(self):
return self.__class__
def validate_type(self, name, val):
if not val and not self._required:
return self.default()
if not isinstance(val, self.__class__):
raise TypeError("Invalid type '%s' for sub-record field '%s'. Expected: %s" % (
type(val), name, self.__class__))
return val
def default(self):
if self._default is not None:
return self._default
else:
return None
def required_default(self):
return self._required_default
class Field(object):
def __init__(self, default=None, required=False, required_default=False):
if default is not None:
default = self.validate_type('default', default)
self._default = default
self._required_default = required_default
self._required = required
@abstractmethod
def type(self):
pass
@abstractmethod
def python_type(self):
pass
def validate_type(self, name, val):
if not val and not self._required:
return self.default()
if type(val) != self.python_type():
raise TypeError("Invalid type '%s' for field '%s'. Expected: %s" % (type(val), name, self.python_type()))
return val
def schema(self):
# For primitive types, the schema would just be the type itself
return self.type()
def schema_info(self, defined_names):
return self.type()
def default(self):
return self._default
def required_default(self):
return self._required_default
# All types
class Null(Field):
def type(self):
return 'null'
def python_type(self):
return type(None)
def validate_type(self, name, val):
if val is not None:
raise TypeError('Field ' + name + ' is set to be None')
return val
class Boolean(Field):
def type(self):
return 'boolean'
def python_type(self):
return bool
def default(self):
if self._default is not None:
return self._default
else:
return False
class Integer(Field):
def type(self):
return 'int'
def python_type(self):
return int
def default(self):
if self._default is not None:
return self._default
else:
return None
class Long(Field):
def type(self):
return 'long'
def python_type(self):
return int
def default(self):
if self._default is not None:
return self._default
else:
return None
class Float(Field):
def type(self):
return 'float'
def python_type(self):
return float
def default(self):
if self._default is not None:
return self._default
else:
return None
class Double(Field):
def type(self):
return 'double'
def python_type(self):
return float
def default(self):
if self._default is not None:
return self._default
else:
return None
class Bytes(Field):
def type(self):
return 'bytes'
def python_type(self):
return bytes
def default(self):
if self._default is not None:
return self._default
else:
return None
class String(Field):
def type(self):
return 'string'
def python_type(self):
return str
def validate_type(self, name, val):
t = type(val)
if not val and not self._required:
return self.default()
if not (t is str or t.__name__ == 'unicode'):
raise TypeError("Invalid type '%s' for field '%s'. Expected a string" % (t, name))
return val
def default(self):
if self._default is not None:
return self._default
else:
return None
# Complex types
class _Enum(Field):
def __init__(self, enum_type):
if not issubclass(enum_type, Enum):
raise Exception(enum_type + " is not a valid Enum type")
self.enum_type = enum_type
self.values = {}
for x in enum_type.__members__.values():
self.values[x.value] = x
super(_Enum, self).__init__()
def type(self):
return 'enum'
def python_type(self):
return self.enum_type
def validate_type(self, name, val):
if val is None:
return None
if type(val) is str:
# The enum was passed as a string, we need to check it against the possible values
if val in self.enum_type.__members__:
return self.enum_type.__members__[val]
else:
raise TypeError(
"Invalid enum value '%s' for field '%s'. Expected: %s" % (val, name, self.enum_type.__members__.keys()))
elif type(val) is int:
# The enum was passed as an int, we need to check it against the possible values
if val in self.values:
return self.values[val]
else:
raise TypeError(
"Invalid enum value '%s' for field '%s'. Expected: %s" % (val, name, self.values.keys()))
elif type(val) != self.python_type():
raise TypeError("Invalid type '%s' for field '%s'. Expected: %s" % (type(val), name, self.python_type()))
else:
return val
def schema(self):
return self.schema_info(set())
def schema_info(self, defined_names):
if self.enum_type.__name__ in defined_names:
return self.enum_type.__name__
defined_names.add(self.enum_type.__name__)
return {
'type': self.type(),
'name': self.enum_type.__name__,
'symbols': [x.name for x in self.enum_type]
}
def default(self):
if self._default is not None:
return self._default
else:
return None
class Array(Field):
def __init__(self, array_type, default=None, required=False, required_default=False):
_check_record_or_field(array_type)
self.array_type = array_type
super(Array, self).__init__(default=default, required=required, required_default=required_default)
def type(self):
return 'array'
def python_type(self):
return list
def validate_type(self, name, val):
if val is None:
return None
super(Array, self).validate_type(name, val)
for x in val:
if type(x) != self.array_type.python_type():
raise TypeError('Array field ' + name + ' items should all be of type '
+ self.array_type.python_type())
return val
def schema(self):
return self.schema_info(set())
def schema_info(self, defined_names):
return {
'type': self.type(),
'items': self.array_type.schema_info(defined_names) if isinstance(self.array_type, (Array, Map, Record))
else self.array_type.type()
}
def default(self):
if self._default is not None:
return self._default
else:
return None
class Map(Field):
def __init__(self, value_type, default=None, required=False, required_default=False):
_check_record_or_field(value_type)
self.value_type = value_type
super(Map, self).__init__(default=default, required=required, required_default=required_default)
def type(self):
return 'map'
def python_type(self):
return dict
def validate_type(self, name, val):
if val is None:
return None
super(Map, self).validate_type(name, val)
for k, v in val.items():
if type(k) != str and not is_unicode(k):
raise TypeError('Map keys for field ' + name + ' should all be strings')
if type(v) != self.value_type.python_type():
raise TypeError('Map values for field ' + name + ' should all be of type '
+ self.value_type.python_type())
return val
def schema(self):
return self.schema_info(set())
def schema_info(self, defined_names):
return {
'type': self.type(),
'values': self.value_type.schema_info(defined_names) if isinstance(self.value_type, (Array, Map, Record))
else self.value_type.type()
}
def default(self):
if self._default is not None:
return self._default
else:
return None
# Python3 has no `unicode` type, so here we use a tricky way to check if the type of `x` is `unicode` in Python2
# and also make it work well with Python3.
def is_unicode(x):
return 'encode' in dir(x) and type(x.encode()) == str