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

notionary/page/properties/{models.py → schemas.py}

@@ -1,9 +1,10 @@
 from enum import StrEnum
-from typing import Annotated, Any, Literal, TypeVar
+from typing import Any, Literal, TypeVar
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 from notionary.blocks.rich_text.models import RichText
+from notionary.shared.models.file import File
 from notionary.shared.properties.type import PropertyType
 from notionary.shared.typings import JsonDict
 from notionary.user.schemas import PersonUserResponseDto, UserResponseDto
@@ -38,38 +39,6 @@ class DateValue(BaseModel):
     time_zone: str | None = None
 
 
-# ============================================================================
-# File Models
-# ============================================================================
-
-
-class FileType(StrEnum):
-    EXTERNAL = "external"
-    FILE = "file"
-
-
-class ExternalFile(BaseModel):
-    """External file hosted outside of Notion."""
-
-    url: str
-
-
-class NotionFile(BaseModel):
-    """File uploaded to Notion with expiration."""
-
-    url: str
-    expiry_time: str
-
-
-class FileObject(BaseModel):
-    """File object can be external or uploaded to Notion."""
-
-    name: str
-    type: FileType
-    external: ExternalFile | None = None
-    file: NotionFile | None = None
-
-
 # ============================================================================
 # Formula Models
 # ============================================================================
@@ -142,25 +111,9 @@ class VerificationValue(BaseModel):
 # ============================================================================
 
 
-class PageStatusProperty(PageProperty):
-    type: Literal[PropertyType.STATUS] = PropertyType.STATUS
-    status: StatusOption | None = None
-    options: list[StatusOption] = Field(default_factory=list)
-
-    @property
-    def option_names(self) -> list[str]:
-        return [option.name for option in self.options]
-
-
-class PageRelationProperty(PageProperty):
-    type: Literal[PropertyType.RELATION] = PropertyType.RELATION
-    relation: list[RelationItem] = Field(default_factory=list)
-    has_more: bool = False
-
-
-class PageURLProperty(PageProperty):
-    type: Literal[PropertyType.URL] = PropertyType.URL
-    url: str | None = None
+class PageTitleProperty(PageProperty):
+    type: Literal[PropertyType.TITLE] = PropertyType.TITLE
+    title: list[RichText] = Field(default_factory=list)
 
 
 class PageRichTextProperty(PageProperty):
@@ -168,6 +121,16 @@ class PageRichTextProperty(PageProperty):
     rich_text: list[RichText] = Field(default_factory=list)
 
 
+class PageSelectProperty(PageProperty):
+    type: Literal[PropertyType.SELECT] = PropertyType.SELECT
+    select: SelectOption | None = None
+    options: list[SelectOption] = Field(default_factory=list)
+
+    @property
+    def option_names(self) -> list[str]:
+        return [option.name for option in self.options]
+
+
 class PageMultiSelectProperty(PageProperty):
     type: Literal[PropertyType.MULTI_SELECT] = PropertyType.MULTI_SELECT
     multi_select: list[SelectOption] = Field(default_factory=list)
@@ -178,19 +141,19 @@ class PageMultiSelectProperty(PageProperty):
         return [option.name for option in self.options]
 
 
-class PageSelectProperty(PageProperty):
-    type: Literal[PropertyType.SELECT] = PropertyType.SELECT
-    select: SelectOption | None = None
-    options: list[SelectOption] = Field(default_factory=list)
+class PageStatusProperty(PageProperty):
+    type: Literal[PropertyType.STATUS] = PropertyType.STATUS
+    status: StatusOption | None = None
+    options: list[StatusOption] = Field(default_factory=list)
 
     @property
     def option_names(self) -> list[str]:
         return [option.name for option in self.options]
 
 
-class PagePeopleProperty(PageProperty):
-    type: Literal[PropertyType.PEOPLE] = PropertyType.PEOPLE
-    people: list[PersonUserResponseDto] = Field(default_factory=list)
+class PageNumberProperty(PageProperty):
+    type: Literal[PropertyType.NUMBER] = PropertyType.NUMBER
+    number: float | None = None
 
 
 class PageDateProperty(PageProperty):
@@ -198,21 +161,16 @@ class PageDateProperty(PageProperty):
     date: DateValue | None = None
 
 
