Booleans¶

Boolean parameters become flags.

def sync(verbose: bool = False, cache: bool = True) -> None:
    ...

$ python app.py --verbose
$ python app.py --no-cache

Default false¶

A boolean with False as the default is enabled by passing the positive flag.

def build(verbose: bool = False) -> bool:
    return verbose

$ python app.py
$ python app.py --verbose

A boolean with True as the default can be disabled with a generated negative flag.

def build(cache: bool = True) -> bool:
    return cache

$ python app.py
$ python app.py --no-cache

The negative prefix defaults to no-.

A required boolean accepts both forms.

def set_enabled(enabled: bool) -> bool:
    return enabled

$ python app.py --enabled
$ python app.py --no-enabled

Some boolean names already sound negative:

def sync(disable_cache: bool = False) -> None:
    ...

By default, Interfacy treats these as one-way flags:

$ python app.py --disable-cache

It does not generate a confusing inverse like --cache unless you opt into dual mode.

Interfacy(
    negative_bool_name_mode="dual",
).run(sync)

Negative-looking prefixes default to:

Configure them with negative_bool_name_prefixes=.

bool_negative_prefix changes generated negative flag names.

Interfacy(bool_negative_prefix="without-").run(build)

$ python app.py --without-cache

Set bool_negative_prefix=None to disable generated negative aliases.