notionary 0.3.1__py3-none-any.whl → 0.4.1__py3-none-any.whl

notionary/comments/client.py

@@ -8,7 +8,10 @@ from notionary.comments.schemas import (
     CommentListResponse,
 )
 from notionary.http.client import NotionHttpClient
-from notionary.utils.pagination import paginate_notion_api, paginate_notion_api_generator
+from notionary.utils.pagination import (
+    paginate_notion_api,
+    paginate_notion_api_generator,
+)
 
 
 class CommentClient(NotionHttpClient):
@@ -21,16 +24,24 @@ class CommentClient(NotionHttpClient):
         total_results_limit: int | None = None,
     ) -> AsyncGenerator[CommentDto]:
         async for comment in paginate_notion_api_generator(
-            self._list_comments_page, block_id=block_id, total_results_limit=total_results_limit
+            self._list_comments_page,
+            block_id=block_id,
+            total_results_limit=total_results_limit,
         ):
             yield comment
 
-    async def get_all_comments(self, block_id: str, *, total_results_limit: int | None = None) -> list[CommentDto]:
+    async def get_all_comments(
+        self, block_id: str, *, total_results_limit: int | None = None
+    ) -> list[CommentDto]:
         all_comments = await paginate_notion_api(
-            self._list_comments_page, block_id=block_id, total_results_limit=total_results_limit
+            self._list_comments_page,
+            block_id=block_id,
+            total_results_limit=total_results_limit,
         )
 
-        self.logger.debug("Retrieved %d total comments for block %s", len(all_comments), block_id)
+        self.logger.debug(
+            "Retrieved %d total comments for block %s", len(all_comments), block_id
+        )
         return all_comments
 
     async def _list_comments_page(
@@ -65,7 +76,9 @@ class CommentClient(NotionHttpClient):
         rich_text: list[RichText],
         discussion_id: str,
     ) -> CommentDto:
-        request = CommentCreateRequest.for_discussion(discussion_id=discussion_id, rich_text=rich_text)
+        request = CommentCreateRequest.for_discussion(
+            discussion_id=discussion_id, rich_text=rich_text
+        )
 
         body = request.model_dump(exclude_unset=True, exclude_none=True)
 

notionary/comments/factory.py

@@ -1,6 +1,8 @@
 import asyncio
 
-from notionary.blocks.rich_text.rich_text_markdown_converter import RichTextToMarkdownConverter
+from notionary.blocks.rich_text.rich_text_markdown_converter import (
+    RichTextToMarkdownConverter,
+)
 from notionary.comments.models import Comment
 from notionary.comments.schemas import CommentDto
 from notionary.user.base import BaseUser
@@ -20,7 +22,9 @@ class CommentFactory(LoggingMixin):
         self.markdown_converter = markdown_converter or RichTextToMarkdownConverter()
 
     async def create_from_dto(self, dto: CommentDto) -> Comment:
-        author_name, content = await asyncio.gather(self._resolve_user_name(dto), self._resolve_content(dto))
+        author_name, content = await asyncio.gather(
+            self._resolve_user_name(dto), self._resolve_content(dto)
+        )
 
         return Comment(author_name=author_name, content=content)
 
@@ -30,7 +34,10 @@ class CommentFactory(LoggingMixin):
         try:
             return await BaseUser.from_id_auto(created_by_id, self.http_client)
         except Exception:
-            self.logger.warning(f"Failed to resolve user name for user_id: {created_by_id}", exc_info=True)
+            self.logger.warning(
+                f"Failed to resolve user name for user_id: {created_by_id}",
+                exc_info=True,
+            )
 
         return self.UNKNOWN_AUTHOR
 

notionary/comments/schemas.py

@@ -8,10 +8,6 @@ from pydantic import BaseModel, Field
 
 from notionary.blocks.rich_text.models import RichText
 
-# ---------------------------
-# Comment Parent
-# ---------------------------
-
 
 class CommentParentType(StrEnum):
     PAGE_ID = "page_id"
@@ -28,7 +24,7 @@ class BlockCommentParent(BaseModel):
     block_id: str
 
 
-CommentParent = PageCommentParent | BlockCommentParent
+type CommentParent = PageCommentParent | BlockCommentParent
 
 
 # ---------------------------
@@ -65,7 +61,9 @@ class CommentAttachmentFileUploadType(StrEnum):
 
 class CommentAttachmentInput(BaseModel):
     file_upload_id: str
-    type: Literal[CommentAttachmentFileUploadType.FILE_UPLOAD] = CommentAttachmentFileUploadType.FILE_UPLOAD
+    type: Literal[CommentAttachmentFileUploadType.FILE_UPLOAD] = (
+        CommentAttachmentFileUploadType.FILE_UPLOAD
+    )
 
 
 # ---------------------------
@@ -84,7 +82,9 @@ class CustomDisplayName(BaseModel):
 
 
 class IntegrationDisplayName(BaseModel):
