deb-mistral/mistral/utils/inspect_utils.py
Nikolay Mahotkin c19e5cde45 Add mechanism for generation action parameters
* Add getting human-readable params for adding
   to action
 * Add getting description for action
 * Parameters and description is already generated
   for std_actions
 * Unit tests

TODO:
  * Add the same for OpenStack Actions

Change-Id: I2f2a8ebe3bc3e75ab53f985adcecb59c0f1d7d8b
2014-09-12 14:23:21 +04:00

59 lines
1.7 KiB
Python

# Copyright 2014 - Mirantis, Inc.
#
# 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
def get_public_fields(obj):
"""Returns only public fields from object or class."""
public_attributes = [attr for attr in dir(obj)
if not attr.startswith("_")]
public_fields = {}
for attribute_str in public_attributes:
attr = getattr(obj, attribute_str)
is_field = not (inspect.isbuiltin(attr)
or inspect.isfunction(attr)
or inspect.ismethod(attr))
if is_field:
public_fields[attribute_str] = attr
return public_fields
def get_docstring(obj):
return inspect.getdoc(obj)
def get_arg_list_as_str(func):
argspec = inspect.getargspec(func)
defs = list(argspec.defaults or [])
args = argspec.args
args.remove('self')
diff_args_defs = len(args) - len(defs)
arg_str_list = []
for index, default in enumerate(args):
if index >= diff_args_defs:
arg_str_list.append("%s=%s" % (args[index],
defs[index - diff_args_defs]))
else:
arg_str_list.append("%s" % args[index])
return ", ".join(arg_str_list)