-class PageTitleProperty(PageProperty):
-    type: Literal[PropertyType.TITLE] = PropertyType.TITLE
-    title: list[RichText] = Field(default_factory=list)
-
-
-class PageNumberProperty(PageProperty):
-    type: Literal[PropertyType.NUMBER] = PropertyType.NUMBER
-    number: float | None = None
-
-
 class PageCheckboxProperty(PageProperty):
     type: Literal[PropertyType.CHECKBOX] = PropertyType.CHECKBOX
     checkbox: bool = False
 
 
+class PageURLProperty(PageProperty):
+    type: Literal[PropertyType.URL] = PropertyType.URL
+    url: str | None = None
+
+
 class PageEmailProperty(PageProperty):
     type: Literal[PropertyType.EMAIL] = PropertyType.EMAIL
     email: str | None = None
@@ -223,29 +181,34 @@ class PagePhoneNumberProperty(PageProperty):
     phone_number: str | None = None
 
 
-class PageCreatedTimeProperty(PageProperty):
-    type: Literal[PropertyType.CREATED_TIME] = PropertyType.CREATED_TIME
-    created_time: str  # ISO 8601 datetime - read-only
-
-
-class PageLastEditedTimeProperty(PageProperty):
-    type: Literal[PropertyType.LAST_EDITED_TIME] = PropertyType.LAST_EDITED_TIME
-    last_edited_time: str  # ISO 8601 datetime - read-only
+class PagePeopleProperty(PageProperty):
+    type: Literal[PropertyType.PEOPLE] = PropertyType.PEOPLE
+    people: list[PersonUserResponseDto] = Field(default_factory=list)
 
 
 class PageCreatedByProperty(PageProperty):
     type: Literal[PropertyType.CREATED_BY] = PropertyType.CREATED_BY
-    created_by: UserResponseDto  # User object - read-only
+    created_by: UserResponseDto
 
 
 class PageLastEditedByProperty(PageProperty):
     type: Literal[PropertyType.LAST_EDITED_BY] = PropertyType.LAST_EDITED_BY
-    last_edited_by: UserResponseDto  # User object - read-only
+    last_edited_by: UserResponseDto
 
 
-class PageFilesProperty(PageProperty):
-    type: Literal[PropertyType.FILES] = PropertyType.FILES
-    files: list[FileObject] = Field(default_factory=list)
+class PageCreatedTimeProperty(PageProperty):
+    type: Literal[PropertyType.CREATED_TIME] = PropertyType.CREATED_TIME
+    created_time: str
+
+
+class PageLastEditedTimeProperty(PageProperty):
+    type: Literal[PropertyType.LAST_EDITED_TIME] = PropertyType.LAST_EDITED_TIME
+    last_edited_time: str
+
+
+class PageLastVisitedTimeProperty(PageProperty):
+    type: Literal[PropertyType.LAST_VISITED_TIME] = PropertyType.LAST_VISITED_TIME
+    last_visited_time: str | None = None
 
 
 class PageFormulaProperty(PageProperty):
@@ -258,14 +221,15 @@ class PageRollupProperty(PageProperty):
     rollup: RollupValue
 
 
-class PageUniqueIdProperty(PageProperty):
-    type: Literal[PropertyType.UNIQUE_ID] = PropertyType.UNIQUE_ID
-    unique_id: UniqueIdValue
+class PageFilesProperty(PageProperty):
+    type: Literal[PropertyType.FILES] = PropertyType.FILES
+    files: list[File] = Field(default_factory=list)
 
 
-class PageVerificationProperty(PageProperty):
-    type: Literal[PropertyType.VERIFICATION] = PropertyType.VERIFICATION
-    verification: VerificationValue
+class PageRelationProperty(PageProperty):
+    type: Literal[PropertyType.RELATION] = PropertyType.RELATION
+    relation: list[RelationItem] = Field(default_factory=list)
+    has_more: bool = False
 
 
 class PageButtonProperty(PageProperty):
@@ -273,36 +237,58 @@ class PageButtonProperty(PageProperty):
     button: JsonDict = Field(default_factory=dict)
 
 
