Regenerate QuantumEngineService gRPC client libraries with GAPIC #7500

hoisinberg · 2025-07-16T22:02:07Z

This PR contains changes made by re-running the GAPIC code generators for the QuantumEngineService, using the Google-internal proto definitions as input. Generated changes include:

REST-based RPC transport in addition to gRPC
A new RPC method QuantumEngineService.GetQuantumProcessorConfig, along with the associated request and response objects
Field renaming whitelisted_users -> allowlisted_users
Updated type hints

In addition to the automated tests, I also verified that the updated RPC clients work by creating a colab which used the updated cirq_google library to send jobs to the production QuantumEngineService.

codecov · 2025-07-17T03:31:28Z

Codecov Report

Attention: Patch coverage is 57.30570% with 412 lines in your changes missing coverage. Please review.

Project coverage is 97.53%. Comparing base (3031b1f) to head (09ff1d5).
Report is 4 commits behind head on main.

Files with missing lines	Patch %	Lines
...ces/quantum_engine_service/transports/rest_base.py	47.79%	249 Missing ⚠️
...v1alpha1/services/quantum_engine_service/pagers.py	6.49%	72 Missing ⚠️
.../quantum_engine_service/transports/grpc_asyncio.py	29.50%	43 Missing ⚠️
...services/quantum_engine_service/transports/grpc.py	27.77%	39 Missing ⚠️
...services/quantum_engine_service/transports/base.py	59.09%	9 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7500      +/-   ##
==========================================
- Coverage   98.68%   97.53%   -1.15%     
==========================================
  Files        1093     1095       +2     
  Lines       97112    98934    +1822     
==========================================
+ Hits        95837    96498     +661     
- Misses       1275     2436    +1161

☔ 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.

review-notebook-app · 2025-07-17T04:09:13Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

hoisinberg · 2025-07-17T18:42:25Z

The regenerated RPC clients were additionally tested locally with a colab which successfully sent jobs to the production QuantumEngineService and retrieved results.

mhucka · 2025-07-18T16:13:11Z

@hoisinberg Thank you for this work. Some best-practices related requests:

Please avoid splitting titles mid-word. It's best if PR and issue titles are self-contained, so that someone reading long lists of them (dozens or hundreds) can figure out more or less what they will do.
As a general rule, good PR titles take the form of phrases written in an imperative style that starts with an action verb. E.g.: "Allow users to run readout benchmarking with sweep", "Support creating foobar objects in the Biftastic module", etc.
Please add a more comprehensive description to this PR. Descriptions should explain the context, the purpose of the pull request, and the effects of the PR. As it stands, reviewers will have no idea what this particular PR is about.

Sorry for the hassle!

mhucka · 2025-07-18T16:14:17Z

Additionally tested locally with a colab which sent jobs to the production QuantumEngineService and retrieved results.

Is this a comment about what the PR does, or an instruction to maintainers, or something else?

pavoljuhas · 2025-07-18T20:38:20Z

cirq-google/cirq_google/cloud/quantum/__init__.py

+from cirq_google.cloud.quantum import gapic_version as package_version
+
+__version__ = package_version.__version__
+


Is this generated or written? If written consider taking it out. The gapic_version.__version__ is currently a placeholder at 0.0.0 so there is no information.

Also this module is a part of the cirq-google package which has its own version at cirq_google.__version__. I don't see a reason to define and maintain a separate version value here.

It is generated, though I can update that version number if you like. Perhaps to have it reference cirq_google.__version__?

Please delete it. It is not there in the main so there is no way any code needs it.

pavoljuhas · 2025-07-18T20:54:35Z

dev_tools/notebooks/isolated_notebook_test.py

+    # temporary: allow name changes of keyword arguments in quantum engine interfaces to stabilize
+    'docs/simulate/virtual_engine_interface.ipynb',


Make sure to do a follow-up PR where this is moved to the NOTEBOOKS_DEPENDING_ON_UNRELEASED_FEATURES list above. Also, it would be better to leave the updates of concepts.ipynb and virtual_engine_interface.ipynb for that PR, so they would not be mixed up with generated code.

Unfortunately these notebook tests would fail without the updates I added. I've assigned myself this issue for the follow-up PR.

pavoljuhas · 2025-07-18T21:00:33Z

cirq-google/cirq_google/engine/abstract_local_processor.py

        start_time: datetime.datetime,
        end_time: datetime.datetime,
-        whitelisted_users: list[str] | None = None,
+        allowlisted_users: list[str] | None = None,


Can we deprecate the old argument name instead?

