Contents

class project_procedures_iterator

Iterator over all the procedures ( procedure ) in a project .

Initialize with project.procedures().

Use as you would any other Python iterator. For example:

# set up project proj, then...
for e in proj.procedures():
    print('procedure: ', e)

project_procedures_iterator Members

Constructors none
Methods __eq__(), __iter__(), __ne__(), __next__(), __repr__(), __str__(), at_end()

project_procedures_iterator Details

class cs.project_procedures_iterator

Iterator over all the procedures ( procedure ) in a project .

__eq__(other)

Iterator equality.

Parameters:other (project_procedures_iterator) –
Return type:bool
Returns:True if and only if self and other are at the same position. Behavior is undefined if self and other are not iterating over the same collection. 
>>> proc_iterA = project.current().procedures()
>>> proc_iterB = project.current().procedures()
>>> proc_iterA == proc_iterB
True
>>> for proc in proc_iterA:
...     if proc.name()=='foo':
...         break
...
>>> proc_iterA == proc_iterB
False
__iter__()

Get the iterator object.

Return type:project_procedures_iterator
Returns:self. 
>>> for proc in project.current().procedures(): # iteration managed by project_procedures_iterator.__iter__()
...                                             # and project_procedures_iterator.__next__()
...     if proc.callers_count()>0 and proc.get_kind() == procedure_kind.USER_DEFINED:
...         print(proc, proc.callers_count())
...
mymalloc 2
bar 4
__ne__(other)

Iterator inequality.

Parameters:other (project_procedures_iterator) – The iterator to compare against.
Return type:bool
Returns:False if and only if self and other are at the same position. Behavior is undefined if self and other are not iterating over the same collection. 
>>> proc_iterA = project.current().procedures()
>>> proc_iterB = project.current().procedures()
>>> proc_iterA != proc_iterB
False
>>> for proc in proc_iterA:
...     if proc.name()=='foo':
...         break
...
>>> proc_iterA != proc_iterB
True
__next__()

Iterator dereference operator.

Return type:procedure
Returns:The element at the current iterator position.
Raises:StopIteration
  • Side effects: Modifies self.

The typical use is implicit:

>>> for item in myiter:
...   (do something to item)

>>> for proc in project.current().procedures(): # iteration managed by project_procedures_iterator.__iter__()
...                                             # and project_procedures_iterator.__next__()
...     if proc.callers_count()>0 and proc.get_kind() == procedure_kind.USER_DEFINED:
...         print(proc, proc.callers_count())
...
mymalloc 2
bar 4
__repr__()

Get a representation of the iterator that includes information useful for debugging.

Return type:str
Returns:The string representation. 
>>> v0 = project.current()
>>> v1 = v0.procedures()
>>> repr(v1)
'<cs.project_procedures_iterator begin>'
__str__()

Get a simple string representation of the iterator.

Return type:str
Returns:The string representation. 
>>> v0 = project.current()
>>> v1 = v0.procedures()
>>> str(v1)
'<cs.project_procedures_iterator begin>'
at_end()

Check: is the iterator at the end of the structure?

Return type:bool
Returns:True if the iterator is at the end of the structure (there are no more elements to iterate over), False otherwise. 
>>> v0 = project.current()
>>> v1 = v0.procedures()
>>> v1.at_end()
False