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

notionary/data_source/properties/schemas.py

@@ -1,7 +1,7 @@
 from enum import StrEnum
-from typing import Annotated, Literal, TypeVar
+from typing import Literal, TypeVar
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 from notionary.shared.properties.type import PropertyType
 from notionary.shared.typings import JsonDict
@@ -126,109 +126,11 @@ class DataSourceStatusGroup(BaseModel):
     option_ids: list[str]
 
 
-# ============================================================================
-# Config Models
-# ============================================================================
-
-
 class DataSourceStatusConfig(BaseModel):
     options: list[DataSourcePropertyOption] = Field(default_factory=list)
     groups: list[DataSourceStatusGroup] = Field(default_factory=list)
 
 
-class DataSourceSelectConfig(BaseModel):
-    options: list[DataSourcePropertyOption] = Field(default_factory=list)
-
-
-class DataSourceMultiSelectConfig(BaseModel):
-    options: list[DataSourcePropertyOption] = Field(default_factory=list)
-
-
-class DataSourceRelationConfig(BaseModel):
-    data_source_id: str
-    type: RelationType = RelationType.SINGLE_PROPERTY
-    single_property: JsonDict = Field(default_factory=dict)
-
-
-class DataSourceNumberConfig(BaseModel):
-    format: NumberFormat
-
-
-class DataSourceFormulaConfig(BaseModel):
-    expression: str
-
-
-class DataSourceUniqueIdConfig(BaseModel):
-    prefix: str | None = None
-
-
-class DataSourceRollupConfig(BaseModel):
-    function: RollupFunction
-    relation_property_id: str
-    relation_property_name: str
-    rollup_property_id: str
-    rollup_property_name: str
-
-
-class DataSourceDateConfig(BaseModel): ...
-
-
-class DataSourceCreatedTimeConfig(BaseModel): ...
-
-
-class DataSourceCreatedByConfig(BaseModel): ...
-
-
-class DataSourceLastEditedTimeConfig(BaseModel): ...
-
-
-class DataSourceLastEditedByConfig(BaseModel): ...
-
-
-class DataSourceLastVisitedTimeConfig(BaseModel): ...
-
-
-class DataSourceTitleConfig(BaseModel): ...
-
-
-class DataSourceRichTextConfig(BaseModel): ...
-
-
-class DataSourceURLConfig(BaseModel): ...
-
-
-class DataSourcePeopleConfig(BaseModel): ...
-
-
-class DataSourceCheckboxConfig(BaseModel): ...
-
-
-class DataSourceEmailConfig(BaseModel): ...
-
-
-class DataSourcePhoneNumberConfig(BaseModel): ...
-
-
-class DataSourceFilesConfig(BaseModel): ...
-
-
-class DataSourceButtonConfig(BaseModel): ...
-
-
-class DataSourceLocationConfig(BaseModel): ...
-
-
-class DataSourceVerificationConfig(BaseModel): ...
-
-
-class DataSourcePlaceConfig(BaseModel): ...
-
-
-# ============================================================================
-# Property Models
-# ============================================================================
-
-
 class DataSourceStatusProperty(DataSourceProperty):
     type: Literal[PropertyType.STATUS] = PropertyType.STATUS
     status: DataSourceStatusConfig = Field(default_factory=DataSourceStatusConfig)
@@ -242,6 +144,10 @@ class DataSourceStatusProperty(DataSourceProperty):
         return [group.name for group in self.status.groups]
 
 
+class DataSourceSelectConfig(BaseModel):
+    options: list[DataSourcePropertyOption] = Field(default_factory=list)
+
+
 class DataSourceSelectProperty(DataSourceProperty):
     type: Literal[PropertyType.SELECT] = PropertyType.SELECT
     select: DataSourceSelectConfig = Field(default_factory=DataSourceSelectConfig)
@@ -251,6 +157,10 @@ class DataSourceSelectProperty(DataSourceProperty):
         return [option.name for option in self.select.options]
 
 
+class DataSourceMultiSelectConfig(BaseModel):
+    options: list[DataSourcePropertyOption] = Field(default_factory=list)
+
+
 class DataSourceMultiSelectProperty(DataSourceProperty):
     type: Literal[PropertyType.MULTI_SELECT] = PropertyType.MULTI_SELECT
     multi_select: DataSourceMultiSelectConfig = Field(default_factory=DataSourceMultiSelectConfig)
@@ -260,6 +170,13 @@ class DataSourceMultiSelectProperty(DataSourceProperty):
         return [option.name for option in self.multi_select.options]
 
 
