Coverage for gws-app/gws/plugin/model_validator/regex/__init__.py: 0%

1"""Regular expression validator for strings. 

2 

3Checks that the field value is a string that matches a regular expression. 

4The match uses ``re.search``, so the expression can match anywhere in the 

5value; add ``^`` and ``$`` anchors to match the whole value. A value that is 

6not a string fails the check. 

7 

8Example:: 

9 

10 fields+ { 

11 name "zip" 

12 type "text" 

13 validators+ { type "regex" regex "^[0-9]{5}$" } 

14 } 

15""" 

16 

17import re 

18 

19import gws 

20import gws.base.model.validator 

21 

22 

23@gws.ext.config.modelValidator('regex') 

24class Config(gws.base.model.validator.Config): 

25 """Checks that a value matches a regular expression.""" 

26 

27 regex: gws.Regex 

28 """Regular expression, matched anywhere in the value unless anchored.""" 

29 

30 

31@gws.ext.object.modelValidator('regex') 

32class Object(gws.base.model.validator.Object): 

33 """Regular expression validator object.""" 

34 

35 regex: str 

36 """The regular expression.""" 

37 

38 def configure(self): 

39 self.regex = self.cfg('regex') 

40 

41 def validate(self, field, feature, mc): 

42 val = feature.attributes.get(field.name) 

43 if not isinstance(val, str): 

44 return False 

45 m = re.search(self.regex, val) 

46 return m is not None