# 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: ./print_signature "paddle.fluid" > signature.txt """ from __future__ import print_function import importlib import inspect import collections import sys import pydoc import hashlib import six import functools member_dict = collections.OrderedDict() visited_modules = set() # 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__", ] def md5(doc): hash = hashlib.md5() hash.update(str(doc).encode('utf-8')) return hash.hexdigest() 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)) def queue_dict(member, cur_name): if cur_name in omitted_list: return doc_md5 = md5(member.__doc__) if inspect.isclass(member): args = member.__module__ + "." + member.__name__ else: try: args = format_spec_doc(inspect.getargspec(member)) 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] = "({}, ('document', '{}'))".format(args, doc_md5) def visit_member(parent_name, member): cur_name = ".".join([parent_name, member.__name__]) if inspect.isclass(member): queue_dict(member, cur_name) 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): queue_dict(member, cur_name) elif inspect.isgetsetdescriptor(member): return else: raise RuntimeError("Unsupported generate signature of member, type {0}". format(str(type(member)))) 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 def visit_all_module(mod): 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) 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 is_primitive(instance): continue if not hasattr(instance, "__name__"): continue if inspect.ismodule(instance): visit_all_module(instance) else: visit_member(mod.__name__, instance) modules = sys.argv[1].split(",") for m in modules: visit_all_module(importlib.import_module(m)) for name in member_dict: print(name, member_dict[name])