70d46772b4
A "_" is a valid python identifier as long as it is not the first letter of the given attribute (as an attribute dict doesn't have the concept of protected/private variables). Also include a few links and comments as to why the restrictions are inplace. Change-Id: I23f17113cedb99b2817bad0c464a43d10af6722c
129 lines
4.0 KiB
Python
129 lines
4.0 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# vim: tabstop=4 shiftwidth=4 softtabstop=4
|
|
|
|
# Copyright (C) 2012-2013 Yahoo! Inc. 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.
|
|
|
|
import inspect
|
|
import six
|
|
import types
|
|
|
|
|
|
def get_member_names(obj, exclude_hidden=True):
|
|
"""Get all the member names for a object."""
|
|
names = []
|
|
for (name, _value) in inspect.getmembers(obj):
|
|
if exclude_hidden and name.startswith("_"):
|
|
continue
|
|
names.append(name)
|
|
return sorted(names)
|
|
|
|
|
|
def get_class_name(obj):
|
|
"""Get class name for object.
|
|
|
|
If object is a type, fully qualified name of the type is returned.
|
|
Else, fully qualified name of the type of the object is returned.
|
|
For builtin types, just name is returned.
|
|
"""
|
|
if not isinstance(obj, six.class_types):
|
|
obj = type(obj)
|
|
if obj.__module__ in ('builtins', '__builtin__', 'exceptions'):
|
|
return obj.__name__
|
|
return '.'.join((obj.__module__, obj.__name__))
|
|
|
|
|
|
def get_all_class_names(obj, up_to=object):
|
|
"""Get class names of object parent classes
|
|
|
|
Iterate over all class names object is instance or subclass of,
|
|
in order of method resolution (mro). If up_to parameter is provided,
|
|
only name of classes that are sublcasses to that class are returned.
|
|
"""
|
|
if not isinstance(obj, six.class_types):
|
|
obj = type(obj)
|
|
for cls in obj.mro():
|
|
if issubclass(cls, up_to):
|
|
yield get_class_name(cls)
|
|
|
|
|
|
def get_callable_name(function):
|
|
"""Generate a name from callable
|
|
|
|
Tries to do the best to guess fully qualified callable name.
|
|
"""
|
|
method_self = get_method_self(function)
|
|
if method_self is not None:
|
|
# this is bound method
|
|
if isinstance(method_self, six.class_types):
|
|
# this is bound class method
|
|
im_class = method_self
|
|
else:
|
|
im_class = type(method_self)
|
|
parts = (im_class.__module__, im_class.__name__,
|
|
function.__name__)
|
|
elif inspect.isfunction(function) or inspect.ismethod(function):
|
|
parts = (function.__module__, function.__name__)
|
|
else:
|
|
im_class = type(function)
|
|
if im_class is type:
|
|
im_class = function
|
|
parts = (im_class.__module__, im_class.__name__)
|
|
return '.'.join(parts)
|
|
|
|
|
|
def get_method_self(method):
|
|
if not inspect.ismethod(method):
|
|
return None
|
|
try:
|
|
return six.get_method_self(method)
|
|
except AttributeError:
|
|
return None
|
|
|
|
|
|
def is_bound_method(method):
|
|
"""Returns if the method given is a bound to a object or not."""
|
|
return bool(get_method_self(method))
|
|
|
|
|
|
def _get_arg_spec(function):
|
|
if isinstance(function, type):
|
|
bound = True
|
|
function = function.__init__
|
|
elif isinstance(function, (types.FunctionType, types.MethodType)):
|
|
bound = is_bound_method(function)
|
|
function = getattr(function, '__wrapped__', function)
|
|
else:
|
|
function = function.__call__
|
|
bound = is_bound_method(function)
|
|
return inspect.getargspec(function), bound
|
|
|
|
|
|
def get_required_callable_args(function):
|
|
"""Get names of argument required by callable"""
|
|
argspec, bound = _get_arg_spec(function)
|
|
f_args = argspec.args
|
|
if argspec.defaults:
|
|
f_args = f_args[:-len(argspec.defaults)]
|
|
if bound:
|
|
f_args = f_args[1:]
|
|
return f_args
|
|
|
|
|
|
def accepts_kwargs(function):
|
|
"""Returns True if function accepts kwargs"""
|
|
argspec, _bound = _get_arg_spec(function)
|
|
return bool(argspec.keywords)
|