Source Code for Module roswtf.rules

 1  # Software License Agreement (BSD License) 
 2  # 
 3  # Copyright (c) 2009, Willow Garage, Inc. 
 4  # All rights reserved. 
 5  # 
 6  # Redistribution and use in source and binary forms, with or without 
 7  # modification, are permitted provided that the following conditions 
 8  # are met: 
 9  # 
10  #  * Redistributions of source code must retain the above copyright 
11  #    notice, this list of conditions and the following disclaimer. 
12  #  * Redistributions in binary form must reproduce the above 
13  #    copyright notice, this list of conditions and the following 
14  #    disclaimer in the documentation and/or other materials provided 
15  #    with the distribution. 
16  #  * Neither the name of Willow Garage, Inc. nor the names of its 
17  #    contributors may be used to endorse or promote products derived 
18  #    from this software without specific prior written permission. 
19  # 
20  # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
21  # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
22  # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
23  # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
24  # COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
25  # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
26  # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
27  # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
28  # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
29  # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
30  # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
31  # POSSIBILITY OF SUCH DAMAGE. 
32  # 
33  # Revision $Id$ 
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   
52 -def _check_rule(rule, ret, ctx, ctx_list, level): 
53      if ret: 
54          d = ctx.as_dictionary() 
55   
56          if type(ret) in (tuple, list): 
57              f_msg = rule[1] 
58              ret_str = '\n'.join([" * %s"%r for r in ret]) 
59              ctx_list.append(level(f_msg%d + "\n" + ret_str+'\n', f_msg, ret)) 
60          elif isinstance(ret, basestring): 
61              f_msg = rule[1] 
62              ctx_list.append(level(f_msg%d + ret%d, f_msg, ret)) 
63          else: 
64              f_msg = rule[1] 
65              ctx_list.append(level(f_msg%d, f_msg, ret)) 
66       
67 -def warning_rule(rule, ret, ctx): 
68      """ 
69      Check return value of rule and update ctx if rule failed. 
70       
71      @param rule: Rule/message pair. 
72      @type  rule: (rule_fn, format_msg) 
73      @param ret: return value of rule. If value is non-zero, rule failed 
74      @param ret: Any 
75      @param ctx: context for which rule failed 
76      @param ctx: L{WtfContext} 
77      """ 
78      _check_rule(rule, ret, ctx, ctx.warnings, WtfWarning) 
79       
80 -def error_rule(rule, ret, ctx): 
81      """ 
82      Check return value of rule and update ctx if rule failed. 
83       
84      @param rule: Rule/message pair. 
85      @type  rule: (rule_fn, format_msg) 
86      @param ret: return value of rule. If value is non-zero, rule failed 
87      @type  ret: Any 
88      @param ctx: context for which rule failed 
89      @type  ctx: L{WtfContext} 
90      """ 
91      _check_rule(rule, ret, ctx, ctx.errors, WtfError) 
92