Programming FAQ about "How do I apply a method to a sequence of objects?" should include the option of an explicit for-loop

[Dominik1123]

BPO	40342
Nosy	@rhettinger, @mdickinson, @vedgar, @Dominik1123

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2020-04-20.21:06:38.162>
labels = ['type-feature', '3.8', '3.9', 'docs']
title = 'Programming FAQ about "How do I apply a method to a sequence of objects?" should include the option of an explicit for-loop'
updated_at = <Date 2020-04-22.07:11:11.110>
user = 'https://github.com/Dominik1123'

bugs.python.org fields:

activity = <Date 2020-04-22.07:11:11.110>
actor = 'veky'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-04-20.21:06:38.162>
creator = 'Dominik V.'
dependencies = []
files = []
hgrepos = []
issue_num = 40342
keywords = []
message_count = 6.0
messages = ['366880', '366885', '366901', '366979', '366980', '366982']
nosy_count = 5.0
nosy_names = ['rhettinger', 'mark.dickinson', 'docs@python', 'veky', 'Dominik V.']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue40342'
versions = ['Python 3.8', 'Python 3.9']

• PR: gh-84522: Add for-loop to apply-method-to-sequence FAQ #94660

• PR: [3.11] gh-84522: Add for-loop to apply-method-to-sequence FAQ (GH-94660) #99362

[Dominik1123]

Right now the question is simply answered with:

result = [obj.method() for obj in mylist]

However this is only appropriate if the result of the method is needed (i.e. if it's some kind of transformation).

There are many cases where it's not and the method is meant to update the object in place. Here it's better to use a for loop:

    for obj in mylist:
        obj.update()

Sometimes people use a one-way list comprehension hack because it saves one line:

[obj.update() for obj in mylist]

However this is discouraged for multiple reasons (builds a superfluous list, obfuscates the actual intent, ...).

So I feel like the Programming FAQ should actively mention this scenario and promote the usage of a for loop here.

[rhettinger]

The current answer seems reasonable to me. It addresses the question that most people want to have answered. Also, it isn't common to loop over methods that don't return values, because those typically do in-place mutations.

[vedgar]

I must say I agree with Dominik here. Too many times my students write list comprehensions when they mean a for loop. It's not just a "has result vs updates inplace" dichotomy: often it produces some output like a drawing or just a print() call [one of rare things that was better when print was a command is that it was impossible to do this:]. Yes, I know print call is not a method, but e.g. .plot() on DataFrame is. I'd sleep easier if I knew the Programming FAQ didn't encourage this style.

It would be enough to add a sentence of a sort
"If you don't care about the return value of the method, use a for loop.
for obj in mylist: obj.method()
"

[mdickinson]

This is an antipattern I've seen on multiple occasions in real code. A common offender is:

[worker.join() for worker in workers]

Similarly, things like:

[plugin.start() for plugin in plugins]

I do think it would be worth updating the FAQ text.

[mdickinson]

However, the list comprehension pattern is not as bad as lines like this one [#1]:

map(lambda plugin: self.start_plugin(plugin), self._plugins)

... which of course stopped working as soon as we transitioned to Python 3. :-(

[#1] https://github.com/enthought/envisage/blob/b7adb8793336dd3859623cb89bcc7bdfefe91b29/enthought/envisage/plugin_manager.py#L105