Improvement to Python example code for aws.ec2.get_instances

[xiongchiamiov]

Problem description

• I saw a product documentation issue on the following URL: https://www.pulumi.com/registry/packages/aws/api-docs/ec2/getinstances/#example-usage

Affected product version(s)

N/A (Or: Python SDK)

Suggestions for a fix

Currently there is this example on the page:

import pulumi
import pulumi_aws as aws

test_instances = aws.ec2.get_instances(instance_tags={
        "Role": "HardWorker",
    },
    filters=[aws.ec2.GetInstancesFilterArgs(
        name="instance.group-id",
        values=["sg-12345678"],
    )],
    instance_state_names=[
        "running",
        "stopped",
    ])
test_eip = []
for range in [{"value": i} for i in range(0, len(test_instances.ids))]:
    test_eip.append(aws.ec2.Eip(f"testEip-{range['value']}", instance=test_instances.ids[range["value"]]))

The last couple lines there took me a while to interpret. The most direct Pythonic translation would be to utilize enumerate:

test_eip = []
for i, instance_id in enumerate(test_instances.ids):
    test_eip.append(aws.ec2.Eip(f"testEip-{i}", instance=instance_id))

Arguably, using a list comprehension would be even more Pythonic, although some folks feel they make things too complex:

test_eip = [aws.ec2.Eip(f"testEip-{i}", instance=instance_id) for i, instance_id in enumerate(test_instances.ids)]

Here's an overall comparison of the approaches, using a mocked simplification of the data, if you find looking at example output helpful:

Python 3.11.5 (main, Aug 24 2023, 15:09:45) [Clang 14.0.3 (clang-1403.0.22.14.1)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> from types import SimpleNamespace
>>> test_instances = SimpleNamespace()
>>> test_instances.ids = ['a', 'b', 'see']
>>> for range in [{"value": i} for i in range(0, len(test_instances.ids))]:
...     print(range['value'], test_instances.ids[range['value']])
...
0 a
1 b
2 see
>>> for i, id in enumerate(test_instances.ids):
...     print(i, id)
...
0 a
1 b
2 see
>>> ['{} {}'.format(i, id) for i, id in enumerate(test_instances.ids)]
['0 a', '1 b', '2 see']
>>> ['{} {}'.format(i, id) for i, id in enumerate([])]
[]

I found the spot in the aws sdk where this is defined, but based on the git blame it seems to be coming from somewhere else and I'm not sure where; after asking about this on the Slack, I was directed to post an issue here. I'm glad to make the actual change if that would be easiest.