Skip to contentSkip to conversation

kunit: tool: Assert version requirement

PATCH Superseded SeongJae Park 4 participants 12 messages Jun 16, 2021 – Jul 12, 2021

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 kunit: tool: Assert version requirement

From: SeongJae Park <[email protected]>

Commit 87c9c1631788 ("kunit: tool: add support for QEMU") on the 'next' tree adds 'from __future__ import annotations' in 'kunit_kernel.py'. Because it is supported on only >=3.7 Python, people using older Python will get below error:

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 20, in <module>
import kunit_kernel
File "/home/sjpark/linux/tools/testing/kunit/kunit_kernel.py", line 9
from __future__ import annotations
^
SyntaxError: future feature annotations is not defined

This commit adds a version assertion in 'kunit.py', so that people get more explicit error message like below:

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 15, in <module>
assert sys.version_info >= (3, 7)
AssertionError

---
 tools/testing/kunit/kunit.py | 2 ++
 1 file changed, 2 insertions(+)
tools/testing/kunit/kunit.py +2 -0
index be8d8d4a4e08..748d88178506 100755
@@ -12,6 +12,8 @@ import sys
 import os
 import time
 
+assert sys.version_info >= (3, 7)
+
 from collections import namedtuple
 from enum import Enum, auto
 
Signature · 1 line
2.17.1
Acked-by on v1 1/1
#1 lore raw
Quoted 7 lines · SeongJae Park

From: SeongJae Park <[email protected]>

Commit 87c9c1631788 ("kunit: tool: add support for QEMU") on the 'next' tree adds 'from __future__ import annotations' in 'kunit_kernel.py'. Because it is supported on only >=3.7 Python, people using older Python will get below error:

Ah, we had been fine with just using 3.6 before this (and could have dropped down to 3.5 with a few lines changed).

But 3.7 came out initially in 2018*, so I assume we're probably fine to rely on that in kunit tool. *https://www.python.org/downloads/release/python-370/

Quoted 12 lines

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 20, in <module>
import kunit_kernel
File "/home/sjpark/linux/tools/testing/kunit/kunit_kernel.py", line 9
from __future__ import annotations
^
SyntaxError: future feature annotations is not defined

This commit adds a version assertion in 'kunit.py', so that people get more explicit error message like below:

Quoted 6 lines

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 15, in <module>
assert sys.version_info >= (3, 7)
AssertionError

tools/testing/kunit/kunit.py import sys · line 15

Quoted 13 lines
---
 tools/testing/kunit/kunit.py | 2 ++
 1 file changed, 2 insertions(+)
tools/testing/kunit/kunit.py +1 -0
index be8d8d4a4e08..748d88178506 100755
@@ -12,6 +12,8 @@ import sys
 import os
 import time
 
+assert sys.version_info >= (3, 7)

Do we perhaps want
assert sys.version_info >= (3, 7), "Python version is too old"

Then the error message would be
Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 15, in <module>
assert sys.version_info >= (3, 7), "Python version is too old"
AssertionError: Python version is too old

I assume kernel devs know some Python, but not necessarily that sys.version_info == "my python version"

Quoted 11 lines
tools/testing/kunit/kunit.py +1 -1
+
 from collections import namedtuple
 from enum import Enum, auto
 
--

2.17.1

--
You received this message because you are subscribed to the Google Groups "KUnit Development" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/20210616094033.18246-1-sj38.park%40gmail.com.

#2 lore raw

From: SeongJae Park <[email protected]>

Hello Daniel,

Quoted 9 lines · On Wed, 16 Jun 2021 14:14:40 -0700 Daniel Latypov <[email protected]> wrote:
Quoted 7 lines · SeongJae Park

From: SeongJae Park <[email protected]>

Commit 87c9c1631788 ("kunit: tool: add support for QEMU") on the 'next' tree adds 'from __future__ import annotations' in 'kunit_kernel.py'. Because it is supported on only >=3.7 Python, people using older Python will get below error:

Quoted 6 lines

Ah, we had been fine with just using 3.6 before this (and could have dropped down to 3.5 with a few lines changed).

