Reflection Signature

Function and method signature utilities.

Signature Module

Function signature inspection utilities.

This submodule provides utilities for inspecting function signatures, parameters, and return annotations.

Examples

from rite.reflection.signature import ( ... signature_get_signature, ... signature_get_parameters ... ) def func(a: int, b: str = "default") -> str: ... return f"{a}{b}" sig = signature_get_signature(func) len(sig.parameters) 2

Modules

signature_get_parameters

Parameters Inspector

Get function parameters.

Examples

from rite.reflection.signature import signature_get_parameters def func(a: int, b: str = "default") -> str: ... return f"{a}{b}" params = signature_get_parameters(func) list(params.keys()) ['a', 'b']

Functions

signature_get_parameters(obj: Any) -> dict[str, inspect.Parameter]

Get function parameters.

Parameters:

Name	Type	Description	Default
obj	Any	Function or method to inspect.	required

Returns:

Type	Description
dict[str, Parameter]	Dictionary of parameter names to Parameter objects.

Examples:

>>> def func(a: int, b: str = "default") -> str:
...     return f"{a}{b}"
>>> params = signature_get_parameters(func)
>>> 'a' in params
True
>>> 'b' in params
True

Notes

Uses inspect.signature. Returns ordered dict of parameters.

signature_get_return_annotation

Return Annotation Inspector

Get function return annotation.

Examples

from rite.reflection.signature import ( ... signature_get_return_annotation ... ) def func(a: int) -> str: ... return str(a) signature_get_return_annotation(func)

Functions

signature_get_return_annotation(obj: Any) -> Any

Get function return annotation.

Parameters:

Name	Type	Description	Default
obj	Any	Function or method to inspect.	required

Returns:

Type	Description
Any	Return annotation or Signature.empty.

Examples:

>>> def func(a: int) -> str:
...     return str(a)
>>> signature_get_return_annotation(func)
<class 'str'>

Notes

Returns Signature.empty if no annotation.

signature_get_signature

Signature Inspector

Get function or method signature.

Examples

from rite.reflection.signature import signature_get_signature def func(a: int, b: str = "default") -> str: ... return f"{a}{b}" sig = signature_get_signature(func) str(sig) "(a: int, b: str = 'default') -> str"

Functions

signature_get_signature(obj: Any) -> inspect.Signature

Get function or method signature.

Parameters:

Name	Type	Description	Default
obj	Any	Function, method, or class to inspect.	required

Returns:

Type	Description
Signature	Signature object.

Examples:

>>> def func(a: int, b: str = "default") -> str:
...     return f"{a}{b}"
>>> sig = signature_get_signature(func)
>>> len(sig.parameters)
2

Notes

Uses inspect.signature. Returns Signature object.

options: show_root_heading: true show_source: false heading_level: 2