Ability to pass in options to SuperstaqProvider and Service

cirq-superstaq/cirq_superstaq/service.py

@@ -116,6 +116,7 @@ def __init__(
  api_version: str = gss.API_VERSION,
  max_retry_seconds: int = 3600,
  verbose: bool = False,
+ **kwargs: Any,
  ) -> None:
  """Creates the Service to access Superstaq's API.
 
@@ -142,19 +143,23 @@ def __init__(
  api_version: Version of the api.
  max_retry_seconds: The number of seconds to retry calls for. Defaults to one hour.
  verbose: Whether to print to stdio and stderr on retriable errors.
+ kwargs: Other optimization and execution parameters.
+ - qiskit_pulse: Whether to use Superstaq's pulse-level optimizations for IBMQ
+ devices.
+ - cq_token: Token from CQ cloud.
 
  Raises:
  EnvironmentError: If an API key was not provided and could not be found.
  """
  self.default_target = default_target
-
  self._client = superstaq_client._SuperstaqClient(
  client_name="cirq-superstaq",
  remote_host=remote_host,
  api_key=api_key,
  api_version=api_version,
  max_retry_seconds=max_retry_seconds,
  verbose=verbose,
+ **kwargs,
  )
 
  def _resolve_target(self, target: Union[str, None]) -> str:
