Bool#

class ctapipe.core.traits.Bool(default_value: Any = traitlets.Undefined, allow_none: bool = False, read_only: bool | None = None, help: str | None = None, config: Any | None = None, **kwargs: Any)#

Bases: TraitType[G, S]

A boolean (True, False) trait.

Attributes Summary

default_value

info_text

Methods Summary

argcompleter(**kwargs)

Completion hints for argcomplete

from_string(s)

Get a value from a config string

subclass_init(cls)

validate(obj, value)

Attributes Documentation

default_value: t.Any = False#
info_text: str = 'a boolean'#

Methods Documentation

argcompleter(**kwargs: Any) → list[str][source]#

Completion hints for argcomplete

from_string(s: str) → G[source]#

Get a value from a config string

such as an environment variable or CLI arguments.

Traits can override this method to define their own parsing of config strings.

See also

item_from_string

Added in version 5.0.

subclass_init(cls: type[Any]) → None[source]#
validate(obj: Any, value: Any) → G[source]#