BackgroundGroup

class BackgroundGroup

property id

The id of the group.

Type

str, read-only

property name

The name of the group.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

list_backgrounds()

List the backgrounds of this group.

Returns

The list of backgrounds in the group.

Return type

list(Background)

duplicate()

Duplicate this background group.

Returns

The duplicated group.

Return type

BackgroundGroup

Raises

ReadOnlyError -- If Database is in read only mode.

remove(force = False)

Delete a background group

Note

By default, only empty groups can be deleted (NotEmptyError is raised otherwise), use force to force deletion of non empty groups.

Parameters

force (bool) -- Force the deletion of the group even if it contains backgrounds.

Raises

• NotEmptyError -- If force is False and the group contains backgrounds.

• ReadOnlyError -- If Database is in read only mode.

create_background(name)

Create a new background.

Parameters

name (str) -- The name of the new background.

Returns

The newly created background.

Return type

Background

Raises

ReadOnlyError -- If Database is in read only mode.