-    type: Literal[CommentDisplayNameType.INTEGRATION] = CommentDisplayNameType.INTEGRATION
+    type: Literal[CommentDisplayNameType.INTEGRATION] = (
+        CommentDisplayNameType.INTEGRATION
+    )
 
 
 class UserDisplayName(BaseModel):
@@ -96,7 +96,9 @@ class CustomCommentDisplayName(BaseModel):
     custom: CustomDisplayName
 
 
-CommentDisplayNameInput = IntegrationDisplayName | UserDisplayName | CustomCommentDisplayName
+type CommentDisplayNameInput = (
+    IntegrationDisplayName | UserDisplayName | CustomCommentDisplayName
+)
 
 
 class CommentDisplayNameDto(BaseModel):
@@ -189,8 +191,6 @@ class UserRef(BaseModel):
 
 
 class CommentDto(BaseModel):
-    """Comment object as returned by the API"""
-
     object: Literal["comment"] = "comment"
     id: str
 
@@ -217,24 +217,3 @@ class CommentListResponse(BaseModel):
     results: list[CommentDto] = Field(default_factory=list)
     next_cursor: str | None = None
     has_more: bool = False
-
-
-# ---------------------------
-# Convenience Builders
-# ---------------------------
-
-
-class CommentDisplayNameBuilder:
-    """Helper class to build display names easily"""
-
-    @staticmethod
-    def integration() -> IntegrationDisplayName:
-        return IntegrationDisplayName()
-
-    @staticmethod
-    def user() -> UserDisplayName:
-        return UserDisplayName()
-
-    @staticmethod
-    def custom(name: str) -> CustomCommentDisplayName:
-        return CustomCommentDisplayName(custom=CustomDisplayName(name=name))

notionary/comments/service.py

@@ -1,6 +1,8 @@
 import asyncio
 
-from notionary.blocks.rich_text.markdown_rich_text_converter import MarkdownRichTextConverter
+from notionary.blocks.rich_text.markdown_rich_text_converter import (
+    MarkdownRichTextConverter,
+)
 from notionary.comments.client import CommentClient
 from notionary.comments.factory import CommentFactory
 from notionary.comments.models import Comment
@@ -20,15 +22,21 @@ class CommentService:
     async def list_all_comments_for_page(self, page_id: str) -> list[Comment]:
         comment_dtos = [dto async for dto in self.client.iter_comments(page_id)]
 
-        comments = await asyncio.gather(*(self.factory.create_from_dto(dto) for dto in comment_dtos))
+        comments = await asyncio.gather(
+            *(self.factory.create_from_dto(dto) for dto in comment_dtos)
+        )
         return comments
 
     async def create_comment_on_page(self, page_id: str, text: str) -> Comment:
         rich_text = await self._converter.to_rich_text(text)
-        comment_dto = await self.client.create_comment_for_page(rich_text=rich_text, page_id=page_id)
+        comment_dto = await self.client.create_comment_for_page(
+            rich_text=rich_text, page_id=page_id
+        )
         return await self.factory.create_from_dto(comment_dto)
 
     async def reply_to_discussion_by_id(self, discussion_id: str, text: str) -> Comment:
         rich_text = await self._converter.to_rich_text(text)
-        comment_dto = await self.client.create_comment_for_discussion(rich_text=rich_text, discussion_id=discussion_id)
+        comment_dto = await self.client.create_comment_for_discussion(
+            rich_text=rich_text, discussion_id=discussion_id
+        )
         return await self.factory.create_from_dto(comment_dto)

notionary/data_source/http/data_source_instance_client.py

@@ -3,14 +3,25 @@ from __future__ import annotations
 from collections.abc import AsyncIterator
 from typing import TYPE_CHECKING, Any, override
 
-from notionary.blocks.rich_text.rich_text_markdown_converter import RichTextToMarkdownConverter
+from notionary.blocks.rich_text.rich_text_markdown_converter import (
+    RichTextToMarkdownConverter,
+)
 from notionary.data_source.query.schema import DataSourceQueryParams
-from notionary.data_source.schemas import DataSourceDto, QueryDataSourceResponse, UpdateDataSourceDto
+from notionary.data_source.schemas import (
+    DataSourceDto,
+    QueryDataSourceResponse,
+    UpdateDataSourceDto,
+)
 from notionary.http.client import NotionHttpClient
 from notionary.page.schemas import NotionPageDto
-from notionary.shared.entity.entity_metadata_update_client import EntityMetadataUpdateClient
+from notionary.shared.entity.entity_metadata_update_client import (
+    EntityMetadataUpdateClient,
+)
 from notionary.shared.typings import JsonDict
-from notionary.utils.pagination import paginate_notion_api, paginate_notion_api_generator
+from notionary.utils.pagination import (
+    paginate_notion_api,
+    paginate_notion_api_generator,
+)
 
 if TYPE_CHECKING:
     from notionary import NotionPage
