Merge branch 'amend-7500-deprecate-whitelisted_users'

* 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

Author: pavoljuhas

cirq-google/cirq_google/cloud/quantum_v1alpha1/services/quantum_engine_service/transports/rest_base.py

@@ -90,7 +90,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {
                     'method': 'post',
@@ -131,7 +131,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {
                     'method': 'post',
@@ -172,7 +172,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {
                     'method': 'post',
@@ -213,7 +213,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {
                     'method': 'post',
@@ -254,7 +254,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {
                     'method': 'post',
@@ -295,7 +295,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {'method': 'delete', 'uri': '/v1alpha1/{name=projects/*/programs/*/jobs/*}'}
             ]
@@ -323,7 +323,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {'method': 'delete', 'uri': '/v1alpha1/{name=projects/*/programs/*}'}
             ]
@@ -351,7 +351,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {
                     'method': 'delete',
@@ -382,7 +382,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {'method': 'get', 'uri': '/v1alpha1/{name=projects/*/processors/*/calibrations/*}'}
             ]
@@ -410,7 +410,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {'method': 'get', 'uri': '/v1alpha1/{name=projects/*/programs/*/jobs/*}'}
             ]
@@ -438,7 +438,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {'method': 'get', 'uri': '/v1alpha1/{name=projects/*/processors/*}'}
             ]
@@ -476,7 +476,7 @@ def _get_unset_required_fields(cls, message_dict):
             }
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {
                     'method': 'get',
@@ -516,7 +516,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {'method': 'get', 'uri': '/v1alpha1/{name=projects/*/programs/*}'}
             ]
@@ -544,7 +544,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {'method': 'get', 'uri': '/v1alpha1/{name=projects/*/processors/*/reservations/*}'}
             ]
@@ -572,7 +572,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {'method': 'get', 'uri': '/v1alpha1/{parent=projects/*/programs/*/jobs/*}/result'}
             ]
@@ -600,7 +600,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {'method': 'get', 'uri': '/v1alpha1/{parent=projects/*/processors/*}/calibrations'}
             ]
@@ -628,7 +628,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {'method': 'get', 'uri': '/v1alpha1/{parent=projects/*/programs/*/jobs/*}/events'}
             ]
@@ -656,7 +656,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {'method': 'get', 'uri': '/v1alpha1/{parent=projects/*/programs/*}/jobs'}
             ]
@@ -684,7 +684,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {'method': 'get', 'uri': '/v1alpha1/{parent=projects/*}/processors'}
             ]
@@ -712,7 +712,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {'method': 'get', 'uri': '/v1alpha1/{parent=projects/*}/programs'}
             ]
@@ -740,7 +740,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {'method': 'get', 'uri': '/v1alpha1/{parent=projects/*}/reservationBudgets'}
             ]
@@ -768,7 +768,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {'method': 'get', 'uri': '/v1alpha1/{parent=projects/*}/reservationGrant'}
             ]
@@ -796,7 +796,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {'method': 'get', 'uri': '/v1alpha1/{parent=projects/*/processors/*}/reservations'}
             ]
@@ -824,7 +824,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {'method': 'get', 'uri': '/v1alpha1/{parent=projects/*/processors/*}/timeSlots'}
             ]
@@ -856,7 +856,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {
                     'method': 'post',
@@ -897,7 +897,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {
                     'method': 'patch',
@@ -938,7 +938,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {
                     'method': 'patch',
@@ -979,7 +979,7 @@ def __hash__(self):  # pragma: NO COVER
             return NotImplementedError("__hash__ must be implemented.")
 
         @staticmethod
-        def _get_http_options():
+        def _get_http_options() -> list[dict[str, str]]:
             http_options: list[dict[str, str]] = [
                 {
                     'method': 'patch',

cirq-google/cirq_google/engine/abstract_local_processor.py

@@ -16,10 +16,11 @@
 
 import abc
 import datetime
-from typing import overload, TYPE_CHECKING
+from typing import Any, overload, TYPE_CHECKING
 
 from google.protobuf.timestamp_pb2 import Timestamp
 
+from cirq import _compat
 from cirq_google.cloud import quantum
 from cirq_google.engine.abstract_processor import AbstractProcessor
 
@@ -47,6 +48,13 @@ def _to_timestamp(union_time: None | datetime.datetime | datetime.timedelta) ->
     return None
 
 
+def _fix_deprecated_allowlisted_users_args(
+    args: tuple[Any, ...], kwargs: dict[str, Any]
+) -> tuple[tuple[Any, ...], dict[str, Any]]:
+    kwargs['allowlisted_users'] = kwargs.pop('whitelisted_users')
+    return args, kwargs
+
+
 class AbstractLocalProcessor(AbstractProcessor):
     """Partial implementation of AbstractProcessor using in-memory objects.
 
@@ -234,6 +242,13 @@ def _is_available(self, time_slot: quantum.QuantumTimeSlot) -> bool:
             return False
         return True
 
+    @_compat.deprecated_parameter(
+        deadline='v1.7',
+        fix='Change whitelisted_users to allowlisted_users.',
+        parameter_desc='whitelisted_users',
+        match=lambda args, kwargs: 'whitelisted_users' in kwargs,
+        rewrite=_fix_deprecated_allowlisted_users_args,
+    )
     def create_reservation(
         self,
         start_time: datetime.datetime,
@@ -281,6 +296,13 @@ def get_reservation(self, reservation_id: str) -> quantum.QuantumReservation | N
         else:
             return None
 
+    @_compat.deprecated_parameter(
+        deadline='v1.7',
+        fix='Change whitelisted_users to allowlisted_users.',
+        parameter_desc='whitelisted_users',
+        match=lambda args, kwargs: 'whitelisted_users' in kwargs,
+        rewrite=_fix_deprecated_allowlisted_users_args,
+    )
     def update_reservation(
         self,
         reservation_id: str,

cirq-google/cirq_google/engine/abstract_local_processor_test.py

@@ -19,6 +19,7 @@
 import pytest
 from google.protobuf.timestamp_pb2 import Timestamp
 
+import cirq
 from cirq_google.cloud import quantum
 from cirq_google.engine.abstract_local_processor import AbstractLocalProcessor
 
@@ -123,6 +124,16 @@ def test_reservations():
     with pytest.raises(ValueError, match='does not exist'):
         p.update_reservation(reservation_id='invalid', allowlisted_users=users)
 
+    day = datetime.timedelta(hours=24)
+    with cirq.testing.assert_deprecated('Change whitelisted_users', deadline='v1.7'):
+        _ = p.create_reservation(
+            start_time=start_reservation + day,
+            end_time=end_reservation + day,
+            whitelisted_users=users,
+        )
+    with cirq.testing.assert_deprecated('Change whitelisted_users', deadline='v1.7'):
+        p.update_reservation(reservation_id=reservation.name, whitelisted_users=users)
+
 
 def test_list_reservations():
     p = NothingProcessor(processor_id='test')