Throw exception when part is accessed that is not requested (#59)

Author: joostlek

.pre-commit-config.yaml

@@ -76,7 +76,7 @@ repos:
         language: system
         types: [text]
         exclude: ^poetry\.lock$
-        entry: poetry run codespell
+        entry: poetry run codespell --skip="./.*,*.csv,*.json"
       - id: detect-private-key
         name: 🕵️  Detect Private Keys
         language: system

src/youtubeaio/models.py

@@ -18,6 +18,8 @@
     "YouTubeChannel",
 ]
 
+from youtubeaio.types import PartMissingError
+
 T = TypeVar("T")
 
 
@@ -68,7 +70,14 @@ class YouTubeVideo(BaseModel):
     """Model representing a video."""
 
     video_id: str = Field(..., alias="id")
-    snippet: YouTubeVideoSnippet | None = None
+    nullable_snippet: YouTubeVideoSnippet | None = Field(None, alias="snippet")
+
+    @property
+    def snippet(self) -> YouTubeVideoSnippet:
+        """Return snippet."""
+        if self.nullable_snippet is None:
+            raise PartMissingError
+        return self.nullable_snippet
 
 
 class YouTubeChannelThumbnails(BaseModel):
@@ -125,18 +134,42 @@ class YouTubeChannel(BaseModel):
     """Model representing a YouTube channel."""
 
     channel_id: str = Field(..., alias="id")
