qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: Kevin Wolf <kwolf@redhat.com>,
	ehabkost@redhat.com, qemu-block@nongnu.org, philmd@redhat.com,
	armbru@redhat.com, Max Reitz <mreitz@redhat.com>,
	John Snow <jsnow@redhat.com>
Subject: [PATCH v9 08/14] iotests: touch up log function signature
Date: Tue, 24 Mar 2020 19:20:57 -0400	[thread overview]
Message-ID: <20200324232103.4195-9-jsnow@redhat.com> (raw)
In-Reply-To: <20200324232103.4195-1-jsnow@redhat.com>

Representing nested, recursive data structures in mypy is notoriously
difficult; the best we can reliably do right now is denote the atom
types as "Any" while describing the general shape of the data.

Regardless, this fully annotates the log() function.

Typing notes:

TypeVar is a Type variable that can optionally be constrained by a
sequence of possible types. This variable is bound per-invocation such
that the signature for filter=() requires that its callables take e.g. a
str and return a str.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 tests/qemu-iotests/iotests.py | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py
index c93c6b4557..3a049ece5b 100644
--- a/tests/qemu-iotests/iotests.py
+++ b/tests/qemu-iotests/iotests.py
@@ -28,6 +28,7 @@
 import struct
 import subprocess
 import sys
+from typing import (Any, Callable, Dict, Iterable, List, Optional, TypeVar)
 import unittest
 
 # pylint: disable=import-error, wrong-import-position
@@ -353,9 +354,16 @@ def _filter(_key, value):
         return value
     return filter_qmp(qmsg, _filter)
 
-def log(msg, filters=(), indent=None):
-    '''Logs either a string message or a JSON serializable message (like QMP).
-    If indent is provided, JSON serializable messages are pretty-printed.'''
+
+Msg = TypeVar('Msg', Dict[str, Any], List[Any], str)
+
+def log(msg: Msg,
+        filters: Iterable[Callable[[Msg], Msg]] = (),
+        indent: Optional[int] = None) -> None:
+    """
+    Logs either a string message or a JSON serializable message (like QMP).
+    If indent is provided, JSON serializable messages are pretty-printed.
+    """
     for flt in filters:
         msg = flt(msg)
     if isinstance(msg, (dict, list)):
-- 
2.21.1



  parent reply	other threads:[~2020-03-24 23:27 UTC|newest]

Thread overview: 39+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-24 23:20 [PATCH v9 00/14] iotests: use python logging John Snow
2020-03-24 23:20 ` [PATCH v9 01/14] iotests: do a light delinting John Snow
2020-03-30 14:39   ` Markus Armbruster
2020-03-30 17:28     ` John Snow
2020-03-30 15:41   ` Kevin Wolf
2020-03-30 17:25     ` John Snow
2020-03-24 23:20 ` [PATCH v9 02/14] iotests: don't use 'format' for drive_add John Snow
2020-03-24 23:20 ` [PATCH v9 03/14] iotests: ignore import warnings from pylint John Snow
2020-03-24 23:20 ` [PATCH v9 04/14] iotests: replace mutable list default args John Snow
2020-03-24 23:20 ` [PATCH v9 05/14] iotests: add pylintrc file John Snow
2020-03-30 14:45   ` Markus Armbruster
2020-03-30 17:35     ` John Snow
2020-03-30 15:49   ` Kevin Wolf
2020-03-30 18:10     ` John Snow
2020-03-24 23:20 ` [PATCH v9 06/14] iotests: alphabetize standard imports John Snow
2020-03-30 12:10   ` Max Reitz
2020-03-24 23:20 ` [PATCH v9 07/14] iotests: drop pre-Python 3.4 compatibility code John Snow
2020-03-30 12:12   ` Max Reitz
2020-03-24 23:20 ` John Snow [this message]
2020-03-30 12:28   ` [PATCH v9 08/14] iotests: touch up log function signature Max Reitz
2020-03-30 17:43     ` John Snow
2020-03-30 16:19   ` Kevin Wolf
2020-03-30 18:31     ` John Snow
2020-03-24 23:20 ` [PATCH v9 09/14] iotests: limit line length to 79 chars John Snow
2020-03-30 12:31   ` Max Reitz
2020-03-30 12:34     ` Max Reitz
2020-03-30 19:19       ` John Snow
2020-03-24 23:20 ` [PATCH v9 10/14] iotests: add hmp helper with logging John Snow
2020-03-30 12:44   ` Max Reitz
2020-03-30 16:27   ` Kevin Wolf
2020-03-24 23:21 ` [PATCH v9 11/14] iotests: add script_initialize John Snow
2020-03-24 23:21 ` [PATCH v9 12/14] iotest 258: use script_main John Snow
2020-03-24 23:21 ` [PATCH v9 13/14] iotests: Mark verify functions as private John Snow
2020-03-30 16:32   ` Kevin Wolf
2020-03-24 23:21 ` [PATCH v9 14/14] iotests: use python logging for iotests.log() John Snow
2020-03-30 13:00 ` [PATCH v9 00/14] iotests: use python logging Max Reitz
2020-03-30 19:41   ` John Snow
2020-03-30 19:03 ` John Snow
2020-03-31 12:15   ` Kevin Wolf

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200324232103.4195-9-jsnow@redhat.com \
    --to=jsnow@redhat.com \
    --cc=armbru@redhat.com \
    --cc=ehabkost@redhat.com \
    --cc=kwolf@redhat.com \
    --cc=mreitz@redhat.com \
    --cc=philmd@redhat.com \
    --cc=qemu-block@nongnu.org \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).