Coverage for gws-app/gws/plugin/model_validator/not_empty/__init__.py: 94%

1"""Validator for non-empty values. 

2 

3Fails if the field value is None or a string that is empty or consists only of 

4whitespace. Fields with ``isAuto`` always pass when a feature is created, 

5since their value is set by the database. 

6 

7Every field runs a default instance of this validator; a failure is reported 

8only if the field is required (``isRequired``). A configured ``notEmpty`` 

9validator replaces the default one, e.g. to set a custom message. 

10 

11Example:: 

12 

13 fields+ { 

14 name "name" 

15 type "text" 

16 isRequired true 

17 validators+ { type "notEmpty" message "Name is required" } 

18 } 

19""" 

20 

21import gws 

22import gws.base.model.validator 

23 

24 

25@gws.ext.config.modelValidator('notEmpty') 

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

27 """Checks that a value is not empty.""" 

28 

29 pass 

30 

31 

32@gws.ext.object.modelValidator('notEmpty') 

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

34 """Not-empty validator object.""" 

35 

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

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

38 

39 if mc.op == gws.ModelOperation.create and field.isAuto: 

40 return True 

41 if isinstance(val, str): 

42 return len(val.strip()) > 0 

43 if val is not None: 

44 return True 

45 

46 return False