nexusrpc.handler.Handler

class documentation

class Handler(BaseServiceCollectionHandler):

Constructor: Handler(user_service_handlers, executor)

A Nexus handler manages a collection of Nexus service handlers.

Operation requests are dispatched to a ServiceHandler based on the service name in the operation context.

This class supports user operation handlers that are either async def or def. If def user operation handlers are to be supported, an executor must be provided.

The methods of this class itself are async def. There is currently no alternative Handler class with def methods.

Example

import concurrent.futures
from nexusrpc.handler import Handler

# Create service handler instances
my_service = MyServiceHandler()

# Create handler with async operations only
handler = Handler([my_service])

# Create handler that supports both async and sync operations
executor = concurrent.futures.ThreadPoolExecutor(max_workers=10)
handler = Handler([my_service], executor=executor)

# Use handler to process requests
result = await handler.start_operation(ctx, input_lazy_value)

Method	`__init__`	Initialize a `Handler` instance from user service handler instances.
Async Method	`cancel_operation`	Handle a Cancel Operation request.
Async Method	`start_operation`	Handle a Start Operation request.
Method	`_assert_async_callable`	Undocumented
Method	`_validate_all_operation_handlers_are_async`	Undocumented

Inherited from BaseServiceCollectionHandler:

Instance Variable	`executor`	Undocumented
Instance Variable	`service_handlers`	Undocumented
Method	`_get_service_handler`	Return a service handler, given the service name.
Method	`_register_service_handlers`	Undocumented

def __init__(self, user_service_handlers: Sequence[Any], executor: concurrent.futures.Executor | None = None): ¶

overrides nexusrpc.handler._core.BaseServiceCollectionHandler.__init__

Initialize a Handler instance from user service handler instances.

The user service handler instances must have been decorated with the @nexusrpc.handler.service_handler decorator.

Parameters
user_service_handlers:`Sequence[Any]`	A sequence of user service handlers.
executor:`concurrent.futures.Executor \| None`	A concurrent.futures.Executor in which to run non-`async def` operation handlers.

async def cancel_operation(self, ctx: CancelOperationContext, token: str): ¶

overrides nexusrpc.handler._core.AbstractHandler.cancel_operation

Handle a Cancel Operation request.

Parameters
ctx:`CancelOperationContext`	The operation context.
token:`str`	The operation token.

async def start_operation(self, ctx: StartOperationContext, input: LazyValueT) -> StartOperationResultSync[Any] | StartOperationResultAsync: ¶

overrides nexusrpc.handler._core.AbstractHandler.start_operation

Handle a Start Operation request.

Parameters
ctx:`StartOperationContext`	The operation context.
input:`LazyValueT`	The input to the operation, as a LazyValue.

Returns
`StartOperationResultSync[Any] \| StartOperationResultAsync`	Undocumented

def _assert_async_callable(self, method: Callable[..., Any]) -> TypeGuard[Callable[..., Awaitable[Any]]]: ¶

Undocumented

def _validate_all_operation_handlers_are_async(self): ¶

Undocumented