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

Move AsyncioExecutor to separate file. #6192

Merged
merged 6 commits into from
Jul 26, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions cirq-google/cirq_google/engine/asyncio_executor.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Copyright 2023 The Cirq Developers
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from typing import Awaitable, Callable, TypeVar
from typing_extensions import ParamSpec
import threading

import asyncio
import duet


R = TypeVar('R')
P = ParamSpec("P")


class AsyncioExecutor:
"""Runs asyncio coroutines in a thread, exposes the results as duet futures.

This lets us bridge between an asyncio event loop (which is what async grpc
code uses) and duet (which is what cirq uses for asynchrony).
"""

def __init__(self) -> None:
loop_future: duet.AwaitableFuture[asyncio.AbstractEventLoop] = duet.AwaitableFuture()
thread = threading.Thread(target=asyncio.run, args=(self._main(loop_future),), daemon=True)
thread.start()
self.loop = loop_future.result()

@staticmethod
async def _main(loop_future: duet.AwaitableFuture) -> None:
loop = asyncio.get_running_loop()
loop_future.set_result(loop)
while True:
await asyncio.sleep(1)

def submit(
self, func: Callable[P, Awaitable[R]], *args: P.args, **kwargs: P.kwargs
) -> duet.AwaitableFuture[R]:
"""Dispatch the given function to be run in an asyncio coroutine.

Args:
func: asyncio function which will be run in a separate thread.
Will be called with *args and **kw and should return an asyncio
awaitable.
*args: Positional args to pass to func.
**kwargs: Keyword args to pass to func.
"""
future = asyncio.run_coroutine_threadsafe(func(*args, **kwargs), self.loop)
return duet.AwaitableFuture.wrap(future)

_instance: 'AsyncioExecutor' = None
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: should be Optional['AsyncioExecutor']


@classmethod
def instance(cls) -> 'AsyncioExecutor':
"""Returns a singleton AsyncioExecutor shared globally."""
if cls._instance is None:
cls._instance = cls()
return cls._instance
49 changes: 3 additions & 46 deletions cirq-google/cirq_google/engine/engine_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.

import asyncio
import datetime
import sys
import threading
from typing import (
AsyncIterable,
Awaitable,
Expand All @@ -39,6 +37,7 @@

from cirq._compat import cached_property
from cirq_google.cloud import quantum
from cirq_google.engine.asyncio_executor import AsyncioExecutor

_M = TypeVar('_M', bound=proto.Message)
_R = TypeVar('_R')
Expand All @@ -53,48 +52,6 @@ def __init__(self, message):
RETRYABLE_ERROR_CODES = [500, 503]


class AsyncioExecutor:
"""Runs asyncio coroutines in a thread, exposes the results as duet futures.

This lets us bridge between an asyncio event loop (which is what async grpc
code uses) and duet (which is what cirq uses for asynchrony).
"""

def __init__(self) -> None:
loop_future: duet.AwaitableFuture[asyncio.AbstractEventLoop] = duet.AwaitableFuture()
thread = threading.Thread(target=asyncio.run, args=(self._main(loop_future),), daemon=True)
thread.start()
self.loop = loop_future.result()

@staticmethod
async def _main(loop_future: duet.AwaitableFuture) -> None:
loop = asyncio.get_running_loop()
loop_future.set_result(loop)
while True:
await asyncio.sleep(1)

def submit(self, func: Callable[..., Awaitable[_R]], *args, **kw) -> duet.AwaitableFuture[_R]:
"""Dispatch the given function to be run in an asyncio coroutine.

Args:
func: asyncio function which will be run in a separate thread.
Will be called with *args and **kw and should return an asyncio
awaitable.
*args: Positional args to pass to func.
**kw: Keyword args to pass to func.
"""
future = asyncio.run_coroutine_threadsafe(func(*args, **kw), self.loop)
return duet.AwaitableFuture.wrap(future)

_instance = None

@classmethod
def instance(cls):
if cls._instance is None:
cls._instance = cls()
return cls._instance


class EngineClient:
"""Client for the Quantum Engine API handling protos and gRPC client.

Expand Down Expand Up @@ -277,7 +234,7 @@ async def list_programs_async(
val = _date_or_time_to_filter_expr('created_before', created_before)
filters.append(f"create_time <= {val}")
if has_labels is not None:
for (k, v) in has_labels.items():
for k, v in has_labels.items():
filters.append(f"labels.{k}:{v}")
request = quantum.ListQuantumProgramsRequest(
parent=_project_name(project_id), filter=" AND ".join(filters)
Expand Down Expand Up @@ -528,7 +485,7 @@ async def list_jobs_async(
val = _date_or_time_to_filter_expr('created_before', created_before)
filters.append(f"create_time <= {val}")
if has_labels is not None:
for (k, v) in has_labels.items():
for k, v in has_labels.items():
filters.append(f"labels.{k}:{v}")
if execution_states is not None:
state_filter = []
Expand Down