[Fixed] What does the “yield” keyword do?
Want to improve this post? Provide detailed answers to this question, including citations and an explanation of why your answer is correct. Answers without enough detail may be edited or deleted.
What is the use of the yield keyword in Python? What does it do?
For example, I’m trying to understand this code1:
def _get_child_candidates(self, distance, min_dist, max_dist):
if self._leftchild and distance – max_dist < self._median: yield self._leftchild if self._rightchild and distance + max_dist >= self._median:
And this is the caller:
result, candidates = , [self]
node = candidates.pop()
distance = node._get_dist(obj)
if distance <= max_dist and distance >= min_dist:
candidates.extend(node._get_child_candidates(distance, min_dist, max_dist))
What happens when the method _get_child_candidates is called?
Is a list returned? A single element? Is it called again? When will subsequent calls stop?
1. This piece of code was written by Jochen Schulz (jrschulz), who made a great Python library for metric spaces. This is the link to the complete source: Module mspace.