TimeFrame.register_flag_system

TimeFrame.register_flag_system(name, flag_system=None)[source]

Register a named flag system with the internal flag manager.

Parameters:

  • name (str) – Short name for the flag system

  • flag_system (dict[str, int] | type[BitwiseFlag] | list[str] | None) –

    The flag system to register, provided either as: - a dict mapping of flag names to single-bit integer values, or; - a BitwiseFlag enum class, whose members are single-bit integers, or; - a list of category name strings, from which bit values are auto-generated.

    The list is sorted before assigning values, so the same set of names always produces the same mapping. An empty list or None produces a single FLAGGED flag at value 1.

Return type:

None