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 Common library for writing rule-style checks for generating warnings
37 and errors. Use of this style streamlines reporting.
38
39 The pattern for rules is simple: a rule provides a function that
40 implements the rule and a format string. If the function returns a
41 non-zero value, that value is combined with the format string to
42 produced an error reporting string. There are other conveniences as
43 well. If the rule returns a list or a tuple, that will be transformed
44 into a human-readable list.
45
46 This library is a layer on top of the base L{WtfWarning} and
47 L{WtfError} representation in roswtf.model.
48 """
49
50 from roswtf.model import WtfWarning, WtfError
51
53 if ret:
54 d = ctx.as_dictionary()
55
56 def isstring(s):
57 """Small helper version to check an object is a string in
58 a way that works for both Python 2 and 3
59 """
60 try:
61 return isinstance(s, basestring)
62 except NameError:
63 return isinstance(s, str)
64
65 if type(ret) in (tuple, list):
66 f_msg = rule[1]
67 ret_str = '\n'.join([" * %s"%r for r in ret])
68 ctx_list.append(level(f_msg%d + "\n" + ret_str+'\n', f_msg, ret))
69 elif isstring(ret):
70 f_msg = rule[1]
71 ctx_list.append(level(f_msg%d + ret%d, f_msg, ret))
72 else:
73 f_msg = rule[1]
74 ctx_list.append(level(f_msg%d, f_msg, ret))
75
77 """
78 Check return value of rule and update ctx if rule failed.
79
80 @param rule: Rule/message pair.
81 @type rule: (rule_fn, format_msg)
82 @param ret: return value of rule. If value is non-zero, rule failed
83 @param ret: Any
84 @param ctx: context for which rule failed
85 @param ctx: L{WtfContext}
86 """
87 _check_rule(rule, ret, ctx, ctx.warnings, WtfWarning)
88
90 """
91 Check return value of rule and update ctx if rule failed.
92
93 @param rule: Rule/message pair.
94 @type rule: (rule_fn, format_msg)
95 @param ret: return value of rule. If value is non-zero, rule failed
96 @type ret: Any
97 @param ctx: context for which rule failed
98 @type ctx: L{WtfContext}
99 """
100 _check_rule(rule, ret, ctx, ctx.errors, WtfError)
101