Skip to content

Props

props

Page properties especially for pages within databases. The names of the properties reflect the name in the Notion UI.

T = TypeVar('T', bound=obj_props.PropertyValue) module-attribute

Checkbox(values)

Simple checkbox type; represented as a boolean.

value: bool | None property

CreatedBy(values)

Created-by property value.

readonly = True class-attribute instance-attribute

CreatedTime(values)

Created-time property value.

readonly = True class-attribute instance-attribute

Date(dt_spec: dt.datetime | dt.date | pnd.Interval)

Date(-time) property value.

obj_ref = obj_props.Date.build(dt_spec) instance-attribute

value: pnd.DateTime | pnd.Date | pnd.Interval | None property

Email(values)

Email property value.

value: str | None property

Files(files: FileInfo | list[FileInfo])

Files property value.

value: list[FileInfo] property

Formula(values)

Formula property value.

readonly = True class-attribute instance-attribute

value: str | float | int | pnd.DateTime | pnd.Date | pnd.Interval | None property

ID(values)

Unique ID property value.

readonly = True class-attribute instance-attribute

LastEditedBy(values)

Last-edited-by property value.

readonly = True class-attribute instance-attribute

LastEditedTime(values)

Last-edited-time property value.

readonly = True class-attribute instance-attribute

MultiSelect(options: str | Option | list[str | Option])

Multi-select property value.

value: list[Option] | None property

Number(values)

Number property value.

value: int | float | None property

People(users: User | list[User])

People property value.

value: list[User] property

PhoneNumber(values)

Phone property value.

value: str | None property

PropertyValue(values)

Base class for Notion property values.

Used to map high-level objects to low-level Notion-API objects

id: str property

readonly: bool = False class-attribute instance-attribute

value: Any abstractmethod property

Return the actual Python value object of this property.

__eq__(other: object) -> bool

__init_subclass__(wraps: type[T], **kwargs: Any)

__repr__() -> str

__str__() -> str

Relations(pages: Page | list[Page])

Relation property value.

value: list[Page] property

Rollup(values)

Rollup property value.

readonly = True class-attribute instance-attribute

value: str | float | int | pnd.Date | pnd.DateTime | pnd.Interval | list[PropertyValue] | None property

Select(option: str | Option)

Single select property value.

value: Option | None property

Status(option: str | Option)

Status property value.

value: Option | None property

Text(text: str)

Rich text property value.

value: rich_text.Text property

Title(text: str)

Title property value.

value: rich_text.Text property

URL(values)

URL property value.

value: str | None property

Verification(values)

Verification property value of pages in wiki databases.

readonly = True class-attribute instance-attribute