Altcademy - a Forbes magazine logo Best Coding Bootcamp 2023

What is yield in Python

Understanding the Concept of Yield

When diving into the world of Python programming, you might come across the term yield. It's a concept that can be a bit confusing at first, but with the right explanation and examples, it becomes a powerful tool in your coding arsenal. To understand yield, think of it as a magic trick in the hands of a Python magician, allowing your functions to pause and resume, creating values on the fly without the need for bulky lists or arrays.

Generators and Iterators: The Basics

Before we tackle yield, we need to understand two important concepts in Python: generators and iterators. An iterator is an object that enables a programmer to traverse through all the elements in a collection, like a list or a string. A generator is a special kind of iterator, one that generates values on the fly instead of storing them all in memory at once.

Imagine you're in a candy store, and you have a bag that you can fill with candies one by one. An iterator would be like having all the candies in your bag at once and taking them out one at a time. A generator, on the other hand, would be like having a magical bag that produces one candy each time you reach into it, without having to carry the whole stock at once.

Yield: The Heart of a Generator

yield is a keyword in Python that is used to turn a function into a generator. It allows the function to return a value and pause its execution, saving its state for later. The next time you call this function, it resumes right where it left off, with all its variables intact.

Here's a simple analogy: think of yield as a bookmark in a novel. You're reading a captivating story (running a function), and then you decide to take a break (the function yields). You place a bookmark (the yield statement) so that you can return later and pick up the story from the exact spot you left off.

A Simple Example of Yield

Let's look at a simple example to see yield in action. Suppose we want to create a generator that gives us the sequence of numbers from 0 to 4. Here's how we can do it:

def number_sequence():
    for number in range(5):
        yield number

# Let's use the generator
for number in number_sequence():

In this code, number_sequence is a generator function. The for loop inside it runs through numbers 0 to 4, but instead of returning them all at once, it yields them one by one. Each time the for loop in the outer code asks for a number, the generator resumes and provides the next number in the sequence.

Yield vs. Return

You might wonder, how is yield different from return? The return statement in Python is used to exit a function and give back a value to the caller. Once a function returns, it's done; it cannot continue where it left off. yield, on the other hand, is like a temporary return that saves the function's state, allowing it to continue from where it paused.

To visualize the difference, imagine you're watching a series of short episodes (using return) versus one long movie with pause breaks (using yield). Each episode is a complete story, and once it's over, you move on to the next. But with the movie, you can pause it and resume watching without missing a beat.

Using Yield to Create Infinite Sequences

One of the great things about yield is that it can be used to create infinite sequences without running out of memory. Let's say we want to make a generator that produces an endless stream of even numbers. Here's how we can do it:

def even_numbers():
    n = 0
    while True:
        yield n
        n += 2

# Let's generate the first 5 even numbers
even_gen = even_numbers()
for _ in range(5):

In this example, the even_numbers generator will keep producing even numbers as long as we keep asking for them. The while True loop never ends, but because we're using yield, we don't have to worry about it using up all our memory.

Yield and Memory Efficiency

The beauty of yield is its ability to be memory efficient. When working with large datasets, you might not want to store all the data in memory at once due to limitations or efficiency concerns. With yield, you can process large amounts of data in chunks, keeping your memory footprint small.

Think of it like a water dispenser that gives you a cup of water every time you press the button, instead of having to fill a giant tank all at once. You get what you need, when you need it, without the excess.

Advanced Use of Yield: Yield From

Python 3.3 introduced a new feature called yield from, which allows a generator to yield all values from another iterator or generator. It's like having a conveyor belt (the yield from statement) that transports items from one place to another seamlessly.

Here's an example:

def first_generator():
    for i in range(3):
        yield i

def second_generator():
    yield from first_generator()
    yield from first_generator()

# Using the second generator
for number in second_generator():

In this code, second_generator yields all values from first_generator twice, creating a sequence of 0, 1, 2, 0, 1, 2.

Conclusion: The Power of Yield

yield is a versatile and powerful feature in Python that allows you to write more memory-efficient and readable code. It's like having a pause button for your functions, giving you the ability to produce values one at a time and only as needed. As you continue your journey in Python programming, you'll find yield to be an invaluable tool, especially when dealing with large data or when you want to write code that's both efficient and elegant.

Remember, the best way to truly understand yield is to practice. Try creating your own generators, play with different sequences, and see firsthand how yield can make your code better. Happy coding!