orionis.introspection.Reflection

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

View In Hierarchy

Undocumented

Static Method	`abstract`	Create a ReflectionAbstract for an abstract class.
Static Method	`callable`	Create a ReflectionCallable for a callable object.
Static Method	`concrete`	Create a ReflectionConcrete for a concrete class.
Static Method	`instance`	Create a ReflectionInstance for an object instance.
Static Method	`isAbstract`	Determine if the object is an abstract base class.
Static Method	`isAsyncGen`	Determine if the object is an asynchronous generator.
Static Method	`isAsyncGenFunction`	Determine if the object is an asynchronous generator function.
Static Method	`isAwaitable`	Determine if the object can be awaited.
Static Method	`isBuiltIn`	Determine if the object is a built-in function or method.
Static Method	`isClass`	Determine if the object is a class.
Static Method	`isCode`	Determine if the object is a code object.
Static Method	`isConcreteClass`	Determine if the object is a concrete user-defined class.
Static Method	`isCoroutine`	Determine if the object is a coroutine.
Static Method	`isCoroutineFunction`	Determine if the object is a coroutine function.
Static Method	`isDataDescriptor`	Determine if the object is a data descriptor.
Static Method	`isFrame`	Determine if the object is a frame object.
Static Method	`isFunction`	Determine if the object is a Python function.
Static Method	`isGenerator`	Determine if the object is a generator.
Static Method	`isGeneratorFunction`	Determine if the object is a generator function.
Static Method	`isGeneric`	Determine if the provided type is a generic type.
Static Method	`isGetSetDescriptor`	Determine if the object is a getset descriptor.
Static Method	`isInstance`	Determine if the object is an instance of a user-defined class.
Static Method	`isMemberDescriptor`	Determine if the object is a member descriptor.
Static Method	`isMethod`	Determine if the object is a method.
Static Method	`isMethodDescriptor`	Determine if the object is a method descriptor.
Static Method	`isModule`	Determine if the object is a module.
Static Method	`isProtocol`	Determine if the object is a subclass of `typing.Protocol`.
Static Method	`isRoutine`	Determine if the object is a user-defined or built-in function or method.
Static Method	`isTraceback`	Determine if the object is a traceback object.
Static Method	`isTypingConstruct`	Determine if the object is a construct from the `typing` module.
Static Method	`module`	Create a reflection object for a module.

@staticmethod

def abstract(abstract: type) -> IReflectionAbstract: (source) ¶

Create a ReflectionAbstract for an abstract class.

Parameters
abstract:`type`	The abstract class to reflect.

Returns
`ReflectionAbstract`	Reflection object for the provided abstract class.

@staticmethod

def callable(fn: Callable) -> IReflectionCallable: (source) ¶

Create a ReflectionCallable for a callable object.

Parameters
fn:`Callable`	The function or method to wrap.

Returns
`ReflectionCallable`	Reflection object encapsulating the provided callable.

@staticmethod

def concrete(concrete: type) -> IReflectionConcrete: (source) ¶

Create a ReflectionConcrete for a concrete class.

Parameters
concrete:`type`	The concrete class to reflect.

Returns
`ReflectionConcrete`	Reflection object for the provided concrete class.

@staticmethod

def instance(instance: Any) -> IReflectionInstance: (source) ¶

Create a ReflectionInstance for an object instance.

Parameters
instance:`Any`	Object instance to reflect.

Returns
`ReflectionInstance`	Reflection object for the provided instance.

@staticmethod

def isAbstract(obj: Any) -> bool: (source) ¶

Determine if the object is an abstract base class.

Parameters
obj:`Any`	Object to check for abstractness.

Returns
`bool`	True if the object is an abstract base class, False otherwise.

@staticmethod

def isAsyncGen(obj: Any) -> bool: (source) ¶

Determine if the object is an asynchronous generator.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is an asynchronous generator, False otherwise.

@staticmethod

def isAsyncGenFunction(obj: Any) -> bool: (source) ¶

Determine if the object is an asynchronous generator function.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is an asynchronous generator function, False otherwise.

@staticmethod

def isAwaitable(obj: Any) -> bool: (source) ¶

Determine if the object can be awaited.

Parameters
obj:`Any`	Object to check for awaitability.

Returns
`bool`	True if the object is awaitable, otherwise False.

