o ci;@sdZddlZddlZddlmZddlmZmZmZm Z m Z m Z ddl m Z ddlmZerJddlmZddlmZdd lmZdd lmZmZmZeeZd d ZGd ddZdS)z^This file defines the interface between the ray client worker and the overall ray module API. N)Future) TYPE_CHECKINGAnyCallableListOptionalUnion)ray_option_utils)_ClientWorkerPropertyAPI) ActorClass) DataResponse)RemoteFunction)ClientActorHandleClientObjectRef ClientStubcCst|tr |dS|S)Nzutf-8) isinstancestrencode)valuerG/home/ubuntu/.local/lib/python3.10/site-packages/ray/util/client/api.py _as_bytess  rc @seZdZdZdiddZddddZdd Zd d Zd d Zddde e fddZ de ddfddZ de ddfddZdjddZ didedeeddfddZdkd ede efd!d"Zd#d$dld&d'Zdd#d(dmd+d,Zdefd-d.Zd/d0Zd1d2Zd3d4Zd5d6Zd7d8Zdefd9d:Zdid;eedee efdd?Z!dd@dAe"ee fdee"ee fdefdBdCZ#dd@dAe"ee fdee"ee fde fdDdEZ$ #dndd@dAe"ee fdFe"ee fdGedee"ee fdef dHdIZ%dddJdAe"ee fdKedee"ee fde&fdLdMZ'dd@dNe"ee fdee"ee fde e fdOdPZ(dQedRe&ddfdSdTZ)d%dUdefdVdWZ*dXdYdefdZd[Z+dAeddfd\d]Z,dAedefd^d_Z-dAefd`daZ.dbd*dce/ddgdfddfdedfZ0defdgdhZ1dS)o _ClientAPIzThe Client-side methods corresponding to the ray API. Delegates to the Client Worker that contains the connection to the ClientServer. NcCs ||_dSN)worker)selfrrrr__init__ s z_ClientAPI.__init__timeoutcCs|jj||dS)zget is the hook stub passed on to replace `ray.get` Args: vals: [Client]ObjectRef or list of these refs to retrieve. timeout: Optional timeout in milliseconds r)rget)rvalsrrrrr#sz_ClientAPI.getcO|jj|i|S)zput is the hook stub passed on to replace `ray.put` Args: val: The value to `put`. args: opaque arguments kwargs: opaque keyword arguments )rputrargskwargsrrrr",sz_ClientAPI.putcOr!)zwait is the hook stub passed on to replace `ray.wait` Args: args: opaque arguments kwargs: opaque keyword arguments )rwaitr#rrrr&6sz_ClientAPI.waitcOsnddlm}t|dkr!t|dkr!t|dr!|dd|dSt|dkr-t|dks2Jtj||dS)a remote is the hook stub passed on to replace `ray.remote`. This sets up remote functions or actors, as the decorator, but does not execute them. Args: args: opaque arguments kwargs: opaque keyword arguments r)remote_decoratorN)options)ray.util.client.commonr'lencallabler remote_args_error_string)rr$r%r'rrrremote?s $ z_ClientAPI.remoteinstancerreturncOs|jj|g|Ri|S)a2call_remote is called by stub objects to execute them remotely. This is used by stub objects in situations where they're called with .remote, eg, `f.remote()` or `actor_cls.remote()`. This allows the client stub objects to delegate execution to be implemented in the most effective way whether it's in the client, clientserver, or raylet worker. Args: instance: The Client-side stub reference to a remote object args: opaque arguments kwargs: opaque keyword arguments )r call_remote)rr/r$r%rrrr1Vsz_ClientAPI.call_remoteidcC |j|S)apAttempts to release an object reference. When client references are destructed, they release their reference, which can opportunistically send a notification through the datachannel to release the reference being held for that object on the server. Args: id: The id of the reference to release on the server side. )r call_releaserr2rrrr4fs z_ClientAPI.call_releasecCr3)aAttempts to retain a client object reference. Increments the reference count on the client side, to prevent the client worker from attempting to release the server reference. Args: id: The id of the reference to retain on the client side. )r call_retainr5rrrr6rs z_ClientAPI.call_retaincC |jS)zsclose cleans up an API connection by closing any channels or shutting down any servers gracefully. )rcloserrrrr8}s z_ClientAPI.closename namespacercC|j||S)zReturns a handle to an actor by name. Args: name: The name passed to this actor by Actor.options(name="name").remote() )r get_actor)rr:r;rrrr=s z_ClientAPI.get_actorFall_namespacescCr3)aList all named actors in the system. Actors must have been created with Actor.options(name="name").remote(). This works for both detached & non-detached actors. By default, only actors in the current namespace will be returned and the returned entries will simply be their name. If `all_namespaces` is set to True, all actors in the cluster will be returned regardless of namespace, and the retunred entries will be of the form '/'. )rlist_named_actors)rr>rrrr?s z_ClientAPI.list_named_actorsT) no_restartactorcCr<)zkill forcibly stops an actor running in the cluster Args: no_restart: Whether this actor should be restarted if it's a restartable actor. )rterminate_actor)rrAr@rrrkillsz_ClientAPI.kill)force recursiveobjrcCs|j|||S)aCancels a task on the cluster. If the specified task is pending execution, it will not be executed. If the task is currently executing, the behavior depends on the ``force`` flag, as per `ray.cancel()` Only non-actor tasks can be canceled. Canceled tasks will not be retried (max_retries will not be respected). Args: object_ref: ObjectRef returned by the task that should be canceled. force: Whether to force-kill a running task by killing the worker that is running the task. recursive: Whether to try to cancel tasks submitted by the task specified. )rterminate_task)rrFrDrErrrcancelsz_ClientAPI.cancelcCr7)zTrue if our client is connected, and if the server is initialized. Returns: A boolean determining if the client is connected and server initialized. )ris_initializedr9rrrrIs z_ClientAPI.is_initializedcC(ddlmmm}|j|jjS)zGet a list of the nodes in the cluster (for debugging only). Returns: Information about the Ray clients in the cluster. rN)!ray.core.generated.ray_client_pb2core generatedray_client_pb2rget_cluster_infoClusterInfoTypeNODESrrNrrrnodessz_ClientAPI.nodescsnddg}d|d}t|dkrtdksJ|D]}d|d|}||vs.J|qfdd }|S) zAnnotate an actor method Args: num_returns: The number of object refs that should be returned by invocations of this actor method. num_returnsconcurrency_groupzZThe @ray.method decorator must be applied using at least one of the arguments in the list z+, for example '@ray.method(num_returns=2)'.rz-Unexpected keyword argument to @ray.method: "z'". The supported keyword arguments are cs(dvr d|_dvrd|_|S)NrTrU)__ray_num_returns____ray_concurrency_group__)methodr%rrannotate_methods   z*_ClientAPI.method..annotate_method)r+)rr$r% valid_kwargs error_stringkeykey_error_stringrZrrYrrXs  z_ClientAPI.methodcCrJ)a'Get the current total cluster resources. Note that this information can grow stale as nodes are added to or removed from the cluster. Returns: A dictionary mapping resource name to the total quantity of that resource in the cluster. rN)rKrLrMrNrrOrPCLUSTER_RESOURCESrRrrrcluster_resourcess z_ClientAPI.cluster_resourcescCrJ)aGet the current available cluster resources. This is different from `cluster_resources` in that this will return idle (available) resources rather than total resources. Note that this information can grow stale as tasks start and finish. Returns: A dictionary mapping resource name to the total quantity of that resource in the cluster. rN)rKrLrMrNrrOrPAVAILABLE_RESOURCESrRrrravailable_resourcess z_ClientAPI.available_resourcescCst|jS)zReturn a Ray RuntimeContext describing the state on the server Returns: A RuntimeContext wrapping a client making get_cluster_info calls. )r rbuild_runtime_contextr9rrrget_runtime_contextsz_ClientAPI.get_runtime_contextcCsgSrrr9rrr get_gpu_ids!sz_ClientAPI.get_gpu_idsfilenamecCsztdddlmmm}|j|jj }|dur;t |d}t ||WddS1s4wYdS|S)NzBTimeline will include events from other clients using this server.rw) loggerwarningrKrLrMrNrrOrPTIMELINEopenjsondump)rrfrN all_eventsoutfilerrrtimeline$s "z_ClientAPI.timelinecCsdS)z.Hook for internal_kv._internal_kv_initialized.Trr9rrr_internal_kv_initialized4sz#_ClientAPI._internal_kv_initializedr;r]cC|jjt|t|dS)z)Hook for internal_kv._internal_kv_exists.rr)rinternal_kv_existsrrr]r;rrr_internal_kv_exists; z_ClientAPI._internal_kv_existscCrs)z&Hook for internal_kv._internal_kv_get.rr)rinternal_kv_getrrurrr_internal_kv_getCrwz_ClientAPI._internal_kv_getr overwritecCs |jjt|t||t|dS)z&Hook for internal_kv._internal_kv_put.rr)rinternal_kv_putr)rr]rrzr;rrr_internal_kv_putKs z_ClientAPI._internal_kv_put del_by_prefixr;r~cCs|jjt||t|dS)z&Hook for internal_kv._internal_kv_del.r})rinternal_kv_delr)rr]r~r;rrr_internal_kv_delXsz_ClientAPI._internal_kv_delprefixcCrs)z'Hook for internal_kv._internal_kv_list.rr)rinternal_kv_listr)rrr;rrr_internal_kv_listds z_ClientAPI._internal_kv_listuri expiration_scCr<)z*Hook for internal_kv._pin_runtime_env_uri.)rpin_runtime_env_uri)rrrrrr_pin_runtime_env_uriosz_ClientAPI._pin_runtime_env_urir cCr3)z@Register a ClientActorClass for the ActorClass and return a UUID)r_convert_actor)rrArrrrs z_ClientAPI._convert_actorfuncr cCr3)z@Register a ClientRemoteFunc for the ActorClass and return a UUID)r_convert_function)rrrrrrwrz_ClientAPI._convert_functioncCr3)z)Given a UUID, return the converted object)r_get_convertedrr]rrrr{rz_ClientAPI._get_convertedcCr3)zACheck if a key UUID is present in the store of converted objects.)r_converted_key_existsrrrrrrz _ClientAPI._converted_key_existscCs"|ds td|||S)N_zNot available in Ray client: `ray.{}`. This method is only available within Ray remote functions and is not yet implemented in the client API.) startswithNotImplementedErrorformat__getattribute__rrrr __getattr__s  z_ClientAPI.__getattr__refcallbackr cCs|j||dSr)rregister_callback)rrrrrr_register_callbacksz_ClientAPI._register_callbackcCs0ddlmmm}|j|jjddS)Nr dashboard_url) rKrLrMrNrrOrP DASHBOARD_URLrrRrrr_get_dashboard_urls z_ClientAPI._get_dashboard_urlr)r0N)F)rAr)rFr)T)2__name__ __module__ __qualname____doc__rrr"r&r.rrr1bytesr4r6r8rrr=boolr?rCrHrIrSrXr`rbrdlistrerrprqrrvryr|intrrrrrrrrrrrrrrrrs         &                  r)rrlloggingconcurrent.futuresrtypingrrrrrr ray._privater ray.util.client.runtime_contextr ray.actorr rKr ray.remote_functionr r*rrr getLoggerrrhrrrrrrs