7310375393

Committed 23 Dec 2023 08:37PM UTC coverage: 88.657% (+0.09%) from 88.571%

Build # 7310375393

Build Type

push

github

Committed by

FlorianWilhelm

Commit Message

Fix nasty bug when working with People property

Run Details

577 of 764 branches covered (0.0%)

Branch coverage included in aggregate %.

15 of 15 new or added lines in 3 files covered. (100.0%)

15 existing lines in 3 files now uncovered.

3628 of 3979 relevant lines covered (91.18%)

4.54 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

88.54

/src/ultimate_notion/blocks.py

"""Core building blocks for pages and databases."""

from __future__ import annotations

from datetime import datetime
from typing import TypeVar
from uuid import UUID

from notion_client.helpers import get_url

from ultimate_notion.obj_api import blocks as obj_blocks
from ultimate_notion.obj_api import objects as objs
from ultimate_notion.objects import User
from ultimate_notion.utils import Wrapper, get_active_session

# Todo: Move the functionality from the PyDantic types in here, i.e. the currenctly commented code
T = TypeVar('T', bound=obj_blocks.DataObject)


class DataObject(Wrapper[T], wraps=obj_blocks.DataObject):
    """The base type for all data-related types, i.e, pages, databases and blocks."""

    def __eq__(self, other: object) -> bool:
        if other is None:
            return False
        elif not isinstance(other, DataObject):
            msg = f'Cannot compare {self.__class__.__name__} with {type(other).__name__}'
            raise RuntimeError(msg)
        else:
            return self.id == other.id

    def __hash__(self) -> int:
        return hash(self.id)

    @property
    def id(self) -> UUID:  # noqa: A003
        return self.obj_ref.id

    @property
    def created_time(self) -> datetime:
        return self.obj_ref.created_time

    @property
    def created_by(self) -> User:
        session = get_active_session()
        return session.get_user(self.obj_ref.created_by.id)

    @property
    def last_edited_time(self) -> datetime:
        return self.obj_ref.last_edited_time

    @property
    def last_edited_by(self) -> User:
        session = get_active_session()
        return session.get_user(self.obj_ref.last_edited_by.id)

    @property
    def parent(self) -> DataObject | None:
        """Return the parent record or None if the workspace is the parent."""
        session = get_active_session()
        parent = self.obj_ref.parent

        if isinstance(parent, objs.WorkspaceRef):
            return None
        elif isinstance(parent, objs.PageRef):
            return session.get_page(page_ref=parent.page_id)
        elif isinstance(parent, objs.DatabaseRef):
            return session.get_db(db_ref=parent.database_id)
        elif isinstance(parent, objs.BlockRef):
            return session._get_block(block_ref=parent.block_id)
        else:
            msg = f'Unknown parent reference {type(parent)}'
            raise RuntimeError(msg)

    @property
    def ancestors(self) -> tuple[DataObject, ...]:
        """Return all ancestors from the workspace to the actual record (excluding)."""
        match parent := self.parent:
            case None:
                return ()
            case _:
                return (*parent.ancestors, parent)

    @property
    def has_children(self) -> bool:
        return self.obj_ref.has_children

    @property
    def is_deleted(self) -> bool:
        """Return wether the object is deleted/archived."""
        return self.obj_ref.archived

    @property
    def url(self) -> str:
        return get_url(str(self.id))


class Block(DataObject[obj_blocks.Block], wraps=obj_blocks.Block):
    """General Notion block."""

    # ToDo: Implement me!


class TextBlock(DataObject[obj_blocks.TextBlock], wraps=obj_blocks.TextBlock):
    """Text block."""

    # ToDo: Implement me!


class ChildrenMixin:
    """Mixin for blocks that support children blocks."""

    # ToDo: Implement me!

    # @property
    # def __children__(self):
    #     """Provide short-hand access to the children in this block."""

    #     return self("children")

    # def __iadd__(self, block):
    #     """Append the given block to the children of this parent in place."""
    #     self.append(block)
    #     return self

    # def append(self, block):
    #     """Append the given block to the children of this parent."""

    #     if block is None:
    #         raise ValueError("block cannot be None")

    #     nested = self()

    #     if nested.children is None:
    #         nested.children = []

    #     nested.children.append(block)

    #     self.has_children = True


