From 3c211c9d44bd56c54d50d2a429a13c387d597cfc Mon Sep 17 00:00:00 2001
From: chang-ning <spiderpower02@gmail.com>
Date: Mon, 13 Aug 2018 23:47:08 +0800
Subject: [PATCH] add Forward references

---
 docs/notes/python-typing.rst | 44 ++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

diff --git a/docs/notes/python-typing.rst b/docs/notes/python-typing.rst
index 53bd9773..10c33870 100644
--- a/docs/notes/python-typing.rst
+++ b/docs/notes/python-typing.rst
@@ -420,6 +420,50 @@ output:
     # mypy will not detect type errors
     $ mypy --strict foo.py
 
+
+Forward references
+-------------------
+
+Based on PEP 484, if we want to reference a type before it has been declared, we
+have to use **string literal** to imply that there is a type of that name later on
+in the file.
+
+.. code-block:: python
+
+    from typing import Optional
+
+
+    class Tree:
+        def __init__(
+            self, data: int,
+            left: Optional["Tree"],  # Forward references.
+            right: Optional["Tree"]
+        ) -> None:
+            self.data = data
+            self.left = left
+            self.right = right
+
+.. note::
+
+    There are some issues that mypy does not complain about Forward References.
+    Get further information from `Issue#948`_.
+
+.. _Issue\#948: https://github.com/python/mypy/issues/948
+
+.. code-block:: python
+
+    class A:
+        def __init__(self, a: A) -> None:  # should fail
+            self.a = a
+
+output:
+
+.. code-block:: bash
+
+    $ mypy --strict type.py
+    $ echo $?
+    0
+
 Type alias
 ----------