If this is a generated code or if you are sure this is basically unused, it is OK to keep it as is. In general the preferred way of changing argument name is to support the old argument with a DeprecationWarning and delete it in a second-next release.

PS: Please see the deprecated_parameter decorator to help with that.

This argument here is not auto-generated, however later in this function (line 262) it is copied into the allowlisted_users field of a QuantumReservation proto. That field was renamed from whitelisted_users in 2023 and it looks like this is the first time anyone has attempted to publish that change to cirq-google. Since QuantumReservation.whitelisted_users has already been gone for so long and users have not encountered issues, I believe this change should be safe.

pavoljuhas

If feasible, please deprecate instead of remove the whitelisted_users argument. Also please see inline suggestions.

hoisinberg · 2025-07-20T19:01:23Z

Is the code in this PR entirely generated or are there some manual changes too?

If there are some manual changes, the best is to split it to 2 commits, the first with the generated output and a second one with manual changes. This would make it easier to review just the manually-written part as it is not the best use of time to check a generated code.

Also as a general rule, when you update your PRs (especially after requesting a review) please just add new commits instead of amending and force-pushing. It will make it easier to see changes w/r to the last round of review. Also to sync with main, please just do a merge commit instead of a rebase-on-main.

The Cirq PRs are squashed to a single commit when merged to the main, but it is still useful to have a more detailed history in PR commits. (These are BTW available from the repo at refs/pull/7500/head)

It is nearly all auto-generated. The only manual changes I added were to address CI breakages:

The linter generated 1400 errors, ~1100 of which were auto-fixed by the linter itself. The remaining 300 or so were all "line too long" complaints which I corrected myself.
Renaming "whitelisted_users" to "allowlisted_users" throughout the library. This is because the corresponding field on the QuantumReservation proto was also renamed from "whitelisted_users" to "allowlisted_users" so attempts to set the now non-existent proto field was causing errors. The internal proto change has been live since 2023 and hasn't caused any breakages for our users, I believe the renaming is safe.
Updating the failing notebook tests.

…n__ where needed

Add deprecation warning to `create_reservation` and `update_reservation`.

Add deprecation warning to `create_reservation_async` and `update_reservation_async`.

Add deprecation warning to `create_reservation` and `update_reservation`.

* Deprecate whitelisted_users in the AbstractLocalProcessor class * Deprecate whitelisted_users in the EngineClient class * Deprecate whitelisted_users in the EngineProcessor class * Address mypy warning on untyped functions

pavoljuhas

I have added deprecation support for the old whitelisted_users arguments in the manually written classes, which should be less disruptive for possible users (09ff1d5).

LGTM on my part. I am holding on with merge in case you have some comments or suggestions.

…on unreleased features (#7528) Closes #7517 Follow up to #7500, which listed this notebook in `SKIP_NOTEBOOKS` in order to get past CI breakages due to the fact that the notebook tests install the fully-released version of Cirq. Once the parameter renaming is released, this can be removed.

…7527) #7500 modified the `quantum_run_stream` method definition by changing the `timeout` argument from `timeout: float | None = None` to `timeout: float | object = gapic_v1.method.DEFAULT`. Setting `timeout=None` is interpreted as having no timeout at all, whereas `timeout=gapic_v1.method.DEFAULT` uses the framework-supplied default value of 60s. For bidirectional streams, the `timeout` is used to set the lifetime of the entire stream, causing batches of jobs which cumulatively take more than 60s to fail with `DEADLINE_EXCEEDED` errors. This change sets `timout=None` explicitly, restoring the behavior previously obtained via the default argument.

hoisinberg requested review from a team, verult, vtomole and wcourtney as code owners July 16, 2025 22:02

github-actions bot added the size: XL lines changed >1000 label Jul 16, 2025

hoisinberg marked this pull request as draft July 16, 2025 23:03

hoisinberg force-pushed the u/hoisinberg/get-quantum-processor-config branch 5 times, most recently from 4b927e3 to f810bb0 Compare July 17, 2025 03:17

hoisinberg force-pushed the u/hoisinberg/get-quantum-processor-config branch 2 times, most recently from ce89603 to 02a62fb Compare July 17, 2025 04:09

hoisinberg force-pushed the u/hoisinberg/get-quantum-processor-config branch 6 times, most recently from 8043d44 to 7fa76b0 Compare July 17, 2025 17:35

hoisinberg marked this pull request as ready for review July 17, 2025 17:39

hoisinberg self-assigned this Jul 17, 2025

hoisinberg force-pushed the u/hoisinberg/get-quantum-processor-config branch 3 times, most recently from 9c36fd9 to 2470042 Compare July 17, 2025 21:58