class Paragraph(DataObject[obj_blocks.Paragraph], ChildrenMixin, wraps=obj_blocks.Paragraph):
    """Paragraph block."""

    # ToDo: Implement me!


class Heading1(DataObject[obj_blocks.Heading1], wraps=obj_blocks.Heading1):
    """Heading 1 block."""

    # ToDo: Implement me!


class Heading2(DataObject[obj_blocks.Heading2], wraps=obj_blocks.Heading2):
    """Heading 2 block."""

    # ToDo: Implement me!


class Heading3(DataObject[obj_blocks.Heading3], wraps=obj_blocks.Heading3):
    """Heading 3 block."""

    # ToDo: Implement me!


class Quote(DataObject[obj_blocks.Quote], ChildrenMixin, wraps=obj_blocks.Quote):
    """Quote block."""

    # ToDo: Implement me!


class Code(DataObject[obj_blocks.Code], wraps=obj_blocks.Code):
    """Code block."""

    # ToDo: Implement me!


class Callout(DataObject[obj_blocks.Callout], wraps=obj_blocks.Callout):
    """Callout block."""

    # ToDo: Implement me!


class BulletedItem(DataObject[obj_blocks.BulletedListItem], ChildrenMixin, wraps=obj_blocks.BulletedListItem):
    """Bulleted list item."""

    # ToDo: Implement me!


class NumberedItem(DataObject[obj_blocks.NumberedListItem], ChildrenMixin, wraps=obj_blocks.NumberedListItem):
    """Numbered list item."""

    # ToDo: Implement me!


class ToDoItem(DataObject[obj_blocks.ToDo], ChildrenMixin, wraps=obj_blocks.ToDo):
    """ToDo list item."""

    # ToDo: Implement me!


class ToggleItem(DataObject[obj_blocks.Toggle], ChildrenMixin, wraps=obj_blocks.Toggle):
    """Toggle list item."""

    # ToDo: Implement me!


class Divider(DataObject[obj_blocks.Divider], wraps=obj_blocks.Divider):
    """Divider block."""

    # ToDo: Implement me!


class TableOfContents(DataObject[obj_blocks.TableOfContents], wraps=obj_blocks.TableOfContents):
    """Table of contents block."""

    # ToDo: Implement me!


class Breadcrumb(DataObject[obj_blocks.Breadcrumb], wraps=obj_blocks.Breadcrumb):
    """Breadcrumb block."""

    # ToDo: Implement me!


class Embed(DataObject[obj_blocks.Embed], wraps=obj_blocks.Embed):
    """Embed block."""

    # ToDo: Implement me!


class Bookmark(DataObject[obj_blocks.Bookmark], wraps=obj_blocks.Bookmark):
    """Bookmark block."""

    # ToDo: Implement me!


class LinkPreview(DataObject[obj_blocks.LinkPreview], wraps=obj_blocks.LinkPreview):
    """Link preview block."""

    # ToDo: Implement me!


class Equation(DataObject[obj_blocks.Equation], wraps=obj_blocks.Equation):
    """Equation block."""

    # ToDo: Implement me!


class File(DataObject[obj_blocks.File], wraps=obj_blocks.File):
    """File block."""

    # ToDo: Implement me!


class Image(DataObject[obj_blocks.Image], wraps=obj_blocks.Image):
    """Image block."""

    # ToDo: Implement me!


class Video(DataObject[obj_blocks.Video], wraps=obj_blocks.Video):
    """Video block."""

    # ToDo: Implement me!


class PDF(DataObject[obj_blocks.PDF], wraps=obj_blocks.PDF):
    """PDF block."""

    # ToDo: Implement me!


class ChildPage(DataObject[obj_blocks.ChildPage], wraps=obj_blocks.ChildPage):
    """Child page block."""

    # ToDo: Implement me!


class ChildDatabase(DataObject[obj_blocks.ChildDatabase], wraps=obj_blocks.ChildDatabase):
    """Child database block."""

    # ToDo: Implement me!


class Column(DataObject[obj_blocks.Column], ChildrenMixin, wraps=obj_blocks.Column):
    """Collumn block."""

    # ToDo: Implement me!


class ColumnList(DataObject[obj_blocks.ColumnList], ChildrenMixin, wraps=obj_blocks.ColumnList):
    """Column list block."""

    # ToDo: Implement me!


