notion.block.collection package

Submodules

notion.block.collection.basic module

class notion.block.collection.basic.CollectionBlock(*args, **kwargs)

Bases: notion.block.basic.Block

Collection Block.

add_row(update_views=True, **kwargs) → notion.block.collection.basic.CollectionRowBlock

Create a new empty CollectionRowBlock under this collection, and return the instance.

Parameters:

• update_views (bool, optional) – Whether or not to update the views after adding the row to Collection. Defaults to True.
• kwargs (dict, optional) – Additional pairs of keys and values set in newly created CollectionRowBlock. Defaults to empty dict()

Returns:

Added row.

Return type:

CollectionRowBlock

cover

description

get_rows(**kwargs)

Get all rows from a collection.

Returns:All rows. Return type:CollectionQueryResult

get_schema_properties() → list

Fetch a flattened list of all properties in the collection’s schema.

Returns:All properties. Return type:list

get_schema_property(identifier: str) → Optional[dict]

Look up a property in the collection’s schema by “property id” (generally a 4-char string), or name (human-readable – there may be duplicates so we pick the first match we find).

identifier

Value used for searching the prop. Can be set to ID, slug or title (if property type is also title).

Type:str

Returns:Schema of the property if found, or None. Return type:dict, optional

name

parent

Get parent block.

Returns:Parent block. Return type:Block

query(**kwargs)

Run a query inline and return the results.

Returns:Result of passed query. Return type:CollectionQueryResult

templates

class notion.block.collection.basic.CollectionRowBlock(client, block_id: str, *args, **kwargs)

Bases: notion.block.basic.PageBlock

Collection Row Block.

collection

get_all_properties()

get_mentioned_pages_on_property(name)

get_property(name)

is_template

schema

set_property(name, value)

class notion.block.collection.basic.TemplateBlock(client, block_id: str, *args, **kwargs)

Bases: notion.block.collection.basic.CollectionRowBlock

Template block.

is_template

notion.block.collection.children module

class notion.block.collection.children.CollectionViewBlockViews(parent)

Bases: notion.block.children.Children

Collection View Block Views.

add_new(view_type='table')

Create a new block, add it as the last child of this parent block, and return the corresponding Block instance.

Parameters:

• block (Block) – Class of block to use.
• child_list_key (str, optional) – Defaults to None.

Returns:

Instance of added block.

Return type:

Block

notion.block.collection.common module

class notion.block.collection.common.NotionDate(start, end=None, timezone=None, reminder=None)

Bases: object

end = None

classmethod from_notion(obj)

reminder = None

start = None

timezone = None

to_notion()

type()

notion.block.collection.media module

class notion.block.collection.media.CollectionViewBlock(client, block_id: str, *args, **kwargs)

Bases: notion.block.media.MediaBlock

Collection View Block.

collection

description

title

views

class notion.block.collection.media.CollectionViewPageBlock(client, block_id: str, *args, **kwargs)

Bases: notion.block.collection.media.CollectionViewBlock

Full Page Collection View Block.

cover

icon

class notion.block.collection.media.LinkToCollectionBlock(client, block_id: str, *args, **kwargs)

Bases: notion.block.media.MediaBlock

Link To Collection.

notion.block.collection.query module

class notion.block.collection.query.BoardQueryResult(collection, result, query: notion.block.collection.query.CollectionQuery)

Bases: notion.block.collection.query.CollectionQueryResult

class notion.block.collection.query.CalendarQueryResult(collection, result, query: notion.block.collection.query.CollectionQuery)

Bases: notion.block.collection.query.CollectionQueryResult

class notion.block.collection.query.CollectionQuery(collection, collection_view, search='', type='table', aggregate=[], aggregations=[], filter=[], sort=[], calendar_by='', group_by='')

Bases: object

Collection Query.

execute() → notion.block.collection.query.CollectionQueryResult

Execute the query.

Returns:Result of the query. Return type:CollectionQueryResult

class notion.block.collection.query.CollectionQueryResult(collection, result, query: notion.block.collection.query.CollectionQuery)

Bases: object

Collection Query Result.

get_aggregate(block_id: str)

class notion.block.collection.query.GalleryQueryResult(collection, result, query: notion.block.collection.query.CollectionQuery)

Bases: notion.block.collection.query.CollectionQueryResult

class notion.block.collection.query.ListQueryResult(collection, result, query: notion.block.collection.query.CollectionQuery)

Bases: notion.block.collection.query.CollectionQueryResult

class notion.block.collection.query.TableQueryResult(collection, result, query: notion.block.collection.query.CollectionQuery)

Bases: notion.block.collection.query.CollectionQueryResult

notion.block.collection.view module

class notion.block.collection.view.BoardView(*args, collection, **kwargs)

Bases: notion.block.collection.view.CollectionView

group_by

class notion.block.collection.view.CalendarView(*args, collection, **kwargs)

Bases: notion.block.collection.view.CollectionView

build_query(**kwargs)

class notion.block.collection.view.CollectionView(*args, collection, **kwargs)

Bases: notion.record.Record

A “view” is a particular visualization of a collection, with a “type” (board, table, list, etc) and filters, sort, etc.

build_query(**kwargs) → notion.block.collection.query.CollectionQuery

default_query() → notion.block.collection.query.CollectionQuery

Return default query.

name

parent

type

class notion.block.collection.view.GalleryView(*args, collection, **kwargs)

Bases: notion.block.collection.view.CollectionView

class notion.block.collection.view.ListView(*args, collection, **kwargs)

Bases: notion.block.collection.view.CollectionView

class notion.block.collection.view.TableView(*args, collection, **kwargs)

Bases: notion.block.collection.view.CollectionView

Module contents