+# https://developers.notion.com/reference/property-object
+class DataSourceRelationConfig(BaseModel):
+    data_source_id: str | None = None
+    type: RelationType = RelationType.SINGLE_PROPERTY
+    single_property: JsonDict = Field(default_factory=dict)
+
+
 class DataSourceRelationProperty(DataSourceProperty):
     type: Literal[PropertyType.RELATION] = PropertyType.RELATION
     relation: DataSourceRelationConfig = Field(default_factory=DataSourceRelationConfig)
@@ -269,51 +186,90 @@ class DataSourceRelationProperty(DataSourceProperty):
         return self.relation.data_source_id
 
 
+class DataSourceDateConfig(BaseModel): ...
+
+
 class DataSourceDateProperty(DataSourceProperty):
     type: Literal[PropertyType.DATE] = PropertyType.DATE
     date: DataSourceDateConfig = Field(default_factory=DataSourceDateConfig)
 
 
+class DataSourceCreatedTimeConfig(BaseModel): ...
+
+
 class DataSourceCreatedTimeProperty(DataSourceProperty):
     type: Literal[PropertyType.CREATED_TIME] = PropertyType.CREATED_TIME
     created_time: DataSourceCreatedTimeConfig = Field(default_factory=DataSourceCreatedTimeConfig)
 
 
+class DataSourceCreatedByConfig(BaseModel): ...
+
+
 class DataSourceCreatedByProperty(DataSourceProperty):
     type: Literal[PropertyType.CREATED_BY] = PropertyType.CREATED_BY
     created_by: DataSourceCreatedByConfig = Field(default_factory=DataSourceCreatedByConfig)
 
 
+class DataSourceLastEditedTimeConfig(BaseModel): ...
+
+
 class DataSourceLastEditedTimeProperty(DataSourceProperty):
     type: Literal[PropertyType.LAST_EDITED_TIME] = PropertyType.LAST_EDITED_TIME
     last_edited_time: DataSourceLastEditedTimeConfig = Field(default_factory=DataSourceLastEditedTimeConfig)
 
 
+class DataSourceLastEditedByConfig(BaseModel): ...
+
+
 class DataSourceLastEditedByProperty(DataSourceProperty):
     type: Literal[PropertyType.LAST_EDITED_BY] = PropertyType.LAST_EDITED_BY
     last_edited_by: DataSourceLastEditedByConfig = Field(default_factory=DataSourceLastEditedByConfig)
 
 
+class DataSourceLastVisitedTimeConfig(BaseModel): ...
+
+
+class DataSourceLastVisitedTimeProperty(DataSourceProperty):
+    type: Literal[PropertyType.LAST_VISITED_TIME] = PropertyType.LAST_VISITED_TIME
+    last_visited_time: DataSourceLastVisitedTimeConfig = Field(default_factory=DataSourceLastVisitedTimeConfig)
+
+
+class DataSourceTitleConfig(BaseModel): ...
+
+
 class DataSourceTitleProperty(DataSourceProperty):
     type: Literal[PropertyType.TITLE] = PropertyType.TITLE
     title: DataSourceTitleConfig = Field(default_factory=DataSourceTitleConfig)
 
 
+class DataSourceRichTextConfig(BaseModel): ...
+
+
 class DataSourceRichTextProperty(DataSourceProperty):
     type: Literal[PropertyType.RICH_TEXT] = PropertyType.RICH_TEXT
     rich_text: DataSourceRichTextConfig = Field(default_factory=DataSourceRichTextConfig)
 
 
+class DataSourceURLConfig(BaseModel): ...
+
+
 class DataSourceURLProperty(DataSourceProperty):
     type: Literal[PropertyType.URL] = PropertyType.URL
     url: DataSourceURLConfig = Field(default_factory=DataSourceURLConfig)
 
 
+class DataSourcePeopleConfig(BaseModel): ...
+
+
 class DataSourcePeopleProperty(DataSourceProperty):
     type: Literal[PropertyType.PEOPLE] = PropertyType.PEOPLE
     people: DataSourcePeopleConfig = Field(default_factory=DataSourcePeopleConfig)
 
 
+class DataSourceNumberConfig(BaseModel):
+    format: NumberFormat
+
+
 class DataSourceNumberProperty(DataSourceProperty):
     type: Literal[PropertyType.NUMBER] = PropertyType.NUMBER
     number: DataSourceNumberConfig
