orionis.introspection.modules.contracts.reflection.IReflectionModule

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

Known subclasses: orionis.introspection.ReflectionModule

View In Hierarchy

Undocumented

Method	`clearCache`	Clear all cached reflection data.
Method	`getClass`	Retrieve a class object by its name from the module.
Method	`getClasses`	Return a dictionary of classes defined in the module.
Method	`getConstant`	Retrieve a constant value by name from the module.
Method	`getConstants`	Retrieve constants defined in the module.
Method	`getFile`	Return the file path of the module.
Method	`getFunctions`	Return a dictionary of functions defined in the module.
Method	`getImports`	Retrieve imported modules from the module.
Method	`getModule`	Return the imported module object.
Method	`getPrivateAsyncFunctions`	Return private asynchronous functions defined in the module.
Method	`getPrivateClasses`	Return a dictionary of private classes defined in the module.
Method	`getPrivateConstants`	Retrieve private constants defined in the module.
Method	`getPrivateFunctions`	Return private functions defined in the module.
Method	`getPrivateSyncFunctions`	Return private synchronous functions defined in the module.
Method	`getProtectedAsyncFunctions`	Return protected asynchronous functions defined in the module.
Method	`getProtectedClasses`	Return a dictionary of protected classes defined in the module.
Method	`getProtectedConstants`	Return protected constants defined in the module.
Method	`getProtectedFunctions`	Return a dictionary of protected functions defined in the module.
Method	`getProtectedSyncFunctions`	Return protected synchronous functions defined in the module.
Method	`getPublicAsyncFunctions`	Return a dictionary of public asynchronous functions in the module.
Method	`getPublicClasses`	Return a dictionary of public classes defined in the module.
Method	`getPublicConstants`	Retrieve public constants defined in the module.
Method	`getPublicFunctions`	Return a dictionary of public functions defined in the module.
Method	`getPublicSyncFunctions`	Return a dictionary of public synchronous functions in the module.
Method	`getSourceCode`	Retrieve the source code of the module.
Method	`hasClass`	Check if a class with the specified name exists in the module.
Method	`removeClass`	Remove a class from the module.
Method	`setClass`	Set a class in the module.

@abstractmethod

def clearCache(self): (source) ¶

overridden in orionis.introspection.ReflectionModule

Clear all cached reflection data.

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

Parameters
None

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

@abstractmethod

def getClass(self, class_name: str) -> type | None: (source) ¶

overridden in orionis.introspection.ReflectionModule

Retrieve a class object by its name from the module.

Parameters
class_name:`str`	Name of the class to retrieve.

Returns
`type or None`	The class object if found, otherwise None.

@abstractmethod

def getClasses(self) -> dict: (source) ¶

overridden in orionis.introspection.ReflectionModule

Return a dictionary of classes defined in the module.

Parameters
None

Returns
`dict`	Dictionary with class names as keys and class objects as values.

@abstractmethod

def getConstant(self, constant_name: str) -> object | None: (source) ¶

overridden in orionis.introspection.ReflectionModule

Retrieve a constant value by name from the module.

Parameters
constant_name:`str`	Name of the constant to retrieve.

Returns
`object or None`	Value of the constant if found, otherwise None.

@abstractmethod

def getConstants(self) -> dict: (source) ¶

overridden in orionis.introspection.ReflectionModule

Retrieve constants defined in the module.

Parameters
None

Returns
`dict`	Dictionary with constant names as keys and their values as values.

@abstractmethod

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

overridden in orionis.introspection.ReflectionModule

Return the file path of the module.

Returns
`str`	The absolute file path of the module.

@abstractmethod

def getFunctions(self) -> dict: (source) ¶

overridden in orionis.introspection.ReflectionModule

Return a dictionary of functions defined in the module.

Parameters
None

Returns
`dict`	Dictionary with function names as keys and function objects as values.

@abstractmethod

def getImports(self) -> dict: (source) ¶

overridden in orionis.introspection.ReflectionModule

Retrieve imported modules from the module.

Returns
`dict`	Dictionary mapping import names to module objects.

@abstractmethod

def getModule(self) -> object: (source) ¶

overridden in orionis.introspection.ReflectionModule

Return the imported module object.

Returns
`object`	The imported module object.

@abstractmethod

def getPrivateAsyncFunctions(self) -> dict: (source) ¶

overridden in orionis.introspection.ReflectionModule

Return private asynchronous functions defined in the module.

Returns
`dict`	Dictionary with function names as keys and function objects as values.

@abstractmethod

def getPrivateClasses(self) -> dict: (source) ¶

overridden in orionis.introspection.ReflectionModule

Return a dictionary of private classes defined in the module.

Parameters
None

Returns
`dict`	Dictionary with class names as keys and class objects as values.

