[1/1] selftests/bpf: clear out Python syntax warnings

Commit Message

Ariel Otilibili Dec. 11, 2024, 9:57 p.m. UTC

Invalid escape sequences are used, and produced syntax warnings:

```
$ test_bpftool_synctypes.py
test_bpftool_synctypes.py:69: SyntaxWarning: invalid escape sequence '\['
  self.start_marker = re.compile(f'(static )?const bool {self.array_name}\[.*\] = {{\n')
test_bpftool_synctypes.py:83: SyntaxWarning: invalid escape sequence '\['
  pattern = re.compile('\[(BPF_\w*)\]\s*= (true|false),?$')
test_bpftool_synctypes.py:181: SyntaxWarning: invalid escape sequence '\s'
  pattern = re.compile('^\s*(BPF_\w+),?(\s+/\*.*\*/)?$')
test_bpftool_synctypes.py:229: SyntaxWarning: invalid escape sequence '\*'
  start_marker = re.compile(f'\*{block_name}\* := {{')
test_bpftool_synctypes.py:229: SyntaxWarning: invalid escape sequence '\*'
  start_marker = re.compile(f'\*{block_name}\* := {{')
test_bpftool_synctypes.py:230: SyntaxWarning: invalid escape sequence '\*'
  pattern = re.compile('\*\*([\w/-]+)\*\*')
test_bpftool_synctypes.py:248: SyntaxWarning: invalid escape sequence '\s'
  start_marker = re.compile(f'"\s*{block_name} := {{')
test_bpftool_synctypes.py:249: SyntaxWarning: invalid escape sequence '\w'
  pattern = re.compile('([\w/]+) [|}]')
test_bpftool_synctypes.py:267: SyntaxWarning: invalid escape sequence '\s'
  start_marker = re.compile(f'"\s*{macro}\s*" [|}}]')
test_bpftool_synctypes.py:267: SyntaxWarning: invalid escape sequence '\s'
  start_marker = re.compile(f'"\s*{macro}\s*" [|}}]')
test_bpftool_synctypes.py:268: SyntaxWarning: invalid escape sequence '\w'
  pattern = re.compile('([\w-]+) ?(?:\||}[ }\]])')
test_bpftool_synctypes.py:287: SyntaxWarning: invalid escape sequence '\w'
  pattern = re.compile('(?:.*=\')?([\w/]+)')
test_bpftool_synctypes.py:319: SyntaxWarning: invalid escape sequence '\w'
  pattern = re.compile('([\w-]+) ?(?:\||}[ }\]"])')
test_bpftool_synctypes.py:341: SyntaxWarning: invalid escape sequence '\|'
  start_marker = re.compile('\|COMMON_OPTIONS\| replace:: {')
test_bpftool_synctypes.py:342: SyntaxWarning: invalid escape sequence '\*'
  pattern = re.compile('\*\*([\w/-]+)\*\*')
```

Escaping them clears out the warnings.

```
$ tools/testing/selftests/bpf/test_bpftool_synctypes.py; echo $?
0
```

Link: https://docs.python.org/fr/3/library/re.html
CC: Alexei Starovoitov <[e-mail]>
CC: Daniel Borkmann <[e-mail]>
CC: Andrii Nakryiko <[e-mail]>
CC: Shuah Khan <[e-mail]>
Signed-off-by: Ariel Otilibili <[e-mail]>
---
 .../selftests/bpf/test_bpftool_synctypes.py   | 28 +++++++++----------
 1 file changed, 14 insertions(+), 14 deletions(-)

Comments

Quentin Monnet Dec. 20, 2024, 4:24 p.m. UTC | #1

