Skip to content

standard

handle_field(name, field)

Handle a standard field as an argument.

Parameters:

Name Type Description Default
name str

The name of the argument.

 required
field FieldInfo

A dictionary representation of the field.

 required

Returns:

Type Description
FuncArgs

Function arguments for the parser add_argument method.
Source code in m/cli/engine/parsers/standard.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
def handle_field(name: str, field: FieldInfo) -> FuncArgs:
    """Handle a standard field as an argument.

    Args:
        name: The name of the argument.
        field: A dictionary representation of the field.

    Returns:
        Function arguments for the parser `add_argument` method.
    """
    extras = cast(dict, field.json_schema_extra or {})
    default = field.default
    validator = extras.get('validator', None)
    required = extras.get('required', False)
    aliases = cast(list[str], extras.get('aliases', None))

    arg_default = default if default is MISSING else repr(default)
    if 'env_var' in repr(validator):
        # special case - do not repr
        arg_default = f'env.{default}'
    args: AnyMap = {
        'help': argument_description(field.description or '', arg_default),
        'required': required,
        'type': str,
    }

    if default is not MISSING:
        args['default'] = default

    if validator:
        args['type'] = validator

    names = [argument_name(name)]
    if aliases:
        names = [argument_name(alias) for alias in aliases]

    return FuncArgs(args=names, kwargs=args)