@@ -22,9 +33,15 @@ class DataSourceInstanceClient(NotionHttpClient, EntityMetadataUpdateClient):
         self._data_source_id = data_source_id
 
     @override
-    async def patch_metadata(self, update_data_source_dto: UpdateDataSourceDto) -> DataSourceDto:
-        update_data_source_dto_dict = update_data_source_dto.model_dump(exclude_none=True)
-        response = await self.patch(f"data_sources/{self._data_source_id}", data=update_data_source_dto_dict)
+    async def patch_metadata(
+        self, update_data_source_dto: UpdateDataSourceDto
+    ) -> DataSourceDto:
+        update_data_source_dto_dict = update_data_source_dto.model_dump(
+            exclude_none=True
+        )
+        response = await self.patch(
+            f"data_sources/{self._data_source_id}", data=update_data_source_dto_dict
+        )
         return DataSourceDto.model_validate(response)
 
     async def update_title(self, title: str) -> DataSourceDto:
@@ -40,28 +57,38 @@ class DataSourceInstanceClient(NotionHttpClient, EntityMetadataUpdateClient):
         await self.patch_metadata(update_data_source_dto)
 
     async def update_description(self, description: str) -> str:
-        from notionary.blocks.rich_text.markdown_rich_text_converter import MarkdownRichTextConverter
+        from notionary.blocks.rich_text.markdown_rich_text_converter import (
+            MarkdownRichTextConverter,
+        )
 
         markdown_rich_text_converter = MarkdownRichTextConverter()
-        rich_text_description = await markdown_rich_text_converter.to_rich_text(description)
+        rich_text_description = await markdown_rich_text_converter.to_rich_text(
+            description
+        )
         update_data_source_dto = UpdateDataSourceDto(description=rich_text_description)
 
         updated_data_source_dto = await self.patch_metadata(update_data_source_dto)
 
         markdown_rich_text_converter = RichTextToMarkdownConverter()
         updated_markdown_description = (
-            await markdown_rich_text_converter.to_markdown(updated_data_source_dto.description)
+            await markdown_rich_text_converter.to_markdown(
+                updated_data_source_dto.description
+            )
             if updated_data_source_dto.description
             else None
         )
         return updated_markdown_description
 
-    async def query(self, query_params: DataSourceQueryParams | None = None) -> QueryDataSourceResponse:
+    async def query(
+        self, query_params: DataSourceQueryParams | None = None
+    ) -> QueryDataSourceResponse:
         query_params_dict = query_params.to_api_params() if query_params else {}
         total_result_limit = query_params.total_results_limit if query_params else None
 
         all_results = await paginate_notion_api(
-            self._make_query_request, query_data=query_params_dict or {}, total_result_limit=total_result_limit
+            self._make_query_request,
+            query_data=query_params_dict or {},
+            total_result_limit=total_result_limit,
         )
 
         return QueryDataSourceResponse(
@@ -70,17 +97,24 @@ class DataSourceInstanceClient(NotionHttpClient, EntityMetadataUpdateClient):
             has_more=False,
         )
 
-    async def query_stream(self, query_params: DataSourceQueryParams | None = None) -> AsyncIterator[Any]:
+    async def query_stream(
+        self, query_params: DataSourceQueryParams | None = None
+    ) -> AsyncIterator[Any]:
         query_params_dict = query_params.model_dump() if query_params else {}
         total_result_limit = query_params.total_results_limit if query_params else None
 
         async for result in paginate_notion_api_generator(
-            self._make_query_request, query_data=query_params_dict or {}, total_results_limit=total_result_limit
+            self._make_query_request,
+            query_data=query_params_dict or {},
+            total_results_limit=total_result_limit,
         ):
             yield result
 
     async def _make_query_request(
-        self, query_data: JsonDict, start_cursor: str | None = None, page_size: int | None = None
+        self,
+        query_data: JsonDict,
+        start_cursor: str | None = None,
+        page_size: int | None = None,
     ) -> QueryDataSourceResponse:
         current_query_data = query_data.copy()
         if start_cursor:
@@ -88,13 +122,21 @@ class DataSourceInstanceClient(NotionHttpClient, EntityMetadataUpdateClient):
         if page_size:
             current_query_data["page_size"] = page_size
 
-        response = await self.post(f"data_sources/{self._data_source_id}/query", data=current_query_data)
+        response = await self.post(
+            f"data_sources/{self._data_source_id}/query", data=current_query_data
+        )
         return QueryDataSourceResponse.model_validate(response)
 
     async def create_blank_page(self, title: str | None = None) -> NotionPage:
         from notionary import NotionPage
 
-        data = {"parent": {"type": "data_source_id", "data_source_id": self._data_source_id}, "properties": {}}
+        data = {
+            "parent": {
+                "type": "data_source_id",
+                "data_source_id": self._data_source_id,
+            },
+            "properties": {},
+        }
 
         if title:
             data["properties"]["Name"] = {"title": [{"text": {"content": title}}]}