add docstrings

Author: aninhasalesp

tests/commands/test_video_search.py

@@ -2,13 +2,18 @@
 import pytest
 
 from io import StringIO
-from unittest.mock import Mock, call
+from unittest.mock import Mock
 from datetime import datetime
 
 from youtool.commands.video_search import VideoSearch
 
 
 def test_video_search_string_output(mocker, videos_ids, videos_urls):
+    """Test the execution of the video-search command and verify the output as string.
+
+    This test simulates the execution of the `VideoSearch.execute` command with a list of video IDs and URLs,
+    and checks if the output is correctly formatted as a CSV string.
+    """
     youtube_mock = mocker.patch("youtool.commands.video_search.YouTube")
     expected_videos_infos = [
         {
@@ -31,6 +36,11 @@ def test_video_search_string_output(mocker, videos_ids, videos_urls):
 
 
 def test_video_search_file_output(mocker, videos_ids, videos_urls, tmp_path):
+    """Test the execution of the video-search command and verify the output to a file.
+
+    This test simulates the execution of the `VideoSearch.execute` command with a list of video IDs and URLs,
+    and checks if the output is correctly written to a CSV file.
+    """
     youtube_mock = mocker.patch("youtool.commands.video_search.YouTube")
     expected_videos_infos = [
         {
@@ -62,5 +72,13 @@ def test_video_search_file_output(mocker, videos_ids, videos_urls, tmp_path):
 
 
 def test_video_search_no_id_and_url_error():
+    """Test if the video-search command raises an exception when neither IDs nor URLs are provided.
+
+    This test checks if executing the `VideoSearch.execute` command without providing IDs or URLs
+    raises the expected exception.
+
+    Assertions:
+        - Assert that the raised exception matches the expected error message.
+    """
     with pytest.raises(Exception, match="Either 'ids' or 'urls' must be provided"):
         VideoSearch.execute(ids=None, urls=None)

youtool/commands/video_search.py

@@ -44,9 +44,11 @@ def execute(cls: Self, **kwargs) -> str:
             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.
             full_info (bool, optional): Flag to indicate whether to get full video info. Default is False.
+            url_column_name (str, optional): The name of the column in the input CSV file that contains the URLs. Default is "video_url".
+            id_column_name (str, optional): The name of the column in the input CSV file that contains the IDs. Default is "video_id".
 
         Returns:
-            A message indicating the result of the command. If output_file_path is specified, 
+            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.