@@ -323,26 +279,42 @@ class DataSourceNumberProperty(DataSourceProperty):
         return self.number.format
 
 
+class DataSourceCheckboxConfig(BaseModel): ...
+
+
 class DataSourceCheckboxProperty(DataSourceProperty):
     type: Literal[PropertyType.CHECKBOX] = PropertyType.CHECKBOX
     checkbox: DataSourceCheckboxConfig = Field(default_factory=DataSourceCheckboxConfig)
 
 
+class DataSourceEmailConfig(BaseModel): ...
+
+
 class DataSourceEmailProperty(DataSourceProperty):
     type: Literal[PropertyType.EMAIL] = PropertyType.EMAIL
     email: DataSourceEmailConfig = Field(default_factory=DataSourceEmailConfig)
 
 
+class DataSourcePhoneNumberConfig(BaseModel): ...
+
+
 class DataSourcePhoneNumberProperty(DataSourceProperty):
     type: Literal[PropertyType.PHONE_NUMBER] = PropertyType.PHONE_NUMBER
     phone_number: DataSourcePhoneNumberConfig = Field(default_factory=DataSourcePhoneNumberConfig)
 
 
+class DataSourceFilesConfig(BaseModel): ...
+
+
 class DataSourceFilesProperty(DataSourceProperty):
     type: Literal[PropertyType.FILES] = PropertyType.FILES
     files: DataSourceFilesConfig = Field(default_factory=DataSourceFilesConfig)
 
 
+class DataSourceFormulaConfig(BaseModel):
+    expression: str
+
+
 class DataSourceFormulaProperty(DataSourceProperty):
     type: Literal[PropertyType.FORMULA] = PropertyType.FORMULA
     formula: DataSourceFormulaConfig
@@ -352,6 +324,14 @@ class DataSourceFormulaProperty(DataSourceProperty):
         return self.formula.expression
 
 
+class DataSourceRollupConfig(BaseModel):
+    function: RollupFunction
+    relation_property_id: str
+    relation_property_name: str
+    rollup_property_id: str
+    rollup_property_name: str
+
+
 class DataSourceRollupProperty(DataSourceProperty):
     type: Literal[PropertyType.ROLLUP] = PropertyType.ROLLUP
     rollup: DataSourceRollupConfig
@@ -361,6 +341,10 @@ class DataSourceRollupProperty(DataSourceProperty):
         return self.rollup.function
 
 
+class DataSourceUniqueIdConfig(BaseModel):
+    prefix: str | None = None
+
+
 class DataSourceUniqueIdProperty(DataSourceProperty):
     type: Literal[PropertyType.UNIQUE_ID] = PropertyType.UNIQUE_ID
     unique_id: DataSourceUniqueIdConfig = Field(default_factory=DataSourceUniqueIdConfig)
@@ -370,11 +354,43 @@ class DataSourceUniqueIdProperty(DataSourceProperty):
         return self.unique_id.prefix
 
 
-# ============================================================================
-# Discriminated Union
-# ============================================================================
+class DataSourceButtonConfig(BaseModel): ...
+
+
+class DataSourceButtonProperty(DataSourceProperty):
+    type: Literal[PropertyType.BUTTON] = PropertyType.BUTTON
+    button: DataSourceButtonConfig = Field(default_factory=DataSourceButtonConfig)
+
+
+class DataSourceLocationConfig(BaseModel): ...
+
+
+class DataSourceLocationProperty(DataSourceProperty):
+    type: Literal[PropertyType.LOCATION] = PropertyType.LOCATION
+    location: DataSourceLocationConfig = Field(default_factory=DataSourceLocationConfig)
+
+
+class DataSourcePlaceConfig(BaseModel): ...
+
+
+class DataSourcePlaceProperty(DataSourceProperty):
+    type: Literal[PropertyType.PLACE] = PropertyType.PLACE
+    place: DataSourcePlaceConfig = Field(default_factory=DataSourcePlaceConfig)
+
+
+class DataSourceVerificationConfig(BaseModel): ...
+
+
+class DataSourceVerificationProperty(DataSourceProperty):
+    type: Literal[PropertyType.VERIFICATION] = PropertyType.VERIFICATION
+    verification: DataSourceVerificationConfig = Field(default_factory=DataSourceVerificationConfig)
+
+
+class DataSourceUnknownProperty(BaseModel):
+    model_config = ConfigDict(extra="allow")
+
 
