print_signatures.py 4.4 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
Z
Zeng Jinle 已提交
28 29
import six
import functools
Y
yuyang18 已提交
30 31 32

member_dict = collections.OrderedDict()

Z
Zeng Jinle 已提交
33 34
visited_modules = set()

35 36 37 38 39 40
# 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__",
]
41

Y
yuyang18 已提交
42

43 44 45 46 47 48
def md5(doc):
    hash = hashlib.md5()
    hash.update(str(doc).encode('utf-8'))
    return hash.hexdigest()


Z
Zeng Jinle 已提交
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
def get_functools_partial_spec(func):
    func_str = func.func.__name__
    args = func.args
    keywords = func.keywords
    return '{}(args={}, keywords={})'.format(func_str, args, keywords)


def format_spec_doc(spec, doc=None):
    args = spec.args
    varargs = spec.varargs
    keywords = spec.keywords
    defaults = list(spec.defaults)
    for idx, item in enumerate(defaults):
        if not isinstance(item, functools.partial):
            continue

        defaults[idx] = get_functools_partial_spec(item)

    return 'ArgSpec(args={}, varargs={}, keywords={}, defaults={})'.format(
        args, varargs, keywords, tuple(defaults))


71
def queue_dict(member, cur_name):
72 73 74
    if cur_name in omitted_list:
        return

Z
Zeng Jinle 已提交
75
    doc_md5 = md5(member.__doc__)
T
tianshuo78520a 已提交
76 77 78 79 80

    if inspect.isclass(member):
        args = member.__module__ + "." + member.__name__
    else:
        try:
Z
Zeng Jinle 已提交
81
            args = format_spec_doc(inspect.getargspec(member))
T
tianshuo78520a 已提交
82 83 84 85 86
        except TypeError:  # special for PyBind method
            args = "  ".join([
                line.strip() for line in pydoc.render_doc(member).split('\n')
                if "->" in line
            ])
Z
Zeng Jinle 已提交
87
    member_dict[cur_name] = "({}, ('document', '{}'))".format(args, doc_md5)
88 89


Y
yuyang18 已提交
90 91
def visit_member(parent_name, member):
    cur_name = ".".join([parent_name, member.__name__])
X
fix py3  
Xin Pan 已提交
92
    if inspect.isclass(member):
93
        queue_dict(member, cur_name)
Y
yuyang18 已提交
94 95 96 97 98
        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):
99
        queue_dict(member, cur_name)
X
fix py3  
Xin Pan 已提交
100 101
    elif inspect.isgetsetdescriptor(member):
        return
Y
yuyang18 已提交
102 103 104 105 106
    else:
        raise RuntimeError("Unsupported generate signature of member, type {0}".
                           format(str(type(member))))


Z
Zeng Jinle 已提交
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
def is_primitive(instance):
    int_types = (int, long) if six.PY2 else (int, )
    pritimitive_types = int_types + (float, str)
    if isinstance(instance, pritimitive_types):
        return True
    elif isinstance(instance, (list, tuple, set)):
        for obj in instance:
            if not is_primitive(obj):
                return False

        return True
    else:
        return False


Y
yuyang18 已提交
122
def visit_all_module(mod):
Z
Zeng Jinle 已提交
123 124 125 126 127 128 129 130 131
    mod_name = mod.__name__
    if mod_name != 'paddle' and not mod_name.startswith('paddle.'):
        return

    if mod in visited_modules:
        return

    visited_modules.add(mod)

Y
yuyang18 已提交
132 133 134 135 136 137 138
    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
Z
Zeng Jinle 已提交
139 140 141 142 143 144 145

        if is_primitive(instance):
            continue

        if not hasattr(instance, "__name__"):
            continue

Y
yuyang18 已提交
146 147 148 149 150 151
        if inspect.ismodule(instance):
            visit_all_module(instance)
        else:
            visit_member(mod.__name__, instance)


X
Xin Pan 已提交
152 153 154
modules = sys.argv[1].split(",")
for m in modules:
    visit_all_module(importlib.import_module(m))
Y
yuyang18 已提交
155 156

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