def _handle_delegates(elt):
"Generates a `docment` dict handling `@delegates` and returns names of the kwargs in `elt`"
kwargs = []
arg_dict = docments(elt, full=True)
delwrap_dict = docments(elt.__delwrap__, full=True)
drop = arg_dict.keys()
for k,v in arg_dict.items():
if k in delwrap_dict.keys() and v["docment"] is None and k != "return":
kwargs.append(k)
if delwrap_dict[k]["docment"] is not None:
v["docment"] = delwrap_dict[k]["docment"] + f" passed to `{qual_name(elt.__delwrap__)}`"
else:
v['docment'] = f"Argument passed to `{qual_name(elt.__delwrap__)}`"
return arg_dict, kwargs
def _format_args(elt,
ment_dict: dict = None,
kwargs=[],
monospace=False,
is_class=False):
"Generates a formatted argument string, potentially from an existing `ment_dict`"
if ment_dict is None:
ment_dict = docments(elt, full=True)
arg_string = ""
return_string = ""
if not _is_static(elt) and is_class:
ment_dict.pop("self", {})
ment_dict.pop("cls", {})
ret = ment_dict.pop("return", None)
has_docment = _has_docment(elt)
if len(ment_dict.keys()) > 0:
if len(kwargs) > 0:
kwarg_dict = filter_keys(ment_dict, lambda x: x in kwargs)
ment_dict = filter_keys(ment_dict, lambda x: x not in kwargs)
arg_string = _generate_arg_string(ment_dict, has_docment)
arg_string += "|||**Valid Keyword Arguments**||\n"
arg_string += _generate_arg_string(
kwarg_dict, has_docment, monospace=monospace).replace(
"||Type|Default|Details|\n|---|---|---|---|\n", "")
else:
arg_string = _generate_arg_string(ment_dict,
has_docment,
monospace=monospace)
if not ret["anno"] == inspect._empty:
return_string = _generate_return_string(ret, has_docment)
return arg_string + return_string
def _format_args(elt):
"Generates a formatted argument string"
ment_dict = docments(elt, full=True)
arg_string = ""
return_string = ""
ment_dict.pop("self", {})
ment_dict.pop("cls", {})
ret = ment_dict.pop("return", None)
has_docment = _has_docment(elt)
if len(ment_dict.keys()) > 0:
arg_string = _generate_arg_string(ment_dict, has_docment)
if not ret["anno"] == inspect._empty:
return_string = _generate_return_string(ret, has_docment)
return arg_string + return_string