Browse Source

在没有编写模块文档的情况下不会报错,而是改为提示。

tags/v0.5.5
ChenXin 5 years ago
parent
commit
f35a4ae2b6
2 changed files with 19 additions and 10 deletions
  1. +1
    -0
      fastNLP/core/collect_fn.py
  2. +18
    -10
      fastNLP/doc_utils.py

+ 1
- 0
fastNLP/core/collect_fn.py View File

@@ -1,3 +1,4 @@
"""undocumented"""
from builtins import sorted

import torch


+ 18
- 10
fastNLP/doc_utils.py View File

@@ -22,13 +22,17 @@ def doc_process(m):
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:`" + m.__name__ + "." + name + "`" \
+ " :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.")
try:
if "undocumented" not in defined_m.__doc__ and name in defined_m.__all__:
obj.__doc__ = r"别名 :class:`" + m.__name__ + "." + name + "`" \
+ " :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
except:
print("Warning: Module {} lacks `__doc__`".format(module_name))
break

# 识别并标注基类,只有基类也在 fastNLP 中定义才显示
@@ -40,7 +44,11 @@ def doc_process(m):
module_name, i = "fastNLP", 1
for i in range(len(parts) - 1):
defined_m = sys.modules[module_name]
if "undocumented" not in defined_m.__doc__ and name in defined_m.__all__:
obj.__doc__ = r"基类 :class:`" + defined_m.__name__ + "." + base.__name__ + "` \n\n" + obj.__doc__
try:
if "undocumented" not in defined_m.__doc__ and name in defined_m.__all__:
obj.__doc__ = r"基类 :class:`" + defined_m.__name__ + "." + base.__name__ + "` \n\n" + obj.__doc__
break
module_name += "." + parts[i + 1]
except:
print("Warning: Module {} lacks `__doc__`".format(module_name))
break
module_name += "." + parts[i + 1]

Loading…
Cancel
Save