flags - Notification flags management

This module lets application put persistent flags to notify for instance that a restart is needed.

Flags can contain data as a simple string, such as the message to be displayed in the notification box.

pycstbox.flags.get_flags()

Returns the list of flags currently defined.

Returns:an iterator on the available flags
pycstbox.flags.create_flag(name, content)

Creates a flag.

Parameters:
  • name (str) – the name of the flag
  • content (str) – its content
pycstbox.flags.read_flag(name)

Returns the content of a given flag.

Parameters:name (str) – the name of the flag
Returns:an array of the text lines of the flag content
Raises:any exception risen during flag file access
pycstbox.flags.rm_flag(name)

Removes a given flag, if it exists.

Parameters:name (str) – the name of the flag