@staticmethod

def isBuiltIn(obj: Any) -> bool: (source) ¶

Determine if the object is a built-in function or method.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is a built-in function or method, False otherwise.

@staticmethod

def isClass(obj: Any) -> bool: (source) ¶

Determine if the object is a class.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is a class, otherwise False.

@staticmethod

def isCode(obj: Any) -> bool: (source) ¶

Determine if the object is a code object.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is a code object, otherwise False.

@staticmethod

def isConcreteClass(obj: Any) -> bool: (source) ¶

Determine if the object is a concrete user-defined class.

Parameters
obj:`Any`	Object to check for concreteness.

Returns
`bool`	True if the object is a concrete class; False otherwise.

@staticmethod

def isCoroutine(obj: Any) -> bool: (source) ¶

Determine if the object is a coroutine.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is a coroutine, otherwise False.

@staticmethod

def isCoroutineFunction(obj: Any) -> bool: (source) ¶

Determine if the object is a coroutine function.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is a coroutine function, otherwise False.

@staticmethod

def isDataDescriptor(obj: Any) -> bool: (source) ¶

Determine if the object is a data descriptor.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is a data descriptor, otherwise False.

@staticmethod

def isFrame(obj: Any) -> bool: (source) ¶

Determine if the object is a frame object.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is a frame object, otherwise False.

@staticmethod

def isFunction(obj: Any) -> bool: (source) ¶

Determine if the object is a Python function.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is a function, otherwise False.

@staticmethod

def isGenerator(obj: Any) -> bool: (source) ¶

Determine if the object is a generator.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is a generator, otherwise False.

@staticmethod

def isGeneratorFunction(obj: Any) -> bool: (source) ¶

Determine if the object is a generator function.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is a generator function, otherwise False.

@staticmethod

def isGeneric(obj: Any) -> bool: (source) ¶

Determine if the provided type is a generic type.

Parameters
obj:`Any`	The type to check.

Returns
`bool`	True if the type is generic, otherwise False.

@staticmethod

def isGetSetDescriptor(obj: Any) -> bool: (source) ¶

Determine if the object is a getset descriptor.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is a getset descriptor, otherwise False.

@staticmethod

def isInstance(obj: Any) -> bool: (source) ¶

Determine if the object is an instance of a user-defined class.

Parameters
obj:`Any`	Object to evaluate.

Returns
`bool`	True if the object is an instance of a user-defined class, False otherwise.

@staticmethod

def isMemberDescriptor(obj: Any) -> bool: (source) ¶

Determine if the object is a member descriptor.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is a member descriptor, otherwise False.

@staticmethod

def isMethod(obj: Any) -> bool: (source) ¶

Determine if the object is a method.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is a method, otherwise False.

@staticmethod

def isMethodDescriptor(obj: Any) -> bool: (source) ¶

Determine if the object is a method descriptor.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is a method descriptor, otherwise False.

@staticmethod

def isModule(obj: Any) -> bool: (source) ¶

Determine if the object is a module.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is a module, otherwise False.

@staticmethod

def isProtocol(obj: Any) -> bool: (source) ¶

Determine if the object is a subclass of typing.Protocol.

Parameters
obj:`Any`	Object or type to evaluate.

Returns
`bool`	True if `obj` is a class that is a subclass of `typing.Protocol` (but not `Protocol` itself), otherwise False.

@staticmethod

def isRoutine(obj: Any) -> bool: (source) ¶

Determine if the object is a user-defined or built-in function or method.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is a routine, otherwise False.

@staticmethod

def isTraceback(obj: Any) -> bool: (source) ¶

Determine if the object is a traceback object.

Parameters
obj:`Any`	Object to check.

Returns
`bool`	True if the object is a traceback object, otherwise False.

@staticmethod

def isTypingConstruct(obj: Any) -> bool: (source) ¶

Determine if the object is a construct from the typing module.

Parameters
obj:`Any`	Object to evaluate.

Returns
`bool`	True if the object is a recognized typing construct from the `typing` module, otherwise False.

@staticmethod

def module(module: str) -> IReflectionModule: (source) ¶

Create a reflection object for a module.

Parameters
module:`str`	Name of the module to reflect.

Returns
`ReflectionModule`	Reflection object for the specified module.