From e884646c168e04845b80d2a3cf87abe9b4eb70f4 Mon Sep 17 00:00:00 2001 From: Maja Date: Tue, 26 Apr 2022 00:35:01 -0400 Subject: [PATCH 1/5] added error message to assert statement --- youtube_transcript_api/_api.py | 3 +++ youtube_transcript_api/test/test_api.py | 19 +++++++++++++++++++ 2 files changed, 22 insertions(+) diff --git a/youtube_transcript_api/_api.py b/youtube_transcript_api/_api.py index a618b0e..dfb790d 100644 --- a/youtube_transcript_api/_api.py +++ b/youtube_transcript_api/_api.py @@ -92,6 +92,8 @@ class YouTubeTranscriptApi(object): video ids, which could not be retrieved :rtype ({str: [{'text': str, 'start': float, 'end': float}]}, [str]}): """ + assert isinstance(video_ids, list), "`video_ids` must be a list of strings" + data = {} unretrievable_videos = [] @@ -126,6 +128,7 @@ class YouTubeTranscriptApi(object): :return: a list of dictionaries containing the 'text', 'start' and 'duration' keys :rtype [{'text': str, 'start': float, 'end': float}]: """ + assert isinstance(video_id, str), "`video_id` must be a string" return cls.list_transcripts(video_id, proxies, cookies).find_transcript(languages).fetch() @classmethod diff --git a/youtube_transcript_api/test/test_api.py b/youtube_transcript_api/test/test_api.py index ef23f9b..e356c72 100644 --- a/youtube_transcript_api/test/test_api.py +++ b/youtube_transcript_api/test/test_api.py @@ -1,3 +1,4 @@ +from ast import Assert from unittest import TestCase from mock import patch @@ -254,6 +255,24 @@ class TestYouTubeTranscriptApi(TestCase): {'text': 'just something shorter, I made up for testing', 'start': 5.7, 'duration': 3.239} ] ) + + def test_get_transcript__assertionerror_if_input_not_string(self): + """ + Raise Assertion error if not expected type + """ + with self.assertRaises(AssertionError): + YouTubeTranscriptApi.get_transcript(['video_id_1', 'video_id_2']) + # YouTubeTranscriptApi.get_transcripts(['video_id_1', 'video_id_2']) + + def test_get_transcripts__assertionerror_if_input_not_list(self): + """ + Raise Assertion error if not expected type + """ + with self.assertRaises(AssertionError): + YouTubeTranscriptApi.get_transcripts('video_id_1') + # YouTubeTranscriptApi.get_transcripts(['video_id_1', 'video_id_2']) + + @patch('youtube_transcript_api.YouTubeTranscriptApi.get_transcript') def test_get_transcripts(self, mock_get_transcript): From 74d645adcefefdf6b598af790c052ae9850a545f Mon Sep 17 00:00:00 2001 From: Maja Date: Wed, 1 Jun 2022 12:09:37 -0400 Subject: [PATCH 2/5] removed ast import --- youtube_transcript_api/test/test_api.py | 1 - 1 file changed, 1 deletion(-) diff --git a/youtube_transcript_api/test/test_api.py b/youtube_transcript_api/test/test_api.py index e356c72..ef8d913 100644 --- a/youtube_transcript_api/test/test_api.py +++ b/youtube_transcript_api/test/test_api.py @@ -1,4 +1,3 @@ -from ast import Assert from unittest import TestCase from mock import patch From b4ac0a17b726761cf14a3ec513c9c44f74e746de Mon Sep 17 00:00:00 2001 From: Maja Date: Wed, 1 Jun 2022 12:13:52 -0400 Subject: [PATCH 3/5] removed comments --- youtube_transcript_api/test/test_api.py | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/youtube_transcript_api/test/test_api.py b/youtube_transcript_api/test/test_api.py index ef8d913..3bda630 100644 --- a/youtube_transcript_api/test/test_api.py +++ b/youtube_transcript_api/test/test_api.py @@ -256,22 +256,12 @@ class TestYouTubeTranscriptApi(TestCase): ) def test_get_transcript__assertionerror_if_input_not_string(self): - """ - Raise Assertion error if not expected type - """ with self.assertRaises(AssertionError): YouTubeTranscriptApi.get_transcript(['video_id_1', 'video_id_2']) - # YouTubeTranscriptApi.get_transcripts(['video_id_1', 'video_id_2']) def test_get_transcripts__assertionerror_if_input_not_list(self): - """ - Raise Assertion error if not expected type - """ with self.assertRaises(AssertionError): YouTubeTranscriptApi.get_transcripts('video_id_1') - # YouTubeTranscriptApi.get_transcripts(['video_id_1', 'video_id_2']) - - @patch('youtube_transcript_api.YouTubeTranscriptApi.get_transcript') def test_get_transcripts(self, mock_get_transcript): From 010735c9e55a961745625327c01093bb1f56fd1a Mon Sep 17 00:00:00 2001 From: Jonas Depoix Date: Mon, 10 Oct 2022 10:29:13 +0200 Subject: [PATCH 4/5] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..9cef8dc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,23 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +# To Reproduce +Steps to reproduce the behavior: + +### Which Python version are you using? + +### Which version of youtube-transcript-api are you using? + +### What code / cli command are you executing? + +# Expected behavior +Describe what you expected to happen. + +# Actual behaviour +Describe what is happening instead of the **Expected behavior**. Add error messages if there are any. From 2c8b89a27f2c4c63b66a532c18f6e9d7d829e616 Mon Sep 17 00:00:00 2001 From: Jonas Depoix Date: Mon, 10 Oct 2022 10:35:41 +0200 Subject: [PATCH 5/5] Update issue templates --- .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..5ce37e3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of how you want youtube-transcript-api to solve your problem. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context about the feature request here. If you have any additional technical information which could be relevant for the implementation, feel free to share them here.