print_signatures.py 3.0 KB
Newer Older
Y
yuyang18 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
# Copyright (c) 2018 PaddlePaddle Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Print all signature of a python module in alphabet order.

Usage:
18
    ./print_signature  "paddle.fluid" > signature.txt
Y
yuyang18 已提交
19
"""
M
minqiyang 已提交
20 21
from __future__ import print_function

Y
yuyang18 已提交
22 23 24 25 26
import importlib
import inspect
import collections
import sys
import pydoc
27
import hashlib
Y
yuyang18 已提交
28 29 30

member_dict = collections.OrderedDict()

31 32 33 34 35 36
# APIs that should not be printed into API.spec 
omitted_list = [
    "paddle.fluid.LoDTensor.set",  # Do not know why it should be omitted
    "paddle.fluid.io.ComposeNotAligned",
    "paddle.fluid.io.ComposeNotAligned.__init__",
]
37

Y
yuyang18 已提交
38

39 40 41 42 43 44
def md5(doc):
    hash = hashlib.md5()
    hash.update(str(doc).encode('utf-8'))
    return hash.hexdigest()


45
def queue_dict(member, cur_name):
46 47 48
    if cur_name in omitted_list:
        return

T
tianshuo78520a 已提交
49 50 51 52 53 54
    doc = ('document', md5(member.__doc__))

    if inspect.isclass(member):
        args = member.__module__ + "." + member.__name__
    else:
        try:
55
            args = inspect.getargspec(member)
T
tianshuo78520a 已提交
56 57 58 59 60 61
        except TypeError:  # special for PyBind method
            args = "  ".join([
                line.strip() for line in pydoc.render_doc(member).split('\n')
                if "->" in line
            ])
    member_dict[cur_name] = (args, doc)
62 63


Y
yuyang18 已提交
64 65
def visit_member(parent_name, member):
    cur_name = ".".join([parent_name, member.__name__])
X
fix py3  
Xin Pan 已提交
66
    if inspect.isclass(member):
67
        queue_dict(member, cur_name)
Y
yuyang18 已提交
68 69 70 71 72
        for name, value in inspect.getmembers(member):
            if hasattr(value, '__name__') and (not name.startswith("_") or
                                               name == "__init__"):
                visit_member(cur_name, value)
    elif callable(member):
73
        queue_dict(member, cur_name)
X
fix py3  
Xin Pan 已提交
74 75
    elif inspect.isgetsetdescriptor(member):
        return
Y
yuyang18 已提交
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
    else:
        raise RuntimeError("Unsupported generate signature of member, type {0}".
                           format(str(type(member))))


def visit_all_module(mod):
    for member_name in (
            name
            for name in (mod.__all__ if hasattr(mod, "__all__") else dir(mod))
            if not name.startswith("_")):
        instance = getattr(mod, member_name, None)
        if instance is None:
            continue
        if inspect.ismodule(instance):
            visit_all_module(instance)
        else:
            visit_member(mod.__name__, instance)


X
Xin Pan 已提交
95 96 97
modules = sys.argv[1].split(",")
for m in modules:
    visit_all_module(importlib.import_module(m))
Y
yuyang18 已提交
98 99

for name in member_dict:
M
minqiyang 已提交
100
    print(name, member_dict[name])