icesat2py/icepyx

add page size checks for sync/async request mode

Open

#243 opened on Nov 9, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (119 forks)auto 404
IS2HW_2022good first issue

Repository metrics

Stars
 (256 stars)
PR merge metrics
 (PR metrics pending)

Description

There's still a reference to using a smaller page size in examples/examples/ICESat-2_DAAC_DataAccess_Example.ipynb because it refers to synchronous requests. Note that this notebook indicates that synchronous requests are done by default, but I think this must be outdated. It looks like the request mode is async by default (https://github.com/icesat2py/icepyx/blob/development/icepyx/core/APIformatting.py#L446).

Given that the page size limit is only 100 when the request mode is synchronous, maybe we need another check somewhere that decreases the page size when a user overrides that default and uses synchronous mode?

Originally posted by @trey-stafford in https://github.com/icesat2py/icepyx/issues/239#issuecomment-963612931

Contributor guide

Research direction
Investigate the APIformatting.py file around line 446 to understand how the request mode is set. Then, implement a check that reduces the page size to 100 when synchronous mode is used, and ensure the change is reflected in examples.
Tech stack
python
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Pythonsync/async programming
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65