-# ============================================================================
-# Discriminated Union
-# ============================================================================
+class PageLocationProperty(PageProperty):
+    type: Literal[PropertyType.LOCATION] = PropertyType.LOCATION
+    location: JsonDict | None = None
 
 
-DiscriminatedPageProperty = Annotated[
-    PageStatusProperty
-    | PageRelationProperty
-    | PageURLProperty
+class PagePlaceProperty(PageProperty):
+    type: Literal[PropertyType.PLACE] = PropertyType.PLACE
+    place: JsonDict | None = None
+
+
+class PageVerificationProperty(PageProperty):
+    type: Literal[PropertyType.VERIFICATION] = PropertyType.VERIFICATION
+    verification: VerificationValue
+
+
+class PageUniqueIdProperty(PageProperty):
+    type: Literal[PropertyType.UNIQUE_ID] = PropertyType.UNIQUE_ID
+    unique_id: UniqueIdValue
+
+
+class PageUnknownProperty(PageProperty):
+    model_config = ConfigDict(extra="allow")
+
+
+type AnyPageProperty = (
+    PageTitleProperty
     | PageRichTextProperty
-    | PageMultiSelectProperty
     | PageSelectProperty
-    | PagePeopleProperty
-    | PageDateProperty
-    | PageTitleProperty
+    | PageMultiSelectProperty
+    | PageStatusProperty
     | PageNumberProperty
+    | PageDateProperty
     | PageCheckboxProperty
+    | PageURLProperty
     | PageEmailProperty
     | PagePhoneNumberProperty
-    | PageCreatedTimeProperty
-    | PageLastEditedTimeProperty
+    | PagePeopleProperty
     | PageCreatedByProperty
     | PageLastEditedByProperty
-    | PageFilesProperty
+    | PageCreatedTimeProperty
+    | PageLastEditedTimeProperty
+    | PageLastVisitedTimeProperty
     | PageFormulaProperty
     | PageRollupProperty
-    | PageUniqueIdProperty
+    | PageFilesProperty
+    | PageRelationProperty
+    | PageButtonProperty
+    | PageLocationProperty
+    | PagePlaceProperty
     | PageVerificationProperty
-    | PageButtonProperty,
-    Field(discriminator="type"),
-]
+    | PageUniqueIdProperty
+    | PageUnknownProperty
+)
 
 PagePropertyT = TypeVar("PagePropertyT", bound=PageProperty)

notionary/page/properties/service.py

@@ -10,7 +10,7 @@ from notionary.exceptions.properties import (
     PagePropertyTypeError,
 )
 from notionary.page.properties.client import PagePropertyHttpClient
