add docstrings

Author: aninhasalesp

tests/commands/test_video_info.py

@@ -8,19 +8,26 @@
 
 @pytest.fixture
 def youtube_mock(mocker, mock_video_info):
+    """Fixture to mock the YouTube instance and its videos_infos method."""
     mock = mocker.patch("youtool.commands.video_info.YouTube")
     mock_instance = mock.return_value
     mock_instance.videos_infos = Mock(return_value=mock_video_info)
     return mock_instance
 
 @pytest.fixture
 def mock_video_info():
+    """Fixture to return mock video information."""
     return [
         {"id": "tmrhPou85HQ", "title": "Title 1", "description": "Description 1", "published_at": "2021-01-01", "view_count": 100, "like_count": 10, "comment_count": 5},
         {"id": "qoI_x9fylaw", "title": "Title 2", "description": "Description 2", "published_at": "2021-02-01", "view_count": 200, "like_count": 20, "comment_count": 10} 
     ]
 
 def test_execute_with_ids_and_urls(youtube_mock, mocker, tmp_path, mock_video_info):
+    """Test the execute method with provided video IDs and URLs.
+
+    This test verifies that the execute method can handle both video IDs and URLs, 
+    and correctly writes the video information to the output CSV file.
+    """
     ids = ["tmrhPou85HQ", "qoI_x9fylaw"]
     urls = ["https://www.youtube.com/watch?v=tmrhPou85HQ&ab_channel=Turicas", "https://www.youtube.com/watch?v=qoI_x9fylaw&ab_channel=PythonicCaf%C3%A9"]
     output_file_path = tmp_path / "output.csv"
@@ -36,12 +43,25 @@ def test_execute_with_ids_and_urls(youtube_mock, mocker, tmp_path, mock_video_in
     assert csv_data[1]["id"] == "qoI_x9fylaw"
 
 def test_execute_missing_arguments():
+    """Test the execute method raises an exception when missing required arguments.
+
+    This test verifies that the execute method raises an exception if neither 
+    video IDs nor URLs are provided.
+
+    Raises:
+        Exception: If neither 'ids' nor 'urls' is provided.
+    """
     with pytest.raises(Exception) as exc_info:
         VideoInfo.execute(api_key="test_api_key")
 
     assert str(exc_info.value) == "Either 'ids' or 'urls' must be provided for the video-info command"
 
 def test_execute_with_input_file_path(youtube_mock, mocker, tmp_path, mock_video_info):
+    """Test the execute method with an input CSV file containing video URLs and IDs.
+
+    This test verifies that the execute method can read video URLs and IDs from 
+    an input CSV file and correctly writes the video information to the output CSV file.
+    """
     input_csv_content = """video_id,video_url
     tmrhPou85HQ,https://www.youtube.com/watch?v=tmrhPou85HQ&ab_channel=Turicas
     qoI_x9fylaw,https://www.youtube.com/watch?v=qoI_x9fylaw&ab_channel=PythonicCaf%C3%A9
@@ -64,6 +84,12 @@ def test_execute_with_input_file_path(youtube_mock, mocker, tmp_path, mock_video
 
 
 def test_execute_with_info_columns(youtube_mock, mocker, tmp_path, mock_video_info):
+    """Test the execute method with specified info columns.
+
+    This test verifies that the execute method can filter the video information 
+    based on specified columns and correctly writes the filtered information 
+    to the output CSV file.
+    """
     ids = ["tmrhPou85HQ", "qoI_x9fylaw"]
     output_file_path = tmp_path / "output.csv"
 

youtool/commands/video_info.py

@@ -32,25 +32,24 @@ def execute(cls: Self, **kwargs) -> str:
         Args:
             ids (list[str], optional): A list of YouTube video IDs. If not provided, input_file_path must be specified.
             urls (list[str], optional): A list of YouTube video URLs. If not provided, input_file_path must be specified.
-            urls_file_path (str, optional): Path to a CSV file containing YouTube channel URLs.
-            ids_file_path (str, optional): Path to a CSV file containing YouTube channel IDs.
             input_file_path (str, optional): Path to a CSV file containing YouTube video URLs or IDs.
             output_file_path (str, optional): Path to the output CSV file where video information will be saved.
             api_key (str): The API key to authenticate with the YouTube Data API.
             url_column_name (str, optional): The name of the column in the input_file_path CSV file that contains the URLs.
-                                             Default is "video_url".
+                                            Default is "video_url".
             id_column_name (str, optional): The name of the column in the input_file_path CSV file that contains the IDs.
                                             Default is "video_id".
-            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:
-            A message indicating the result of the command. If output_file_path is specified, 
-            the message will include the path to the generated CSV file. 
-            Otherwise, it will return the result as a string.
+            str: A message indicating the result of the command. If output_file_path is specified, the message will
+                include the path to the generated CSV file. Otherwise, it will return the result as a string.
 
         Raises:
             Exception: If neither ids, urls, nor input_file_path is provided.
         """
+
         ids = kwargs.get("ids", [])
         urls = kwargs.get("urls", [])
         input_file_path = kwargs.get("input_file_path")