Skip to contentSkip to conversation

iotests: Fix pylint warnings

PATCH In review Hanna Reitz 4 participants 7 messages Aug 24, 2021 – Sep 15, 2021

lore
Share & tools
lore
#0 lore raw

cover iotests: Fix pylint warnings

Hi,

I’ve updated my pylint to 2.10.2 and was greeted with some new warnings. Some are fixed by John’s “Run iotest linters during Python CI” series
(https://lists.nongnu.org/archive/html/qemu-block/2021-07/msg00611.html),
but some are not (namely unspecified-encoding, use-list-literal, and use-dict-literal). This series cleans up that rest.

Hanna Reitz (2):
iotests: Fix unspecified-encoding pylint warnings
iotests: Fix use-{list,dict}-literal warnings

 tests/qemu-iotests/297        |  2 +-
 tests/qemu-iotests/iotests.py | 12 +++++++-----
 2 files changed, 8 insertions(+), 6 deletions(-)
Signature · 1 line
2.31.1
#1 lore raw

PATCH 1/2 iotests: Fix unspecified-encoding pylint warnings

As of recently, pylint complains when open() calls are missing an encoding= specified. Everything we have should be UTF-8 (and in fact, everything should be UTF-8, period (exceptions apply)), so use that.

---
 tests/qemu-iotests/297        | 2 +-
 tests/qemu-iotests/iotests.py | 8 +++++---
 2 files changed, 6 insertions(+), 4 deletions(-)
tests/qemu-iotests/297 +1 -1
index 433b732336..0a49953d27 100755
@@ -46,7 +46,7 @@ def is_python_file(filename):
     if filename.endswith('.py'):
         return True
 
-    with open(filename) as f:
+    with open(filename, encoding='utf-8') as f:
         try:
             first_line = f.readline()
             return re.match('^#!.*python', first_line) is not None
tests/qemu-iotests/iotests.py +5 -3
index 4c8971d946..c05c16494b 100644
@@ -610,7 +610,7 @@ def _post_shutdown(self) -> None:
             return
         valgrind_filename =  f"{test_dir}/{self._popen.pid}.valgrind"
         if self.exitcode() == 99:
-            with open(valgrind_filename) as f:
+            with open(valgrind_filename, encoding='utf-8') as f:
                 print(f.read())
         else:
             os.remove(valgrind_filename)
@@ -1120,7 +1120,8 @@ def notrun(reason):
     # Each test in qemu-iotests has a number ("seq")
     seq = os.path.basename(sys.argv[0])
 
-    with open('%s/%s.notrun' % (output_dir, seq), 'w') as outfile:
+    with open('%s/%s.notrun' % (output_dir, seq), 'w', encoding='utf-8') \
+            as outfile:
         outfile.write(reason + '\n')
     logger.warning("%s not run: %s", seq, reason)
     sys.exit(0)
@@ -1134,7 +1135,8 @@ def case_notrun(reason):
     # Each test in qemu-iotests has a number ("seq")
     seq = os.path.basename(sys.argv[0])
 
-    with open('%s/%s.casenotrun' % (output_dir, seq), 'a') as outfile:
+    with open('%s/%s.casenotrun' % (output_dir, seq), 'a', encoding='utf-8') \
+            as outfile:
         outfile.write('    [case not run] ' + reason + '\n')
 
 def _verify_image_format(supported_fmts: Sequence[str] = (),
Signature · 1 line
2.31.1
Reviewed-by on v1 1/2
#2 lore raw

Re: [PATCH 1/2] iotests: Fix unspecified-encoding pylint warnings

Quoted 9 lines · Hanna Reitz

As of recently, pylint complains when open() calls are missing an encoding= specified. Everything we have should be UTF-8 (and in fact, everything should be UTF-8, period (exceptions apply)), so use that.

---
 tests/qemu-iotests/297        | 2 +-
 tests/qemu-iotests/iotests.py | 8 +++++---
 2 files changed, 6 insertions(+), 4 deletions(-)
Reviewed-by
#3 lore raw

Re: [PATCH 1/2] iotests: Fix unspecified-encoding pylint warnings

Quoted 5 lines · Philippe Mathieu-Daudé
Quoted 4 lines · Hanna Reitz

As of recently, pylint complains when open() calls are missing an encoding= specified. Everything we have should be UTF-8 (and in fact, everything should be UTF-8, period (exceptions apply)), so use that.

Quoted 9 lines
Quoted 5 lines
---
 tests/qemu-iotests/297        | 2 +-
 tests/qemu-iotests/iotests.py | 8 +++++---
 2 files changed, 6 insertions(+), 4 deletions(-)

I don't see this upstream just yet, so ...

I'll get around to revisiting my "run the iotest linters on Python CI" thing soon which will flush out anything else that might still be missing.

--js

#4 lore raw

PATCH 2/2 iotests: Fix use-{list,dict}-literal warnings

In reply to Hanna Reitz

pylint proposes using [] instead of list() and {} instead of dict(), because it is faster. That seems simple enough, so heed its advice.

---
 tests/qemu-iotests/iotests.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
tests/qemu-iotests/iotests.py +2 -2
index c05c16494b..8b44e6c437 100644
@@ -702,7 +702,7 @@ def hmp_qemu_io(self, drive: str, cmd: str,
 
     def flatten_qmp_object(self, obj, output=None, basestr=''):
         if output is None:
-            output = dict()
+            output = {}
         if isinstance(obj, list):
             for i, item in enumerate(obj):
                 self.flatten_qmp_object(item, output, basestr + str(i) + '.')
@@ -715,7 +715,7 @@ def flatten_qmp_object(self, obj, output=None, basestr=''):
 
     def qmp_to_opts(self, obj):
         obj = self.flatten_qmp_object(obj)
-        output_list = list()
+        output_list = []
         for key in obj:
             output_list += [key + '=' + obj[key]]
         return ','.join(output_list)
Signature · 1 line
2.31.1
#6 lore raw
In reply to Hanna Reitz
Quoted 7 lines · Hanna Reitz

Hi,

I’ve updated my pylint to 2.10.2 and was greeted with some new warnings. Some are fixed by John’s “Run iotest linters during Python CI” series
(https://lists.nongnu.org/archive/html/qemu-block/2021-07/msg00611.html),
but some are not (namely unspecified-encoding, use-list-literal, and use-dict-literal). This series cleans up that rest.

Thanks for the reviews, applied to my block branch:

https://github.com/XanClic/qemu/commits/block

Hanna