soulfire.user_connect.UserServiceSync

class soulfire.user_connect.UserServiceSync[source]

Bases: Protocol

Base class for protocol classes.

Protocol classes are defined as:

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).

For example:

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as:

class GenProto[T](Protocol):
    def meth(self) -> T:
        ...
create_user(request: soulfire.user_pb2.UserCreateRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.UserCreateRequest, soulfire.user_pb2.UserCreateResponse]) → soulfire.user_pb2.UserCreateResponse[source]
delete_user(request: soulfire.user_pb2.UserDeleteRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.UserDeleteRequest, soulfire.user_pb2.UserDeleteResponse]) → soulfire.user_pb2.UserDeleteResponse[source]
list_users(request: soulfire.user_pb2.UserListRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.UserListRequest, soulfire.user_pb2.UserListResponse]) → soulfire.user_pb2.UserListResponse[source]
get_user_info(request: soulfire.user_pb2.UserInfoRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.UserInfoRequest, soulfire.user_pb2.UserInfoResponse]) → soulfire.user_pb2.UserInfoResponse[source]
invalidate_sessions(request: soulfire.user_pb2.InvalidateSessionsRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.InvalidateSessionsRequest, soulfire.user_pb2.InvalidateSessionsResponse]) → soulfire.user_pb2.InvalidateSessionsResponse[source]
update_user(request: soulfire.user_pb2.UpdateUserRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.UpdateUserRequest, soulfire.user_pb2.UpdateUserResponse]) → soulfire.user_pb2.UpdateUserResponse[source]
generate_user_api_token(request: soulfire.user_pb2.GenerateUserAPITokenRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.GenerateUserAPITokenRequest, soulfire.user_pb2.GenerateUserAPITokenResponse]) → soulfire.user_pb2.GenerateUserAPITokenResponse[source]
list_user_plugin_permission_grants(request: soulfire.user_pb2.ListUserPluginPermissionGrantsRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.ListUserPluginPermissionGrantsRequest, soulfire.user_pb2.ListUserPluginPermissionGrantsResponse]) → soulfire.user_pb2.ListUserPluginPermissionGrantsResponse[source]
set_user_plugin_permission_grant(request: soulfire.user_pb2.SetUserPluginPermissionGrantRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.SetUserPluginPermissionGrantRequest, soulfire.user_pb2.UserPluginPermissionGrant]) → soulfire.user_pb2.UserPluginPermissionGrant[source]
delete_user_plugin_permission_grant(request: soulfire.user_pb2.DeleteUserPluginPermissionGrantRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.DeleteUserPluginPermissionGrantRequest, soulfire.user_pb2.DeleteUserPluginPermissionGrantResponse]) → soulfire.user_pb2.DeleteUserPluginPermissionGrantResponse[source]