CallSignature

A Python call signature, e.g. the part after the def keyword and the name in a function expression.

jsx

import { CallSignature } from "@alloy-js/python";

<CallSignature
  args
  classFunction
  instanceFunction
  kwargs
  parameters={ParameterDescriptor[] | string[]}
  returnType={Children}
  typeParameters={string[]}
 />

stc

import { CallSignature } from "@alloy-js/python/stc";

CallSignature({
  args: boolean,
  classFunction: boolean,
  instanceFunction: boolean,
  kwargs: boolean,
  parameters: ParameterDescriptor[] | string[],
  returnType: Children,
  typeParameters: string[],
}).children(children)

Props

args	optionalboolean Indicates if there are positional arguments (*args) in the function
classFunction	optionalboolean Indicates that this is a class function.
instanceFunction	optionalboolean Indicates that this is an instance function.
kwargs	optionalboolean Indicates if there are keyword arguments (**kwargs) in the function
parameters	optionalParameterDescriptor[] | string[] The parameters to the call signature. Can be an array of strings for parameters which don’t have a type or a default value. Otherwise, it’s an array of ParameterDescriptors.
returnType	optionalChildren The return type of the function.
typeParameters	optionalstring[] The type parameters of the call signature, e.g. for a generic function. This is only supported in Python 3.12+.

Remarks

Any parameters or type parameters declared in this signature will be placed in the current scope. This component does not make a scope to hold its parameters.

Example

<CallSignature
  parameters={[{ name: "a", type: "int" }, { name: "b", type: "str" }]}
  returnType="int"
/>

renders to

(a: int, b: str) -> int