hoisinberg force-pushed the u/hoisinberg/get-quantum-processor-config branch from 2470042 to a7028de Compare July 18, 2025 17:50

pavoljuhas reviewed Jul 18, 2025

View reviewed changes

pavoljuhas requested changes Jul 18, 2025

View reviewed changes

hoisinberg mentioned this pull request Jul 20, 2025

Move docs/simulate/virtual_engine_interface.ipynb to NOTEBOOKS_DEPENDING_ON_UNRELEASED_FEATURES #7517

Closed

hoisinberg requested a review from pavoljuhas July 21, 2025 20:03

hoisinberg and others added 7 commits July 21, 2025 19:49

Remove gapic_version.py everywhere and subistute cirq_google.__versio…

99b7452

…n__ where needed

Merge branch 'main' into u/hoisinberg/get-quantum-processor-config

38df9a4

Deprecate whitelisted_users in the AbstractLocalProcessor class

e994cf8

Add deprecation warning to `create_reservation` and `update_reservation`.

Deprecate whitelisted_users in the EngineClient class

55a30cb

Add deprecation warning to `create_reservation_async` and `update_reservation_async`.

Deprecate whitelisted_users in the EngineProcessor class

17bb52d

Add deprecation warning to `create_reservation` and `update_reservation`.

Address mypy warning on untyped functions

3ac1951

Merge branch 'amend-7500-deprecate-whitelisted_users'

09ff1d5

* Deprecate whitelisted_users in the AbstractLocalProcessor class * Deprecate whitelisted_users in the EngineClient class * Deprecate whitelisted_users in the EngineProcessor class * Address mypy warning on untyped functions

pavoljuhas approved these changes Jul 22, 2025

View reviewed changes

pavoljuhas added the priority/before-1.6 Finish before the Cirq 1.6 release label Jul 22, 2025

pavoljuhas added this pull request to the merge queue Jul 22, 2025

Merged via the queue into main with commit 86b38ab Jul 22, 2025
37 of 39 checks passed

pavoljuhas deleted the u/hoisinberg/get-quantum-processor-config branch July 22, 2025 17:28

pavoljuhas mentioned this pull request Jul 22, 2025

Amend 7500 - deprecate whitelisted_users API argument #7524

Closed

This was referenced Jul 22, 2025

Restore behavior which persists quantum_run_streams indefinitely #7527

Merged

Indicate that docs/simulate/virtual_engine_interface.ipynb depends on unreleased features #7528

Merged

This was referenced Aug 5, 2025

Add a new transformer that performs random pauli insertion #7558

Open

update the RB fitting method to compensate for the standard deviation induced from the random number generator #7562

Merged

NoureldinYosri mentioned this pull request Sep 11, 2025

Create a gauge for idle moments #7648

Merged

NoureldinYosri mentioned this pull request Sep 25, 2025

fix bug in idle moments gauge #7669

Merged

NoureldinYosri mentioned this pull request Oct 21, 2025

Remove xfail from QSD tests #7712

Merged

		from cirq_google.cloud.quantum import gapic_version as package_version

		__version__ = package_version.__version__

		# temporary: allow name changes of keyword arguments in quantum engine interfaces to stabilize
		'docs/simulate/virtual_engine_interface.ipynb',

Regenerate QuantumEngineService gRPC client libraries with GAPIC #7500

Regenerate QuantumEngineService gRPC client libraries with GAPIC #7500

Uh oh!

Conversation

hoisinberg commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

review-notebook-app bot commented Jul 17, 2025

Uh oh!

hoisinberg commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mhucka commented Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mhucka commented Jul 18, 2025

Uh oh!

pavoljuhas Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

hoisinberg Jul 20, 2025

Choose a reason for hiding this comment

Uh oh!

pavoljuhas Jul 22, 2025

Choose a reason for hiding this comment

Uh oh!

pavoljuhas Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

hoisinberg Jul 20, 2025

Choose a reason for hiding this comment

Uh oh!

pavoljuhas Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hoisinberg Jul 20, 2025

Choose a reason for hiding this comment

Uh oh!

pavoljuhas left a comment

Choose a reason for hiding this comment

Uh oh!

hoisinberg commented Jul 20, 2025

Uh oh!

pavoljuhas left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

hoisinberg commented Jul 16, 2025 •

edited

Loading

codecov bot commented Jul 17, 2025 •

edited

Loading

hoisinberg commented Jul 17, 2025 •

edited

Loading

mhucka commented Jul 18, 2025 •

edited

Loading

pavoljuhas Jul 18, 2025 •

edited

Loading

pavoljuhas left a comment •

edited

Loading