Skip to content

Blocks

blocks

Core building blocks for pages and databases.

BT = TypeVar('BT', bound=obj_blocks.Block) module-attribute

FT = TypeVar('FT', bound=obj_blocks.FileObjectBlock) module-attribute

T = TypeVar('T', bound=obj_blocks.DataObject) module-attribute

Block(*args: Any, **kwargs: Any)

General Notion block.

block_url: str property

Return the URL of the block.

to_markdown() -> str abstractmethod

Return the content of the block as Markdown.

Bookmark(*args: Any, **kwargs: Any)

Bookmark block.

url: str | None property

Return the URL of the bookmark.

to_markdown() -> str

Breadcrumb(*args: Any, **kwargs: Any)

Breadcrumb block.

to_markdown() -> str

BulletedItem(*args: Any, **kwargs: Any)

Bulleted list item.

to_markdown() -> str

Callout(*args: Any, **kwargs: Any)

Callout block.

icon: objects.File | objects.Emoji | None property

to_markdown() -> str

ChildDatabase(*args: Any, **kwargs: Any)

Child database block.

title: str property

url: str property

to_markdown() -> str

ChildPage(*args: Any, **kwargs: Any)

Child page block.

title: str property

url: str property

to_markdown() -> str

ChildrenMixin(*args: Any, **kwargs: Any)

Mixin for blocks that support children blocks.

children: list[Block] property

Return all children.

Code(*args: Any, **kwargs: Any)

Code block.

caption: RichText property

to_markdown() -> str

Column(*args: Any, **kwargs: Any)

Collumn block.

to_markdown() -> str

ColumnList(*args: Any, **kwargs: Any)

Column list block.

to_markdown() -> str

DataObject(*args: Any, **kwargs: Any)

The base type for all data-related types, i.e, pages, databases and blocks.

ancestors: tuple[DataObject, ...] property

Return all ancestors from the workspace to the actual record (excluding).

created_by: User property

created_time: datetime property

has_children: bool property

id: UUID property

is_deleted: bool property

Return wether the object is deleted/archived.

last_edited_by: User property

last_edited_time: datetime property

parent: DataObject | None property

Return the parent record or None if the workspace is the parent.

__eq__(other: object) -> bool

__hash__() -> int

Divider(*args: Any, **kwargs: Any)

Divider block.

to_markdown() -> str

Embed(*args: Any, **kwargs: Any)

Embed block.

caption: RichText property

embed_url: str | None property

Return the URL of the embeded item.

to_markdown() -> str

Equation(*args: Any, **kwargs: Any)

Equation block.

expression: str property

to_markdown() -> str

File(*args: Any, **kwargs: Any)

File block.

name: str property

to_markdown() -> str

FileObjectBlock(*args: Any, **kwargs: Any)

Abstract Block holding a FileObject

caption: RichText property

url: str property

Heading1(*args: Any, **kwargs: Any)

Heading 1 block.

to_markdown() -> str

Heading2(*args: Any, **kwargs: Any)

Heading 2 block.

to_markdown() -> str

Heading3(*args: Any, **kwargs: Any)

Heading 3 block.

to_markdown() -> str

Image(*args: Any, **kwargs: Any)

Image block.

to_markdown() -> str

LinkPreview(*args: Any, **kwargs: Any)

Link preview block.

url: str | None property

to_markdown() -> str

LinkToPage(*args: Any, **kwargs: Any)

Link to page block.

page: Page property

url: str property

to_markdown() -> str

NumberedItem(*args: Any, **kwargs: Any)

Numbered list item.

to_markdown() -> str

PDF(*args: Any, **kwargs: Any)

PDF block.

to_markdown() -> str

Paragraph(*args: Any, **kwargs: Any)

Paragraph block.

to_markdown() -> str

Quote(*args: Any, **kwargs: Any)

Quote block.

to_markdown() -> str

SyncedBlock(*args: Any, **kwargs: Any)

Synced block - either original or synched.

block: SyncedBlock property

is_original: bool property

Is this block the original content.

is_synched: bool property

to_markdown(*, with_comment: bool = True) -> str

Table(*args: Any, **kwargs: Any)

Table block.

has_column_header: bool property

has_row_header: bool property

rows: list[TableRow] property

width: int property

__getitem__(index: tuple[int, int]) -> RichText

to_markdown() -> str

TableOfContents(*args: Any, **kwargs: Any)

Table of contents block.

to_markdown() -> str

TableRow(*args: Any, **kwargs: Any)

Table row block.

cells: list[RichText] property

to_markdown() -> str

Template(*args: Any, **kwargs: Any)

Template block.

to_markdown() -> str

TextBlock(*args: Any, **kwargs: Any)

Abstract Text block.

rich_text: RichText property

Return the text content of this text block.

ToDoItem(*args: Any, **kwargs: Any)

ToDo list item.

is_checked() -> bool

to_markdown() -> str

ToggleItem(*args: Any, **kwargs: Any)

Toggle list item.

to_markdown() -> str

Unsupported(*args: Any, **kwargs: Any)

Unsupported blocks in the API.

to_markdown() -> str

Video(*args: Any, **kwargs: Any)

Video block.

to_markdown() -> str