Home > Articles

  • Print
  • + Share This
This chapter is from the book

4.10 Generators

There’s no subject in Python about which more confusion abounds than generators. It’s not a difficult feature once you understand it. Explaining it’s the hard part.

But first, what does a generator do? The answer: It enables you to deal with a sequence one element at a time.

Suppose you need to deal with a sequence of elements that would take a long time to produce if you had to store it all in memory at the same time. For example, you want to examine all the Fibonacci numbers up to 10 to the 50th power. It would take a lot of time and space to calculate the entire sequence. Or you may want to deal with an infinite sequence, such as all even numbers.

The advantage of a generator is that it enables you to deal with one member of a sequence at a time. This creates a kind of “virtual sequence.”

4.10.1 What’s an Iterator?

One of the central concepts in Python is that of iterator (sometimes confused with iterable). An iterator is an object that produces a stream of values, one at a time.

All lists can be iterated, but not all iterators are lists. There are many functions, such as reversed, that produce iterators that are not lists. These cannot be indexed or printed in a useful way, at least not directly. Here’s an example:

>>> iter1 = reversed([1, 2, 3, 4])
>>> print(iter1)
<list_reverseiterator object at 0x1111d7f28>

However, you can convert an iterator to a list and then print it, index it, or slice it:

>>> print(list(iter1))
[4, 3, 2, 1]

Iterators in Python work with for statements. For example, because iter1 is an iterator, the following lines of code work perfectly well.

>>> iter1 = reversed([1, 2, 3, 4])
>>> for i in iter1:
      print(i, end='  ')

4  3  2  1

Iterators have state information; after reaching the end of its series, an iterator is exhausted. If we used iter1 again without resetting it, it would produce no more values.

4.10.2 Introducing Generators

A generator is one of the easiest ways to produce an iterator. But the generator function is not itself an iterator. Here’s the basic procedure.

  • Write a generator function. You do this by using a yield statement anywhere in the definition.

  • Call the function you completed in step 1 to get an iterator object.

  • The iterator created in step 2 is what yields values in response to the next function. This object contains state information and can be reset as needed.

Figure 4.4 illustrates the process.

FIGURE 4.4

Figure 4.4. Returning a generator from a function

Here’s what almost everybody gets wrong when trying to explain this process: It looks as if the yield statement, placed in the generator function (the thing on the left in Figure 4.4), is doing the yielding. That’s “sort of” true, but it’s not really what’s going on.

The generator function defines the behavior of the iterator. But the iterator object, the thing to its right in Figure 4.4, is what actually executes this behavior.

When you include one or more yield statements in a function, the function is no longer an ordinary Python function; yield describes a behavior in which the function does not return a value but sends a value back to the caller of next. State information is saved, so when next is called again, the iterator advances to the next value in the series without starting over. This part, everyone seems to understand.

But—and this is where people get confused—it isn’t the generator function that performs these actions, even though that’s where the behavior is defined. Fortunately, you don’t need to understand it; you just need to use it. Let’s start with a function that prints even numbers from 2 to 10:

def print_evens():
    for n in range(2, 11, 2):
        print(n)

Now replace print(n) with the statement yield n. Doing so changes the nature of what the function does. While we’re at it, let’s change the name to make_evens_gen to have a more accurate description.

def make_evens_gen():
    for n in range(2, 11, 2):
        yield n

The first thing you might say is “This function no longer returns anything; instead, it yields the value n, suspending its execution and saving its internal state.”

But this revised function, make_evens_gen, does indeed have a return value! As shown in Figure 4.4, the value returned is not n; the return value is an iterator object, also called a “generator object.” Look what happens if you call make_evens_gen and examine the return value.

>>> make_evens_gen()
<generator object make_evens_gen at 0x1068bd410>

What did the function do? Yield a value for n? No! Instead, it returned an iterator object, and that’s the object that yields a value. We can save the iterator object (or generator object) and then pass it to next.