-from notionary.page.properties.models import (
+from notionary.page.properties.schemas import (
     PageCheckboxProperty,
     PageCreatedTimeProperty,
     PageDateProperty,

notionary/page/schemas.py

@@ -1,13 +1,13 @@
 from pydantic import BaseModel
 
-from notionary.page.properties.models import DiscriminatedPageProperty
+from notionary.page.properties.schemas import AnyPageProperty
 from notionary.shared.entity.schemas import EntityResponseDto
 
 
 class NotionPageDto(EntityResponseDto):
     archived: bool
-    properties: dict[str, DiscriminatedPageProperty]
+    properties: dict[str, AnyPageProperty]
 
 
 class PgePropertiesUpdateDto(BaseModel):
-    properties: dict[str, DiscriminatedPageProperty]
+    properties: dict[str, AnyPageProperty]

notionary/page/service.py

@@ -11,7 +11,7 @@ from notionary.page.content.service import PageContentService
 from notionary.page.page_http_client import NotionPageHttpClient
 from notionary.page.page_metadata_update_client import PageMetadataUpdateClient
 from notionary.page.properties.factory import PagePropertyHandlerFactory
-from notionary.page.properties.models import PageTitleProperty
+from notionary.page.properties.schemas import PageTitleProperty
 from notionary.page.properties.service import PagePropertyHandler
 from notionary.page.schemas import NotionPageDto
 from notionary.shared.entity.service import Entity

notionary/shared/entity/dto_parsers.py

@@ -1,40 +1,5 @@
-from typing import cast
-
 from notionary.blocks.rich_text.rich_text_markdown_converter import RichTextToMarkdownConverter
-from notionary.shared.entity.schemas import Describable, EntityResponseDto, Titled
-from notionary.shared.models.cover import CoverType
-from notionary.shared.models.icon import IconType
-from notionary.shared.models.parent import DatabaseParent, DataSourceParent, ParentType
-
-
-def extract_emoji_icon_from_dto(entity_dto: EntityResponseDto) -> str | None:
-    if not entity_dto.icon or entity_dto.icon.type != IconType.EMOJI:
-        return None
-    return entity_dto.icon.emoji
-
-
-def extract_external_icon_url_from_dto(entity_dto: EntityResponseDto) -> str | None:
-    if not entity_dto.icon or entity_dto.icon.type != IconType.EXTERNAL:
-        return None
-    return entity_dto.icon.external.url if entity_dto.icon.external else None
-
-
-def extract_cover_image_url_from_dto(entity_dto: EntityResponseDto) -> str | None:
-    if not entity_dto.cover or entity_dto.cover.type != CoverType.EXTERNAL:
-        return None
-    return entity_dto.cover.external.url if entity_dto.cover.external else None
-
-
-def extract_database_id(entity_dto: EntityResponseDto) -> str | None:
-    if entity_dto.parent.type == ParentType.DATA_SOURCE_ID:
-        data_source_parent = cast(DataSourceParent, entity_dto.parent)
-        return data_source_parent.database_id if data_source_parent else None
-
-    if entity_dto.parent.type == ParentType.DATABASE_ID:
-        database_parent = cast(DatabaseParent, entity_dto.parent)
-        return database_parent.database_id if database_parent else None
-
-    return None
+from notionary.shared.entity.schemas import Describable, Titled
 
 
 async def extract_title(

notionary/shared/entity/entity_metadata_update_client.py

@@ -1,8 +1,8 @@
 from abc import ABC, abstractmethod
 
 from notionary.shared.entity.schemas import EntityResponseDto, NotionEntityUpdateDto
-from notionary.shared.models.cover import NotionCover
-from notionary.shared.models.icon import EmojiIcon, ExternalIcon
+from notionary.shared.models.file import ExternalFile, FileUploadFile
+from notionary.shared.models.icon import EmojiIcon, Icon
 
 
 class EntityMetadataUpdateClient(ABC):
@@ -15,7 +15,14 @@ class EntityMetadataUpdateClient(ABC):
         return await self.patch_metadata(update_dto)
 
     async def patch_external_icon(self, icon_url: str) -> EntityResponseDto:
-        icon = ExternalIcon.from_url(icon_url)
+        icon = ExternalFile.from_url(icon_url)
+        return await self._patch_icon(icon)
+
+    async def patch_icon_from_file_upload(self, file_upload_id: str) -> EntityResponseDto:
+        icon = FileUploadFile.from_id(id=file_upload_id)
+        return await self._patch_icon(icon)
+
+    async def _patch_icon(self, icon: Icon) -> EntityResponseDto:
         update_dto = NotionEntityUpdateDto(icon=icon)
         return await self.patch_metadata(update_dto)
 
@@ -24,7 +31,14 @@ class EntityMetadataUpdateClient(ABC):
         return await self.patch_metadata(update_dto)
 
     async def patch_external_cover(self, cover_url: str) -> EntityResponseDto:
-        cover = NotionCover.from_url(cover_url)
+        cover = ExternalFile.from_url(cover_url)
+        return await self._patch_cover(cover)
+
+    async def patch_cover_from_file_upload(self, file_upload_id: str) -> EntityResponseDto:
+        cover = FileUploadFile.from_id(id=file_upload_id)
+        return await self._patch_cover(cover)
+
+    async def _patch_cover(self, cover: Icon) -> EntityResponseDto:
         update_dto = NotionEntityUpdateDto(cover=cover)
         return await self.patch_metadata(update_dto)
 

notionary/shared/entity/schemas.py

@@ -4,26 +4,26 @@ from typing import Protocol
 from pydantic import BaseModel
 
 from notionary.blocks.rich_text.models import RichText
-from notionary.shared.models.cover import NotionCover
+from notionary.shared.models.file import File
 from notionary.shared.models.icon import Icon
 from notionary.shared.models.parent import Parent
 from notionary.user.schemas import PartialUserDto
 
 
-class EntityWorkspaceQueryObjectType(StrEnum):
+class _EntityType(StrEnum):
     PAGE = "page"
     DATA_SOURCE = "data_source"
     DATABASE = "database"
 
 
 class EntityResponseDto(BaseModel):
-    object: EntityWorkspaceQueryObjectType
+    object: _EntityType
     id: str
     created_time: str
     created_by: PartialUserDto
     last_edited_time: str
     last_edited_by: PartialUserDto
-    cover: NotionCover | None = None
+    cover: File | None = None
     icon: Icon | None = None
     parent: Parent
     in_trash: bool
@@ -32,8 +32,8 @@ class EntityResponseDto(BaseModel):
 
 
 class NotionEntityUpdateDto(BaseModel):
-    icon: Icon | None = None
-    cover: NotionCover | None = None
+    icon: File | None = None
+    cover: File | None = None
     in_trash: bool | None = None
 
 

notionary/shared/entity/service.py

@@ -1,12 +1,14 @@
 import random
 from abc import ABC, abstractmethod
 from collections.abc import Sequence
-from typing import Self
+from pathlib import Path
+from typing import Self, cast
 
+from notionary.file_upload.service import NotionFileUpload
 from notionary.shared.entity.entity_metadata_update_client import EntityMetadataUpdateClient
 from notionary.shared.entity.schemas import EntityResponseDto
-from notionary.shared.models.cover import CoverType
-from notionary.shared.models.icon import IconType
+from notionary.shared.models.file import ExternalFile, FileType, NotionHostedFile
+from notionary.shared.models.icon import EmojiIcon, IconType
 from notionary.shared.models.parent import ParentType
 from notionary.user.base import BaseUser
 from notionary.user.service import UserService
@@ -19,6 +21,7 @@ class Entity(LoggingMixin, ABC):
         self,
         dto: EntityResponseDto,
         user_service: UserService | None = None,
+        file_upload_service: NotionFileUpload | None = None,
     ) -> None:
         self._id = dto.id
         self._created_time = dto.created_time
@@ -35,6 +38,7 @@ class Entity(LoggingMixin, ABC):
         self._cover_image_url = self._extract_cover_image_url(dto)
 
         self._user_service = user_service or UserService()
+        self._file_upload_service = file_upload_service or NotionFileUpload()
 
     @staticmethod
     def _extract_emoji_icon(dto: EntityResponseDto) -> str | None:
@@ -43,25 +47,36 @@ class Entity(LoggingMixin, ABC):
         if dto.icon.type is not IconType.EMOJI:
             return None
 
-        return dto.icon.emoji
+        emoji_icon = cast(EmojiIcon, dto.icon)
+        return emoji_icon.emoji
 
     @staticmethod
     def _extract_external_icon_url(dto: EntityResponseDto) -> str | None:
         if dto.icon is None:
             return None
-        if dto.icon.type is not IconType.EXTERNAL:
-            return None
 
-        return dto.icon.external.url
+        if dto.icon.type == IconType.EXTERNAL:
+            external_icon = cast(ExternalFile, dto.icon)
+            return external_icon.external.url
+        elif dto.icon.type == IconType.FILE:
+            notion_file_icon = cast(NotionHostedFile, dto.icon)
+            return notion_file_icon.file.url
+
+        return None
 
     @staticmethod
     def _extract_cover_image_url(dto: EntityResponseDto) -> str | None:
         if dto.cover is None:
             return None
-        if dto.cover.type is not CoverType.EXTERNAL:
-            return None
 
-        return dto.cover.external.url
+        if dto.cover.type == FileType.EXTERNAL:
+            external_cover = cast(ExternalFile, dto.cover)
+            return external_cover.external.url
+        elif dto.cover.type == FileType.FILE:
+            notion_file_cover = cast(NotionHostedFile, dto.cover)
+            return notion_file_cover.file.url
+
+        return None
 
     @classmethod
     @abstractmethod
@@ -82,10 +97,7 @@ class Entity(LoggingMixin, ABC):
 
     @property
     @abstractmethod
-    def _entity_metadata_update_client(self) -> EntityMetadataUpdateClient:
-        # functionality for updating properties like title, icon, cover, archive status depends on interface for template like implementation
-        # has to be implementated by inheritants to correctly use the methods below
-        ...
+    def _entity_metadata_update_client(self) -> EntityMetadataUpdateClient: ...
 
     @property
     def id(self) -> str:
@@ -123,10 +135,6 @@ class Entity(LoggingMixin, ABC):
     def public_url(self) -> str | None:
         return self._public_url
 
-    # =========================================================================
-    # Parent ID Getters
-    # =========================================================================
-
     def get_parent_database_id_if_present(self) -> str | None:
         if self._parent.type == ParentType.DATABASE_ID:
             return self._parent.database_id
@@ -150,20 +158,12 @@ class Entity(LoggingMixin, ABC):
     def is_workspace_parent(self) -> bool:
         return self._parent.type == ParentType.WORKSPACE
 
-    # =========================================================================
-    # User Methods
-    # =========================================================================
-
     async def get_created_by_user(self) -> BaseUser | None:
         return await self._user_service.get_user_by_id(self._created_by.id)
 
     async def get_last_edited_by_user(self) -> BaseUser | None:
         return await self._user_service.get_user_by_id(self._last_edited_by.id)
 
-    # =========================================================================
-    # Icon & Cover Methods
-    # =========================================================================
-
     async def set_emoji_icon(self, emoji: str) -> None:
         entity_response = await self._entity_metadata_update_client.patch_emoji_icon(emoji)
         self._emoji_icon = self._extract_emoji_icon(entity_response)
@@ -174,6 +174,19 @@ class Entity(LoggingMixin, ABC):
         self._emoji_icon = None
         self._external_icon_url = self._extract_external_icon_url(entity_response)
 
+    async def set_icon_from_file(self, file_path: Path, filename: str | None = None) -> None:
+        upload_response = await self._file_upload_service.upload_file(file_path, filename)
+        await self._set_icon_from_file_upload(upload_response.id)
+
+    async def set_icon_from_bytes(self, file_content: bytes, filename: str, content_type: str | None = None) -> None:
+        upload_response = await self._file_upload_service.upload_from_bytes(file_content, filename, content_type)
+        await self._set_icon_from_file_upload(upload_response.id)
+
+    async def _set_icon_from_file_upload(self, file_upload_id: str) -> None:
+        entity_response = await self._entity_metadata_update_client.patch_icon_from_file_upload(file_upload_id)
+        self._emoji_icon = None
+        self._external_icon_url = self._extract_external_icon_url(entity_response)
+
     async def remove_icon(self) -> None:
         await self._entity_metadata_update_client.remove_icon()
         self._emoji_icon = None
@@ -183,6 +196,20 @@ class Entity(LoggingMixin, ABC):
         entity_response = await self._entity_metadata_update_client.patch_external_cover(image_url)
         self._cover_image_url = self._extract_cover_image_url(entity_response)
 
+    async def set_cover_image_from_file(self, file_path: Path, filename: str | None = None) -> None:
+        upload_response = await self._file_upload_service.upload_file(file_path, filename)
+        await self._set_cover_image_from_file_upload(upload_response.id)
+
+    async def set_cover_image_from_bytes(
+        self, file_content: bytes, filename: str, content_type: str | None = None
+    ) -> None:
+        upload_response = await self._file_upload_service.upload_from_bytes(file_content, filename, content_type)
+        await self._set_cover_image_from_file_upload(upload_response.id)
+
+    async def _set_cover_image_from_file_upload(self, file_upload_id: str) -> None:
+        entity_response = await self._entity_metadata_update_client.patch_cover_from_file_upload(file_upload_id)
+        self._cover_image_url = self._extract_cover_image_url(entity_response)
+
     async def set_random_gradient_cover(self) -> None:
         random_cover_url = self._get_random_gradient_cover()
         await self.set_cover_image_by_url(random_cover_url)
@@ -191,10 +218,6 @@ class Entity(LoggingMixin, ABC):
         await self._entity_metadata_update_client.remove_cover()
         self._cover_image_url = None
 
-    # =========================================================================
-    # Trash Methods
-    # =========================================================================
-
     async def move_to_trash(self) -> None:
         if self._in_trash:
             self.logger.warning("Entity is already in trash.")