Contents

class warningclass_flags

Flag class: describes properties of a warningclass .

warningclass_flags Members

Constructors none
Static Method from_integer()
Methods __and__(), __cmp__(), __eq__(), __ge__(), __gt__(), __hash__(), __invert__(), __le__(), __lt__(), __ne__(), __or__(), __repr__(), __str__(), as_integer(), name()
Attributes FORCE_PATH, NONE, PADDING, PAD_ABOVE, PAD_BELOW, SHOW_ENTIRE_PROCEDURE, WARNING_POINT_IS_START_POINT

warningclass_flags Details

class cs.warningclass_flags

Flag class: describes properties of a warningclass .

static from_integer(_inner)

Construct an instance from an integer representation.

Parameters:_inner (int) – The integer representation, as returned by warningclass_flags.as_integer().
Return type:warningclass_flags
Raises:result.ERROR_INVALID_ARGUMENT if _inner is not a valid integer representation for a warningclass_flags instance.

Invariant: For warningclass_flags x, warningclass_flags.from_integer(x.as_integer()) == x

>>> wcf = (warningclass_flags.WARNING_POINT_IS_START_POINT | warningclass_flags.PAD_ABOVE).as_integer()
>>> wcf
5
>>> warningclass_flags.from_integer(wcf)
<cs.warningclass_flags warning_point_is_start_point|pad_above>
__and__(b)

AND operator for warningclass_flags .

Parameters:b (warningclass_flags) – AND operand.
Return type:warningclass_flags
Returns:A warningclass_flags object containing all flags that are in both self and b. 
>>> warningclass_flags.PAD_BELOW & warningclass_flags.PADDING
<cs.warningclass_flags pad_below>
__cmp__(other)

Comparison function for warningclass_flags , with respect to a stable overall ordering.

Parameters:other (warningclass_flags) – The warningclass_flags object to compare against.
Return type:int
Returns:An integer N such that:
  • N==0 if the two objects compare equal
  • N<0 if self < other
  • N>0 if self > other
 
>>> warningclass_flags.PAD_ABOVE.__cmp__(warningclass_flags.PAD_BELOW)
-1
__eq__(b)

Equality operator for warningclass_flags .

Parameters:b (warningclass_flags) – The warningclass_flags object to compare against.
Return type:bool
Returns:True if self and b compare equal, False otherwise. 
>>> warningclass_flags.PADDING == warningclass_flags.PAD_BELOW
False
>>> warningclass_flags.PADDING == warningclass_flags.PAD_BELOW|warningclass_flags.PAD_ABOVE
True
__ge__(b)

Greater-than-or-equal operator for warningclass_flags .

Parameters:b (warningclass_flags) – The warningclass_flags object to compare against.
Return type:bool
Returns:True if self >= b , False otherwise. 
>>> warningclass_flags.PAD_BELOW >= warningclass_flags.PADDING
False
__gt__(b)

Greater-than operator for warningclass_flags .

Parameters:b (warningclass_flags) – The warningclass_flags object to compare against.
Return type:bool
Returns:True if self > b , False otherwise. 
>>> warningclass_flags.WARNING_POINT_IS_START_POINT > warningclass_flags.PADDING
False
__hash__()

Hash function for warningclass_flags .

Return type:int 
>>> hash(warningclass_flags.PAD_ABOVE)
4
__invert__()

Complementation operator.

Return type:warningclass_flags
Returns:A warningclass_flags object containing the flags that are NOT contained in self. 
>>> ~warningclass_flags.SHOW_ENTIRE_PROCEDURE
<cs.warningclass_flags warning_point_is_start_point|pad_above|pad_below|force_path>
__le__(b)

Less-than-or-equal operator for warningclass_flags .

Parameters:b (warningclass_flags) – The warningclass_flags object to compare against.
Return type:bool
Returns:True if self <= b , False otherwise. 
>>> warningclass_flags.NONE <= warningclass_flags.SHOW_ENTIRE_PROCEDURE
True
__lt__(b)