But 3.7 came out initially in 2018*, so I assume we're probably fine to rely on that in kunit tool. *https://www.python.org/downloads/release/python-370/

Agreed.

Quoted 13 lines
Quoted 13 lines

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 20, in <module>
import kunit_kernel
File "/home/sjpark/linux/tools/testing/kunit/kunit_kernel.py", line 9
from __future__ import annotations
^
SyntaxError: future feature annotations is not defined

This commit adds a version assertion in 'kunit.py', so that people get more explicit error message like below:

Quoted 8 lines
Quoted 6 lines

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 15, in <module>
assert sys.version_info >= (3, 7)
AssertionError

Thank you! :)

Quoted 18 lines
Quoted 10 lines
---
 tools/testing/kunit/kunit.py | 2 ++
 1 file changed, 2 insertions(+)
tools/testing/kunit/kunit.py +0 -0
index be8d8d4a4e08..748d88178506 100755

tools/testing/kunit/kunit.py import sys · line 15

Quoted 4 lines
tools/testing/kunit/kunit.py +1 -0
@@ -12,6 +12,8 @@ import sys
 import os
 import time
 
+assert sys.version_info >= (3, 7)

Do we perhaps want
assert sys.version_info >= (3, 7), "Python version is too old"

Quoted 5 lines

Then the error message would be
Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 15, in <module>
assert sys.version_info >= (3, 7), "Python version is too old"
AssertionError: Python version is too old

That looks easier to understand. I will post v2 in reply to this.

Thanks,
SeongJae Park

Quoted 15 lines

I assume kernel devs know some Python, but not necessarily that sys.version_info == "my python version"

Quoted 11 lines
tools/testing/kunit/kunit.py +1 -1
+
 from collections import namedtuple
 from enum import Enum, auto
 
--

2.17.1

--
You received this message because you are subscribed to the Google Groups "KUnit Development" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/20210616094033.18246-1-sj38.park%40gmail.com.

#3 lore raw

PATCH v2 1/1 kunit: tool: Assert the version requirement

Commit 87c9c1631788 ("kunit: tool: add support for QEMU") on the 'next' tree adds 'from __future__ import annotations' in 'kunit_kernel.py'. Because it is supported on only >=3.7 Python, people using older Python will get below error:

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 20, in <module>
import kunit_kernel
File "/home/sjpark/linux/tools/testing/kunit/kunit_kernel.py", line 9
from __future__ import annotations
^
SyntaxError: future feature annotations is not defined

This commit adds a version assertion in 'kunit.py', so that people get more explicit error message like below:

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 15, in <module>
assert sys.version_info >= (3, 7), "Python version is too old"
AssertionError: Python version is too old

---

Changes from v1
- Add assertion failure message (Daniel Latypov)
- Add Acked-by: Daniel Latypov <[email protected]>

 tools/testing/kunit/kunit.py | 2 ++
 1 file changed, 2 insertions(+)
tools/testing/kunit/kunit.py +2 -0
index be8d8d4a4e08..6276ce0c0196 100755
@@ -12,6 +12,8 @@ import sys
 import os
 import time
 
+assert sys.version_info >= (3, 7), "Python version is too old"
+
 from collections import namedtuple
 from enum import Enum, auto
 
Signature · 1 line
2.17.1
#4 lore raw

Re: [PATCH v2] kunit: tool: Assert the version requirement

Quoted 11 lines · SeongJae Park

Commit 87c9c1631788 ("kunit: tool: add support for QEMU") on the 'next' tree adds 'from __future__ import annotations' in 'kunit_kernel.py'. Because it is supported on only >=3.7 Python, people using older Python will get below error:

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 20, in <module>
import kunit_kernel
File "/home/sjpark/linux/tools/testing/kunit/kunit_kernel.py", line 9
from __future__ import annotations

Chatted offline with David about this.
He was thinking if we could instead drop the minimal version back to 3.6.

I think we can do so, see below.
Perhaps we should drop the import and then chain this patch on top of that, specifying a minimum version of 3.6?

Checking out https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/?h=kunit-fixes