2024-12-11 22:57 UTC+0100 ~ Ariel Otilibili
<[e-mail]>
> Invalid escape sequences are used, and produced syntax warnings:
> 
> ```
> $ test_bpftool_synctypes.py
> test_bpftool_synctypes.py:69: SyntaxWarning: invalid escape sequence '\['
>   self.start_marker = re.compile(f'(static )?const bool {self.array_name}\[.*\] = {{\n')
> test_bpftool_synctypes.py:83: SyntaxWarning: invalid escape sequence '\['
>   pattern = re.compile('\[(BPF_\w*)\]\s*= (true|false),?$')
> test_bpftool_synctypes.py:181: SyntaxWarning: invalid escape sequence '\s'
>   pattern = re.compile('^\s*(BPF_\w+),?(\s+/\*.*\*/)?$')
> test_bpftool_synctypes.py:229: SyntaxWarning: invalid escape sequence '\*'
>   start_marker = re.compile(f'\*{block_name}\* := {{')
> test_bpftool_synctypes.py:229: SyntaxWarning: invalid escape sequence '\*'
>   start_marker = re.compile(f'\*{block_name}\* := {{')
> test_bpftool_synctypes.py:230: SyntaxWarning: invalid escape sequence '\*'
>   pattern = re.compile('\*\*([\w/-]+)\*\*')
> test_bpftool_synctypes.py:248: SyntaxWarning: invalid escape sequence '\s'
>   start_marker = re.compile(f'"\s*{block_name} := {{')
> test_bpftool_synctypes.py:249: SyntaxWarning: invalid escape sequence '\w'
>   pattern = re.compile('([\w/]+) [|}]')
> test_bpftool_synctypes.py:267: SyntaxWarning: invalid escape sequence '\s'
>   start_marker = re.compile(f'"\s*{macro}\s*" [|}}]')
> test_bpftool_synctypes.py:267: SyntaxWarning: invalid escape sequence '\s'
>   start_marker = re.compile(f'"\s*{macro}\s*" [|}}]')
> test_bpftool_synctypes.py:268: SyntaxWarning: invalid escape sequence '\w'
>   pattern = re.compile('([\w-]+) ?(?:\||}[ }\]])')
> test_bpftool_synctypes.py:287: SyntaxWarning: invalid escape sequence '\w'
>   pattern = re.compile('(?:.*=\')?([\w/]+)')
> test_bpftool_synctypes.py:319: SyntaxWarning: invalid escape sequence '\w'
>   pattern = re.compile('([\w-]+) ?(?:\||}[ }\]"])')
> test_bpftool_synctypes.py:341: SyntaxWarning: invalid escape sequence '\|'
>   start_marker = re.compile('\|COMMON_OPTIONS\| replace:: {')
> test_bpftool_synctypes.py:342: SyntaxWarning: invalid escape sequence '\*'
>   pattern = re.compile('\*\*([\w/-]+)\*\*')
> ```
> 
> Escaping them clears out the warnings.
> 
> ```
> $ tools/testing/selftests/bpf/test_bpftool_synctypes.py; echo $?
> 0
> ```
> 
> Link: https://docs.python.org/fr/3/library/re.html


En version anglaise : https://docs.python.org/3/library/re.html


> CC: Alexei Starovoitov <[e-mail]>
> CC: Daniel Borkmann <[e-mail]>
> CC: Andrii Nakryiko <[e-mail]>
> CC: Shuah Khan <[e-mail]>
> Signed-off-by: Ariel Otilibili <[e-mail]>

Right, this seems to be a change in Python 3.12 [0][1]:

'A backslash-character pair that is not a valid escape sequence now
generates a SyntaxWarning, instead of DeprecationWarning. For example,
re.compile("\d+\.\d+") now emits a SyntaxWarning ("\d" is an invalid
escape sequence, use raw strings for regular expression:
re.compile(r"\d+\.\d+")).'

although I can't remember seeing any DeprecationWarning before.

Anyway, the fix makes sense, and does address the warnings. Thank you
for this!

Tested-by: Quentin Monnet <[e-mail]>
Reviewed-by: Quentin Monnet <[e-mail]>


[0] https://docs.python.org/3.12/whatsnew/3.12.html#other-language-changes
[1] https://github.com/python/cpython/issues/98401

Ariel Otilibili Dec. 20, 2024, 4:28 p.m. UTC | #2

On Friday, December 20, 2024 17:24 CET, Quentin Monnet <[e-mail]> wrote:

> 2024-12-11 22:57 UTC+0100 ~ Ariel Otilibili
> <[e-mail]>
> > Invalid escape sequences are used, and produced syntax warnings:
> > 
> > ```
> > $ test_bpftool_synctypes.py
> > test_bpftool_synctypes.py:69: SyntaxWarning: invalid escape sequence '\['
> >   self.start_marker = re.compile(f'(static )?const bool {self.array_name}\[.*\] = {{\n')
> > test_bpftool_synctypes.py:83: SyntaxWarning: invalid escape sequence '\['
> >   pattern = re.compile('\[(BPF_\w*)\]\s*= (true|false),?$')
> > test_bpftool_synctypes.py:181: SyntaxWarning: invalid escape sequence '\s'
> >   pattern = re.compile('^\s*(BPF_\w+),?(\s+/\*.*\*/)?$')
> > test_bpftool_synctypes.py:229: SyntaxWarning: invalid escape sequence '\*'
> >   start_marker = re.compile(f'\*{block_name}\* := {{')
> > test_bpftool_synctypes.py:229: SyntaxWarning: invalid escape sequence '\*'
> >   start_marker = re.compile(f'\*{block_name}\* := {{')
> > test_bpftool_synctypes.py:230: SyntaxWarning: invalid escape sequence '\*'
> >   pattern = re.compile('\*\*([\w/-]+)\*\*')
> > test_bpftool_synctypes.py:248: SyntaxWarning: invalid escape sequence '\s'
> >   start_marker = re.compile(f'"\s*{block_name} := {{')
> > test_bpftool_synctypes.py:249: SyntaxWarning: invalid escape sequence '\w'
> >   pattern = re.compile('([\w/]+) [|}]')
> > test_bpftool_synctypes.py:267: SyntaxWarning: invalid escape sequence '\s'
> >   start_marker = re.compile(f'"\s*{macro}\s*" [|}}]')
> > test_bpftool_synctypes.py:267: SyntaxWarning: invalid escape sequence '\s'
> >   start_marker = re.compile(f'"\s*{macro}\s*" [|}}]')
> > test_bpftool_synctypes.py:268: SyntaxWarning: invalid escape sequence '\w'
> >   pattern = re.compile('([\w-]+) ?(?:\||}[ }\]])')
> > test_bpftool_synctypes.py:287: SyntaxWarning: invalid escape sequence '\w'
> >   pattern = re.compile('(?:.*=\')?([\w/]+)')
> > test_bpftool_synctypes.py:319: SyntaxWarning: invalid escape sequence '\w'
> >   pattern = re.compile('([\w-]+) ?(?:\||}[ }\]"])')
> > test_bpftool_synctypes.py:341: SyntaxWarning: invalid escape sequence '\|'
> >   start_marker = re.compile('\|COMMON_OPTIONS\| replace:: {')
> > test_bpftool_synctypes.py:342: SyntaxWarning: invalid escape sequence '\*'
> >   pattern = re.compile('\*\*([\w/-]+)\*\*')
> > ```
> > 
> > Escaping them clears out the warnings.
> > 
> > ```
> > $ tools/testing/selftests/bpf/test_bpftool_synctypes.py; echo $?
> > 0
> > ```
> > 
> > Link: https://docs.python.org/fr/3/library/re.html
> 
> 
> En version anglaise : https://docs.python.org/3/library/re.html

Merci!
> 
> 
> > CC: Alexei Starovoitov <[e-mail]>
> > CC: Daniel Borkmann <[e-mail]>
> > CC: Andrii Nakryiko <[e-mail]>
> > CC: Shuah Khan <[e-mail]>
> > Signed-off-by: Ariel Otilibili <[e-mail]>
> 
> Right, this seems to be a change in Python 3.12 [0][1]:
> 
> 'A backslash-character pair that is not a valid escape sequence now
> generates a SyntaxWarning, instead of DeprecationWarning. For example,
> re.compile("\d+\.\d+") now emits a SyntaxWarning ("\d" is an invalid
> escape sequence, use raw strings for regular expression:
> re.compile(r"\d+\.\d+")).'
> 
> although I can't remember seeing any DeprecationWarning before.
> 
> Anyway, the fix makes sense, and does address the warnings. Thank you
> for this!
> 
> Tested-by: Quentin Monnet <[e-mail]>
> Reviewed-by: Quentin Monnet <[e-mail]>

Awesome, Quentin! Thanks for the feedback!
> 
> 
> [0] https://docs.python.org/3.12/whatsnew/3.12.html#other-language-changes
> [1] https://github.com/python/cpython/issues/98401

Patch

diff --git a/tools/testing/selftests/bpf/test_bpftool_synctypes.py b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
index 0ed67b6b31dd..238121fda5b6 100755
--- a/tools/testing/selftests/bpf/test_bpftool_synctypes.py
+++ b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
@@ -66,7 +66,7 @@  class ArrayParser(BlockParser):
 
     def __init__(self, reader, array_name):
         self.array_name = array_name
-        self.start_marker = re.compile(f'(static )?const bool {self.array_name}\[.*\] = {{\n')
+        self.start_marker = re.compile(fr'(static )?const bool {self.array_name}\[.*\] = {{\n')
         super().__init__(reader)
 
     def search_block(self):
