ctapipe is not stable yet, so expect large and rapid changes to structure and functionality as we explore various design choices before the 1.0 release.

Enum#

class ctapipe.core.traits.Enum(values: Sequence[G] | None, default_value: G | Sentinel | None = traitlets.Undefined, allow_none: bool = False, read_only: bool | None = None, help: str | None = None, config: Any | None = None, **kwargs: Any)#

Bases: TraitType[G, G]

An enum whose value must be in a given sequence.

Methods Summary

argcompleter(**kwargs)

Completion hints for argcomplete

from_string(s)

Get a value from a config string

info()

info_rst()

subclass_init(cls)

validate(obj, value)

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.

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