o `۷iW@sddlZddlZddlmZmZmZmZddlZddl m Z ddl m Z ddl mZddlmZddlmZddlmZmZeeZeGd d d eZdaeZee d efd d ZdS)N)AnyDictListOptional)client_mode_hook)actors)(parse_pg_formatted_resources_to_original)TaskID) RuntimeEnv) Deprecated PublicAPIc@s$eZdZdZddZeddddeeeffdd Z e ed ddd d Z defd dZ e edddddZ defddZdefddZdefddZe edddddZdeefddZdefddZdeefdd Zdeefd!d"Ze ed#ddd$d%Zdeefd&d'Zdeefd(d)Ze d*d+Ze d,d-Ze ed.ddd/d0Zdeefd1d2Ze d3d4Zd5d6Z d7d8Z!e d9d:Z"e d;d<Z#e d=d>Z$ed?dddeee%effd@dAZ&deee%effdBdCZ'deee%effdDdEZ(de)fdFdGZ*dHS)IRuntimeContextz)A class used for getting runtime context.cCs|dusJ||_dSN)workerselfrrI/home/ubuntu/vllm_env/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. zRuntimeContext.job_idcC tstd|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: RuntimeError: If Ray has not been initialized. z=Job ID is not available because Ray has not been initialized.)ris_initialized RuntimeErrorrr$hexr&rrr get_job_id>  zRuntimeContext.get_job_idzUse get_node_id() insteadcCr#)aRGet the ID for the node that this process is running on. This can be called from within a driver, task, or actor. When called from a driver that is connected to a remote Ray cluster using Ray Client, this returns the ID of the head node. Returns: A node id for this worker or driver. )rcurrent_node_idr%rrrrrrRr'zRuntimeContext.node_idcCr()aGet the ID for the node that this process is running on. This can be called from within a driver, task, or actor. When called from a driver that is connected to a remote Ray cluster using Ray Client, this returns the ID of the head node. Returns: A node id in hex format for this worker or driver. Raises: RuntimeError: If Ray has not been initialized. z>Node ID is not available because Ray has not been initialized.)rr)r*rr.r+r/rrr get_node_idbr-zRuntimeContext.get_node_idcCststd|jjjS)a%Get the session name for the Ray cluster this process is connected to. The session name uniquely identifies a Ray cluster instance. This is the same value that appears as the ``SessionName`` label in Ray metrics, making it useful for filtering metrics when multiple clusters run the same application name. This can be called from within a driver, task, or actor. Example: .. testcode:: import ray ray.init() session_name = ray.get_runtime_context().get_session_name() print(f"Session Name: {session_name}") @ray.remote def get_session_name(): return ray.get_runtime_context().get_session_name() # Session name is the same across all processes in the cluster assert ray.get(get_session_name.remote()) == session_name # Use SessionName label to filter metrics by cluster, e.g.: # ray_serve_http_request_latency_ms_bucket{SessionName=""} Returns: A session name string for the Ray cluster (e.g., "session_2025-01-01_00-00-00_000000_1234"). Raises: RuntimeError: If Ray has not been initialized. zCSession name is not available because Ray has not been initialized.)rr)r*rnode session_namerrrrget_session_namevs % zRuntimeContext.get_session_namecCststd|jjS)zGet current worker ID for this worker or driver process. Returns: A worker id in hex format for this worker or driver process. Raises: RuntimeError: If Ray has not been initialized. z@Worker ID is not available because Ray has not been initialized.)rr)r*r worker_idr+r3rrr get_worker_ids   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%rrrrrrs$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) rrrrr loggerrr8r%r+r9rrr get_task_ids&zRuntimeContext.get_task_idcC|jjSr)rcurrent_task_idr3rrrr8 sz#RuntimeContext._get_current_task_idcC2|jjtjjjkrtd|jjdS|jjS)aCGet current task name for this worker. Task name by default is the task's function 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 available 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_name Returns: The current worker's task name r:N)rrrrr r;rcurrent_task_namer3rrr get_task_name s2zRuntimeContext.get_task_namecCr?)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 module name].Actor.get_task_function_name [python module name].AsyncActor.get_task_function_name [python module name].get_task_function_name Returns: The current worker's task function call string r:N)rrrrr r;rcurrent_task_function_namer3rrrget_task_function_nameGs+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. r7N)rrrrr rr%rrrrrrzs 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. r:N) rrrrr r;debugrr%r+rDrrr get_actor_ids 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. r:N) rrrrr r;rrr% actor_namerDrrrget_actor_names zRuntimeContext.get_actor_namecCr=)zvGet the current namespace of this worker. Returns: The current namespace of this worker. )rrr3rrrrszRuntimeContext.namespacecCs2|jr Jdt|jd}|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.)r NumRestartsr)rr%rr+)r actor_inforrrwas_current_actor_reconstructeds z.RuntimeContext.was_current_actor_reconstructedz$Use get_placement_group_id() insteadcCr=)zGet the current Placement group ID of this worker. Returns: The current placement group id of this worker. )rplacement_group_idr3rrrcurrent_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)rrLr%r+)rpg_idrrrget_placement_group_idsz%RuntimeContext.get_placement_group_idcCr=)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_groupr3rrrrPs zszCRuntimeContext.get_assigned_resources...)sum)rQresmappingrrr sz9RuntimeContext.get_assigned_resources..) rrrrr check_connected core_worker resource_idsitemsr)rresource_id_map resource_mapresultrrrget_assigned_resourcess   z%RuntimeContext.get_assigned_resourcescCr=)zGet the runtime env string used for the current driver or worker. Returns: The runtime env string currently using by this worker. )r runtime_envr3rrrget_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 deserializerbr3rrrras 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.)rrYrr%r*rZget_actor_handle)rrrrrr current_actors  zRuntimeContext.current_actorcCs|j|jjjS)znGet the GCS address of the ray cluster. Returns: The GCS address of the cluster. )rrY gcs_clientaddressr3rrr gcs_address(s  zRuntimeContext.gcs_addressz!Use get_accelerator_ids() insteadcCs|Sr)get_accelerator_idsr3rrrget_resource_ids2szRuntimeContext.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)rQidrrr Isz6RuntimeContext.get_accelerator_ids..)rrYrr accelerators"get_all_accelerator_resource_names,get_accelerator_ids_for_accelerator_resource)rrids_dictaccelerator_resource_nameaccelerator_idsrrrri6s   z"RuntimeContext.get_accelerator_idscCs|j}||jS)z Get the node labels of the current worker. Returns: A dictionary of label key-value pairs. )rrYcurrent_node_labelsrrrrget_node_labelsLszRuntimeContext.get_node_labelscCs@|jjtjjjkrtd|jj|jjrtd|jjS)amCheck if the current task has been canceled. This can be used to periodically check if ray.cancel() has been called on the current task and perform graceful cleanup. Returns: True if the task has been canceled, False otherwise. Raises: RuntimeError: If called from a driver or async actor context. r:z/This method is not supported in an async actor.) rrrrr r*rZcurrent_actor_is_asyncio is_canceledr3rrrrxXs  zRuntimeContext.is_canceledN)+__name__ __module__ __qualname____doc__rr rrlrr"propertyrr,rr0r4r6rrr<r r8rArCrrFrHrrKrMrOrPr`rbrarerhrrjrirvboolrxrrrrr sh    +  )/:3             r rcCsBttdurttjjjatWdS1swYdS)afGet the runtime context of the current driver/worker. The obtained runtime context can be used to get the metadata of the current driver, task, or actor. Example: .. testcode:: import ray # Get the job id. ray.get_runtime_context().get_job_id() # Get the session name (used as SessionName label in Ray metrics). ray.get_runtime_context().get_session_name() # 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_contextts $r)logging threadingtypingrrrrray._private.workerrray._private.client_mode_hookrray._private.staterray._private.utilsr ray._rayletr ray.runtime_envr ray.util.annotationsr r getLoggerryr;objectr rLockrrrrrrs,      c