[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v4 04/27] python/aqmp: add asyncio compatibility wrappers
From: |
John Snow |
Subject: |
[PATCH v4 04/27] python/aqmp: add asyncio compatibility wrappers |
Date: |
Wed, 15 Sep 2021 12:29:32 -0400 |
Python 3.6 does not have all of the goodies that Python 3.7 does, and we
need to support both. Add some compatibility wrappers needed for this
purpose.
(Note: Python 3.6 is EOL December 2021.)
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/qemu/aqmp/util.py | 89 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 89 insertions(+)
create mode 100644 python/qemu/aqmp/util.py
diff --git a/python/qemu/aqmp/util.py b/python/qemu/aqmp/util.py
new file mode 100644
index 0000000000..28acd995db
--- /dev/null
+++ b/python/qemu/aqmp/util.py
@@ -0,0 +1,89 @@
+"""
+Miscellaneous Utilities
+
+This module provides asyncio utilities and compatibility wrappers for
+Python 3.6 to provide some features that otherwise become available in
+Python 3.7+.
+"""
+
+import asyncio
+import sys
+from typing import (
+ Any,
+ Coroutine,
+ Optional,
+ TypeVar,
+)
+
+
+T = TypeVar('T')
+
+
+# -------------------------------
+# Section: Compatibility Wrappers
+# -------------------------------
+
+
+def create_task(coro: Coroutine[Any, Any, T],
+ loop: Optional[asyncio.AbstractEventLoop] = None
+ ) -> 'asyncio.Future[T]':
+ """
+ Python 3.6-compatible `asyncio.create_task` wrapper.
+
+ :param coro: The coroutine to execute in a task.
+ :param loop: Optionally, the loop to create the task in.
+
+ :return: An `asyncio.Future` object.
+ """
+ if sys.version_info >= (3, 7):
+ if loop is not None:
+ return loop.create_task(coro)
+ return asyncio.create_task(coro) # pylint: disable=no-member
+
+ # Python 3.6:
+ return asyncio.ensure_future(coro, loop=loop)
+
+
+def is_closing(writer: asyncio.StreamWriter) -> bool:
+ """
+ Python 3.6-compatible `asyncio.StreamWriter.is_closing` wrapper.
+
+ :param writer: The `asyncio.StreamWriter` object.
+ :return: `True` if the writer is closing, or closed.
+ """
+ if sys.version_info >= (3, 7):
+ return writer.is_closing()
+
+ # Python 3.6:
+ transport = writer.transport
+ assert isinstance(transport, asyncio.WriteTransport)
+ return transport.is_closing()
+
+
+async def wait_closed(writer: asyncio.StreamWriter) -> None:
+ """
+ Python 3.6-compatible `asyncio.StreamWriter.wait_closed` wrapper.
+
+ :param writer: The `asyncio.StreamWriter` to wait on.
+ """
+ if sys.version_info >= (3, 7):
+ await writer.wait_closed()
+ return
+
+ # Python 3.6
+ transport = writer.transport
+ assert isinstance(transport, asyncio.WriteTransport)
+
+ while not transport.is_closing():
+ await asyncio.sleep(0)
+
+ # This is an ugly workaround, but it's the best I can come up with.
+ sock = transport.get_extra_info('socket')
+
+ if sock is None:
+ # Our transport doesn't have a socket? ...
+ # Nothing we can reasonably do.
+ return
+
+ while sock.fileno() != -1:
+ await asyncio.sleep(0)
--
2.31.1
- [PATCH v4 00/27] python: introduce Asynchronous QMP package, John Snow, 2021/09/15
- [PATCH v4 01/27] python/aqmp: add asynchronous QMP (AQMP) subpackage, John Snow, 2021/09/15
- [PATCH v4 02/27] python/aqmp: add error classes, John Snow, 2021/09/15
- [PATCH v4 03/27] python/pylint: Add exception for TypeVar names ('T'), John Snow, 2021/09/15
- [PATCH v4 04/27] python/aqmp: add asyncio compatibility wrappers,
John Snow <=
- [PATCH v4 06/27] python/aqmp: add runstate state machine to AsyncProtocol, John Snow, 2021/09/15
- [PATCH v4 05/27] python/aqmp: add generic async message-based protocol support, John Snow, 2021/09/15
- [PATCH v4 07/27] python/aqmp: Add logging utility helpers, John Snow, 2021/09/15
- [PATCH v4 08/27] python/aqmp: add logging to AsyncProtocol, John Snow, 2021/09/15
- [PATCH v4 09/27] python/aqmp: add AsyncProtocol.accept() method, John Snow, 2021/09/15
- [PATCH v4 10/27] python/aqmp: add configurable read buffer limit, John Snow, 2021/09/15
- [PATCH v4 11/27] python/aqmp: add _cb_inbound and _cb_outbound logging hooks, John Snow, 2021/09/15
- [PATCH v4 12/27] python/aqmp: add AsyncProtocol._readline() method, John Snow, 2021/09/15
- [PATCH v4 13/27] python/aqmp: add QMP Message format, John Snow, 2021/09/15
- [PATCH v4 14/27] python/aqmp: add well-known QMP object models, John Snow, 2021/09/15