now.now_dataclasses module#

This module implements a command-line dialog with the user. Its goal is to configure a UserInput object with users specifications. Optionally, values can be passed from the command-line when jina-now is launched. In that case, the dialog won’t ask for the value.

class now.now_dataclasses.UserInput(**data)[source]#

Bases: BaseModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

app_instance: Optional[JinaNOWApp]#

flow_name: Optional[str]#

dataset_type: Optional[DatasetTypes]#

dataset_name: Optional[str]#

dataset_path: Optional[str]#

aws_access_key_id: Optional[str]#

aws_secret_access_key: Optional[str]#

aws_region_name: Optional[str]#

index_fields: Optional[List]#

index_field_candidates_to_modalities: Optional[Dict[str, TypeVar]]#

filter_fields: Optional[List]#

filter_field_candidates_to_modalities: Optional[Dict[str, str]]#

field_names_to_dataclass_fields: Optional[Dict[str, str]]#

model_choices: Optional[Dict[str, List]]#

es_index_name: Optional[str]#

es_host_name: Optional[str]#

es_additional_args: Optional[Dict]#

cluster: Optional[str]#

secured: Optional[StrictBool]#

jwt: Optional[Dict[str, str]]#

admin_name: Optional[str]#

admin_emails: Optional[List[str]]#

user_emails: Optional[List[str]]#

additional_user: Optional[StrictBool]#

api_key: Optional[str]#

class Config[source]#

Bases: object

arbitrary_types_allowed = True#

to_safe_dict()[source]#

Return type: Dict[str, Any]

class now.now_dataclasses.DialogOptions(name, prompt_message, prompt_type, choices=None, is_terminal_command=False, argparse_kwargs=<factory>, description=None, depends_on=None, default=None, conditional_check=None, post_func=None, dynamic_func=None)[source]#

Bases: object

name: str#

prompt_message: str#

prompt_type: str#

choices: Union[List[Dict[str, Union[str, bool]]], Callable[[Any], List[Dict[str, str]]]] = None#

is_terminal_command: StrictBool = False#

argparse_kwargs: Dict[str, Any]#

description: str = None#

depends_on: Optional['DialogOptions', StrictBool] = None#

default: Optional[str] = None#

conditional_check: Callable[[Any], bool] = None#

post_func: Callable[[Any], None] = None#

dynamic_func: Callable[[Any], List[DialogOptions]] = None#