o ciK@sddlZddlZddlZddlmZddlmZmZmZm Z m Z m Z m Z ddl mZmZmZmZddlmZddlmZddlmZmZddlmZdd lmZmZmZdd lm Z e!eZ"e d d Gd ddZ#e d d GdddZ$de$defddZ%dede$fddZ&dS)N)deepcopy)AnyCallableDictListOptionalTupleUnion)DeploymentConfig ReplicaConfigRequestRouterConfighandle_num_replicas_auto)SERVE_LOGGER_NAME) ServeUsageTag)DEFAULTDefault)AutoscalingConfig)DeploymentSchema LoggingConfigRayActorOptionsSchema) PublicAPIstable) stabilityc@seZdZdZdddZdS) ApplicationaOne or more deployments bound with arguments that can be deployed together. Can be passed into another `Deployment.bind()` to compose multiple deployments in a single application, passed to `serve.run`, or deployed via a Serve config file. For example, to define an Application and run it in Python: .. code-block:: python from ray import serve from ray.serve import Application @serve.deployment class MyDeployment: pass app: Application = MyDeployment.bind(OtherDeployment.bind()) serve.run(app) To run the same app using the command line interface (CLI): .. code-block:: bash serve run python_file:app To deploy the same app via a config file: .. code-block:: yaml applications: my_app: import_path: python_file:app bound_deployment DeploymentcCs ||_dSN)_bound_deployment)selfrrH/home/ubuntu/.local/lib/python3.10/site-packages/ray/serve/deployment.py__init__<s zApplication.__init__N)rr)__name__ __module__ __qualname____doc__r!rrrr rs#rc/@seZdZdZ  dIdedededeeddf d d Zdefd d Z e defd dZ e deefddZ e de eeffddZe defddZe defddZe defddZe defddZe ddZe deefddZe deefdd Ze deefd!d"Ze deefd#d$Ze defd%d&Zd'efd(d)Zd*d+Zde fd,d-Z!de"j#e"j#e"j#e"j#e"j#e"j#e"j#e"j#e"j#e"j#e"j#e"j#e"j#e"j#e"j#e"j#e"j#e"j#e"j#e"j#dfd.eede$ede$ed/e$ee eefd0e$e edfd1e$eed2e$e%eee&fd3e$ed4e$ed5e$eed6e$ed7e$ed8e$e ee'dfd9e$e&d:e$e&d;e$e&de$eed?e$eeefd@e*ddf.dAdBZ+dCdDZ,dEdFZ-dGdHZ.dS)JraClass (or function) decorated with the `@serve.deployment` decorator. This is run on a number of replica actors. Requests to those replicas call this class. One or more deployments can be composed together into an `Application` which is then run via `serve.run` or a config file. Example: .. code-block:: python @serve.deployment class MyDeployment: def __init__(self, name: str): self._name = name def __call__(self, request): return "Hello world!" app = MyDeployment.bind() # Run via `serve.run` or the `serve run` CLI command. serve.run(app) NFnamedeployment_configreplica_configversionreturncCs|std|||dust|tstdd}t|jr6t|jdr6|jj dkr6t|jdr6|jj }||_ ||_ ||_ ||_||_dS)NzZThe Deployment constructor should not be called directly. Use `@serve.deployment` instead.zversion must be a string.r#z ray.serve.api__fastapi_docs_path__) RuntimeError_validate_name isinstancestr TypeErrorinspectisclassdeployment_defhasattrr#r+_name_version_deployment_config_replica_config _docs_path)rr&r'r(r) _internal docs_pathrrr r!]s*      zDeployment.__init__cCs4t|ts tdd|vrtd|ddSdS)Nzname must be a string.#zvDeployment names should not contain the '#' character, this will raise an error starting in Ray 2.46.0. Current name: .)r.r/r0warningswarn)rr&rrr r-|s zDeployment._validate_namecC|jS)zUnique name of this deployment.r5rrrr r&szDeployment.namecCr@r)r6rBrrr r)szDeployment.versioncC|jjS)z8Underlying class or function that this deployment wraps.)r8r3rBrrr func_or_classzDeployment.func_or_classcCrC)zTarget number of replicas.)r7 num_replicasrBrrr rFrEzDeployment.num_replicascCrC)z%Dynamic user-provided config options.)r7 user_configrBrrr rGrEzDeployment.user_configcCrC)z4Max number of requests a replica can handle at once.)r7max_ongoing_requestsrBrrr rHrEzDeployment.max_ongoing_requestscCrC)zDMax number of requests that can be queued in each deployment handle.)r7max_queued_requestsrBrrr rIrEzDeployment.max_queued_requestscCtd)N`route_prefix` can no longer be specified at the deployment level. Pass it to `serve.run` or in the application config instead.) ValueErrorrBrrr route_prefixszDeployment.route_prefixcCrC)z:Actor options such as resources required for each replica.)r8ray_actor_optionsrBrrr rNrEzDeployment.ray_actor_optionscCrCr)r8 init_argsrBrrr rOzDeployment.init_argscCrCr)r8 init_kwargsrBrrr rQrPzDeployment.init_kwargscCstddS)NzUDeprecationWarning: `Deployment.url` is deprecated and will be removed in the future.)loggerwarningrBrrr urlszDeployment.urlcCrCrr7logging_configrBrrr rVrPzDeployment.logging_configrVcCs ||j_dSrrU)rrVrrr set_logging_configs zDeployment.set_logging_configcCrJ)NzNDeployments cannot be constructed directly. Use `deployment.deploy() instead.`)r,rBrrr __call__szDeployment.__call__cOst|j||dS)zBind the arguments to the deployment and return an Application. The returned Application can be deployed using `serve.run` (or via config file) or bound to another deployment for composition. ) _init_args _init_kwargs)roptions)rargskwargsrrr bindszDeployment.bindrDrFrMrNplacement_group_bundlesplacement_group_strategymax_replicas_per_noderGrHrIautoscaling_configgraceful_shutdown_wait_loop_sgraceful_shutdown_timeout_shealth_check_period_shealth_check_timeout_srequest_router_configrYrZr:c CsX|tjur td| durtd|dkr$d}t| | \} } tjdddtD}t |j }|s;|j ||tjddfvrN| tjdfvrNtd|d krVtd |sc|tjurct d n |tjdfvrm||_| tjuru| |_| tjur}| |_| tjur| |_|dur|jj}|tjur|j}|tjur|j}|tjur|jj}|tjur|jj}|tjur|jj}|tjur|jj}|tjur|jj}| tjur|jj} | tjur| |_|tjur||_|tjur||_|tjur||_ |tjur||_!|tjur||_"|tjurt#|t$r|%}||_&t'j(||||||| d }t)||||d dS)aReturn a copy of this deployment with updated options. Only those options passed in will be updated, all others will remain unchanged from the existing deployment. Refer to the `@serve.deployment` decorator docs for available arguments. rKNz2`max_ongoing_requests` must be non-null, got None.auto1cSs&g|]\}}|dvr|tjur|qS)>rr:rD)rVALUE).0optionvaluerrr s  z&Deployment.options..zQManually setting num_replicas is not allowed when autoscaling_config is provided.rz)num_replicas is expected to larger than 0zDeprecationWarning: `version` in `Deployment.options()` has been deprecated. Explicitly specifying version will raise an error in the future!)rOrQrNr_r`raT)r)r:)*rrjrLr rAUTO_NUM_REPLICAS_USEDrecordlocalsitemsrr7user_configured_option_namesupdaterRrSrFrGrHrIr8r3r5r6rOrQrNr_r`rarbrgrcrdrerfr.rdictrVr creater)rrDr&r)rFrMrNr_r`rarGrHrIrbrcrdrerfrVrgrYrZr:rsnew_deployment_confignew_replica_configrrr r[s $                      zDeployment.optionscCsPt|j|jk|j|jk|j|jk|jj|jjk|jj|jjk|jj|jjkgSr)allr5r6r7r8rOrQrN)rotherrrr __eq__s   zDeployment.__eq__cCsd|jdS)NzDeployment(name=)rArBrrr __str__szDeployment.__str__cCst|Sr)r/rBrrr __repr__szDeployment.__repr__)NF)/r"r#r$r%r/r r rr!r-propertyr&r)r rrDintrFrrGrHrIrMrrNrrOrQrTrVrWrXrr^rrjrrfloatrrr boolr[r{r}r~rrrr rAs              3 rdr*cCs|jdur t|j}nd}id|jd|jjrdn|jd|jd|jd|j d|jjd|jj d |jj d |jj d |jj d |d |jjd|jjd|jjd|jjd|jj}t|D]}|dkrt||jjvrt||=qetdi|S)zConverts a live deployment object to a corresponding structured schema. Args: d: Deployment object to convert Nr&rFrHrIrGrbrcrdrerfrNr`r_rarVrgr)rNr parse_objr&r7rbrFrHrIrGrcrdrerfr8r`r_rarVrglistkeysrsr)rray_actor_options_schemadeployment_optionsrlrrr deployment_to_schemasZ       rsc Cs|jtjur d}n|jjdd}|jtjurd}n|j}|jtjur%d}n|j}|jtjur1d}n|j}tj|j |j |j |j |j |j|j|j|j|j|jd }||_tjddi||||d}t|j||ddS) aMCreates a deployment with parameters specified in schema. The returned deployment CANNOT be deployed immediately. It's func_or_class value is an empty string (""), which is not a valid import path. The func_or_class value must be overwritten with a valid function or class before the deployment can be deployed. NT) exclude_unset) rFrGrHrIrbrcrdrerfrVrgr)r3rOrQrNr_r`ra)r&r'r(r:)rNrrjrur_r`rar from_defaultrFrGrHrIrbrcrdrerfrVrg!_get_user_configured_option_namesrsr rvrr&)rrNr_r`rar'r(rrr schema_to_deploymentsT     r)'r1loggingr>copyrtypingrrrrrrr ray.serve._private.configr r r r ray.serve._private.constantsrray.serve._private.usagerray.serve._private.utilsrrray.serve.configrray.serve.schemarrrray.util.annotationsr getLoggerrRrrrrrrrr s* $     )`3