orionis.introspection.callables.contracts.reflection.IReflectionCallable

ORIONIS API REFERENCE

Modules Classes Names

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 IReflectionCallable(ABC): (source)

Known subclasses: orionis.introspection.ReflectionCallable

View In Hierarchy

Undocumented

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

@abstractmethod

def clearCache(self): (source) ¶

overridden in orionis.introspection.ReflectionCallable

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.

@abstractmethod

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

overridden in orionis.introspection.ReflectionCallable

Return the callable function associated with this instance.

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

@abstractmethod

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

overridden in orionis.introspection.ReflectionCallable

Analyze and return the dependency signature of the wrapped callable.

Inspects the callable's parameters and resolves each one into a typed dependency descriptor. The result is cached so that repeated calls do not re-run the analysis.

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

@abstractmethod

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

overridden in orionis.introspection.ReflectionCallable

Return the docstring of the callable.

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

@abstractmethod

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

overridden in orionis.introspection.ReflectionCallable

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.

@abstractmethod

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

overridden in orionis.introspection.ReflectionCallable

Return the module name where the callable is defined.

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

@abstractmethod

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

overridden in orionis.introspection.ReflectionCallable

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.

@abstractmethod

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

overridden in orionis.introspection.ReflectionCallable

Return the name of the callable.

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

@abstractmethod

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

overridden in orionis.introspection.ReflectionCallable

Return the signature of the callable.

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

@abstractmethod

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

overridden in orionis.introspection.ReflectionCallable

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 = (source) ¶

overridden in orionis.introspection.ReflectionCallable

Undocumented