Skip to content

Option

option

Functionality for general Notion objects like texts, files, options, etc.

Option(name: str, *, color: Color | str | UnsetType = Unset)

Option for select & multi-select property.

color: Color property

Color of the option.

description: str property

Description of the option.

id: str property

ID of the option.

name: str property

Name of the option.

__eq__(other: object) -> bool

__hash__() -> int

__repr__() -> str

__str__() -> str

OptionGroup(group_type: OptionGroupType | str, options: list[Option])

Group of options for status property.

name: str property

Name of the option group.

options: list[Option] property

Options within this option group.

__eq__(other: object) -> bool

__hash__() -> int

__repr__() -> str

__str__() -> str

wrap_obj_ref(obj_ref: objs.SelectGroup, /, *, options: list[Option] | None = None) -> OptionGroup classmethod

Convienence constructor for the group of options.

OptionNS

Option namespace to simplify working with (Multi-)Select options.

to_list() -> list[Option] classmethod

Convert the enum to a list as needed by the (Multi)Select property types.

OptionNSType

Metaclass to implement len for type OptionNS itself, not an instance of it.

__len__() -> int

check_for_updates(old: list[Option], new: list[Option]) -> dict[str, list[str]]

Check if two lists of options contain updates.

Returns which attributes have changed for each option. This is mainly used to check if options have changed when updating a select or multi-select property as this is not supported by the Notion API.