def test_infer_arg_sig_from_docstring(self) -> None:
assert_equal(infer_arg_sig_from_docstring("(*args, **kwargs)"),
[ArgSig(name='*args'), ArgSig(name='**kwargs')])
assert_equal(
infer_arg_sig_from_docstring(
"(x: Tuple[int, Tuple[str, int], str]=(1, ('a', 2), 'y'), y: int=4)"),
[ArgSig(name='x', type='Tuple[int,Tuple[str,int],str]', default=True),
ArgSig(name='y', type='int', default=True)])
def test_infer_arg_sig_from_docstring(self) -> None:
assert_equal(infer_arg_sig_from_docstring("(*args, **kwargs)"),
[ArgSig(name='*args'), ArgSig(name='**kwargs')])
assert_equal(
infer_arg_sig_from_docstring(
"(x: Tuple[int, Tuple[str, int], str]=(1, ('a', 2), 'y'), y: int=4)"),
[ArgSig(name='x', type='Tuple[int,Tuple[str,int],str]', default=True),
ArgSig(name='y', type='int', default=True)])
def generate_c_function_stub(
module: ModuleType,
name: str,
obj: object,
output: List[str],
imports: List[str],
self_var: Optional[str] = None,
sigs: Optional[Dict[str, str]] = None,
class_name: Optional[str] = None,
class_sigs: Optional[Dict[str, str]] = None) -> None:
"""Generate stub for a single function or method.
The result (always a single line) will be appended to 'output'.
If necessary, any required names will be added to 'imports'.
The 'class_name' is used to find signature of __init__ or __new__ in
'class_sigs'.
"""
if sigs is None:
sigs = {}
if class_sigs is None:
class_sigs = {}
ret_type = 'None' if name == '__init__' and class_name else 'Any'
if (name in ('__new__', '__init__') and name not in sigs and class_name
and class_name in class_sigs):
inferred = [
FunctionSig(name=name,
args=infer_arg_sig_from_docstring(
class_sigs[class_name]),
ret_type=ret_type)
] # type: Optional[List[FunctionSig]]
else:
docstr = getattr(obj, '__doc__', None)
inferred = infer_sig_from_docstring(docstr, name)
if not inferred:
if class_name and name not in sigs:
inferred = [
FunctionSig(name,
args=infer_method_sig(name),
ret_type=ret_type)
]
else:
inferred = [
FunctionSig(name=name,
args=infer_arg_sig_from_docstring(
sigs.get(name, '(*args, **kwargs)')),
ret_type=ret_type)
]
is_overloaded = len(inferred) > 1 if inferred else False
if is_overloaded:
imports.append('from typing import overload')
if inferred:
for signature in inferred:
sig = []
for arg in signature.args:
if arg.name == self_var:
arg_def = self_var
else:
arg_def = arg.name
if arg_def == 'None':
arg_def = '_none' # None is not a valid argument name
if arg.type:
arg_def += ": " + strip_or_import(
arg.type, module, imports)
if arg.default:
arg_def += " = ..."
sig.append(arg_def)
if is_overloaded:
output.append('@overload')
output.append('def {function}({args}) -> {ret}: ...'.format(
function=name,
args=", ".join(sig),
ret=strip_or_import(signature.ret_type, module, imports)))
def generate_c_function_stub(module: ModuleType,
name: str,
obj: object,
output: List[str],
imports: List[str],
self_var: Optional[str] = None,
sigs: Optional[Dict[str, str]] = None,
class_name: Optional[str] = None,
class_sigs: Optional[Dict[str, str]] = None) -> None:
"""Generate stub for a single function or method.
The result (always a single line) will be appended to 'output'.
If necessary, any required names will be added to 'imports'.
The 'class_name' is used to find signature of __init__ or __new__ in
'class_sigs'.
"""
if sigs is None:
sigs = {}
if class_sigs is None:
class_sigs = {}
ret_type = 'None' if name == '__init__' and class_name else 'Any'
if (name in ('__new__', '__init__') and name not in sigs and class_name and
class_name in class_sigs):
inferred = [FunctionSig(name=name,
args=infer_arg_sig_from_docstring(class_sigs[class_name]),
ret_type=ret_type)] # type: Optional[List[FunctionSig]]
else:
docstr = getattr(obj, '__doc__', None)
inferred = infer_sig_from_docstring(docstr, name)
if not inferred:
if class_name and name not in sigs:
inferred = [FunctionSig(name, args=infer_method_sig(name), ret_type=ret_type)]
else:
inferred = [FunctionSig(name=name,
args=infer_arg_sig_from_docstring(
sigs.get(name, '(*args, **kwargs)')),
ret_type=ret_type)]
is_overloaded = len(inferred) > 1 if inferred else False
if is_overloaded:
imports.append('from typing import overload')
if inferred:
for signature in inferred:
sig = []
for arg in signature.args:
if arg.name == self_var:
arg_def = self_var
else:
arg_def = arg.name
if arg.type:
arg_def += ": " + strip_or_import(arg.type, module, imports)
if arg.default:
arg_def += " = ..."
sig.append(arg_def)
if is_overloaded:
output.append('@overload')
output.append('def {function}({args}) -> {ret}: ...'.format(
function=name,
args=", ".join(sig),
ret=strip_or_import(signature.ret_type, module, imports)
))