Documentation

reflect.Signature

The runtime signature of a function value, reconstructed from the value itself (BEP-062). Positional (required) parameters appear in `args` in declaration order; named/optional parameters appear in `opts`, keyed by name. A bound method reports its receiver-adjusted signature (no `self`).

Reference version

Signature

class reflect.Signature

The runtime signature of a function value, reconstructed from the value itself (BEP-062). Positional (required) parameters appear in args in declaration order; named/optional parameters appear in opts, keyed by name. A bound method reports its receiver-adjusted signature (no self).

Source:<builtin>/reflect/reflect.bamlbytes 14768–15333

Fields

name

string | null

The name the function was declared with; null for host callables and compiler-synthesized callables (including lambdas).

args

reflect.Arg[]

Positional (required) parameters, in order.

opts

map<string, reflect.Arg>

Named/optional parameters, keyed by parameter name.

errors

reflect.Type

The error type; never if the function cannot throw.

docstring

string | null

The function's doc comment (joined /// lines); null when absent.

Implementations

reflect.AnyClass for T

Instance methods

function

attributes

(self) -> reflect.Meta throws never

The class declaration's schema metadata, or empty metadata when the runtime type is not a class.

function

find

<T>(self, name: string) -> T | null throws reflect.errors.TypeMismatch

Read the field called name as T, or null if this value's class declares no such field. A present field holding null also reads as null; use has_field or get<T?> to tell the two apart.

Throws

  • reflect.errors.TypeMismatch if the field's value is not a T.
function

find_field

(self, name: string) -> reflect.class.Field | null throws never

A value-bound handle to the field called name, or null if this value's class declares no such field.

function

get

<T>(self, name: string) -> T throws reflect.errors.NotFound | reflect.errors.TypeMismatch

Read the field called name as T. Read a nullable field with a nullable T (get<int?>). find returns null for a missing field instead of throwing.

Throws

  • reflect.errors.NotFound if this value's class declares no field called name.
  • reflect.errors.TypeMismatch if the field's value is not a T.
function

get_field

(self, name: string) -> reflect.class.Field throws reflect.errors.NotFound

A value-bound handle to the field called name. find_field returns null instead of throwing.

Throws

  • reflect.errors.NotFound if this value's class declares no field called name.
function

has_field

(self, name: string) -> bool throws never

Whether this value's runtime class declares a field called name. false when the runtime type is not a class.

function

list_fields

(self) -> reflect.class.Field[] throws never

Reflected fields bound to this value for Field.value<T>().

function

name

(self) -> string throws never

The rendered name of this value's concrete runtime type.

function

type

(self) -> reflect.Type throws never

This value's concrete runtime type.

Source:<builtin>/reflect/reflect.bamlbytes 14431–14461