The offending "annotations" import is related to type annotations. Specifically https://www.python.org/dev/peps/pep-0563/

So let's see how the two most popular typecheckers fare.

pytype is happy with or without import.
mypy has the same issues with or without the import.

$ mypy tools/testing/kunit/*.py
tools/testing/kunit/kunit_kernel.py:227: error: Item "_Loader" of
"Optional[_Loader]" has no attribute "exec_module"
tools/testing/kunit/kunit_kernel.py:227: error: Item "None" of
"Optional[_Loader]" has no attribute "exec_module"
tools/testing/kunit/kunit_kernel.py:228: error: Module has no
attribute "QEMU_ARCH"
tools/testing/kunit/kunit_kernel.py:229: error: Module has no
attribute "QEMU_ARCH"

So clearly it's not doing anything for them.

Taking a look over 87c9c1631788 ("kunit: tool: add support for QEMU") next then...
I don't see anything that would warrant the import, so we should probably drop it.

In that case, the minimum supported version should drop back down to 3.6. We use enum.auto, which is from 3.6
https://docs.python.org/3/library/enum.html#enum.auto

We could consider stopping using that, and I think we might be then 3.5-compatible.
Maybe we have a chain of 3 patches then, drop the import, drop auto, and then add in a >=3.5 version check?

Quoted 38 lines

^
SyntaxError: future feature annotations is not defined

This commit adds a version assertion in 'kunit.py', so that people get more explicit error message like below:

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 15, in <module>
assert sys.version_info >= (3, 7), "Python version is too old"
AssertionError: Python version is too old

---

Changes from v1
- Add assertion failure message (Daniel Latypov)
- Add Acked-by: Daniel Latypov <[email protected]>

 tools/testing/kunit/kunit.py | 2 ++
 1 file changed, 2 insertions(+)
tools/testing/kunit/kunit.py +2 -1
index be8d8d4a4e08..6276ce0c0196 100755
@@ -12,6 +12,8 @@ import sys
 import os
 import time
 
+assert sys.version_info >= (3, 7), "Python version is too old"
+
 from collections import namedtuple
 from enum import Enum, auto
 
--

2.17.1

Reviewed-by
#5 lore raw

Re: [PATCH v2] kunit: tool: Assert the version requirement

Quoted 14 lines · Daniel Latypov
Quoted 11 lines · SeongJae Park

Commit 87c9c1631788 ("kunit: tool: add support for QEMU") on the 'next' tree adds 'from __future__ import annotations' in 'kunit_kernel.py'. Because it is supported on only >=3.7 Python, people using older Python will get below error:

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 20, in <module>
import kunit_kernel
File "/home/sjpark/linux/tools/testing/kunit/kunit_kernel.py", line 9
from __future__ import annotations

Quoted 6 lines

Chatted offline with David about this.
He was thinking if we could instead drop the minimal version back to 3.6.

I think we can do so, see below.
Perhaps we should drop the import and then chain this patch on top of that, specifying a minimum version of 3.6?

Actually, now I've gotten python3.6 installed on my machine, I see we have another issue.

We pass text=true to subprocess.
That didn't exist back in 3.6, see
https://docs.python.org/3.6/library/subprocess.html

We can workaround that, but there's more chance of subtle bugs that I'd rather we don't touch it.

Quoted 21 lines

Checking out https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/?h=kunit-fixes

The offending "annotations" import is related to type annotations. Specifically https://www.python.org/dev/peps/pep-0563/

So let's see how the two most popular typecheckers fare.

pytype is happy with or without import.
mypy has the same issues with or without the import.

$ mypy tools/testing/kunit/*.py
tools/testing/kunit/kunit_kernel.py:227: error: Item "_Loader" of
"Optional[_Loader]" has no attribute "exec_module"
tools/testing/kunit/kunit_kernel.py:227: error: Item "None" of
"Optional[_Loader]" has no attribute "exec_module"
tools/testing/kunit/kunit_kernel.py:228: error: Module has no
attribute "QEMU_ARCH"
tools/testing/kunit/kunit_kernel.py:229: error: Module has no
attribute "QEMU_ARCH"
Quoted 6 lines

So clearly it's not doing anything for them.

Taking a look over 87c9c1631788 ("kunit: tool: add support for QEMU") next then...
I don't see anything that would warrant the import, so we should probably drop it.

Also, using 3.6 now I have it installed, I found what it was added for. But it doesn't need to be there.

This patch drops it and makes things work, afaict:

(quoted diff) +0 -0

b/tools/testing/kunit/kunit_kernel.py
index e1951fa60027..5987d5b1b874 100644

tools/testing/kunit/kunit_kernel.py +1 -3
@@ -6,15 +6,13 @@
 # Author: Felix Guo <[email protected]>
 # Author: Brendan Higgins <[email protected]>
 
-from __future__ import annotations
 import importlib.util
 import logging
 import subprocess
 import os
 import shutil
 import signal
-from typing import Iterator
-from typing import Optional
+from typing import Iterator, Optional, Tuple
 
 from contextlib import ExitStack
 
@@ -208,7 +206,7 @@ def get_source_tree_ops(arch: str, cross_compile:

Optional[str]) -> LinuxSourceT
raise ConfigError(arch + ' is not a valid arch')

def get_source_tree_ops_from_qemu_config(config_path: str,
- cross_compile: Optional[str]) -> tuple[
+ cross_compile: Optional[str]) -> Tuple[
str,
LinuxSourceTreeOperations]:
# The module name/path has very little to do with where the actual file # exists (I learned this through experimentation and could not find it

Quoted 23 lines

In that case, the minimum supported version should drop back down to 3.6. We use enum.auto, which is from 3.6
https://docs.python.org/3/library/enum.html#enum.auto

We could consider stopping using that, and I think we might be then 3.5-compatible.
Maybe we have a chain of 3 patches then, drop the import, drop auto, and then add in a >=3.5 version check?

Quoted 13 lines

^
SyntaxError: future feature annotations is not defined

This commit adds a version assertion in 'kunit.py', so that people get more explicit error message like below:

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 15, in <module>
assert sys.version_info >= (3, 7), "Python version is too old"
AssertionError: Python version is too old

As mentioned above, we do actually need 3.7, and not just for the extra import. Now I know that, I feel more strongly that this patch should go in, as-is.

Quoted 25 lines
Quoted 25 lines

---

Changes from v1
- Add assertion failure message (Daniel Latypov)
- Add Acked-by: Daniel Latypov <[email protected]>

 tools/testing/kunit/kunit.py | 2 ++
 1 file changed, 2 insertions(+)
tools/testing/kunit/kunit.py +2 -1
index be8d8d4a4e08..6276ce0c0196 100755
@@ -12,6 +12,8 @@ import sys
 import os
 import time
 
+assert sys.version_info >= (3, 7), "Python version is too old"
+
 from collections import namedtuple
 from enum import Enum, auto
 
--

2.17.1

#6 lore raw

Re: [PATCH v2] kunit: tool: Assert the version requirement

Hello Brendan, could I ask you opinion for this patch?

Thanks,
SeongJae Park

[...]

#7 lore raw

Re: [PATCH v2] kunit: tool: Assert the version requirement

Quoted 2 lines · SeongJae Park

Hello Brendan, could I ask you opinion for this patch?

Yep, sorry, I just wanted to make sure everything else (there were a lot of things in the queue) was in order for the 5.14 merge window first.

Looks good!

Thanks

Reviewed-by on v2 1/1
#8 lore raw

Re: [PATCH v2] kunit: tool: Assert the version requirement

In reply to SeongJae Park
Quoted 17 lines · SeongJae Park

Commit 87c9c1631788 ("kunit: tool: add support for QEMU") on the 'next' tree adds 'from __future__ import annotations' in 'kunit_kernel.py'. Because it is supported on only >=3.7 Python, people using older Python will get below error:

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 20, in <module>
import kunit_kernel
File "/home/sjpark/linux/tools/testing/kunit/kunit_kernel.py", line 9
from __future__ import annotations
^
SyntaxError: future feature annotations is not defined

This commit adds a version assertion in 'kunit.py', so that people get more explicit error message like below:

Quoted 7 lines

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 15, in <module>
assert sys.version_info >= (3, 7), "Python version is too old"
AssertionError: Python version is too old

maintainer
#9 lore raw

Re: [PATCH v2] kunit: tool: Assert the version requirement

Quoted 18 lines · Brendan Higgins
Quoted 17 lines · SeongJae Park

Commit 87c9c1631788 ("kunit: tool: add support for QEMU") on the 'next' tree adds 'from __future__ import annotations' in 'kunit_kernel.py'. Because it is supported on only >=3.7 Python, people using older Python will get below error:

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 20, in <module>
import kunit_kernel
File "/home/sjpark/linux/tools/testing/kunit/kunit_kernel.py", line 9
from __future__ import annotations
^
SyntaxError: future feature annotations is not defined

This commit adds a version assertion in 'kunit.py', so that people get more explicit error message like below:

Quoted 6 lines
Quoted 6 lines

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 15, in <module>
assert sys.version_info >= (3, 7), "Python version is too old"
AssertionError: Python version is too old

Your from and Signed-off-by email addresses don't match.

Please resend the patch with the correction.

thanks,
-- Shuah

#10 lore raw

Re: [PATCH v2] kunit: tool: Assert the version requirement

From: SeongJae Park <[email protected]>

Quoted 24 lines · On Mon, 12 Jul 2021 13:42:34 -0600 Shuah Khan <[email protected]> wrote:
Quoted 23 lines · Brendan Higgins
Quoted 22 lines · SeongJae Park

Commit 87c9c1631788 ("kunit: tool: add support for QEMU") on the 'next' tree adds 'from __future__ import annotations' in 'kunit_kernel.py'. Because it is supported on only >=3.7 Python, people using older Python will get below error:

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 20, in <module>
import kunit_kernel
File "/home/sjpark/linux/tools/testing/kunit/kunit_kernel.py", line 9
from __future__ import annotations
^
SyntaxError: future feature annotations is not defined

This commit adds a version assertion in 'kunit.py', so that people get more explicit error message like below:

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 15, in <module>
assert sys.version_info >= (3, 7), "Python version is too old"
AssertionError: Python version is too old

Quoted 5 lines
Quoted 1 line
Quoted 1 line

Your from and Signed-off-by email addresses don't match.

Please resend the patch with the correction.

Sorry, my fault. Will send fixed one as a reply to this.

Thanks,
SeongJae Park

Quoted 3 lines

thanks,
-- Shuah

#11 lore raw

PATCH v3 1/1 kunit: tool: Assert the version requirement

In reply to Shuah Khan

From: SeongJae Park <[email protected]>

Commit 87c9c1631788 ("kunit: tool: add support for QEMU") on the 'next' tree adds 'from __future__ import annotations' in 'kunit_kernel.py'. Because it is supported on only >=3.7 Python, people using older Python will get below error:

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 20, in <module>
import kunit_kernel
File "/home/sjpark/linux/tools/testing/kunit/kunit_kernel.py", line 9
from __future__ import annotations
^
SyntaxError: future feature annotations is not defined

This commit adds a version assertion in 'kunit.py', so that people get more explicit error message like below:

Traceback (most recent call last):
File "./tools/testing/kunit/kunit.py", line 15, in <module>
assert sys.version_info >= (3, 7), "Python version is too old"
AssertionError: Python version is too old

---

Changes from v2
- Fix mismatch of Signed-off and from

Changes from v1
- Add assertion failure message (Daniel Latypov)
- Add Acked-by: Daniel Latypov <[email protected]>

 tools/testing/kunit/kunit.py | 2 ++
 1 file changed, 2 insertions(+)
tools/testing/kunit/kunit.py +2 -0
index be8d8d4a4e08..6276ce0c0196 100755
@@ -12,6 +12,8 @@ import sys
 import os
 import time
 
+assert sys.version_info >= (3, 7), "Python version is too old"
+
 from collections import namedtuple
 from enum import Enum, auto
 
Signature · 1 line
2.17.1