bundles / traitlets 5.15.0 / traitlets / config / application / boolean_flag

function

`traitlets.config.application:boolean_flag`

source: /traitlets/config/application.py :1093

Signature

   def     boolean_flag (    name  :  str    ,    configurable  :  str    ,    set_help  :  str    =  ''   ,    unset_help  :  str    =  ''     )   →  StrDict

Summary

Helper for building basic --trait, --no-trait flags.

Parameters

name : str: The name of the flag.
configurable : str: The 'Class.trait' string of the trait to be set/unset with the flag
set_help : unicode: help string for --name flag
unset_help : unicode: help string for --no-name flag

Returns

cfg : dict: A dict with two keys: 'name', and 'no-name', for setting and unsetting the trait, respectively.

Aliases

traitlets.config.boolean_flag

Referenced by

This package