Support comments in custom DRC rules

Author: yaqwsx

kikit/sexpr.py

@@ -141,6 +141,18 @@ def readWhitespace(stream):
         c = stream.peek()
     return "".join(w)
 
+def readWhitespaceWithComments(stream):
+    w = []
+    c = stream.peek()
+    while c.isspace() or c == "#":
+        w.append(stream.read())
+        if c == "#":
+            while stream.peek() != "\n":
+                w.append(stream.read())
+            w.append(stream.read())
+        c = stream.peek()
+    return "".join(w)
+
 def readSexpr(stream, limit=None):
     """
     Reads SExpression from the stream. You can optionally try to parse only the
@@ -193,10 +205,10 @@ def parseSexprListF(sourceStream, limit=None):
     sexprs = []
     stream = Stream(sourceStream)
     while stream.peek() != "":
-        lw = readWhitespace(stream)
+        lw = readWhitespaceWithComments(stream)
         s = readSexpr(stream, limit=limit)
         s.leadingWhitespace = lw
-        s.trailingOuterWhitespace = readWhitespace(stream)
+        s.trailingOuterWhitespace = readWhitespaceWithComments(stream)
         sexprs.append(s)
     return sexprs
 

test/units/test_sexpr.py

@@ -28,7 +28,6 @@ def test_readQuotedString():
     res = str(a)
     assert res == SOURCE
 
-
 def test_identiy():
     SOURCE = "../resources/conn.kicad_pcb"
     with open(SOURCE, encoding="utf-8") as f:
@@ -41,3 +40,10 @@ def test_identiy():
     with open(SOURCE, encoding="utf-8") as f:
         ast2 = parseSexprF(f, limit=3)
     assert str(ast2) == truth
+
+def test_readwhitespace_with_comments():
+    stream = Stream(StringIO("  \n\n# Aloha\n("))
+    assert readWhitespaceWithComments(stream) == "  \n\n# Aloha\n"
+
+    stream = Stream(StringIO("  \n\n \t# Aloha\n("))
+    assert readWhitespaceWithComments(stream) == "  \n\n \t# Aloha\n"