Skip to content

Let Session get clients by name #867

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Mar 15, 2023
Merged

Let Session get clients by name #867

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
3623413
Let Session get clients by name
sgillies Mar 8, 2023
577e22a
Add guidance about Client(session) vs session.client()
sgillies Mar 9, 2023
5882a44
Change to session.client usage
sgillies Mar 14, 2023
7d13359
Remove whitespace
sgillies Mar 14, 2023
67f2116
Switch to session.client usage
sgillies Mar 14, 2023
ca11ada
Appease yapf
sgillies Mar 14, 2023
6c88b93
Appease yapf
sgillies Mar 14, 2023
a6d0ab5
I'm so used to black yapf makes no sense to me :)
sgillies Mar 14, 2023
69eb2c3
Restore assignment of item id lists to variables
sgillies Mar 14, 2023
0762454
Appease yapf
sgillies Mar 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 31 additions & 21 deletions examples/orders_create_and_download_multiple_orders.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import planet

Copy link
Contributor

@kevinlacaille kevinlacaille Mar 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we get rid of the 2020 copyright on line 1?

Copy link
Contributor

@jreiberkyle jreiberkyle Mar 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nope, according to @cholmes investigation, we just add a line above

DOWNLOAD_DIR = os.getenv('TEST_DOWNLOAD_DIR', '.')

iowa_aoi = {
"type":
"Polygon",
Expand All @@ -36,11 +36,18 @@
[-91.198465, 42.893071]]]
}

iowa_images = ['20200925_161029_69_2223', '20200925_161027_48_2223']
iowa_order = planet.order_request.build_request(
'iowa_order',
[planet.order_request.product(iowa_images, 'analytic_udm2', 'PSScene')],
tools=[planet.order_request.clip_tool(iowa_aoi)])
name='iowa_order',
products=[
planet.order_request.product(
item_ids=['20200925_161029_69_2223', '20200925_161027_48_2223'],
product_bundle='analytic_udm2',
item_type='PSScene')
],
Copy link
Contributor Author

@sgillies sgillies Mar 14, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using product()'s keyword arguments makes the calls more understandable and the whole example more instructive.

Copy link
Contributor

@kevinlacaille kevinlacaille Mar 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes it much more readable, thank you!

tools=[
planet.order_request.clip_tool(aoi=iowa_aoi)
]
)

oregon_aoi = {
"type":
Expand All @@ -50,33 +57,36 @@
[-117.558734, 45.229745]]]
}

oregon_images = ['20200909_182525_1014', '20200909_182524_1014']
oregon_order = planet.order_request.build_request(
'oregon_order',
[planet.order_request.product(oregon_images, 'analytic_udm2', 'PSScene')],
tools=[planet.order_request.clip_tool(oregon_aoi)])


async def create_and_download(order_detail, directory, client):
name='oregon_order',
products=[
planet.order_request.product(
item_ids=['20200909_182525_1014', '20200909_182524_1014'],
product_bundle='analytic_udm2',
item_type='PSScene')
],
tools=[
planet.order_request.clip_tool(aoi=oregon_aoi)
]
)


async def create_and_download(client, order_detail, directory):
Copy link
Contributor Author

@sgillies sgillies Mar 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I moved the client argument to the head of the list to make the signature of this function more like that of client.download_order(), where client (aka self) is implicitly the first argument.

"""Place an order, wait for completion, and download assets as a single task."""
with planet.reporting.StateBar(state='creating') as reporter:
# create
order = await client.create_order(order_detail)
reporter.update(state='created', order_id=order['id'])

# wait for completion
await client.wait(order['id'], callback=reporter.update_state)

# download
Copy link
Contributor Author

@sgillies sgillies Mar 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed obvious comments and rolled them up into a docstring.

Copy link
Contributor

@kevinlacaille kevinlacaille Mar 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's do the same thing for the data example.

await client.download_order(order['id'], directory, progress_bar=True)


async def main():
async with planet.Session() as ps:
client = planet.OrdersClient(ps)

async with planet.Session() as sess:
client = sess.client('orders')
await asyncio.gather(
create_and_download(iowa_order, DOWNLOAD_DIR, client),
create_and_download(oregon_order, DOWNLOAD_DIR, client),
create_and_download(client, iowa_order, DOWNLOAD_DIR),
Copy link
Contributor Author

@sgillies sgillies Mar 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment above.

create_and_download(client, oregon_order, DOWNLOAD_DIR),
)


Expand Down