@abstractmethod

def getPrivateConstants(self) -> dict: (source) ¶

overridden in orionis.introspection.ReflectionModule

Retrieve private constants defined in the module.

Parameters
None

Returns
`dict`	Dictionary with constant names as keys and their values as values.

@abstractmethod

def getPrivateFunctions(self) -> dict: (source) ¶

overridden in orionis.introspection.ReflectionModule

Return private functions defined in the module.

Parameters
None

Returns
`dict`	Dictionary mapping function names to function objects.

@abstractmethod

def getPrivateSyncFunctions(self) -> dict: (source) ¶

overridden in orionis.introspection.ReflectionModule

Return private synchronous functions defined in the module.

Parameters
None

Returns
`dict`	Dictionary with function names as keys and function objects as values.

@abstractmethod

def getProtectedAsyncFunctions(self) -> dict: (source) ¶

overridden in orionis.introspection.ReflectionModule

Return protected asynchronous functions defined in the module.

Parameters
None

Returns
`dict`	Dictionary mapping function names to function objects.

@abstractmethod

def getProtectedClasses(self) -> dict: (source) ¶

overridden in orionis.introspection.ReflectionModule

Return a dictionary of protected classes defined in the module.

Parameters
None

Returns
`dict`	Dictionary with class names as keys and class objects as values.

@abstractmethod

def getProtectedConstants(self) -> dict: (source) ¶

overridden in orionis.introspection.ReflectionModule

Return protected constants defined in the module.

Parameters
None

Returns
`dict`	Dictionary with constant names as keys and their values as values.

@abstractmethod

def getProtectedFunctions(self) -> dict: (source) ¶

overridden in orionis.introspection.ReflectionModule

Return a dictionary of protected functions defined in the module.

Parameters
None

Returns
`dict`	Dictionary mapping protected function names to function objects.

@abstractmethod

def getProtectedSyncFunctions(self) -> dict: (source) ¶

overridden in orionis.introspection.ReflectionModule

Return protected synchronous functions defined in the module.

Parameters
None

Returns
`dict`	Dictionary mapping function names to function objects.

@abstractmethod

def getPublicAsyncFunctions(self) -> dict: (source) ¶

overridden in orionis.introspection.ReflectionModule

Return a dictionary of public asynchronous functions in the module.

Parameters
None

Returns
`dict`	Dictionary mapping function names to function objects.

@abstractmethod

def getPublicClasses(self) -> dict: (source) ¶

overridden in orionis.introspection.ReflectionModule

Return a dictionary of public classes defined in the module.

Parameters
None

Returns
`dict`	Dictionary with class names as keys and class objects as values.

@abstractmethod

def getPublicConstants(self) -> dict: (source) ¶

overridden in orionis.introspection.ReflectionModule

Retrieve public constants defined in the module.

Parameters
None

Returns
`dict`	Dictionary with constant names as keys and their values as values.

@abstractmethod

def getPublicFunctions(self) -> dict: (source) ¶

overridden in orionis.introspection.ReflectionModule

Return a dictionary of public functions defined in the module.

Parameters
None

Returns
`dict`	Dictionary mapping function names to function objects.

@abstractmethod

def getPublicSyncFunctions(self) -> dict: (source) ¶

overridden in orionis.introspection.ReflectionModule

Return a dictionary of public synchronous functions in the module.

Parameters
None

Returns
`dict`	Dictionary mapping function names to function objects.

@abstractmethod

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

overridden in orionis.introspection.ReflectionModule

Retrieve the source code of the module.

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

Raises
`ValueError`	If the source code cannot be read from the module file.

@abstractmethod

def hasClass(self, class_name: str) -> bool: (source) ¶

overridden in orionis.introspection.ReflectionModule

Check if a class with the specified name exists in the module.

Parameters
class_name:`str`	Name of the class to check.

Returns
`bool`	True if the class exists in the module, otherwise False.

@abstractmethod

def removeClass(self, class_name: str) -> bool: (source) ¶

overridden in orionis.introspection.ReflectionModule

Remove a class from the module.

Parameters
class_name:`str`	Name of the class to remove.

Returns
`bool`	True if the class was removed successfully.

Raises
`ValueError`	If `class_name` is not a valid identifier or if the class does not exist.

@abstractmethod

def setClass(self, class_name: str, cls: type) -> bool: (source) ¶

overridden in orionis.introspection.ReflectionModule

Set a class in the module.

Parameters
class_name:`str`	Name of the class to set.
cls:`type`	Class object to set.

Returns
`bool`	True if the class was set successfully.

Raises
`ValueError`	If `cls` is not a class type, if `class_name` is not a valid identifier, or if `class_name` is a reserved keyword.