>>> my_gen = make_evens_gen()
>>> next(my_gen)
2
>>> next(my_gen)
4
>>> next(my_gen)
6

Eventually, calling next exhausts the series, and a StopIteration exception is raised. But what if you want to reset the sequence of values to the beginning? Easy. You can do that by calling make_evens_gen again, producing a new instance of the iterator. This has the effect of starting over.

>>> my_gen = make_evens_gen()   # Start over
>>> next(my_gen)
2
>>> next(my_gen)
4
>>> next(my_gen)
6
>>> my_gen = make_evens_gen()   # Start over
>>> next(my_gen)
2
>>> next(my_gen)
4
>>> next(my_gen)
6

What happens if you call make_evens_gen every time? In that case, you keep starting over, because each time you’re creating a new generator object. This is most certainly not what you want.

>>> next(make_evens_gen())
2
>>> next(make_evens_gen())
2
>>> next(make_evens_gen())
2

Generators can be used in for statements, and that’s one of the most frequent uses. For example, we can call make_evens_gen as follows:

for i in make_evens_gen():
    print(i, end='  ')

This block of code produces the result you’d expect:

2  4  6  8  10

But let’s take a look at what’s really happening. The for block calls make_evens_gen one time. The result of the call is to get a generator object. That object then provides the values in the for loop. The same effect is achieved by the following code, which breaks the function call onto an earlier line.

>>> my_gen = make_evens_gen()
>>> for i in my_gen:
      print(i, end='  ')

Remember that my_gen is an iterator object. If you instead referred to make_evens_gen directly, Python would raise an exception.

for i in make_evens_gen:       # ERROR! Not an iterable!
    print(i, end='  ')

Once you understand that the object returned by the generator function is the generator object, also called the iterator, you can call it anywhere an iterable or iterator is accepted in the syntax. For example, you can convert a generator object to a list, as follows.

>>> my_gen = make_evens_gen()
>>> a_list = list(my_gen)
>>> a_list
[2, 4, 6, 8, 10]
>>> a_list = list(my_gen)       # Oops! No reset!
>>> a_list
[]

The problem with the last few statements in this example is that each time you iterate through a sequence using a generator object, the iteration is exhausted and needs to be reset.

>>> my_gen = make_evens_gen()   # Reset!
>>> a_list = list(my_gen)
>>> a_list
[2, 4, 6, 8, 10]

You can of course combine the function call and the list conversion. The list itself is stable and (unlike a generator object) will retain its values.

>>> a_list = list(make_evens_gen())
>>> a_list
[2, 4, 6, 8, 10]

One of the most practical uses of an iterator is with the in and not in keywords. We can, for example, generate an iterator that produces Fibonacci numbers up to and including N, but not larger than N.

def make_fibo_gen(n):
    a, b = 1, 1
    while a <= n:
        yield a
        a, b = a + b, a

The yield statement changes this function from an ordinary function to a generator function, so it returns a generator object (iterator). We can now determine whether a number is a Fibonacci by using the following test:

n = int(input('Enter number: '))
if n in make_fibo_gen(n):
    print('number is a Fibonacci. ')
else:
    print('number is not a Fibonacci. ')

This example works because the iterator produced does not yield an infinite sequence, something that would cause a problem. Instead, the iterator terminates if n is reached without being confirmed as a Fibonacci.

Remember—and we state this one last time—by putting yield into the function make_fibo_gen, it becomes a generator function and it returns the generator object we need. The previous example could have been written as follows, so that the function call is made in a separate statement. The effect is the same.

n = int(input('Enter number: '))
my_fibo_gen = make_fibo_gen(n)
if n in my_fibo_gen:
    print('number is a Fibonacci. ')
else:
    print('number is not a Fibonacci. ')

As always, remember that a generator function (which contains the yield statement) is not a generator object at all, but rather a generator factory. This is confusing, but you just have to get used to it. In any case, Figure 4.4 shows what’s really going on, and you should refer to it often.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020