Return a single results object instead of always a list - IonQ

[splch]

ionq results api can return a list of results or a single result, so this change allows for either a list or single element to be returned from the results endpoint

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.56%. Comparing base (c3e676c) to head (747749b).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7285      +/-   ##
==========================================
- Coverage   99.57%   99.56%   -0.01%     
==========================================
  Files        1102     1102              
  Lines       98434    98510      +76     
==========================================
+ Hits        98014    98085      +71     
- Misses        420      425       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[Cynocracy]

can you add a test for the correctness of the order of multiple results being returned?

[mhucka]

@splch Thank you for this work!

Could you let us know the status of this? For example, there was the comment from @Cynocracy to add a test, but it's not immediately clear if that was resolved.

[Cynocracy]

The new run batch preserves order test covers what I was hoping for :) lgtm

[dstrain115]

Will this cause any backwards incompatibility for programs people have already written?

[Cynocracy]

@dstrain115 this is a good question. The answer is unfortunately yes, but it's attempting to revert a change in interface caused by #6652 (which made it so that jobs that previously returned a single Result were returning an Iterable of them). FWIW, I am conflicted on whether it makes sense to change back, as imo, both changes are somewhat burdensome to users.

[mhucka]

@dstrain115 this is a good question. The answer is unfortunately yes, but it's attempting to revert a change in interface caused by #6652 (which made it so that jobs that previously returned a single Result were returning an Iterable of them). FWIW, I am conflicted on whether it makes sense to change back, as imo, both changes are somewhat burdensome to users.

Is there a way to consult users (perhaps some especially major users) and ask them for their input? (I guess this is a question for @Cynocracy )

[mhucka]

@splch there were some test failures in CI; these might have been due to some changes in Cirq since the PR was originally submitted. I tried to fix them, and took the liberty of pushing the changes to your PR branch in an effort to help make up for lost time. Hopefully it's correct. Please feel free to make any changes necessary.

[mhucka]

LGTM, but please check if you agree with the changes I made (and feel free to make any corrections).

[splch]

That looks great thank you @mhucka! I appreciate the help making the linter happy :) I'm happy to get this PR merged whenever y'all are ready