Skip to content

Props

props

Page property values especially for pages within data sources. The names of the properties reflect the name in the Notion UI.

PV_co = TypeVar('PV_co', bound=obj_props.PropertyValue, default=obj_props.PropertyValue, covariant=True) module-attribute

Button(values: Any | Sequence[Any])

Button property value.

This is a read-only property that represents a button in a data source.

readonly = True class-attribute instance-attribute

value: None property

__repr__() -> str

__str__() -> str

Checkbox(values: Any | Sequence[Any])

Simple checkbox type; represented as a boolean.

value: bool | None property

CreatedBy(values: Any | Sequence[Any])

Created-by property value.

readonly = True class-attribute instance-attribute

value: User property

CreatedTime(values: Any | Sequence[Any])

Created-time property value.

readonly = True class-attribute instance-attribute

value: pnd.DateTime property

Date(dt_spec: str | DateTimeOrRange)

Date(-time) property value.

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

value: DateTimeOrRange | None property

Email(values: Any | Sequence[Any])

Email property value.

value: str | None property

Files(files: AnyFile | Sequence[AnyFile])

Files property value.

value: list[AnyFile] property

Formula(values: Any | Sequence[Any])

Formula property value.

readonly = True class-attribute instance-attribute

value: str | float | int | DateTimeOrRange | None property

Return the formula result, or None when it is empty or unsupported.

Inspect value_type to distinguish unsupported results from empty values.

value_type: FormulaType | None property

Return the type of the formula result.

ID(values: Any | Sequence[Any])

Unique ID property value.

number: int property

prefix: str | None property

readonly = True class-attribute instance-attribute

value: str property

LastEditedBy(values: Any | Sequence[Any])

Last-edited-by property value.

readonly = True class-attribute instance-attribute

value: User property

LastEditedTime(values: Any | Sequence[Any])

Last-edited-time property value.

readonly = True class-attribute instance-attribute

value: pnd.DateTime property

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

Multi-select property value.

value: list[Option] | None property

Number(values: Any | Sequence[Any])

Number property value.

value: int | float | None property

Person(users: User | Sequence[User])

Person/People property value.

value: list[User] property

Phone(values: Any | Sequence[Any])

Phone property value.

value: str | None property

Place(place: obj_props.PlaceDict | None = None)

A PropertyItem returned by the Notion API containing the Place property.

value: obj_props.Place.TypeData | None property

__repr__() -> str

__str__() -> str

PropertyValue(values: Any | Sequence[Any])

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[obj_props.PropertyValue], **kwargs: Any)

__repr__() -> str

__str__() -> str

Relations(pages: Page | Sequence[Page])

Relation property values.

value: list[Page] property

Rollup(values: Any | Sequence[Any])

Rollup property value.

readonly = True class-attribute instance-attribute

value: float | int | DateTimeOrRange | list[Any] | None property

Return the rollup result, or None when it is empty or unsupported.

Inspect value_type to distinguish unsupported results from empty values.

value_type: RollupType | None property

Return the type of the rollup result.

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 | None)

Rich text property value.

value: rt.Text | None property

Title(text: str | None)

Title property value.

value: rt.Text | None property

URL(values: Any | Sequence[Any])

URL property value.

value: str | None property

Verification(values: Any | Sequence[Any])

Verification property value of pages in wiki data sources.

date: pnd.DateTime | None property

readonly = True class-attribute instance-attribute

state: VState property

value: Self property

verified_by: User | None property