add docstrings

Author: aninhasalesp

tests/commands/test_base.py

@@ -21,11 +21,17 @@ def execute(cls, **kwargs):
 
 @pytest.fixture
 def subparsers():
+    """Fixture to create subparsers for argument parsing."""
     parser = argparse.ArgumentParser()
     return parser.add_subparsers()
 
 
 def test_generate_parser(subparsers):
+    """Test to verify the parser generation.
+
+    This test checks if the `generate_parser` method correctly generates a parser
+    for the command and sets the appropriate properties
+    """
     parser = TestCommand.generate_parser(subparsers)
 
     assert parser is not None, "Parser should not be None"
@@ -34,6 +40,11 @@ def test_generate_parser(subparsers):
 
 
 def test_parse_arguments(subparsers):
+    """Test to verify argument parsing.
+
+    This test checks if the `parse_arguments` method correctly adds the command's
+    arguments to the parser and sets the default function to the command's execute method.
+    """
     subparsers_mock = MagicMock(spec=subparsers)
 
     TestCommand.parse_arguments(subparsers_mock)
@@ -45,6 +56,11 @@ def test_parse_arguments(subparsers):
 
 
 def test_command():
+    """Test to verify that the `execute` method is implemented.
+
+    This test ensures that if a command does not implement the `execute` method,
+    a `NotImplementedError` is raised.
+    """
     class MyCommand(Command):
         pass
 
@@ -54,6 +70,7 @@ class MyCommand(Command):
 
 @pytest.fixture
 def mock_csv_file():
+    """Fixture to provide mock CSV content for tests."""
 
     csv_content = """URL
     http://example.com
@@ -62,6 +79,14 @@ def mock_csv_file():
     return csv_content
 
 def test_data_from_csv_valid(mock_csv_file):
+    """Test to verify reading data from a valid CSV file.
+
+    This test checks if the `data_from_csv` method correctly reads data from a valid CSV file
+    and returns the expected list of URLs.
+
+    Args:
+        mock_csv_file (str): The mock CSV file content.
+    """
     with patch('pathlib.Path.is_file', return_value=True):
         with patch('builtins.open', mock_open(read_data=mock_csv_file)):
             data_column_name = "URL"
@@ -72,6 +97,11 @@ def test_data_from_csv_valid(mock_csv_file):
             assert result[1] == "http://example2.com"
 
 def test_data_from_csv_file_not_found():
+    """Test to verify behavior when the specified column is not found in the CSV file.
+
+    This test checks if the `data_from_csv` method raises an exception when the specified
+    column does not exist in the CSV file.
+    """
     with patch('pathlib.Path.is_file', return_value=False):
         file_path = Path("/fake/path/not_found.csv")
         with pytest.raises(FileNotFoundError):
@@ -88,12 +118,18 @@ def test_data_from_csv_column_not_found(mock_csv_file):
 
 @pytest.fixture
 def sample_data():
+    """Fixture to provide sample data for tests."""
     return [
         {"id": "123", "name": "Channel One"},
         {"id": "456", "name": "Channel Two"}
     ]
 
 def test_data_to_csv_with_output_file_path(tmp_path, sample_data):
+    """Test to verify writing data to a CSV file with an output file path specified.
+
+    This test checks if the `data_to_csv` method correctly writes the sample data to
+    a CSV file when an output file path is provided.
+    """
     output_file_path = tmp_path / "output.csv"
 
     result_path = Command.data_to_csv(sample_data, str(output_file_path))
@@ -107,13 +143,24 @@ def test_data_to_csv_with_output_file_path(tmp_path, sample_data):
         assert rows[0]["id"] == "123" and rows[1]["id"] == "456", "The IDs should match the sample data"
 
 def test_data_to_csv_without_output_file_path(sample_data):
+    """Test to verify writing data to a CSV format without an output file path specified.
+
+    This test checks if the `data_to_csv` method correctly returns the CSV content
+    as a string when no output file path is provided.
+    """
     csv_content = Command.data_to_csv(sample_data)
 
     assert "id,name" in csv_content
     assert "123,Channel One" in csv_content
     assert "456,Channel Two" in csv_content
 
 def test_data_to_csv_output(tmp_path):
+    """
+    Test to verify the content of the output CSV file.
+
+    This test checks if the `data_to_csv` method writes the expected content
+    to the output CSV file.
+    """
     output_file_path = tmp_path / "output.csv"
 
     data = [

tests/commands/test_channel_id.py

@@ -8,18 +8,30 @@
 
 @pytest.fixture
 def csv_file(tmp_path):
+    """Fixture to create a temporary CSV file with a single YouTube channel URL."""
+
     csv_content = "channel_url\nhttps://www.youtube.com/@Turicas/featured\n"
     csv_file = tmp_path / "urls.csv"
     csv_file.write_text(csv_content)
     return csv_file
 
 @pytest.fixture
 def youtube_api_mock():
+    """Fixture to mock the YouTube API.
+
+    This fixture mocks the `YouTube` class and its `channel_id_from_url` method
+    to return a channel ID based on the URL.
+    """
     with patch("youtool.commands.channel_id.YouTube") as mock:
         mock.return_value.channel_id_from_url.side_effect = lambda url: f"channel-{url}"
         yield mock
 
 def test_channels_ids_csv_preparation(youtube_api_mock):
+    """Fixture to mock the YouTube API.
+
+    This fixture mocks the `YouTube` class and its `channel_id_from_url` method
+    to return a channel ID based on the URL.
+    """
     urls = ["https://www.youtube.com/@Turicas/featured", "https://www.youtube.com/c/PythonicCaf%C3%A9"]
     api_key = "test_api_key"
     id_column_name = "custom_id_column"
@@ -40,16 +52,29 @@ def test_channels_ids_csv_preparation(youtube_api_mock):
 
 
 def test_resolve_urls_with_direct_urls():
-    # Tests whether the function returns the directly given list of URLs.
+    """Test to verify resolving URLs when provided directly.
+
+    This test checks if the `resolve_urls` method of the `ChannelId` class correctly
+    returns the given list of URLs when provided directly.
+    """
     urls = ["https://www.youtube.com/@Turicas/featured"]
     result = ChannelId.resolve_urls(urls, None, None)
     assert result == urls
 
 def test_resolve_urls_with_file_path(csv_file):
+    """Test to verify resolving URLs from a CSV file.
+
+    This test checks if the `resolve_urls` method of the `ChannelId` class correctly
+    reads URLs from a given CSV file.
+    """
     result = ChannelId.resolve_urls(None, csv_file, "channel_url")
     assert result == ["https://www.youtube.com/@Turicas/featured"]
 
 def test_resolve_urls_raises_exception():
-    # Tests whether the function throws an exception when neither urls nor urls_file_path are provided.
+    """Test to verify exception raising when no URLs are provided.
+
+    This test checks if the `resolve_urls` method of the `ChannelId` class raises an exception
+    when neither direct URLs nor a file path are provided.
+    """
     with pytest.raises(Exception, match="Either 'username' or 'url' must be provided for the channel-id command"):
         ChannelId.resolve_urls(None, None, None)

tests/test_cli.py

@@ -11,6 +11,11 @@
     "command", COMMANDS
 )
 def test_missing_api_key(monkeypatch: pytest.MonkeyPatch, command: Command):
+    """Test to verify behavior when the YouTube API key is missing.
+    
+    This test ensures that when the YouTube API key is not set, running any command
+    from the youtool CLI results in an appropriate error message and exit code.
+    """
     monkeypatch.delenv('YOUTUBE_API_KEY', raising=False)
     cli_path = "youtool/cli.py"
     command = ["python", cli_path, command.name]