@@ -270,7 +275,6 @@ def create_job(
  serialized_circuits = css.serialization.serialize_circuits(circuit)
 
  target = self._resolve_target(target)
-
  result = self._client.create_job(
  serialized_circuits={"cirq_circuits": serialized_circuits},
  repetitions=repetitions,

general-superstaq/general_superstaq/superstaq_client.py

@@ -18,6 +18,7 @@
 import textwrap
 import time
 import urllib
+import warnings
 from typing import Any, Callable, Dict, List, Optional, Union
 
 import qubovert as qv
@@ -48,6 +49,7 @@ def __init__(
  api_version: str = gss.API_VERSION,
  max_retry_seconds: float = 60, # 1 minute
  verbose: bool = False,
+ **kwargs: Any,
  ):
  """Creates the SuperstaqClient.
 
@@ -66,6 +68,10 @@ def __init__(
  which is the most recent version when this client was downloaded.
  max_retry_seconds: The time to continue retriable responses. Defaults to 3600.
  verbose: Whether to print to stderr and stdio any retriable errors that are encountered.
+ kwargs: Other optimization and execution parameters.
+ - qiskit_pulse: Whether to use Superstaq's pulse-level optimizations for IBMQ
+ devices.
+ - cq_token: Token from CQ cloud.
  """
 
  self.api_key = api_key or gss.superstaq_client.find_api_key()
@@ -93,6 +99,7 @@ def __init__(
  "X-Client-Name": self.client_name,
  "X-Client-Version": self.api_version,
  }
+ self._client_kwargs = kwargs
 
  def get_request(self, endpoint: str) -> Any:
  """Performs a GET request on a given endpoint.
@@ -193,12 +200,19 @@ def create_job(
  "target": target,
  "shots": int(repetitions),
  }
-
  if method is not None:
  json_dict["method"] = method
+ if kwargs or self._client_kwargs:
+ json_dict["options"] = json.dumps({**kwargs, **self._client_kwargs})
+ if "cq_token" in json_dict["options"]:
+ warnings.warn(
+ "Starting with client-superstaq v0.4.20, passing in `cq_token` when "
+ "submitting the job won't work. Pass `cq_token` when creating the provider "
+ "or service instead.",
+ DeprecationWarning,
+ stacklevel=2,
+ )
 
- if kwargs:
- json_dict["options"] = json.dumps(kwargs)
  return self.post_request("/jobs", json_dict)
 
  def get_job(self, job_id: str) -> Dict[str, str]:
@@ -213,7 +227,49 @@ def get_job(self, job_id: str) -> Dict[str, str]:
  Raises:
  SuperstaqServerException: For other API call failures.
  """
- return self.get_request(f"/job/{job_id}")
+ warnings.warn(
+ "Starting with client-superstaq v0.4.20, the `get_job` method and "
+ "endpoint won't exist. Call `fetch_jobs` instead.",
+ DeprecationWarning,
+ stacklevel=2,
+ )
+ return self.fetch_jobs([job_id])[0]
+
+ def fetch_jobs(
+ self,
+ job_ids: List[str],
+ tags: Optional[List[str]] = None,
+ targets: Optional[List[str]] = None,
+ **kwargs: Any,
+ ) -> List[Dict[str, str]]:
+ """Get the job from the Superstaq API.
+
+ Args:
+ job_ids: The UUID of the job (returned when the job was created).
+ tags: optional tags of jobs
+ targets: optional targets of jobs
+ kwargs: Extra options needed to fetch jobs.
+ - cq_token: CQ Cloud credentials.
+
+ Returns:
+ The json body of the response as a dict.
+
+ Raises:
+ SuperstaqServerException: For other API call failures.
+ """
+
+ json_dict: Dict[str, Any] = {
+ "job_ids": job_ids,
+ }
+
+ if tags:
+ json_dict["tags"] = tags
+ if targets:
+ json_dict["targets"] = targets
+ if kwargs or self._client_kwargs:
+ json_dict["options"] = json.dumps({**kwargs, **self._client_kwargs})
+
+ return self.post_request("/fetch_jobs", json_dict)
 
  def get_balance(self) -> Dict[str, float]:
  """Get the querying user's account balance in USD.

general-superstaq/general_superstaq/superstaq_client_test.py

@@ -152,21 +152,26 @@ def test_supertstaq_client_create_job(mock_post: mock.MagicMock) -> None:
  remote_host="http://example.com",
  api_key="to_my_heart",
  )
- response = client.create_job(
- serialized_circuits={"Hello": "World"},
- repetitions=200,
- target="ss_example_qpu",
- method="dry-run",
- qiskit_pulse=True,
- )
+
+ with pytest.warns(DeprecationWarning):
+ response = client.create_job(
+ serialized_circuits={"Hello": "World"},
+ repetitions=200,
+ target="ss_example_qpu",
+ method="dry-run",
+ qiskit_pulse=True,
+ cq_token={"@type": "RefreshFlowState", "access_token": "123"},
+ )
  assert response == {"foo": "bar"}
 
  expected_json = {
  "Hello": "World",
  "target": "ss_example_qpu",
  "shots": 200,
  "method": "dry-run",
- "options": json.dumps({"qiskit_pulse": True}),
+ "options": json.dumps(
+ {"qiskit_pulse": True, "cq_token": {"@type": "RefreshFlowState", "access_token": "123"}}
+ ),
  }
  mock_post.assert_called_with(
  f"http://example.com/{API_VERSION}/jobs",
@@ -287,20 +292,29 @@ def test_superstaq_client_create_job_json(mock_post: mock.MagicMock) -> None:
  )
 
 
-@mock.patch("requests.get")
-def test_superstaq_client_get_job(mock_get: mock.MagicMock) -> None:
- mock_get.return_value.ok = True
- mock_get.return_value.json.return_value = {"foo": "bar"}
+@mock.patch("requests.post")
+def test_superstaq_client_fetch_jobs(mock_post: mock.MagicMock) -> None:
+ mock_post.return_value.ok = True
+ mock_post.return_value.json.return_value = [{"foo": "bar"}]
  client = gss.superstaq_client._SuperstaqClient(
  client_name="general-superstaq",
  remote_host="http://example.com",
  api_key="to_my_heart",
  )
- response = client.get_job(job_id="job_id")
- assert response == {"foo": "bar"}
-
- mock_get.assert_called_with(
- f"http://example.com/{API_VERSION}/job/job_id", headers=EXPECTED_HEADERS, verify=False
+ response = client.fetch_jobs(
+ job_ids=["job_id"], tags=["tag"], targets=["targets"], cq_token="token"
+ )
+ assert response == [{"foo": "bar"}]
+ mock_post.assert_called_with(
+ f"http://example.com/{API_VERSION}/fetch_jobs",
+ json={
+ "job_ids": ["job_id"],
+ "tags": ["tag"],
+ "targets": ["targets"],
+ "options": '{"cq_token": "token"}',
+ },
+ headers=EXPECTED_HEADERS,
+ verify=False,
  )
 
 
@@ -451,10 +465,10 @@ def test_superstaq_client_get_targets(mock_get: mock.MagicMock) -> None:
  )
 
 
-@mock.patch("requests.get")
-def test_superstaq_client_get_job_unauthorized(mock_get: mock.MagicMock) -> None:
- mock_get.return_value.ok = False
- mock_get.return_value.status_code = requests.codes.unauthorized
+@mock.patch("requests.post")
+def test_superstaq_client_get_job_unauthorized(mock_post: mock.MagicMock) -> None:
+ mock_post.return_value.ok = False
+ mock_post.return_value.status_code = requests.codes.unauthorized
 
  client = gss.superstaq_client._SuperstaqClient(
  client_name="general-superstaq",
@@ -465,10 +479,10 @@ def test_superstaq_client_get_job_unauthorized(mock_get: mock.MagicMock) -> None
  _ = client.get_job("job_id")
 
 
-@mock.patch("requests.get")
-def test_superstaq_client_get_job_not_found(mock_get: mock.MagicMock) -> None:
- (mock_get.return_value).ok = False
- (mock_get.return_value).status_code = requests.codes.not_found
+@mock.patch("requests.post")
+def test_superstaq_client_get_job_not_found(mock_post: mock.MagicMock) -> None:
+ (mock_post.return_value).ok = False
+ (mock_post.return_value).status_code = requests.codes.not_found
 
  client = gss.superstaq_client._SuperstaqClient(
  client_name="general-superstaq",
@@ -479,10 +493,10 @@ def test_superstaq_client_get_job_not_found(mock_get: mock.MagicMock) -> None:
  _ = client.get_job("job_id")
 
 
-@mock.patch("requests.get")
-def test_superstaq_client_get_job_not_retriable(mock_get: mock.MagicMock) -> None:
- mock_get.return_value.ok = False
- mock_get.return_value.status_code = requests.codes.bad_request
+@mock.patch("requests.post")
+def test_superstaq_client_get_job_not_retriable(mock_post: mock.MagicMock) -> None:
+ mock_post.return_value.ok = False
+ mock_post.return_value.status_code = requests.codes.bad_request
 
  client = gss.superstaq_client._SuperstaqClient(
  client_name="general-superstaq",
@@ -493,11 +507,11 @@ def test_superstaq_client_get_job_not_retriable(mock_get: mock.MagicMock) -> Non
  _ = client.get_job("job_id")
 
 
-@mock.patch("requests.get")
-def test_superstaq_client_get_job_retry(mock_get: mock.MagicMock) -> None:
+@mock.patch("requests.post")
+def test_superstaq_client_get_job_retry(mock_post: mock.MagicMock) -> None:
  response1 = mock.MagicMock()
  response2 = mock.MagicMock()
- mock_get.side_effect = [response1, response2]
+ mock_post.side_effect = [response1, response2]
  response1.ok = False
  response1.status_code = requests.codes.service_unavailable
  response2.ok = True
@@ -507,7 +521,7 @@ def test_superstaq_client_get_job_retry(mock_get: mock.MagicMock) -> None:
  api_key="to_my_heart",
  )
  _ = client.get_job("job_id")
- assert mock_get.call_count == 2
+ assert mock_post.call_count == 2
 
 
 @mock.patch("requests.post")

qiskit-superstaq/qiskit_superstaq/superstaq_provider.py

@@ -47,6 +47,7 @@ def __init__(
  api_version: str = gss.API_VERSION,
  max_retry_seconds: int = 3600,
  verbose: bool = False,
+ **kwargs: Any,
  ) -> None:
  """Initializes a SuperstaqProvider.
 
@@ -83,6 +84,7 @@ def __init__(
  api_version=api_version,
  max_retry_seconds=max_retry_seconds,
  verbose=verbose,
+ **kwargs,
  )
 
  def __str__(self) -> str: