From: fenglei <1579628578@qq.com>
Date: Sat, 21 Dec 2024 10:15:12 +0000 (+0800)
Subject: tests: fix docs compile syntax warning
X-Git-Tag: v25.10-rc0~253
X-Git-Url: https://gerrit.fd.io/r/gitweb?a=commitdiff_plain;h=38d9b3479f780d94e6caa03058b2e44ca24858fb;p=vpp.git

tests: fix docs compile syntax warning

- make docs will generate syntax warning
/opt/vpp/docs/_scripts/siphon/generate.py:31: SyntaxWarning: invalid escape sequence '\s'
  siphon_block_start = re.compile("^\s*/\*\?\s*(.*)$")
/opt/vpp/docs/_scripts/siphon/generate.py:34: SyntaxWarning: invalid escape sequence '\s'
  siphon_block_stop = re.compile("^(.*)\s*\?\*/\s*$")
/opt/vpp/docs/_scripts/siphon/generate.py:42: SyntaxWarning: invalid escape sequence '\s'
  "(%s)\s*([a-zA-Z0-9_:]+)\s+(.*)\s*(%s)"
/opt/vpp/docs/_scripts/siphon/generate.py:47: SyntaxWarning: invalid escape sequence '\s'
  siphon_initializer = re.compile("\s*=")
/opt/vpp/docs/_scripts/siphon/generate_clicmd.py:23: SyntaxWarning: invalid escape sequence '\s'
  "(?P<m>VLIB_CLI_COMMAND)\s*" "[(](?P<name>[a-zA-Z0-9_]+)(,[^)]*)?[)]"
/opt/vpp/docs/_scripts/siphon/generate_syscfg.py:23: SyntaxWarning: invalid escape sequence '\s'
  "(?P<m>VLIB_CONFIG_FUNCTION)\s*"
/opt/vpp/docs/_scripts/siphon/generate_syscfg.py:24: SyntaxWarning: invalid escape sequence '\s'
  '[(](?P<fn>[a-zA-Z0-9_]+)\s*,\s*"(?P<name>[^"]*)"[)]'

Type: improvement

Change-Id: I6f7555cb0368a671a8bb164d51466d526895e925
Signed-off-by: fenglei <1579628578@qq.com>
---

diff --git a/docs/_scripts/siphon/generate.py b/docs/_scripts/siphon/generate.py
index 1244c4658e4..1bd3e03fdcb 100644
--- a/docs/_scripts/siphon/generate.py
+++ b/docs/_scripts/siphon/generate.py
@@ -28,10 +28,10 @@ siphon_patterns = []
 class Generate(object):
     """Matches a siphon comment block start"""
 
-    siphon_block_start = re.compile("^\s*/\*\?\s*(.*)$")
+    siphon_block_start = re.compile(r"^\s*/\*\?\s*(.*)$")
 
     """Matches a siphon comment block stop"""
-    siphon_block_stop = re.compile("^(.*)\s*\?\*/\s*$")
+    siphon_block_stop = re.compile(r"^(.*)\s*\?\*/\s*$")
 
     """Siphon block directive delimiter"""
     siphon_block_delimiter = "%%"
@@ -39,12 +39,12 @@ class Generate(object):
     """Matches a siphon block directive such as
        '%clicmd:group_label Debug CLI%'"""
     siphon_block_directive = re.compile(
-        "(%s)\s*([a-zA-Z0-9_:]+)\s+(.*)\s*(%s)"
+        r"(%s)\s*([a-zA-Z0-9_:]+)\s+(.*)\s*(%s)"
         % (siphon_block_delimiter, siphon_block_delimiter)
     )
 
     """Matches the start of an initializer block"""
-    siphon_initializer = re.compile("\s*=")
+    siphon_initializer = re.compile(r"\s*=")
 
     """Collated output for each siphon"""
     output = None
diff --git a/docs/_scripts/siphon/generate_clicmd.py b/docs/_scripts/siphon/generate_clicmd.py
index 2e2f6281a39..8db9d0c0056 100644
--- a/docs/_scripts/siphon/generate_clicmd.py
+++ b/docs/_scripts/siphon/generate_clicmd.py
@@ -20,7 +20,7 @@ from . import generate
 generate.siphon_patterns.append(
     (
         re.compile(
-            "(?P<m>VLIB_CLI_COMMAND)\s*" "[(](?P<name>[a-zA-Z0-9_]+)(,[^)]*)?[)]"
+            r"(?P<m>VLIB_CLI_COMMAND)\s*" "[(](?P<name>[a-zA-Z0-9_]+)(,[^)]*)?[)]"
         ),
         "clicmd",
     )
diff --git a/docs/_scripts/siphon/generate_syscfg.py b/docs/_scripts/siphon/generate_syscfg.py
index 105a59c8262..a403d311539 100644
--- a/docs/_scripts/siphon/generate_syscfg.py
+++ b/docs/_scripts/siphon/generate_syscfg.py
@@ -20,8 +20,8 @@ from . import generate
 generate.siphon_patterns.append(
     (
         re.compile(
-            "(?P<m>VLIB_CONFIG_FUNCTION)\s*"
-            '[(](?P<fn>[a-zA-Z0-9_]+)\s*,\s*"(?P<name>[^"]*)"[)]'
+            r"(?P<m>VLIB_CONFIG_FUNCTION)\s*"
+            r'[(](?P<fn>[a-zA-Z0-9_]+)\s*,\s*"(?P<name>[^"]*)"[)]'
         ),
         "syscfg",
     )