o biM@sddlZddlmZmZmZmZddlZddlZddl m Z ddl m Z ddl mZddlmZddlmZmZeeZeGdd d eZdaeZee d efd d ZdS) N)AnyDictListOptional)client_mode_hook)(parse_pg_formatted_resources_to_original)TaskID) RuntimeEnv) Deprecated PublicAPIc@seZdZdZddZeddddeeeffdd Z e ed ddd d Z defd dZ e edddddZ defddZdefddZe edddddZdeefddZdefddZdeefddZdeefdd Ze ed!ddd"d#Zdeefd$d%Zdeefd&d'Ze d(d)Ze d*d+Ze ed,ddd-d.Zdeefd/d0Ze d1d2Zd3d4Zd5d6Z e d7d8Z!e d9d:Z"e d;d<Z#ed=dddeee$effd>d?Z%deee$effd@dAZ&deee$effdBdCZ'dDS)ERuntimeContextz)A class used for getting runtime context.cCs|dusJ||_dSN)workerselfrrG/home/ubuntu/.local/lib/python3.10/site-packages/ray/runtime_context.py__init__s  zRuntimeContext.__init__z4Use get_xxx_id() methods to get relevant ids insteadT)messagewarningreturncCsP|j|j|jd}|jjtjjjkr&|jdur|j|d<|j dur&|j |d<|S)zxGet a dictionary of the current context. Returns: dict: Dictionary of the current context. )job_idnode_id namespaceNtask_idactor_id) rrrrmoderay_private WORKER_MODErr)rcontextrrrgets     zRuntimeContext.getzUse get_job_id() insteadcC|jj}|r J|S)aGet current job ID for this worker or driver. Job ID is the id of your Ray drivers that create tasks or actors. Returns: If called by a driver, this returns the job ID. If called in a task, return the job ID of the associated driver. )rcurrent_job_idis_nilrrrrrr-s zRuntimeContext.job_idcC tsJd|jj}|S)aGet current job ID for this worker or driver. Job ID is the id of your Ray drivers that create tasks or actors. Returns: If called by a driver, this returns the job ID. If called in a task, return the job ID of the associated driver. The job ID will be hex format. Raises: AssertionError: If not called in a driver or worker. Generally, this means that ray.init() was not called. z=Job ID is not available because Ray has not been initialized.)ris_initializedrr#hexr%rrr get_job_id=s zRuntimeContext.get_job_idzUse get_node_id() insteadcCr")zGet current node ID for this worker or driver. Node ID is the id of a node that your driver, task, or actor runs. Returns: A node id for this worker or driver. )rcurrent_node_idr$rrrrrrQs zRuntimeContext.node_idcCr&)aGet current node ID for this worker or driver. Node ID is the id of a node that your driver, task, or actor runs. The ID will be in hex format. Returns: A node id in hex format for this worker or driver. Raises: AssertionError: If not called in a driver or worker. Generally, this means that ray.init() was not called. z>Node ID is not available because Ray has not been initialized.)rr'rr*r(r+rrr get_node_id_s zRuntimeContext.get_node_idcCstsJd|jjS)zGet current worker ID for this worker or driver process. Returns: A worker id in hex format for this worker or driver process. z@Worker ID is not available because Ray has not been initialized.)rr'r worker_idr(rrrr get_worker_idrs  zRuntimeContext.get_worker_idzUse get_task_id() insteadcCs<|jjtjjjksJd|jj|}|s|SdS)aZGet current task ID for this worker. Task ID is the id of a Ray task. This shouldn't be used in a driver process. Example: .. testcode:: import ray @ray.remote class Actor: def ready(self): return True @ray.remote def f(): return True # All the below code generates different task ids. # Task ids are available for actor creation. a = Actor.remote() # Task ids are available for actor tasks. a.ready.remote() # Task ids are available for normal tasks. f.remote() Returns: The current worker's task id. None if there's no task id. ZThis method is only available when the process is a worker. Current mode: N)rrrrr_get_current_task_idr$rrrrrr}s$zRuntimeContext.task_idcCsF|jjtjjjkrtd|jjdS|}|s!| SdS)aGet current task ID for this worker. Task ID is the id of a Ray task. The ID will be in hex format. This shouldn't be used in a driver process. Example: .. testcode:: import ray @ray.remote class Actor: def get_task_id(self): return ray.get_runtime_context().get_task_id() @ray.remote def get_task_id(): return ray.get_runtime_context().get_task_id() # All the below code generates different task ids. a = Actor.remote() # Task ids are available for actor tasks. print(ray.get(a.get_task_id.remote())) # Task ids are available for normal tasks. print(ray.get(get_task_id.remote())) .. testoutput:: :options: +MOCK 16310a0f0a45af5c2746a0e6efb235c0962896a201000000 c2668a65bda616c1ffffffffffffffffffffffff01000000 Returns: The current worker's task id in hex. None if there's no task id. JThis method is only available when the process is a worker. Current mode: N) rrrrrloggerrr1r$r(r2rrr get_task_ids&zRuntimeContext.get_task_idcC|jjSr )rcurrent_task_idr.rrrr1sz#RuntimeContext._get_current_task_idcC2|jjtjjjkrtd|jjdS|jjS)aBGet current task name for this worker. Task name by default is the task's funciton call string. It can also be specified in options when triggering a task. Example: .. testcode:: import ray @ray.remote class Actor: def get_task_name(self): return ray.get_runtime_context().get_task_name() @ray.remote class AsyncActor: async def get_task_name(self): return ray.get_runtime_context().get_task_name() @ray.remote def get_task_name(): return ray.get_runtime_context().get_task_name() a = Actor.remote() b = AsyncActor.remote() # Task names are available for actor tasks. print(ray.get(a.get_task_name.remote())) # Task names are avaiable for async actor tasks. print(ray.get(b.get_task_name.remote())) # Task names are available for normal tasks. # Get default task name print(ray.get(get_task_name.remote())) # Get specified task name print(ray.get(get_task_name.options(name="task_name").remote())) .. testoutput:: :options: +MOCK Actor.get_task_name AsyncActor.get_task_name get_task_name task_nams Returns: The current worker's task name r3N)rrrrrr4rcurrent_task_namer.rrr get_task_names2zRuntimeContext.get_task_namecCr8)aGet current task function name string for this worker. Example: .. testcode:: import ray @ray.remote class Actor: def get_task_function_name(self): return ray.get_runtime_context().get_task_function_name() @ray.remote class AsyncActor: async def get_task_function_name(self): return ray.get_runtime_context().get_task_function_name() @ray.remote def get_task_function_name(): return ray.get_runtime_context().get_task_function_name() a = Actor.remote() b = AsyncActor.remote() # Task functions are available for actor tasks. print(ray.get(a.get_task_function_name.remote())) # Task functions are available for async actor tasks. print(ray.get(b.get_task_function_name.remote())) # Task functions are available for normal tasks. print(ray.get(get_task_function_name.remote())) .. testoutput:: :options: +MOCK [python modual name].Actor.get_task_function_name [python modual name].AsyncActor.get_task_function_name [python modual name].get_task_function_name Returns: The current worker's task function call string r3N)rrrrrr4rcurrent_task_function_namer.rrrget_task_function_names+z%RuntimeContext.get_task_function_namezUse get_actor_id() insteadcCs<|jjtjjjksJd|jj|jj}|s|SdS)zGet the current actor ID in this worker. ID of the actor of the current process. This shouldn't be used in a driver process. Returns: The current actor id in this worker. None if there's no actor id. r0N)rrrrrrr$rrrrrrGs zRuntimeContext.actor_idcCsF|jjtjjjkrtd|jjdS|jj}|s!| SdS)a6Get the current actor ID in this worker. ID of the actor of the current process. This shouldn't be used in a driver process. The ID will be in hex format. Returns: The current actor id in hex format in this worker. None if there's no actor id. r3N) rrrrrr4debugrr$r(r=rrr get_actor_idZs zRuntimeContext.get_actor_idcCsF|jjtjjjkrtd|jjdS|jj}|s!|jj SdS)aGet the current actor name of this worker. This shouldn't be used in a driver process. The name is in string format. Returns: The current actor name of this worker. If a current worker is an actor, and if actor name doesn't exist, it returns an empty string. If a current worker is not an actor, it returns None. r3N) rrrrrr4rrr$ actor_namer=rrrget_actor_nameos zRuntimeContext.get_actor_namecCr6)zvGet the current namespace of this worker. Returns: The current namespace of this worker. )rrr.rrrrszRuntimeContext.namespacecCs6|jr Jdtjj|j}|o|ddkS)zCheck whether this actor has been restarted. Returns: Whether this actor has been ever restarted. z0This method should't be called inside Ray tasks. NumRestartsr)rr$rrstateactorsr()r actor_inforrrwas_current_actor_reconstructeds z.RuntimeContext.was_current_actor_reconstructedz$Use get_placement_group_id() insteadcCr6)zGet the current Placement group ID of this worker. Returns: The current placement group id of this worker. )rplacement_group_idr.rrrcurrent_placement_group_idsz)RuntimeContext.current_placement_group_idcCs|jj}|s |SdS)zGet the current Placement group ID of this worker. Returns: The current placement group id in hex format of this worker. N)rrGr$r()rpg_idrrrget_placement_group_idsz%RuntimeContext.get_placement_group_idcCr6)a Get if the current task should capture parent's placement group. This returns True if it is called inside a driver. Returns: Return True if the current task should implicitly capture the parent placement group. )r-should_capture_child_tasks_in_placement_groupr.rrrrKs zszCRuntimeContext.get_assigned_resources...)sum)rLresmappingrrr sz9RuntimeContext.get_assigned_resources..) rrrrrcheck_connected core_worker resource_idsitemsr)rresource_id_map resource_mapresultrrrget_assigned_resourcess   z%RuntimeContext.get_assigned_resourcescCr6)zGet the runtime env string used for the current driver or worker. Returns: The runtime env string currently using by this worker. )r runtime_envr.rrrget_runtime_env_stringsz%RuntimeContext.get_runtime_env_stringcCst|S)zGet the runtime env used for the current driver or worker. Returns: The runtime env currently using by this worker. The type of return value is ray.runtime_env.RuntimeEnv. )r deserializer]r.rrrr\s zRuntimeContext.runtime_envcCs0|j}||j}|rtd|j|S)zvGet the current actor handle of this actor itself. Returns: The handle of current actor. z*This method is only available in an actor.)rrTrr$ RuntimeErrorrUget_actor_handle)rrrrrr current_actors  zRuntimeContext.current_actorcCs|j|jjjS)zmGet the GCS address of the ray cluster. Returns: The GCS address of the cluster. )rrT gcs_clientaddressr.rrr gcs_addresss  zRuntimeContext.gcs_addressz!Use get_accelerator_ids() insteadcCs|Sr )get_accelerator_idsr.rrrget_resource_idsszRuntimeContext.get_resource_idscCsN|j}|i}tjjD]}||d|d}dd|D||<q|S)a Get the current worker's visible accelerator ids. Returns: A dictionary keyed by the accelerator resource name. The values are a list of ids `{'GPU': ['0', '1'], 'neuron_cores': ['0', '1'], 'TPU': ['0', '1']}`. ^z_group_[0-9A-Za-z]+$cSsg|]}t|qSr)str)rLidrrr sz6RuntimeContext.get_accelerator_ids..)rrTrr accelerators"get_all_accelerator_resource_names,get_accelerator_ids_for_accelerator_resource)rrids_dictaccelerator_resource_nameaccelerator_idsrrrres   z"RuntimeContext.get_accelerator_idscCs|j}||jS)z Get the node labels of the current worker. Returns: A dictionary of label key-value pairs. )rrTcurrent_node_labelsrrrrget_node_labelsszRuntimeContext.get_node_labelsN)(__name__ __module__ __qualname____doc__rr rrhrr!propertyrr)rr,r/rrr5rr1r:r<rr?rArrFrHrJrKr[r]r\rardrrfrerrrrrrr sd       )/:3            r rcCsBttdurttjjjatWdS1swYdS)aGet the runtime context of the current driver/worker. The obtained runtime context can be used to get the metadata of the current task and actor. Note: For Ray Client, ray.get_runtime_context().get_node_id() should point to the head node. Also, keep in mind that ray._private.worker.global_worker will create a new worker object here if global_worker doesn't point to one. Example: .. testcode:: import ray # Get the job id. ray.get_runtime_context().get_job_id() # Get the actor id. ray.get_runtime_context().get_actor_id() # Get the task id. ray.get_runtime_context().get_task_id() N)_runtime_context_lock_runtime_contextr rrr global_workerrrrrget_runtime_context)s $r{)loggingtypingrrrr threadingray._private.workerrray._private.client_mode_hookrray._private.utilsr ray._rayletrray.runtime_envr ray.util.annotationsr r getLoggerrsr4objectr ryLockrxr{rrrrs*