@@ -80,7 +80,7 @@  class ArrayParser(BlockParser):
         Parse a block and return data as a dictionary. Items to extract must be
         on separate lines in the file.
         """
-        pattern = re.compile('\[(BPF_\w*)\]\s*= (true|false),?$')
+        pattern = re.compile(r'\[(BPF_\w*)\]\s*= (true|false),?$')
         entries = set()
         while True:
             line = self.reader.readline()
@@ -178,7 +178,7 @@  class FileExtractor(object):
         @enum_name: name of the enum to parse
         """
         start_marker = re.compile(f'enum {enum_name} {{\n')
-        pattern = re.compile('^\s*(BPF_\w+),?(\s+/\*.*\*/)?$')
+        pattern = re.compile(r'^\s*(BPF_\w+),?(\s+/\*.*\*/)?$')
         end_marker = re.compile('^};')
         parser = BlockParser(self.reader)
         parser.search_block(start_marker)
@@ -226,8 +226,8 @@  class FileExtractor(object):
 
         @block_name: name of the blog to parse, 'TYPE' in the example
         """
-        start_marker = re.compile(f'\*{block_name}\* := {{')
-        pattern = re.compile('\*\*([\w/-]+)\*\*')
+        start_marker = re.compile(fr'\*{block_name}\* := {{')
+        pattern = re.compile(r'\*\*([\w/-]+)\*\*')
         end_marker = re.compile('}\n')
         return self.__get_description_list(start_marker, pattern, end_marker)
 
@@ -245,8 +245,8 @@  class FileExtractor(object):
 
         @block_name: name of the blog to parse, 'TYPE' in the example
         """
-        start_marker = re.compile(f'"\s*{block_name} := {{')
-        pattern = re.compile('([\w/]+) [|}]')
+        start_marker = re.compile(fr'"\s*{block_name} := {{')
+        pattern = re.compile(r'([\w/]+) [|}]')
         end_marker = re.compile('}')
         return self.__get_description_list(start_marker, pattern, end_marker)
 
@@ -264,8 +264,8 @@  class FileExtractor(object):
 
         @macro: macro starting the block, 'HELP_SPEC_OPTIONS' in the example
         """
-        start_marker = re.compile(f'"\s*{macro}\s*" [|}}]')
-        pattern = re.compile('([\w-]+) ?(?:\||}[ }\]])')
+        start_marker = re.compile(fr'"\s*{macro}\s*" [|}}]')
+        pattern = re.compile(r'([\w-]+) ?(?:\||}[ }\]])')
         end_marker = re.compile('}\\\\n')
         return self.__get_description_list(start_marker, pattern, end_marker)
 
@@ -283,8 +283,8 @@  class FileExtractor(object):
 
         @block_name: name of the blog to parse, 'TYPE' in the example
         """
-        start_marker = re.compile(f'local {block_name}=\'')
-        pattern = re.compile('(?:.*=\')?([\w/]+)')
+        start_marker = re.compile(fr'local {block_name}=\'')
+        pattern = re.compile(r'(?:.*=\')?([\w/]+)')
         end_marker = re.compile('\'$')
         return self.__get_description_list(start_marker, pattern, end_marker)
 
@@ -316,7 +316,7 @@  class MainHeaderFileExtractor(SourceFileExtractor):
             {'-p', '-d', '--pretty', '--debug', '--json', '-j'}
         """
         start_marker = re.compile(f'"OPTIONS :=')
-        pattern = re.compile('([\w-]+) ?(?:\||}[ }\]"])')
+        pattern = re.compile(r'([\w-]+) ?(?:\||}[ }\]"])')
         end_marker = re.compile('#define')
 
         parser = InlineListParser(self.reader)
@@ -338,8 +338,8 @@  class ManSubstitutionsExtractor(SourceFileExtractor):
 
             {'-p', '-d', '--pretty', '--debug', '--json', '-j'}
         """
-        start_marker = re.compile('\|COMMON_OPTIONS\| replace:: {')
-        pattern = re.compile('\*\*([\w/-]+)\*\*')
+        start_marker = re.compile(r'\|COMMON_OPTIONS\| replace:: {')
+        pattern = re.compile(r'\*\*([\w/-]+)\*\*')
         end_marker = re.compile('}$')
 
         parser = InlineListParser(self.reader)