NTV.json_ntv.ntv_validate

  1# -*- coding: utf-8 -*-
  2"""
  3@author: Philippe@loco-labs.io
  4
  5The `ntv_validate` module is part of the `NTV.json_ntv` package ([specification document](
  6https://loco-philippe.github.io/ES/JSON%20semantic%20format%20(JSON-NTV).htm)).
  7
  8It contains the `Validator` class.
  9
 10Function in Validator class are Datatype.validate overloading for each subclass.
 11
 12For more information, see the
 13[user guide](https://loco-philippe.github.io/NTV/documentation/user_guide.html)
 14or the [github repository](https://github.com/loco-philippe/NTV).
 15"""
 16import datetime
 17import re
 18
 19_DUR_S = "([0-9]+S)"
 20_DUR_N = '(' + '([0-9]+M)' + _DUR_S + '?)'
 21_DUR_H = '(' + '([0-9]+H)' + _DUR_N + '?)'
 22_DUR_TIME = '(T(' + _DUR_H + '|' + _DUR_N + '|' + _DUR_S + '))'
 23_DUR_D = "([0-9]+D)"
 24_DUR_M = '(' + '([0-9]+M)' + _DUR_D + '?)'
 25_DUR_Y = '(' + '([0-9]+Y)' + _DUR_M + '?)'
 26_DUR_DATE = '((' + _DUR_D + '|'+_DUR_M + '|' + \
 27    _DUR_Y + ')(' + _DUR_TIME + ')?)'
 28_DUR_WEEK = '([0-9]+W)'
 29DURATION = re.compile('P('+_DUR_DATE+'|'+_DUR_TIME+'|'+_DUR_WEEK+')')
 30GEOJSON = {'Point': 'coordinates', 'LineString': 'coordinates',
 31           'Polygon': 'coordinates', 'MultiPoint': 'coordinates',
 32           'MultiLineString': 'coordinates', 'MultiPolygon': 'coordinates',
 33           'GeometryCollection': 'geometries', 'Feature': 'geometry',
 34           'FeatureCollection': 'features'}
 35OLC = re.compile(
 36    r'([2-90CFGHJMPQRVWX]{2}){4}\+([2-9CFGHJMPQRVWX]{2}[2-9CFGHJMPQRVWX]*)?')
 37URI = re.compile(r'^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?')
 38UUID = re.compile('[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}',
 39                  flags=re.IGNORECASE)
 40_DOC_ATOM = r'(\s*[a-zA-Z0-9!#\$%&\*\+-/=\^_`{}\|~.]+)'
 41_QUOTED_STRING = r'(\s*"[\s*[!#-~]*]*\s*"\s*)'
 42_DOMAIN_LITERAL = r'(\s*\[(\s*[!-Z^-~]+)*\s*\]\s*)'
 43_ADDR_SPEC = '((' + _DOC_ATOM + '|' + _QUOTED_STRING + \
 44    ')@(' + _DOC_ATOM + '|' + _DOMAIN_LITERAL + '))'
 45_MAILBOX = r'((.*\s*\<' + _ADDR_SPEC + r'\>\s*)|' + _ADDR_SPEC + ')'
 46ADDRESS = re.compile(
 47    _MAILBOX + '|(.*:(' + _MAILBOX + '(,' + _MAILBOX + r')*)?;\s*)')  # without CFWS
 48HOSTNAME = re.compile(r'[-a-zA-Z_]{1,63}(\.[-a-zA-Z_]{1,63})*')
 49IPV4 = re.compile(
 50    r'(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])')
 51_PATH_ABSOLUTE = r'(([a-zA-Z]:)?((/([-a-z0-9_~!&,;=:@\.\$\'\(\)\*\+]|(%[a-f0-9]{2}))*)*))'
 52FILE = re.compile(r'/*[-a-z0-9_~!&,;=:@\.\$\'\(\)\*\+]*' + _PATH_ABSOLUTE)
 53
 54
 55class Validator:
 56    '''Validator class contains static methods.
 57    Each method is associated to a global Datatype (name before the _) and
 58    return a boolean (type conformity).'''
 59
 60    @staticmethod
 61    def json_valid(val):
 62        '''validate method'''
 63        return isinstance(val, (float, int, str, dict, list, bool)) or val is None
 64
 65    @staticmethod
 66    def number_valid(val):
 67        '''validate method'''
 68        return isinstance(val, (float, int))
 69
 70    @staticmethod
 71    def boolean_valid(val):
 72        '''validate method'''
 73        return isinstance(val, bool)
 74
 75    @staticmethod
 76    def null_valid(val):
 77        '''validate method'''
 78        return val is None
 79
 80    @staticmethod
 81    def string_valid(val):
 82        '''validate method'''
 83        return isinstance(val, str)
 84
 85    @staticmethod
 86    def array_valid(val):
 87        '''validate method'''
 88        return isinstance(val, list)
 89
 90    @staticmethod
 91    def object_valid(val):
 92        '''validate method'''
 93        return isinstance(val, dict)
 94
 95    @staticmethod
 96    def int_valid(val):
 97        '''validate method'''
 98        return isinstance(val, int)
 99
