Contents

class ast_traverse_flags

Flag class: specifies what kind of traversal an ast_iterator will carry out.

Unless otherwise specified with ast_traverse_flags settings, traversal is preorder and left-to-right.

ast_traverse_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 NONE, POSTORDER, RIGHT_TO_LEFT

ast_traverse_flags Details

class cs.ast_traverse_flags

Flag class: specifies what kind of traversal an ast_iterator will carry out.

static from_integer(_inner)

Construct an instance from an integer representation.

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

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

>>> atf = ast_traverse_flags.NONE.as_integer()
>>> atf
0
>>> ast_traverse_flags.from_integer(atf)
<cs.ast_traverse_flags none>
__and__(b)

AND operator for ast_traverse_flags .

Parameters:b (ast_traverse_flags) – AND operand.
Return type:ast_traverse_flags
Returns:A ast_traverse_flags object containing all flags that are in both self and b. 
>>> ast_traverse_flags.POSTORDER & ast_traverse_flags.NONE
<cs.ast_traverse_flags none>
__cmp__(other)

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

Parameters:other (ast_traverse_flags) – The ast_traverse_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
 
>>> ast_traverse_flags.RIGHT_TO_LEFT.__cmp__(ast_traverse_flags.POSTORDER)
-1
__eq__(b)

Equality operator for ast_traverse_flags .

Parameters:b (ast_traverse_flags) – The ast_traverse_flags object to compare against.
Return type:bool
Returns:True if self and b compare equal, False otherwise. 
>>> ast_traverse_flags.NONE == ast_traverse_flags.POSTORDER
False
__ge__(b)

Greater-than-or-equal operator for ast_traverse_flags .

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

Greater-than operator for ast_traverse_flags .

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

Hash function for ast_traverse_flags .

Return type:int 
>>> hash(ast_traverse_flags.POSTORDER)
2
__invert__()

Complementation operator.

Return type:ast_traverse_flags
Returns:A ast_traverse_flags object containing the flags that are NOT contained in self. 
>>> ~ast_traverse_flags.RIGHT_TO_LEFT
<cs.ast_traverse_flags postorder>
__le__(b)

Less-than-or-equal operator for ast_traverse_flags .

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

Less-than operator for ast_traverse_flags .

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

Inequality operator for ast_traverse_flags .

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

OR operator for ast_traverse_flags .

Parameters:b (ast_traverse_flags) – OR operand.
Return type:ast_traverse_flags
Returns:A ast_traverse_flags object containing all flags that are in at least one of self, b. 
>>> ast_traverse_flags.NONE | ast_traverse_flags.POSTORDER
<cs.ast_traverse_flags postorder>
__repr__()

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

Return type:str
Returns:The string representation. 
>>> repr(ast_traverse_flags.POSTORDER)
'<cs.ast_traverse_flags postorder>'
__str__()

Get a simple string representation of a ast_traverse_flags object.

Return type:str
Returns:The string representation. 
>>> str(ast_traverse_flags.NONE)
'none'
as_integer()

Get an integer representation of self.

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

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

>>> atf = ast_traverse_flags.NONE.as_integer()
>>> atf
0
>>> ast_traverse_flags.from_integer(atf)
<cs.ast_traverse_flags none>
name()

Get the name of a ast_traverse_flags object.

Return type:str 
>>> ast_traverse_flags.RIGHT_TO_LEFT.name()
'right_to_left'
NONE

No flags set.

>>> ast_traverse_flags.NONE
<cs.ast_traverse_flags none>
POSTORDER

Postorder traversal.

>>> ast_traverse_flags.POSTORDER
<cs.ast_traverse_flags postorder>
RIGHT_TO_LEFT

Right-to-left traversal.

>>> ast_traverse_flags.RIGHT_TO_LEFT
<cs.ast_traverse_flags right_to_left>