Add docstring hook tests

Author: chadrik

mypy/test/testcheck.py

@@ -76,6 +76,7 @@
     'check-classvar.test',
     'check-enum.test',
     'check-incomplete-fixture.test',
+    'check-docstring-hook.test',
 ]
 
 

test-data/unit/check-docstring-hook.test

@@ -0,0 +1,110 @@
+[case testFunctionDocstringHook]
+# flags: --config-file tmp/mypy.ini
+def f(x):
+    """
+    x: int
+    return: str
+    """
+    return 1  # E: Incompatible return value type (got "int", expected "str")
+f('')  # E: Argument 1 to "f" has incompatible type "str"; expected "int"
+[file mypy.ini]
+[[mypy]
+hooks.docstring_parser = tmp/myhooks.py:parse_docstring
+[file myhooks.py]
+def parse_docstring(docstring, opts, errs):
+    params = [l.split(':', 1) for l in docstring.strip().split('\n')]
+    return {k.strip(): (v.strip(), i + 1) for i, (k, v) in enumerate(params)}
+
+[case testMethodDocstringHook]
+# flags: --config-file tmp/mypy.ini
+class A:
+    def f(self, x):
+        """
+        x: int
+        return: str
+        """
+        self.f('')  # E: Argument 1 to "f" of "A" has incompatible type "str"; expected "int"
+        return 1  # E: Incompatible return value type (got "int", expected "str")
+A().f('')  # E: Argument 1 to "f" of "A" has incompatible type "str"; expected "int"
+[file mypy.ini]
+[[mypy]
+hooks.docstring_parser = tmp/myhooks.py:parse_docstring
+[file myhooks.py]
+def parse_docstring(docstring, opts, errs):
+    params = [l.split(':', 1) for l in docstring.strip().split('\n')]
+    return {k.strip(): (v.strip(), i + 1) for i, (k, v) in enumerate(params)}
+
+[case testSparseDocstringAnnotations]
+# flags: --config-file tmp/mypy.ini
+def f(x, y):
+    """
+    x: int
+    """
+    return 1
+f('', 1)  # E: Argument 1 to "f" has incompatible type "str"; expected "int"
+[file mypy.ini]
+[[mypy]
+hooks.docstring_parser = tmp/myhooks.py:parse_docstring
+[file myhooks.py]
+def parse_docstring(docstring, opts, errs):
+    params = [l.split(':', 1) for l in docstring.strip().split('\n')]
+    return {k.strip(): (v.strip(), i + 1) for i, (k, v) in enumerate(params)}
+
+
+[case testInvalidDocstringAnnotation]
+# flags: --config-file tmp/mypy.ini
+def f(x):
+    """
+    x: B/A/D
+    return: None
+    """
+    return None
+[file mypy.ini]
+[[mypy]
+hooks.docstring_parser = tmp/myhooks.py:parse_docstring
+[file myhooks.py]
+def parse_docstring(docstring, opts, errs):
+    params = [l.split(':', 1) for l in docstring.strip().split('\n')]
+    return {k.strip(): (v.strip(), i + 1) for i, (k, v) in enumerate(params)}
+[out]
+main:3: error: invalid type comment or annotation
+
+-- Python 2.7
+-- -------------------------
+
+[case testFunctionDocstringHook27]
+# flags: --config-file tmp/mypy.ini --python-version 2.7
+def f(x):
+    """
+    x: int
+    return: str
+    """
+    return 1  # E: Incompatible return value type (got "int", expected "str")
+f('')  # E: Argument 1 to "f" has incompatible type "str"; expected "int"
+[file mypy.ini]
+[[mypy]
+hooks.docstring_parser = tmp/myhooks.py:parse_docstring
+[file myhooks.py]
+def parse_docstring(docstring, opts, errs):
+    params = [l.split(':', 1) for l in docstring.strip().split('\n')]
+    return {k.strip(): (v.strip(), i + 1) for i, (k, v) in enumerate(params)}
+
+[case testMethodDocstringHook27]
+# flags: --config-file tmp/mypy.ini --python-version 2.7
+class A:
+    def f(self, x):
+        """
+        x: int
+        return: str
+        """
+        self.f('')  # E: Argument 1 to "f" of "A" has incompatible type "str"; expected "int"
+        return 1  # E: Incompatible return value type (got "int", expected "str")
+A().f('')  # E: Argument 1 to "f" of "A" has incompatible type "str"; expected "int"
+[file mypy.ini]
+[[mypy]
+hooks.docstring_parser = tmp/myhooks.py:parse_docstring
+[file myhooks.py]
+def parse_docstring(docstring, opts, errs):
+    params = [l.split(':', 1) for l in docstring.strip().split('\n')]
+    return {k.strip(): (v.strip(), i + 1) for i, (k, v) in enumerate(params)}
+