100    @staticmethod
101    def int8_valid(val):
102        '''validate method'''
103        return isinstance(val, int) and -128 <= val <= 127
104
105    @staticmethod
106    def int16_valid(val):
107        '''validate method'''
108        return isinstance(val, int) and -32768 <= val <= 32767
109
110    @staticmethod
111    def int32_valid(val):
112        '''validate method'''
113        return isinstance(val, int) and -2147483648 <= val <= 2147483647
114
115    @staticmethod
116    def int64_valid(val):
117        '''validate method'''
118        return isinstance(val, int) and -2 ^ 63 <= val <= 2 ^ 63
119
120    @staticmethod
121    def uint8_valid(val):
122        '''validate method'''
123        return isinstance(val, int) and 0 <= val <= 255
124
125    @staticmethod
126    def uint16_valid(val):
127        '''validate method'''
128        return isinstance(val, int) and 0 <= val <= 65535
129
130    @staticmethod
131    def uint32_valid(val):
132        '''validate method'''
133        return isinstance(val, int) and 0 <= val <= 4294967295
134
135    @staticmethod
136    def uint64_valid(val):
137        '''validate method'''
138        return isinstance(val, int) and 0 <= val <= 2 ^ 64 - 1
139
140    @staticmethod
141    def float_valid(val):
142        '''validate method'''
143        return isinstance(val, float)
144
145    @staticmethod
146    def float16_valid(val):
147        '''validate method'''
148        return isinstance(val, float) and abs(val) <= 65500
149
150    @staticmethod
151    def float32_valid(val):
152        '''validate method'''
153        return isinstance(val, float) and abs(val) <= 3.4028237E38
154
155    @staticmethod
156    def float64_valid(val):
157        '''validate method'''
158        return isinstance(val, float)
159
160    @staticmethod
161    def decimal64_valid(val):
162        '''validate method'''
163        return isinstance(val, float)
164
165    @staticmethod
166    def bit_valid(val):
167        '''validate method'''
168        if not isinstance(val, str):
169            return False
170        return val in ['0', '1']
171
172    @staticmethod
173    def binary_valid(val):
174        '''validate method'''
175        if not isinstance(val, str):
176            return False
177        for char in val:
178            if char not in ['0', '1']:
179                return False
180        return True
181
182    @staticmethod
183    def base64_valid(val):
184        '''validate method'''
185        if not isinstance(val, str):
186            return False
187        for car in val:
188            if (not 'a' <= car <= 'z' and not 'A' <= car <= 'Z' and
189                    not '0' <= car <= '9' and car not in ['-', '_', '=']):
190                return False
191        return True
192
193    @staticmethod
194    def base32_valid(val):
195        '''validate method'''
196        if not isinstance(val, str):
197            return False
198        for car in val:
199            if not 'A' <= car <= 'Z' and not '1' < car < '8' and not car == '=':
200                return False
201        return True
202
203    @staticmethod
204    def base16_valid(val):
205        '''validate method'''
206        if not isinstance(val, str):
207            return False
208        for car in val:
209            if not '0' <= car <= '9' and not 'A' <= car <= 'F':
210                return False
211        return True
212
213    @staticmethod
214    def year_valid(val):
215        '''validate method'''
216        return isinstance(val, int) and 0 <= val
217
218    @staticmethod
219    def month_valid(val):
220        '''validate method'''
221        return isinstance(val, int) and 0 < val < 13
222
223    @staticmethod
224    def yearmonth_valid(val):
225        '''validate method'''
226        if not isinstance(val, str):
227            return False
228        y_m = val.split('-', maxsplit=1)
229        return Validator.year_valid(int(y_m[0])) and Validator.month_valid(int(y_m[1]))
230
231    @staticmethod
232    def week_valid(val):
233        '''validate method'''
234        return isinstance(val, int) and 0 < val < 54
235
236    @staticmethod
237    def day_valid(val):
238        '''validate method'''
239        return isinstance(val, int) and 0 < val < 32
240
241    @staticmethod
242    def wday_valid(val):
243        '''validate method'''
244        return isinstance(val, int) and 0 < val < 8
245
246    @staticmethod
247    def yday_valid(val):
248        '''validate method'''
249        return isinstance(val, int) and 0 < val < 367
250
251    @staticmethod
252    def hour_valid(val):
253        '''validate method'''
254        return isinstance(val, int) and 0 <= val < 13
255
256    @staticmethod
257    def minute_valid(val):
258        '''validate method'''
259        return isinstance(val, int) and 0 <= val < 60
260
261    @staticmethod
262    def second_valid(val):
263        '''validate method'''
264        return isinstance(val, int) and 0 <= val < 60
265
266    @staticmethod
267    def dat_valid(val):
268        '''validate method'''
269        return (Validator.date_valid(val) or Validator.time_valid(val) or
270                Validator.datetime_valid(val) or Validator.timetz_valid(val) or
271                Validator.datetimetz_valid(val))
272
273    @staticmethod
274    def date_valid(val):
275        '''validate method'''
276        try:
277            datetime.date.fromisoformat(val)
278        except ValueError:
279            return False
280        return True
281
282    @staticmethod
283    def time_valid(val):
284        '''validate method'''
285        try:
286            tim = datetime.time.fromisoformat(val)
287        except ValueError:
288            return False
289        # return True if not tim.tzinfo else False
290        return bool(not tim.tzinfo)
291
292    @staticmethod
293    def timetz_valid(val):
294        '''validate method'''
295        try:
296            tim = datetime.time.fromisoformat(val)
297        except ValueError:
298            return False
299        # return True if tim.tzinfo else False
300        return bool(tim.tzinfo)
301
302    @staticmethod
303    def datetime_valid(val):
304        '''validate method'''
305        try:
306            tim = datetime.datetime.fromisoformat(val)
307        except ValueError:
308            return False
309        # return True if not tim.tzinfo else False
310        return bool(not tim.tzinfo)
311
312    @staticmethod
313    def datetimetz_valid(val):
314        '''validate method'''
315        try:
316            tim = datetime.datetime.fromisoformat(val)
317        except ValueError:
318            return False
319        # return True if tim.tzinfo else False
320        return bool(tim.tzinfo)
321
322    @staticmethod
323    def duration_valid(val):
324        '''validate method'''
325        if not isinstance(val, str):
326            return False
327        return DURATION.fullmatch(val) is not None
328
329    @staticmethod
330    def period_valid(val):
331        '''validate method'''
332        if not isinstance(val, str):
333            return False
334        period = val.split('/', maxsplit=1)
335        for per in period:
336            if not (Validator.datetime_valid(per) or
337                    Validator.datetimetz_valid(per) or
338                    Validator.duration_valid(per)):
339                return False
340        if period[0][0] == 'P' and period[1][0] == 'P':
341            return False
342        return True
343
344    @staticmethod
345    def timearray_valid(val):
346        '''validate method'''
347        return (isinstance(val, list) and len(val) == 2 and
348                Validator.dat_valid(val[0]) and Validator.dat_valid(val[1]))
349
350    @staticmethod
351    def point_valid(val):
352        '''validate method'''
353        return (isinstance(val, list) and len(val) == 2 and
354                isinstance(val[0], (int, float)) and -180 <= val[0] <= 180 and
355                isinstance(val[1], (int, float)) and -180 <= val[1] <= 180)
356
357    @staticmethod
358    def pointstr_valid(val):
359        '''validate method'''
360        if not isinstance(val, str):
361            return False
362        coord = val.split(',', maxsplit=1)
363        if len(coord) != 2:
364            return False
365        try:
366            point = [float(coord[0]), float(coord[1])]
367        except ValueError:
368            return False
369        return Validator.point_valid(point)
370
371    @staticmethod
372    def pointobj_valid(val):
373        '''validate method'''
374        if not (isinstance(val, dict) and 'lon' in val and 'lat' in val):
375            return False
376        return Validator.point_valid([val['lon'], val['lat']])
377
378    @staticmethod
379    def multipoint_valid(val):
380        '''validate method'''
381        if not isinstance(val, list):
382            return False
383        for point in val:
384            if not Validator.point_valid(point):
385                return False
386        return True
387
388    @staticmethod
389    def line_valid(val):
390        '''validate method'''
391        return Validator.multipoint_valid(val)
392
393    @staticmethod
394    def multiline_valid(val):
395        '''validate method'''
396        if not isinstance(val, list):
397            return False
398        for line in val:
399            if not Validator.multipoint_valid(line):
400                return False
401        return True
402
403    @staticmethod
404    def polygon_valid(val):
405        '''validate method'''
406        return Validator.multiline_valid(val)
407
408    @staticmethod
409    def multipolygon_valid(val):
410        '''validate method'''
411        if not isinstance(val, list):
412            return False
413        for poly in val:
414            if not Validator.multiline_valid(poly):
415                return False
416        return True
417
418    @staticmethod
419    def geometry_valid(val):
420        '''validate method'''
421        return (Validator.point_valid(val) or Validator.line_valid(val) or
422                Validator.polygon_valid(val))
423
424    @staticmethod
425    def multigeometry_valid(val):
426        '''validate method'''
427        if not isinstance(val, list):
428            return False
429        for geo in val:
430            if not Validator.geometry_valid(geo):
431                return False
432        return True
433
434    @staticmethod
435    def box_valid(val):
436        '''validate method'''
437        if not (isinstance(val, list) and len(val) == 4):
438            return False
439        for coor in val:
440            if not (isinstance(coor, (int, float)) and -90 <= coor <= 90):
441                return False
442        return True
443
444    @staticmethod
445    def geojson_valid(val):
446        '''validate method'''
447        if not (isinstance(val, dict) and 'type' in val):
448            return False
449        return val['type'] in GEOJSON and GEOJSON[val['type']] in val
450
451    @staticmethod
452    def codeolc_valid(val):
453        '''validate method'''
454        if not isinstance(val, str):
455            return False
456        return OLC.fullmatch(val) is not None
457
458    @staticmethod
459    def loc_valid(val):
460        '''validate method'''
461        return (Validator.point_valid(val) or Validator.pointstr_valid(val) or
462                Validator.pointobj_valid(val) or Validator.line_valid(val) or
463                Validator.polygon_valid(val) or Validator.multipolygon_valid(val) or
464                Validator.box_valid(val) or Validator.geojson_valid(val) or
465                Validator.codeolc_valid(val))
466
467    @staticmethod
468    def unit_valid(val):
469        '''validate method'''
470        return isinstance(val, str)
471
472    @staticmethod
473    def uri_valid(val):
474        '''validate method'''
475        if not isinstance(val, str):
476            return False
477        return URI.fullmatch(val) is not None
478
479    @staticmethod
480    def uriref_valid(val):
481        '''validate method'''
482        if not isinstance(val, str):
483            return False
484        return URI.fullmatch(val) is not None
485
486    @staticmethod
487    def iri_valid(val):
488        '''validate method'''
489        if not isinstance(val, str):
490            return False
491        return URI.fullmatch(val) is not None
492
493    @staticmethod
494    def iriref_valid(val):
495        '''validate method'''
496        if not isinstance(val, str):
497            return False
498        return URI.fullmatch(val) is not None
499
500    @staticmethod
501    def uritem_valid(val):
502        '''validate method'''
503        if not isinstance(val, str):
504            return False
505        return URI.fullmatch(val) is not None
506
507    @staticmethod
508    def uuid_valid(val):
509        '''validate method'''
510        if not isinstance(val, str):
511            return False
512        return UUID.fullmatch(val) is not None
513
514    @staticmethod
515    def email_valid(val):
516        '''validate method'''
517        if not isinstance(val, str):
518            return False
519        return ADDRESS.fullmatch(val) is not None
520
521    @staticmethod
522    def hostname_valid(val):
523        '''validate method'''
524        if not isinstance(val, str) or len(val) > 253:
525            return False
526        return HOSTNAME.fullmatch(val) is not None
527
528    @staticmethod
529    def jpointer_valid(val):
530        '''validate method'''
531        if not isinstance(val, str) or (len(val) > 0 and val[0] != '/'):
532            return False
533        return True
534
535    @staticmethod
536    def ipv4_valid(val):
537        '''validate method'''
538        if not isinstance(val, str):
539            return False
540        return IPV4.fullmatch(val) is not None
541
542    @staticmethod
543    def file_valid(val):
544        '''validate method'''
545        if not isinstance(val, str):
546            return False
547        return FILE.fullmatch(val) is not None
548
549    @staticmethod
550    def ipv6_valid(val):
551        '''validate method'''
552
553    @staticmethod
554    def idnemail_valid(val):
555        '''validate method'''
556
557    @staticmethod
558    def idnhostname_valid(val):
559        '''validate method'''
560
561    @staticmethod
562    def rjpointer_valid(val):
563        '''validate method'''
564
565    @staticmethod
566    def regex_valid(val):
567        '''validate method'''
568
569    @staticmethod
570    def row_valid(val):
571        '''validate method'''
572
573    @staticmethod
574    def tab_valid(val):
575        '''validate method'''
576
577    @staticmethod
578    def field_valid(val):
579        '''validate method'''
580
581    @staticmethod
582    def ntv_valid(val):
583        '''validate method'''
584
585    @staticmethod
586    def sch_valid(val):
587        '''validate method'''
588
589    @staticmethod
590    def narray_valid(val):
591        '''validate method'''
592
593    @staticmethod
594    def ndarray_valid(val):
595        '''validate method'''
596
597    @staticmethod
598    def xndarray_valid(val):
599        '''validate method'''
600
601    @staticmethod
602    def xdataset_valid(val):
603        '''validate method'''
604
605
606class ValidateError(Exception):
607    '''Validator exception'''