Source code for jina.parsers.orchestrate.deployment
"""Argparser module for Deployment runtimes"""importargparsefromjina.enumsimportDeploymentRoleTypefromjina.parsers.helperimport_SHOW_ALL_ARGS,KVAppendAction,add_arg_group
[docs]defmixin_base_deployment_parser(parser):"""Add mixin arguments required by :class:`BaseDeployment` into the given parser. :param parser: the parser instance to which we add arguments """gp=add_arg_group(parser,title='Deployment')gp.add_argument('--uses-before',type=str,help='The executor attached before the Pods described by --uses, typically before sending to all ''shards, accepted type follows `--uses`. This argument only applies for sharded Deployments (shards > 1).',)gp.add_argument('--uses-after',type=str,help='The executor attached after the Pods described by --uses, typically used for receiving from ''all shards, accepted type follows `--uses`. This argument only applies for sharded Deployments (shards > 1).',)gp.add_argument('--when',action=KVAppendAction,metavar='KEY: VALUE',nargs='*',help='The condition that the documents need to fulfill before reaching the Executor.''The condition can be defined in the form of a `DocArray query condition <https://docarray.jina.ai/fundamentals/documentarray/find/#query-by-conditions>`',)gp.add_argument('--external',action='store_true',default=False,help='The Deployment will be considered an external Deployment that has been started independently from the Flow.''This Deployment will not be context managed by the Flow.',)# hidden CLI used for internal onlygp.add_argument('--deployment-role',type=DeploymentRoleType.from_string,choices=list(DeploymentRoleType),help='The role of this deployment in the flow'if_SHOW_ALL_ARGSelseargparse.SUPPRESS,)