-    snippet: YouTubeChannelSnippet | None = None
-    content_details: YouTubeChannelContentDetails | None = Field(
+    nullable_snippet: YouTubeChannelSnippet | None = Field(None, alias="snippet")
+    nullable_content_details: YouTubeChannelContentDetails | None = Field(
         None,
         alias="contentDetails",
     )
-    statistics: YouTubeChannelStatistics | None = None
+    nullable_statistics: YouTubeChannelStatistics | None = Field(
+        None,
+        alias="statistics",
+    )
 
     @property
     def upload_playlist_id(self) -> str:
         """Return playlist id with uploads from channel."""
         return str(self.channel_id).replace("UC", "UU", 1)
 
+    @property
+    def snippet(self) -> YouTubeChannelSnippet:
+        """Return snippet."""
+        if self.nullable_snippet is None:
+            raise PartMissingError
+        return self.nullable_snippet
+
+    @property
+    def content_details(self) -> YouTubeChannelContentDetails:
+        """Return content details."""
+        if self.nullable_content_details is None:
+            raise PartMissingError
+        return self.nullable_content_details
+
+    @property
+    def statistics(self) -> YouTubeChannelStatistics:
+        """Return statistics."""
+        if self.nullable_statistics is None:
+            raise PartMissingError
+        return self.nullable_statistics
+
 
 class YouTubeSubscriptionSnippet(BaseModel):
     """Model representing a YouTube subscription snippet."""
@@ -156,7 +189,14 @@ class YouTubeSubscription(BaseModel):
     """Model representing a YouTube subscription."""
 
     subscription_id: str = Field(..., alias="id")
-    snippet: YouTubeSubscriptionSnippet | None = None
+    nullable_snippet: YouTubeSubscriptionSnippet | None = Field(None, alias="snippet")
+
+    @property
+    def snippet(self) -> YouTubeSubscriptionSnippet:
+        """Return snippet."""
+        if self.nullable_snippet is None:
+            raise PartMissingError
+        return self.nullable_snippet
 
 
 class YouTubePlaylistItemSnippet(BaseModel):
@@ -179,8 +219,22 @@ class YouTubePlaylistItem(BaseModel):
     """Model representing a YouTube playlist item."""
 
     playlist_item_id: str = Field(..., alias="id")
-    snippet: YouTubePlaylistItemSnippet | None = Field(None)
-    content_details: YouTubePlaylistItemContentDetails | None = Field(
+    nullable_snippet: YouTubePlaylistItemSnippet | None = Field(None, alias="snippet")
+    nullable_content_details: YouTubePlaylistItemContentDetails | None = Field(
         None,
         alias="contentDetails",
     )
+
+    @property
+    def snippet(self) -> YouTubePlaylistItemSnippet:
+        """Return snippet."""
+        if self.nullable_snippet is None:
+            raise PartMissingError
+        return self.nullable_snippet
+
+    @property
+    def content_details(self) -> YouTubePlaylistItemContentDetails:
+        """Return content details."""
+        if self.nullable_content_details is None:
+            raise PartMissingError
+        return self.nullable_content_details

src/youtubeaio/types.py

@@ -59,6 +59,10 @@ class YouTubeBackendError(YouTubeAPIError):
     """When the YouTube API itself is down."""
 
 
+class PartMissingError(YouTubeAPIError):
+    """If you request a part which is not requested."""
+
+
 class MissingAppSecretError(YouTubeAPIError):
     """When the app secret is not set but app authorization is attempted."""
 

tests/__init__.py

@@ -1,8 +1,27 @@
 """Tests for the YouTube Library."""
+import json
 from pathlib import Path
+from typing import Any
 
 
 def load_fixture(filename: str) -> str:
     """Load a fixture."""
     path = Path(__package__) / "fixtures" / filename
     return path.read_text(encoding="utf-8")
+
+
+def construct_fixture(object_type: str, parts: list[str], object_number: int) -> Any:
+    """Construct a fixture from different files."""
+    base_path = Path(__package__) / "fixtures" / object_type
+    base_json = json.loads((base_path / "base.json").read_text(encoding="utf-8"))
+
+    object_json = base_path / str(object_number)
+    base_object_json = json.loads(
+        (object_json / "base.json").read_text(encoding="utf-8"),
+    )
+    for part in parts:
+        part_json_path = object_json / f"{part}.json"
+        part_json = json.loads(part_json_path.read_text(encoding="utf-8"))
+        base_object_json[part] = part_json
+    base_json["items"].append(base_object_json)
+    return base_json

tests/fixtures/channel/1/base.json

@@ -0,0 +1,5 @@
+{
+    "kind": "youtube#channel",
+    "etag": "PT8fdvojgSn53JoWCx_QVmL-M1E",
+    "id": "UC_x5XG1OV2P6uZZ5FSM9Ttw"
+}

tests/fixtures/channel/1/brandingSettings.json

@@ -0,0 +1,13 @@
+{
+    "channel": {
+        "title": "Google for Developers",
+        "description": "Subscribe to join a community of creative developers and learn the latest in Google technology — from AI and cloud, to mobile and web.\n\nExplore more at developers.google.com\n\n",
+        "keywords": "\"google developers\" developers \"Google developers videos\" \"google developer tutorials\" \"developer tutorials\" \"developer news\" android firebase tensorflow chrome web flutter \"google developer experts\" \"google launchpad\" \"developer updates\" google \"google design\"",
+        "trackingAnalyticsAccountId": "YT-9170156-1",
+        "unsubscribedTrailer": "bC8fvcpocBU",
+        "country": "US"
+    },
+    "image": {
+        "bannerExternalUrl": "https://yt3.googleusercontent.com/Oxa3gK3h8fgC8wNLkMJVcj2VJ_rRzZL02eAEEVOiKpts-ed5LApGEKZTJ2YrmrsRq6lrJRmZ9g"
+    }
+}

tests/fixtures/channel/1/contentDetails.json

@@ -0,0 +1,6 @@
+{
+    "relatedPlaylists": {
+        "likes": "",
+        "uploads": "UU_x5XG1OV2P6uZZ5FSM9Ttw"
+    }
+}

tests/fixtures/channel/1/snippet.json

@@ -0,0 +1,28 @@
+{
+    "title": "Google for Developers",
+    "description": "Subscribe to join a community of creative developers and learn the latest in Google technology — from AI and cloud, to mobile and web.\n\nExplore more at developers.google.com\n\n",
+    "customUrl": "@googledevelopers",
+    "publishedAt": "2007-08-23T00:34:43Z",
+    "thumbnails": {
+        "default": {
+            "url": "https://yt3.ggpht.com/fca_HuJ99xUxflWdex0XViC3NfctBFreIl8y4i9z411asnGTWY-Ql3MeH_ybA4kNaOjY7kyA=s88-c-k-c0x00ffffff-no-rj",
+            "width": 88,
+            "height": 88
+        },
+        "medium": {
+            "url": "https://yt3.ggpht.com/fca_HuJ99xUxflWdex0XViC3NfctBFreIl8y4i9z411asnGTWY-Ql3MeH_ybA4kNaOjY7kyA=s240-c-k-c0x00ffffff-no-rj",
+            "width": 240,
+            "height": 240
+        },
+        "high": {
+            "url": "https://yt3.ggpht.com/fca_HuJ99xUxflWdex0XViC3NfctBFreIl8y4i9z411asnGTWY-Ql3MeH_ybA4kNaOjY7kyA=s800-c-k-c0x00ffffff-no-rj",
+            "width": 800,
+            "height": 800
+        }
+    },
+    "localized": {
+        "title": "Google for Developers",
+        "description": "Subscribe to join a community of creative developers and learn the latest in Google technology — from AI and cloud, to mobile and web.\n\nExplore more at developers.google.com\n\n"
+    },
+    "country": "US"
+}

tests/fixtures/channel/1/statistics.json

@@ -0,0 +1,6 @@
+{
+    "viewCount": "234084903",
+    "subscriberCount": "2300000",
+    "hiddenSubscriberCount": false,
+    "videoCount": "5783"
+}

tests/fixtures/channel/1/status.json

@@ -0,0 +1,6 @@
+{
+    "privacyStatus": "public",
+    "isLinked": true,
+    "longUploadsStatus": "longUploadsUnspecified",
+    "madeForKids": false
+}