Less-than operator for warningclass_flags .

Parameters:b (warningclass_flags) – The warningclass_flags object to compare against.
Return type:bool
Returns:True if self < b , False otherwise. 
>>> warningclass_flags.PAD_ABOVE < warningclass_flags.WARNING_POINT_IS_START_POINT
False
__ne__(b)

Inequality operator for warningclass_flags .

Parameters:b (warningclass_flags) – The warningclass_flags object to compare against.
Return type:bool
Returns:False if self and b compare equal, True otherwise. 
>>> warningclass_flags.PAD_BELOW != warningclass_flags.NONE
True
__or__(b)

OR operator for warningclass_flags .

Parameters:b (warningclass_flags) – OR operand.
Return type:warningclass_flags
Returns:A warningclass_flags object containing all flags that are in at least one of self, b. 
>>> warningclass_flags.FORCE_PATH | warningclass_flags.WARNING_POINT_IS_START_POINT
<cs.warningclass_flags warning_point_is_start_point|force_path>
__repr__()

Get a representation of a warningclass_flags object that includes information useful for debugging.

Return type:str
Returns:The string representation. 
>>> repr(warningclass_flags.SHOW_ENTIRE_PROCEDURE)
'<cs.warningclass_flags show_entire_procedure>'
__str__()

Get a simple string representation of a warningclass_flags object.

Return type:str
Returns:The string representation. 
>>> str(warningclass_flags.PADDING)
'pad_above|pad_below'
as_integer()

Get an integer representation of self.

Return type:int
Returns:An integer suitable for use with warningclass_flags.from_integer().

Invariant: For warningclass_flags x, warningclass_flags.from_integer(x.as_integer()) == x

>>> wcf = (warningclass_flags.WARNING_POINT_IS_START_POINT | warningclass_flags.PAD_ABOVE).as_integer()
>>> wcf
5
>>> warningclass_flags.from_integer(wcf)
<cs.warningclass_flags warning_point_is_start_point|pad_above>
name()

Get the name of a warningclass_flags object.

Return type:str 
>>> warningclass_flags.PAD_BELOW.name()
'pad_below'
FORCE_PATH

Singleton set containing the “force_path” flag: warnings of this class will always be treated as “pathy”, even if they are reported using a warningclass.report() or warningclass.report_return_warning() overload that would otherwise indicate a pathless warning.

This affects various presentation heuristics for the displayed warning. The main application of this flag is for importing warnings from other tools where a list of locations is known to actually represent a path.

>>> warningclass_flags.FORCE_PATH
<cs.warningclass_flags force_path>
NONE

Empty set: contains no flags.

>>> warningclass_flags.NONE
<cs.warningclass_flags none>
PADDING

Set containing the “pad below” and “pad above” flags: in the warning report, pad both before and after the warning proper with additional lines of code.

>>> warningclass_flags.PADDING
<cs.warningclass_flags pad_above|pad_below>
PAD_ABOVE

Singleton set containing the “pad above” flag: in the warning report, pad before the beginning of the warning proper with additional lines of code.

>>> warningclass_flags.PAD_ABOVE
<cs.warningclass_flags pad_above>
PAD_BELOW

Singleton set containing the “pad below” flag: In the warning report, pad after the end of the warning proper with additional lines of code.

>>> warningclass_flags.PAD_BELOW
<cs.warningclass_flags pad_below>
SHOW_ENTIRE_PROCEDURE

Singleton set containing the “show entire procedure” flag: if any part of a procedure appears on a path, show the entire procedure in the warning report.

>>> warningclass_flags.SHOW_ENTIRE_PROCEDURE
<cs.warningclass_flags show_entire_procedure>
WARNING_POINT_IS_START_POINT

The start point of the path is most interesting (not the end point).

>>> warningclass_flags.WARNING_POINT_IS_START_POINT
<cs.warningclass_flags warning_point_is_start_point>