class TableRow(DataObject[obj_blocks.TableRow], wraps=obj_blocks.TableRow):
    """Table row block."""

    # ToDo: Implement me!


class Table(DataObject[obj_blocks.Table], ChildrenMixin, wraps=obj_blocks.Table):
    """Table block."""

    # ToDo: Implement me!


class LinkToPage(DataObject[obj_blocks.LinkToPage], wraps=obj_blocks.LinkToPage):
    """Link to page block."""

    # ToDo: Implement me!


class SyncedBlock(DataObject[obj_blocks.SyncedBlock], ChildrenMixin, wraps=obj_blocks.SyncedBlock):
    """Synced block - either original or synched."""

    @property
    def is_original(self) -> bool:
        """Is this block the original content."""
        return self.obj_ref.synced_block.synced_from is None

    @property
    def is_synched(self) -> bool:
        return not self.is_original


class Template(DataObject[obj_blocks.Template], ChildrenMixin, wraps=obj_blocks.Template):
    """Template block."""

1	"""Core building blocks for pages and databases."""	5✔
2
3	from __future__ import annotations	5✔
4
5	from datetime import datetime	5✔
6	from typing import TypeVar	5✔
7	from uuid import UUID	5✔
8
9	from notion_client.helpers import get_url	5✔
10
11	from ultimate_notion.obj_api import blocks as obj_blocks	5✔
12	from ultimate_notion.obj_api import objects as objs	5✔
13	from ultimate_notion.objects import User	5✔
14	from ultimate_notion.utils import Wrapper, get_active_session	5✔
15
16	# Todo: Move the functionality from the PyDantic types in here, i.e. the currenctly commented code
17	T = TypeVar('T', bound=obj_blocks.DataObject)	5✔
18
19
20	class DataObject(Wrapper[T], wraps=obj_blocks.DataObject):	5✔
21	"""The base type for all data-related types, i.e, pages, databases and blocks."""	5✔
22
23	def __eq__(self, other: object) -> bool:	5✔
24	if other is None:	5✔
UNCOV 25	return False	×
26	elif not isinstance(other, DataObject):	5✔
27	msg = f'Cannot compare {self.__class__.__name__} with {type(other).__name__}'	×
UNCOV 28	raise RuntimeError(msg)	×
29	else:
30	return self.id == other.id	5✔
31
32	def __hash__(self) -> int:	5✔
33	return hash(self.id)	5✔
34
35	@property	5✔
36	def id(self) -> UUID: # noqa: A003	5✔
37	return self.obj_ref.id	5✔
38
39	@property	5✔
40	def created_time(self) -> datetime:	5✔
UNCOV 41	return self.obj_ref.created_time	×
42
43	@property	5✔
44	def created_by(self) -> User:	5✔
45	session = get_active_session()	5✔
46	return session.get_user(self.obj_ref.created_by.id)	5✔
47
48	@property	5✔
49	def last_edited_time(self) -> datetime:	5✔
UNCOV 50	return self.obj_ref.last_edited_time	×
51
52	@property	5✔
53	def last_edited_by(self) -> User:	5✔
54	session = get_active_session()	5✔
55	return session.get_user(self.obj_ref.last_edited_by.id)	5✔
56
57	@property	5✔
58	def parent(self) -> DataObject \| None:	5✔
59	"""Return the parent record or None if the workspace is the parent."""
60	session = get_active_session()	5✔
61	parent = self.obj_ref.parent	5✔
62
63	if isinstance(parent, objs.WorkspaceRef):	5✔
64	return None	5✔
65	elif isinstance(parent, objs.PageRef):	5✔
66	return session.get_page(page_ref=parent.page_id)	5✔
67	elif isinstance(parent, objs.DatabaseRef):	5✔
68	return session.get_db(db_ref=parent.database_id)	5✔
UNCOV 69	elif isinstance(parent, objs.BlockRef):	×
UNCOV 70	return session._get_block(block_ref=parent.block_id)	×
71	else:
72	msg = f'Unknown parent reference {type(parent)}'	×
UNCOV 73	raise RuntimeError(msg)	×
74
75	@property	5✔
76	def ancestors(self) -> tuple[DataObject, ...]:	5✔
77	"""Return all ancestors from the workspace to the actual record (excluding)."""
78	match parent := self.parent:	5✔
79	case None:	5✔
80	return ()	5✔
81	case _:	5✔
82	return (*parent.ancestors, parent)	5✔
83
84	@property	5✔
85	def has_children(self) -> bool:	5✔
UNCOV 86	return self.obj_ref.has_children	×
87
88	@property	5✔
89	def is_deleted(self) -> bool:	5✔
90	"""Return wether the object is deleted/archived."""
91	return self.obj_ref.archived	5✔
92
93	@property	5✔
94	def url(self) -> str:	5✔
UNCOV 95	return get_url(str(self.id))	×
96
97
98	class Block(DataObject[obj_blocks.Block], wraps=obj_blocks.Block):	5✔
99	"""General Notion block."""	5✔
100
101	# ToDo: Implement me!
102
103
104	class TextBlock(DataObject[obj_blocks.TextBlock], wraps=obj_blocks.TextBlock):	5✔
105	"""Text block."""	5✔
106
107	# ToDo: Implement me!
108
109
110	class ChildrenMixin:	5✔
111	"""Mixin for blocks that support children blocks."""	5✔
112
113	# ToDo: Implement me!
114
115	# @property
116	# def __children__(self):
117	# """Provide short-hand access to the children in this block."""
118
119	# return self("children")
120
121	# def __iadd__(self, block):
122	# """Append the given block to the children of this parent in place."""
123	# self.append(block)
124	# return self
125
126	# def append(self, block):
127	# """Append the given block to the children of this parent."""
128
129	# if block is None:
130	# raise ValueError("block cannot be None")
131
132	# nested = self()
133
134	# if nested.children is None:
135	# nested.children = []
136
137	# nested.children.append(block)
138
139	# self.has_children = True
140
141
142	class Paragraph(DataObject[obj_blocks.Paragraph], ChildrenMixin, wraps=obj_blocks.Paragraph):	5✔
143	"""Paragraph block."""	5✔
144
145	# ToDo: Implement me!
146
147
148	class Heading1(DataObject[obj_blocks.Heading1], wraps=obj_blocks.Heading1):	5✔
149	"""Heading 1 block."""	5✔
150
151	# ToDo: Implement me!
152
153
154	class Heading2(DataObject[obj_blocks.Heading2], wraps=obj_blocks.Heading2):	5✔
155	"""Heading 2 block."""	5✔
156
157	# ToDo: Implement me!
158
159
160	class Heading3(DataObject[obj_blocks.Heading3], wraps=obj_blocks.Heading3):	5✔
161	"""Heading 3 block."""	5✔
162
163	# ToDo: Implement me!
164
165
166	class Quote(DataObject[obj_blocks.Quote], ChildrenMixin, wraps=obj_blocks.Quote):	5✔
167	"""Quote block."""	5✔
168
169	# ToDo: Implement me!
170
171
172	class Code(DataObject[obj_blocks.Code], wraps=obj_blocks.Code):	5✔
173	"""Code block."""	5✔
174
175	# ToDo: Implement me!
176
177
178	class Callout(DataObject[obj_blocks.Callout], wraps=obj_blocks.Callout):	5✔
179	"""Callout block."""	5✔
180
181	# ToDo: Implement me!
182
183
184	class BulletedItem(DataObject[obj_blocks.BulletedListItem], ChildrenMixin, wraps=obj_blocks.BulletedListItem):	5✔
185	"""Bulleted list item."""	5✔
186
187	# ToDo: Implement me!
188
189
190	class NumberedItem(DataObject[obj_blocks.NumberedListItem], ChildrenMixin, wraps=obj_blocks.NumberedListItem):	5✔
191	"""Numbered list item."""	5✔
192
193	# ToDo: Implement me!
194
195
196	class ToDoItem(DataObject[obj_blocks.ToDo], ChildrenMixin, wraps=obj_blocks.ToDo):	5✔
197	"""ToDo list item."""	5✔
198
199	# ToDo: Implement me!
200
201
202	class ToggleItem(DataObject[obj_blocks.Toggle], ChildrenMixin, wraps=obj_blocks.Toggle):	5✔
203	"""Toggle list item."""	5✔
204
205	# ToDo: Implement me!
206
207
208	class Divider(DataObject[obj_blocks.Divider], wraps=obj_blocks.Divider):	5✔
209	"""Divider block."""	5✔
210
211	# ToDo: Implement me!
212
213
214	class TableOfContents(DataObject[obj_blocks.TableOfContents], wraps=obj_blocks.TableOfContents):	5✔
215	"""Table of contents block."""	5✔
216
217	# ToDo: Implement me!
218
219
220	class Breadcrumb(DataObject[obj_blocks.Breadcrumb], wraps=obj_blocks.Breadcrumb):	5✔
221	"""Breadcrumb block."""	5✔
222
223	# ToDo: Implement me!
224
225
226	class Embed(DataObject[obj_blocks.Embed], wraps=obj_blocks.Embed):	5✔
227	"""Embed block."""	5✔
228
229	# ToDo: Implement me!
230
231
232	class Bookmark(DataObject[obj_blocks.Bookmark], wraps=obj_blocks.Bookmark):	5✔
233	"""Bookmark block."""	5✔
234
235	# ToDo: Implement me!
236
237
238	class LinkPreview(DataObject[obj_blocks.LinkPreview], wraps=obj_blocks.LinkPreview):	5✔
239	"""Link preview block."""	5✔
240
241	# ToDo: Implement me!
242
243
244	class Equation(DataObject[obj_blocks.Equation], wraps=obj_blocks.Equation):	5✔
245	"""Equation block."""	5✔
246
247	# ToDo: Implement me!
248
249
250	class File(DataObject[obj_blocks.File], wraps=obj_blocks.File):	5✔
251	"""File block."""	5✔
252
253	# ToDo: Implement me!
254
255
256	class Image(DataObject[obj_blocks.Image], wraps=obj_blocks.Image):	5✔
257	"""Image block."""	5✔
258
259	# ToDo: Implement me!
260
261
262	class Video(DataObject[obj_blocks.Video], wraps=obj_blocks.Video):	5✔
263	"""Video block."""	5✔
264
265	# ToDo: Implement me!
266
267
268	class PDF(DataObject[obj_blocks.PDF], wraps=obj_blocks.PDF):	5✔
269	"""PDF block."""	5✔
270
271	# ToDo: Implement me!
272
273
274	class ChildPage(DataObject[obj_blocks.ChildPage], wraps=obj_blocks.ChildPage):	5✔
275	"""Child page block."""	5✔
276
277	# ToDo: Implement me!
278
279
280	class ChildDatabase(DataObject[obj_blocks.ChildDatabase], wraps=obj_blocks.ChildDatabase):	5✔
281	"""Child database block."""	5✔
282
283	# ToDo: Implement me!
284
285
286	class Column(DataObject[obj_blocks.Column], ChildrenMixin, wraps=obj_blocks.Column):	5✔
287	"""Collumn block."""	5✔
288
289	# ToDo: Implement me!
290
291
292	class ColumnList(DataObject[obj_blocks.ColumnList], ChildrenMixin, wraps=obj_blocks.ColumnList):	5✔
293	"""Column list block."""	5✔
294
295	# ToDo: Implement me!
296
297
298	class TableRow(DataObject[obj_blocks.TableRow], wraps=obj_blocks.TableRow):	5✔
299	"""Table row block."""	5✔
300
301	# ToDo: Implement me!
302
303
304	class Table(DataObject[obj_blocks.Table], ChildrenMixin, wraps=obj_blocks.Table):	5✔
305	"""Table block."""	5✔
306
307	# ToDo: Implement me!
308
309
310	class LinkToPage(DataObject[obj_blocks.LinkToPage], wraps=obj_blocks.LinkToPage):	5✔
311	"""Link to page block."""	5✔
312
313	# ToDo: Implement me!
314
315
316	class SyncedBlock(DataObject[obj_blocks.SyncedBlock], ChildrenMixin, wraps=obj_blocks.SyncedBlock):	5✔
317	"""Synced block - either original or synched."""	5✔
318
319	@property	5✔
320	def is_original(self) -> bool:	5✔
321	"""Is this block the original content."""
UNCOV 322	return self.obj_ref.synced_block.synced_from is None	×
323
324	@property	5✔
325	def is_synched(self) -> bool:	5✔
UNCOV 326	return not self.is_original	×
327
328
329	class Template(DataObject[obj_blocks.Template], ChildrenMixin, wraps=obj_blocks.Template):	5✔
330	"""Template block."""	5✔

ultimate-notion / ultimate-notion / 7310375393

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous