Add docstrings to fmt checking functions, add to docs

[etc/vim.git] / blib2to3 / pgen2 / literals.py

diff --git a/blib2to3/pgen2/literals.py b/blib2to3/pgen2/literals.py
index b9b63e6e5572c1bc35526c6126db2b31b798d270..b5fe42851148e7fd6270ae728a0327f1523dd4b5 100644 (file)
--- a/blib2to3/pgen2/literals.py
+++ b/blib2to3/pgen2/literals.py
@@ -5,18 +5,24 @@
 
 import re
 
-simple_escapes = {"a": "\a",
-                  "b": "\b",
-                  "f": "\f",
-                  "n": "\n",
-                  "r": "\r",
-                  "t": "\t",
-                  "v": "\v",
-                  "'": "'",
-                  '"': '"',
-                  "\\": "\\"}
-
-def escape(m):
+from typing import Dict, Match, Text
+
+
+simple_escapes: Dict[Text, Text] = {
+    "a": "\a",
+    "b": "\b",
+    "f": "\f",
+    "n": "\n",
+    "r": "\r",
+    "t": "\t",
+    "v": "\v",
+    "'": "'",
+    '"': '"',
+    "\\": "\\",
+}
+
+
+def escape(m: Match[Text]) -> Text:
     all, tail = m.group(0, 1)
     assert all.startswith("\\")
     esc = simple_escapes.get(tail)
@@ -37,17 +43,19 @@ def escape(m):
             raise ValueError("invalid octal string escape ('\\%s')" % tail) from None
     return chr(i)
 
-def evalString(s):
+
+def evalString(s: Text) -> Text:
     assert s.startswith("'") or s.startswith('"'), repr(s[:1])
     q = s[0]
-    if s[:3] == q*3:
-        q = q*3
-    assert s.endswith(q), repr(s[-len(q):])
-    assert len(s) >= 2*len(q)
-    s = s[len(q):-len(q)]
+    if s[:3] == q * 3:
+        q = q * 3
+    assert s.endswith(q), repr(s[-len(q) :])
+    assert len(s) >= 2 * len(q)
+    s = s[len(q) : -len(q)]
     return re.sub(r"\\(\'|\"|\\|[abfnrtv]|x.{0,2}|[0-7]{1,3})", escape, s)
 
-def test():
+
+def test() -> None:
     for i in range(256):
         c = chr(i)
         s = repr(c)