-DiscriminatedDataSourceProperty = Annotated[
+type AnyDataSourceProperty = (
     DataSourceStatusProperty
     | DataSourceSelectProperty
     | DataSourceMultiSelectProperty
@@ -384,6 +400,7 @@ DiscriminatedDataSourceProperty = Annotated[
     | DataSourceCreatedByProperty
     | DataSourceLastEditedTimeProperty
     | DataSourceLastEditedByProperty
+    | DataSourceLastVisitedTimeProperty
     | DataSourceTitleProperty
     | DataSourceRichTextProperty
     | DataSourceURLProperty
@@ -395,8 +412,12 @@ DiscriminatedDataSourceProperty = Annotated[
     | DataSourceFilesProperty
     | DataSourceFormulaProperty
     | DataSourceRollupProperty
-    | DataSourceUniqueIdProperty,
-    Field(discriminator="type"),
-]
+    | DataSourceUniqueIdProperty
+    | DataSourceButtonProperty
+    | DataSourceLocationProperty
+    | DataSourcePlaceProperty
+    | DataSourceVerificationProperty
+    | DataSourceUnknownProperty
+)
 
 DataSourcePropertyT = TypeVar("DataSourcePropertyT", bound=DataSourceProperty)

notionary/data_source/query/__init__.py

@@ -0,0 +1,9 @@
+from .builder import DataSourceQueryBuilder
+from .resolver import QueryResolver
+from .schema import DataSourceQueryParams
+
+__all__ = [
+    "DataSourceQueryBuilder",
+    "DataSourceQueryParams",
+    "QueryResolver",
+]

notionary/data_source/query/builder.py

@@ -46,6 +46,7 @@ class DataSourceQueryBuilder:
         self._negate_next = False
         self._or_group: list[FilterCondition] | None = None
         self._page_size: int | None = None
+        self._total_results_limit: int | None = None
 
     def where(self, property_name: str) -> Self:
         self._finalize_current_or_group()
@@ -193,9 +194,15 @@ class DataSourceQueryBuilder:
         self._sorts.append(sort)
         return self
 
-    def limit(self, page_size: int) -> Self:
-        if page_size < 1:
+    def total_results_limit(self, total_result_limit: int) -> Self:
+        if total_result_limit < 1:
             raise ValueError("Limit must be at least 1")
+        self._total_results_limit = total_result_limit
+        return self
+
+    def page_size(self, page_size: int) -> Self:
+        if page_size < 1:
+            raise ValueError("Page size must be at least 1")
         self._page_size = page_size
         return self
 
@@ -203,7 +210,9 @@ class DataSourceQueryBuilder:
         self._finalize_current_or_group()
         notion_filter = self._create_notion_filter_if_needed()
         sorts = self._create_sorts_if_needed()
-        return DataSourceQueryParams(filter=notion_filter, sorts=sorts, page_size=self._page_size)
+        return DataSourceQueryParams(
+            filter=notion_filter, sorts=sorts, page_size=self._page_size, total_results_limit=self._total_results_limit
+        )
 
     def _select_property_without_negation(self, property_name: str) -> None:
         self._current_property = property_name

notionary/data_source/query/schema.py

@@ -289,6 +289,8 @@ class DataSourceQueryParams(BaseModel):
     sorts: list[NotionSort] | None = None
     page_size: int | None = None
 
+    total_results_limit: int | None = None
+
     @model_serializer
     def to_api_params(self) -> JsonDict:
         result: JsonDict = {}
@@ -299,4 +301,7 @@ class DataSourceQueryParams(BaseModel):
         if self.sorts is not None and len(self.sorts) > 0:
             result["sorts"] = [sort.model_dump() for sort in self.sorts]
 
+        if self.page_size is not None:
+            result["page_size"] = self.page_size
+
         return result

notionary/data_source/schemas.py

@@ -1,7 +1,7 @@
 from pydantic import BaseModel
 
 from notionary.blocks.rich_text.models import RichText
-from notionary.data_source.properties.schemas import DiscriminatedDataSourceProperty
+from notionary.data_source.properties.schemas import AnyDataSourceProperty
 from notionary.page.schemas import NotionPageDto
 from notionary.shared.entity.schemas import EntityResponseDto, NotionEntityUpdateDto
 from notionary.shared.models.parent import Parent
@@ -24,4 +24,4 @@ class DataSourceDto(EntityResponseDto):
     title: list[RichText]
     description: list[RichText]
     archived: bool
-    properties: dict[str, DiscriminatedDataSourceProperty]
+    properties: dict[str, AnyDataSourceProperty]