Skip to content
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.

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

Implement high level helper functions for asynchronous APIs #69

Open
dspruell-s01 opened this issue Jun 7, 2021 · 0 comments
Open

Implement high level helper functions for asynchronous APIs #69

dspruell-s01 opened this issue Jun 7, 2021 · 0 comments

Comments

@dspruell-s01
Copy link

The API server implements several asynchronous APIs that require users to submit job, poll for status, and finally fetch results. It would be logical and would help fulfill the purpose of the Python SDK as a high level client to expose helper methods that support handling these asynchronous backend jobs smoothly. The goal would be for a single call to handle necessary functionality:

  1. Submit job
  2. Poll for completion
  3. Return results

Support should allow for some specification by user of things like poll period, maximum number of tries/timeout, etc. The higher level methods could then signal situations like timeouts and failures with exceptions or similar.

The outcome would be higher level support in the SDK that smooths out the user experience and enables simpler client code without the need to add in so much polling and retry logic, etc.

Similar ideas have been proposed in #3 and #32.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant