From 113ef8b11a34ca72fd0a1b6a1496dd42e272b94d Mon Sep 17 00:00:00 2001
From: ChenXin <will131@foxmail.com>
Date: Wed, 4 Sep 2019 14:31:45 +0800
Subject: [PATCH] add code to detect the defined location automatically

---
 fastNLP/__init__.py            |  4 ++++
 fastNLP/doc_utils.py           | 21 +++++++++++++++++++++
 fastNLP/embeddings/__init__.py |  4 ++++
 fastNLP/io/__init__.py         |  4 ++++
 fastNLP/models/__init__.py     |  4 ++++
 fastNLP/modules/__init__.py    |  4 ++++
 6 files changed, 41 insertions(+)
 create mode 100644 fastNLP/doc_utils.py

diff --git a/fastNLP/__init__.py b/fastNLP/__init__.py
index 19efac31..aceaf47f 100644
--- a/fastNLP/__init__.py
+++ b/fastNLP/__init__.py
@@ -70,3 +70,7 @@ from . import models
 from . import modules
 from .core import *
 from .io import loader, pipe
+
+import sys
+from .doc_utils import doc_process
+doc_process(sys.modules[__name__])
\ No newline at end of file
diff --git a/fastNLP/doc_utils.py b/fastNLP/doc_utils.py
new file mode 100644
index 00000000..924b7a6a
--- /dev/null
+++ b/fastNLP/doc_utils.py
@@ -0,0 +1,21 @@
+import inspect
+import sys
+
+
+def doc_process(m):
+    for name, obj in inspect.getmembers(m):
+        if inspect.isclass(obj) or inspect.isfunction(obj):
+            if obj.__module__ != m.__name__:
+                if obj.__doc__ is None:
+                    print(name, obj.__doc__)
+                else:
+                    module_name = obj.__module__
+                    while 1:
+                        defined_m = sys.modules[module_name]
+                        if "undocumented" not in defined_m.__doc__ and name in defined_m.__all__:
+                            obj.__doc__ = r"定义在 :class:`" + module_name + "." + name + "`\n" + obj.__doc__
+                            break
+                        module_name = ".".join(module_name.split('.')[:-1])
+                        if module_name == m.__name__:
+                            print(name, ": not found defined doc.")
+                            break
diff --git a/fastNLP/embeddings/__init__.py b/fastNLP/embeddings/__init__.py
index 8a970e25..ea99154e 100644
--- a/fastNLP/embeddings/__init__.py
+++ b/fastNLP/embeddings/__init__.py
@@ -25,3 +25,7 @@ from .bert_embedding import BertEmbedding, BertWordPieceEncoder
 from .char_embedding import CNNCharEmbedding, LSTMCharEmbedding
 from .stack_embedding import StackEmbedding
 from .utils import get_embeddings
+
+import sys
+from ..doc_utils import doc_process
+doc_process(sys.modules[__name__])
\ No newline at end of file
diff --git a/fastNLP/io/__init__.py b/fastNLP/io/__init__.py
index 6f727f05..c8b3dfaa 100644
--- a/fastNLP/io/__init__.py
+++ b/fastNLP/io/__init__.py
@@ -88,3 +88,7 @@ from .model_io import ModelLoader, ModelSaver
 
 from .loader import *
 from .pipe import *
+
+import sys
+from ..doc_utils import doc_process
+doc_process(sys.modules[__name__])
\ No newline at end of file
diff --git a/fastNLP/models/__init__.py b/fastNLP/models/__init__.py
index a659e1d5..62adbf69 100644
--- a/fastNLP/models/__init__.py
+++ b/fastNLP/models/__init__.py
@@ -38,3 +38,7 @@ from .cnn_text_classification import CNNText
 from .sequence_labeling import SeqLabeling, AdvSeqLabel
 from .snli import ESIM
 from .star_transformer import StarTransEnc, STSeqCls, STNLICls, STSeqLabel
+
+import sys
+from ..doc_utils import doc_process
+doc_process(sys.modules[__name__])
\ No newline at end of file
diff --git a/fastNLP/modules/__init__.py b/fastNLP/modules/__init__.py
index 7959e454..769dc42a 100644
--- a/fastNLP/modules/__init__.py
+++ b/fastNLP/modules/__init__.py
@@ -54,3 +54,7 @@ from . import encoder
 from .decoder import *
 from .dropout import TimestepDropout
 from .encoder import *
+
+import sys
+from ..doc_utils import doc_process
+doc_process(sys.modules[__name__])