fix(channel): 🐛 fix the parameter channel name for get channel and examples

MerleLiuKun · MerleLiuKun · commit 2f9b58037968 · 2021-09-22T15:47:43.000+08:00
ISSUES CLOSED: sns-sdks#107 sns-sdks#86
diff --git a/examples/channel_videos.py b/examples/channel_videos.py
@@ -11,9 +11,9 @@
 API_KEY = "xxx"  # replace this with your api key.
 
 
-def get_videos(channel_name):
+def get_videos(channel_id):
     api = pyyoutube.Api(api_key=API_KEY)
-    channel_res = api.get_channel_info(channel_name=channel_name)
+    channel_res = api.get_channel_info(channel_id=channel_id)
 
     playlist_id = channel_res.items[0].contentDetails.relatedPlaylists.uploads
 
@@ -30,8 +30,8 @@ def get_videos(channel_name):
 
 
 def processor():
-    channel_name = "googledevelopers"
-    videos = get_videos(channel_name)
+    channel_id = "UC_x5XG1OV2P6uZZ5FSM9Ttw"
+    videos = get_videos(channel_id)
 
     with open("videos.json", "w+") as f:
         for video in videos:
diff --git a/examples/subscription.py b/examples/subscription.py
@@ -27,7 +27,7 @@ def get_subscriptions():
         "\nCopy the whole url if you finished the step to authorize:\n"
     )
 
-    api.exchange_code_to_access_token(authorization_response=auth_response)
+    api.generate_access_token(authorization_response=auth_response)
 
     sub_res = api.get_subscription_by_me(mine=True, parts="id,snippet", count=None)
 
diff --git a/pyyoutube/api.py b/pyyoutube/api.py
@@ -479,7 +479,7 @@ def get_channel_info(
         self,
         *,
         channel_id: Optional[Union[str, list, tuple, set]] = None,
-        channel_name: Optional[str] = None,
+        for_username: Optional[str] = None,
         mine: Optional[bool] = None,
         parts: Optional[Union[str, list, tuple, set]] = None,
         hl: str = "en_US",
@@ -498,8 +498,10 @@ def get_channel_info(
             channel_id ((str,list,tuple,set), optional):
                 The id or comma-separated id string for youtube channel which you want to get.
                 You can also pass this with an id list, tuple, set.
-            channel_name (str, optional):
-                The name for youtube channel which you want to get.
+            for_username (str, optional):
+                The name for YouTube username which you want to get.
+                Note: This name may the old youtube version's channel's user's username, Not the the channle name.
+                Refer: https://developers.google.com/youtube/v3/guides/working_with_channel_ids
             mine (bool, optional):
                 If you have give the authorization. Will return your channels.
                 Must provide the access token.
@@ -520,8 +522,8 @@ def get_channel_info(
             "part": enf_parts(resource="channels", value=parts),
             "hl": hl,
         }
-        if channel_name is not None:
-            args["forUsername"] = channel_name
+        if for_username is not None:
+            args["forUsername"] = for_username
         elif channel_id is not None:
             args["id"] = enf_comma_separated("channel_id", channel_id)
         elif mine is not None:
diff --git a/tests/apis/test_channels.py b/tests/apis/test_channels.py
@@ -63,7 +63,7 @@ def testGetChannelInfo(self) -> None:
             self.assertEqual(res_by_channel_id.items[0].id, "UC_x5XG1OV2P6uZZ5FSM9Ttw")
 
             res_by_channel_name = self.api.get_channel_info(
-                channel_name="GoogleDevelopers", return_json=True
+                for_username="GoogleDevelopers", return_json=True
             )
             self.assertEqual(
                 res_by_channel_name["items"][0]["id"], "UC_x5XG1OV2P6uZZ5FSM9Ttw"

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ def get_subscriptions():`
`27`	`27`	`"\nCopy the whole url if you finished the step to authorize:\n"`
`28`	`28`	`)`
`29`	`29`
`30`		`- api.exchange_code_to_access_token(authorization_response=auth_response)`
	`30`	`+ api.generate_access_token(authorization_response=auth_response)`
`31`	`31`
`32`	`32`	`sub_res = api.get_subscription_by_me(mine=True, parts="id,snippet", count=None)`
`33`	`33`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ def testGetChannelInfo(self) -> None:`
`63`	`63`	`self.assertEqual(res_by_channel_id.items[0].id, "UC_x5XG1OV2P6uZZ5FSM9Ttw")`
`64`	`64`
`65`	`65`	`res_by_channel_name = self.api.get_channel_info(`
`66`		`- channel_name="GoogleDevelopers", return_json=True`
	`66`	`+ for_username="GoogleDevelopers", return_json=True`
`67`	`67`	`)`
`68`	`68`	`self.assertEqual(`
`69`	`69`	`res_by_channel_name["items"][0]["id"], "UC_x5XG1OV2P6uZZ5FSM9Ttw"`