add docstrings

Author: aninhasalesp

tests/commands/test_channel_info.py

@@ -1,11 +1,14 @@
-import pytest
+from unittest.mock import Mock, call
 
-from unittest.mock import patch, Mock, call
-
-from youtool.commands.channel_info import ChannelInfo, YouTube
+from youtool.commands.channel_info import ChannelInfo
 
 
 def test_filter_fields():
+    """Test to verify the filtering of channel information fields.
+
+    This test checks if the `filter_fields` method of the `ChannelInfo` class correctly
+    filters out unwanted fields from the channel information dictionary based on the provided columns.
+    """
     channel_info = {
         'channel_id': '123456',
         'channel_name': 'Test Channel',
@@ -27,6 +30,11 @@ def test_filter_fields():
 
 
 def test_channel_ids_from_urls_and_usernames(mocker):
+    """Test to verify fetching channel IDs from both URLs and usernames.
+
+    This test checks if the `execute` method of the `ChannelInfo` class correctly fetches channel IDs
+    from a list of URLs and usernames, and then calls the `channels_infos` method with these IDs.
+    """
     urls = ["https://www.youtube.com/@Turicas/featured", "https://www.youtube.com/c/PythonicCaf%C3%A9"]
     usernames = ["Turicas", "PythonicCafe"]
 

youtool/commands/channel_info.py

@@ -8,8 +8,7 @@
 
 
 class ChannelInfo(Command):
-    """
-    Get channel info from a list of IDs (or CSV filename with IDs inside), generate CSV output 
+    """Get channel info from a list of IDs (or CSV filename with IDs inside), generate CSV output 
     (same schema for `channel` dicts)
     """
     name = "channel-info"
@@ -35,8 +34,7 @@ class ChannelInfo(Command):
 
     @staticmethod
     def filter_fields(channel_info: Dict, info_columns: Optional[List] = None):
-        """
-        Filters the fields of a dictionary containing channel information based on 
+        """Filters the fields of a dictionary containing channel information based on 
         specified columns.
 
         Args:
@@ -55,8 +53,8 @@ def filter_fields(channel_info: Dict, info_columns: Optional[List] = None):
 
     @classmethod
     def execute(cls: Self, **kwargs) -> str:
-        """
-        Execute the channel-info command to fetch YouTube channel information from URLs or usernames and save them to a CSV file.
+        """Execute the channel-info command to fetch YouTube channel information from URLs or
+        usernames and save them to a CSV file.
 
         Args:
             urls (list[str], optional): A list of YouTube channel URLs. If not provided, `urls_file_path` must be specified.
@@ -69,7 +67,8 @@ def execute(cls: Self, **kwargs) -> str:
                                             Default is "channel_url".
             username_column_name (str, optional): The name of the column in the `usernames_file_path` CSV file that contains the usernames.
                                             Default is "channel_username".
-            info_columns (str, optional): Comma-separated list of columns to include in the output CSV. Default is the class attribute `INFO_COLUMNS`.
+            info_columns (str, optional): Comma-separated list of columns to include in the output CSV.
+                                            Default is the class attribute `INFO_COLUMNS`.
 
         Returns:
             str: A message indicating the result of the command. If `output_file_path` is specified, the message will
@@ -78,6 +77,7 @@ def execute(cls: Self, **kwargs) -> str:
         Raises:
             Exception: If neither `urls`, `usernames`, `urls_file_path` nor `usernames_file_path` is provided.
         """
+
         urls = kwargs.get("urls")
         usernames = kwargs.get("usernames")
         urls_file_path = kwargs.get("urls_file_path")