orionis.introspection.ReflectionCallable

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

Explore modules View classes

class documentation

class ReflectionCallable(IReflectionCallable): (source)

Constructor: ReflectionCallable(fn)

View In Hierarchy

Undocumented

Method	`__contains__`	Check if the cache contains the specified key.
Method	`__delitem__`	Remove an item from the memory cache by key.
Method	`__getitem__`	Retrieve a cached value by key.
Method	`__init__`	Initialize the reflection wrapper with a callable object.
Method	`__setitem__`	Store a value in the cache with the specified key.
Method	`clearCache`	Clear all cached reflection data.
Method	`getCallable`	Return the callable function associated with this instance.
Method	`getDependencies`	Analyze and return the dependency signature of the wrapped callable.
Method	`getDocstring`	Return the docstring of the callable.
Method	`getFile`	Retrieve the absolute path to the source file of the callable.
Method	`getModuleName`	Return the module name where the callable is defined.
Method	`getModuleWithCallableName`	Return the fully qualified name of the callable.
Method	`getName`	Return the name of the callable.
Method	`getSignature`	Return the signature of the callable.
Method	`getSourceCode`	Retrieve the source code of the wrapped callable.
Class Variable	`__slots__`	Undocumented
Instance Variable	`_cache`	Undocumented
Instance Variable	`_docstring`	Undocumented
Instance Variable	`_function`	Undocumented
Instance Variable	`_module`	Undocumented
Instance Variable	`_name`	Undocumented

def __contains__(self, key: str) -> bool: (source) ¶

Check if the cache contains the specified key.

Parameters
key:`str`	The key to check for existence in the cache.

Returns
`bool`	True if the key exists in the cache, False otherwise.

def __delitem__(self, key: str): (source) ¶

Remove an item from the memory cache by key.

Parameters
key:`str`	The key to remove from the cache.

Returns
`None`	This method does not return a value.

def __getitem__(self, key: str) -> object | None: (source) ¶

Retrieve a cached value by key.

Parameters
key:`str`	The key to look up in the cache.

Returns
`object or None`	The cached value if found, otherwise None.

def __init__(self, fn: callable): (source) ¶

Initialize the reflection wrapper with a callable object.

Parameters
fn:`callable`	The function, method, or lambda to be wrapped.

Returns
`None`	This method does not return a value.

Raises
`TypeError`	If `fn` is not a function, method, or lambda.

def __setitem__(self, key: str, value: object): (source) ¶

Store a value in the cache with the specified key.

Parameters
key:`str`	The key under which to store the value.
value:`object`	The value to store in the cache.

Returns
`None`	This method does not return a value.

def clearCache(self): (source) ¶

overrides orionis.introspection.callables.contracts.reflection.IReflectionCallable.clearCache

Clear all cached reflection data.

Removes all cached entries stored in the reflection instance. Forces fresh computation on subsequent method calls.

Returns
`None`	This method does not return a value.

def getCallable(self) -> callable: (source) ¶

overrides orionis.introspection.callables.contracts.reflection.IReflectionCallable.getCallable

Return the callable function associated with this instance.

Returns
`callable`	The function object encapsulated by this instance.

def getDependencies(self) -> Signature: (source) ¶

overrides orionis.introspection.callables.contracts.reflection.IReflectionCallable.getDependencies

Analyze and return the dependency signature of the wrapped callable.

Delegates to ReflectDependencies to inspect each parameter and resolve its type annotation into a dependency descriptor. The result is stored in the shared cache so that repeated calls skip reanalysis.

Returns
`Signature`	A structure that holds the resolved and unresolved dependencies derived from the callable's parameter annotations.

def getDocstring(self) -> str: (source) ¶

overrides orionis.introspection.callables.contracts.reflection.IReflectionCallable.getDocstring

Return the docstring of the callable.

Returns
`str`	The docstring of the function, or an empty string if not present.

def getFile(self) -> str: (source) ¶

overrides orionis.introspection.callables.contracts.reflection.IReflectionCallable.getFile

Retrieve the absolute path to the source file of the callable.

Returns
`str`	Absolute path to the file containing the callable.

Raises
`TypeError`	If the callable is built-in or its file cannot be determined.

def getModuleName(self) -> str: (source) ¶

overrides orionis.introspection.callables.contracts.reflection.IReflectionCallable.getModuleName

Return the module name where the callable is defined.

Returns
`str`	The name of the module in which the function was declared.

def getModuleWithCallableName(self) -> str: (source) ¶

overrides orionis.introspection.callables.contracts.reflection.IReflectionCallable.getModuleWithCallableName

Return the fully qualified name of the callable.

Combines the module name and callable name to create a complete identifier.

Returns
`str`	The module and callable name separated by a dot.

def getName(self) -> str: (source) ¶

overrides orionis.introspection.callables.contracts.reflection.IReflectionCallable.getName

Return the name of the callable.

Returns
`str`	Name of the function as defined in its declaration.

def getSignature(self) -> inspect.Signature: (source) ¶

overrides orionis.introspection.callables.contracts.reflection.IReflectionCallable.getSignature

Return the signature of the callable.

Returns
`inspect.Signature`	The signature object representing the callable's parameters, default values, and type annotations.

def getSourceCode(self) -> str: (source) ¶

overrides orionis.introspection.callables.contracts.reflection.IReflectionCallable.getSourceCode

Retrieve the source code of the wrapped callable.

Uses Python's inspect module to extract the complete source code of the callable function from its definition file.

Returns
`str`	The source code of the callable function as a string.

Raises
`AttributeError`	If the source code cannot be obtained due to an OSError or if the callable is built-in without accessible source.

__slots__: tuple[str, ...] = (source) ¶

overrides orionis.introspection.callables.contracts.reflection.IReflectionCallable.__slots__

Undocumented

_cache: dict[str, object] = (source) ¶

Undocumented

_docstring: str = (source) ¶

Undocumented

_function = (source) ¶

Undocumented

_module: str = (source) ¶

Undocumented

_name: str = (source) ¶

Undocumented