Merge branch 'unstable'

Author: deepjyoti30

README.md

@@ -165,9 +165,10 @@ usage: ytmdl [-h] [-q] [-o OUTPUT_DIR] [--song SONG-METADATA]
              [--on-meta-error ON_META_ERROR] [--proxy URL] [--url URL]
              [--list PATH TO LIST] [--nolocal] [--format FORMAT] [--trim]
              [--version] [--keep-chapter-name] [--download-archive FILE]
-             [--ignore-chapters] [--ytdl-config PATH] [--pl-start NUMBER]
-             [--pl-end NUMBER] [--pl-items ITEM_SPEC] [--ignore-errors]
-             [--title-as-name] [--level LEVEL] [--disable-file] [--list-level]
+             [--ignore-chapters] [--ytdl-config PATH] [--dont-transcode]
+             [--pl-start NUMBER] [--pl-end NUMBER] [--pl-items ITEM_SPEC]
+             [--ignore-errors] [--title-as-name] [--level LEVEL]
+             [--disable-file] [--list-level]
              [SONG_NAME ...]
 
 positional arguments:
@@ -213,6 +214,8 @@ options:
                         like one video
   --ytdl-config PATH    Path to the youtube-dl config location or the
                         directory
+  --dont-transcode      Don't transcode the audio after downloading.
+                        Applicable for OPUS format only. (Default: false)
 
 Metadata:
   --song SONG-METADATA  The song to search in Metadata. Particularly useful
@@ -244,7 +247,7 @@ Metadata:
                         the metadata (Default: false)
   --on-meta-error ON_META_ERROR
                         What to do if adding the metadata fails for some
-                        reasong like lack of metadata or perhaps a network
+                        reason like lack of metadata or perhaps a network
                         issue. Options are ['exit', 'skip', 'manual']
 
 Playlist:

setup.py

@@ -16,7 +16,7 @@
     'itunespy',
     'requests',
     'colorama',
-    'bs4',
+    'beautifulsoup4',
     'downloader-cli',
     'pyxdg',
     'ffmpeg-python',
@@ -25,7 +25,7 @@
     'youtube-search-python',
     'pyDes',
     'urllib3',
-    'simber',
+    'simber==0.2.5',
     'rich',
     'musicbrainzngs',
     'ytmusicapi',
@@ -75,7 +75,7 @@
             "Environment :: Console",
             "Topic :: Multimedia :: Sound/Audio",
         ),
-        python_requires=">=3.*",
+        python_requires=">=3.6.2",
         install_requires=req_pkgs,
         setup_requires=req_pkgs,
         extras_require=extra_features,

utils/completion.py

@@ -1,9 +1,11 @@
+#!/usr/bin/env python3
 """Build the completion files
 
 The arguments can be fetched by using the ytmdl
 command.
 """
 from subprocess import Popen, PIPE
+from os import environ
 from pathlib import Path
 
 
@@ -17,7 +19,9 @@
 
 def build_files():
     """Build the files"""
-    process = Popen("ytmdl --get-opts".split(), stdout=PIPE, stderr=PIPE)
+    environ["PYTHONPATH"] = "./ytmdl"
+    process = Popen(
+        "python3 -m main --get-opts".split(), stdout=PIPE, stderr=PIPE)
     out, err = process.communicate()
 
     opts = out.decode("utf-8").replace("\n", "")

ytmdl/core.py

@@ -69,7 +69,7 @@ def search(song_name, args) -> Union[str, str]:
 
         # Check if choice if -2. If it is that, then we need to stop executing
         # of the current song and gracefully exit.
-        if choice == -2:
+        if choice == -2 or choice == -1:
             return False, False
 
         return (
@@ -90,7 +90,7 @@ def search(song_name, args) -> Union[str, str]:
     if type(temp_data) is str and temp_data.lower() == "Unauthorized".lower():
         if args.ignore_errors:
             logger.warning("{}: is unauthorized".format(URL))
-            return
+            return None, None
         else:
             logger.critical("{}: is unauthorized".format(URL))
 
@@ -116,7 +116,7 @@ def download(link, yt_title, args) -> str:
     ))
     path = yt.dw(link, args.proxy, yt_title,
                  args.format, no_progress=args.quiet,
-                 ytdl_config=args.ytdl_config)
+                 ytdl_config=args.ytdl_config, dont_convert=args.dont_transcode)
 
     if type(path) is not str:
         # Probably an error occured
@@ -130,7 +130,8 @@ def convert(
     path: str,
     passed_format: str,
     start: float = None,
-    end: float = None
+    end: float = None,
+    dont_convert: bool = False
 ) -> str:
     """Convert the song into the proper format as asked by
     the user.
@@ -155,7 +156,10 @@ def convert(
         return conv_name
 
     # If it is m4a, don't convert
-    if passed_format == "m4a":
+    #
+    # If dont_convert is passed, we can skip the conversion since
+    # the user wants to keep the original audio
+    if passed_format == "m4a" or dont_convert:
         return path
 
     # Else the format needs to be in the list
@@ -246,4 +250,10 @@ def meta(conv_name: str, song_name: str, search_by: str, args):
     if type(option) is not int:
         raise MetadataError(search_by)
 
+    # If meta was skipped, indicate that
+    if option == -1:
+        logger.warning(
+            "Metadata was skipped because -1 was entered as the option")
+        return None
+
     return TRACK_INFO[option]

ytmdl/main.py

@@ -42,6 +42,7 @@
 from ytmdl.utils.ytdl import is_ytdl_config_present
 from ytmdl.yt import is_yt_url
 from ytmdl.__version__ import __version__
+from typing import Tuple
 
 # init colorama for windows
 init()
@@ -111,7 +112,7 @@ def arguments():
     metadata_group.add_argument("--ask-meta-name", help="Ask the user to enter a separate \
                         name for searching the metadata (Default: false)", action="store_true")
     metadata_group.add_argument("--on-meta-error", help="What to do if adding the metadata fails \
-                        for some reasong like lack of metadata or perhaps a network issue. \
+                        for some reason like lack of metadata or perhaps a network issue. \
                         Options are {}".format(defaults.DEFAULT.ON_ERROR_OPTIONS),
                                 type=str, default=None)
 
@@ -156,6 +157,9 @@ def arguments():
                         action="store_true")
     parser.add_argument('--ytdl-config', help="Path to the youtube-dl config location or the "
                         "directory", default=None, metavar="PATH", type=str)
+    parser.add_argument("--dont-transcode", help="Don't transcode the audio after \
+                        downloading. Applicable for OPUS format only. (Default: false)",
+                        action="store_true")
 
     playlist_group = parser.add_argument_group("Playlist")
     playlist_group.add_argument(
@@ -228,7 +232,8 @@ def arguments():
 def main(args):
     """Run on program call."""
 
-    song_name = extract_song_name(args)
+    song_name, verify_name = extract_song_name(args)
+    logger.debug("verify title: ", str(verify_name))
 
     # Extract the archive file contents
     is_download_archive = args.download_archive is not None
@@ -292,7 +297,15 @@ def main(args):
     # Try to extract the chapters
     chapters = yt.get_chapters(link, args.ytdl_config)
 
-    songs_to_download = [{}]
+    # Add the current passed song as the only entry here
+    # This dictionary will be cleared if the song is found to be containing
+    # chapters.
+    #
+    # Moreover, the `is_original` field is **not** present from the youtube
+    # response which would force the following code to verify the title
+    # for chapters which is the behavior we want.
+    songs_to_download = [{'title': song_name, 'is_original': not verify_name}]
+
     # If the chapters are present, we will have to iterate and extract each chapter
     if chapters and not args.ignore_chapters:
         logger.info("The song has chapters in it.",
@@ -302,12 +315,15 @@ def main(args):
         for chapter in chapters:
             songs_to_download.append(chapter)
 
-    logger.debug(songs_to_download)
+    logger.debug("songs to download: ", str(songs_to_download))
     for song in songs_to_download:
         song_title = song.get("title", yt_title)
         start_time = song.get("start_time", None)
         end_time = song.get("end_time", None)
 
+        is_original = song.get("is_original", False)
+        logger.debug("is original: ", str(is_original))
+
         if "title" in song.keys():
             logger.debug("Has the attribute")
             # Update the song_metadata with the name of the chapter
@@ -318,7 +334,7 @@ def main(args):
             # NOTE: Check if skip meta is passed, we don't need to
             # extract the new title.
             song_metadata = utility.get_new_title(song_metadata) if \
-                not (args.keep_chapter_name and args.skip_meta) else song_metadata
+                (not args.keep_chapter_name and not args.skip_meta and not is_original) else song_metadata
 
         # Pass the song for post processing
         try:
@@ -369,7 +385,8 @@ def post_processing(
     logger.debug(stream)
     # Try to convert the song
     try:
-        conv_name = convert(path, passed_format, start_time, end_time)
+        conv_name = convert(path, passed_format, start_time,
+                            end_time, args.dont_transcode)
     except ConvertError as convert_error:
         logger.critical('ERROR: {}'.format(convert_error))
         return
@@ -414,6 +431,16 @@ def post_processing(
     add_song_to_archive(
         stream=stream, youtube_link=link) if is_download_archive else None
 
+    # If no metadata was selected, just do a dry cleanup and skip the
+    # song
+    if track_selected is None:
+        if dir.dry_cleanup(conv_name, song_name):
+            logger.info("Done")
+        elif not args.ignore_errors or args.on_meta_error == 'exit':
+            logger.critical(
+                ". Pass `--ignore-errors` or `on-meta-error` to ignore this.")
+        return
+
     if dir.cleanup([track_selected], 0, passed_format, remove_cached=False):
         logger.info("Done")
 
@@ -484,12 +511,12 @@ def pre_checks(args):
             "Song Name is required. Check 'ytmdl --help' for help.")
 
 
-def extract_song_name(args) -> str:
+def extract_song_name(args) -> Tuple[str, bool]:
     """Extract the name of the song from the given args"""
     logger.debug(args.SONG_NAME)
 
     if args.SONG_NAME:
-        return " ".join(args.SONG_NAME)
+        return " ".join(args.SONG_NAME), False
 
     # If song name is not passed then try to extract
     # the title of the song using the URL.
@@ -501,7 +528,7 @@ def extract_song_name(args) -> str:
         if not args.ignore_errors:
             logger.critical("Wasn't able to extract song data.",
                             "Use `--ignore-errors` to ignore this error")
-        return
+        return None, False
 
     # Ask the user if they want to go with the extracted
     # title or if they would like to change it.
@@ -511,8 +538,9 @@ def extract_song_name(args) -> str:
     # passed.
     if not args.title_as_name and not args.skip_meta and verify_title:
         song_name = utility.get_new_title(song_name)
+        verify_title = False
 
-    return song_name
+    return song_name, verify_title
 
 
 def extract_data():

ytmdl/song.py

@@ -147,7 +147,7 @@ def getChoice(SONG_INFO, type):
 
     logger.info('Choose One {}'.format(
         '(One with [M] is verified music)'
-        if type == 'mp3' else ''))
+        if type == 'mp3' else '(Enter -1 to skip metadata)'))
 
     results = len(SONG_INFO)
 
@@ -173,7 +173,7 @@ def getChoice(SONG_INFO, type):
         # The choice is valid if it is in the range and it is greater than 0
         # We also need to break when the user enters -1 which means the exec
         # will skip the current song
-        if (choice <= len(SONG_INFO) and choice > 0) or choice == -1:
+        if choice == -1 or (choice <= len(SONG_INFO) and choice > 0):
             break
         elif choice == 0 and results < len(SONG_INFO):
             PRINT_WHOLE = True
@@ -182,7 +182,7 @@ def getChoice(SONG_INFO, type):
         else:
             PRINT_WHOLE = False
 
-    return choice - 1
+    return choice - 1 if choice != -1 else -1
 
 
 def set_MP3_data(song, song_path):
@@ -314,13 +314,16 @@ def set_OPUS_data(song, song_path):
     try:
         SONG_PATH = os.path.join(defaults.DEFAULT.SONG_TEMP_DIR,
                                  song_path)
+        logger.debug("Opening file at {} to add metadata".format(SONG_PATH))
         mutagen_file = File(SONG_PATH)
 
         # Try adding the tags container
         try:
             mutagen_file.add_tags()
-        except Exception:
+        except Exception as e:
             # If exception is thrown, the tags already exist
+            logger.debug(
+                "Got exception while adding tags to the passed file: ", str(e))
             pass
 
         # Clear out the tags from the file
@@ -386,6 +389,10 @@ def setData(SONG_INFO, is_quiet, song_path, datatype='mp3', choice=None):
     option = _get_option(SONG_INFO, is_quiet, choice)
     logger.debug(option)
 
+    # If -1 then skip setting the metadata
+    if option == -1:
+        return option
+
     song = SONG_INFO[option]
 
     get_more_data_dict = preconfig.CONFIG().GET_EXTRA_DATA
@@ -413,6 +420,11 @@ def setData(SONG_INFO, is_quiet, song_path, datatype='mp3', choice=None):
             song_path
         )
 
+    # Handle exception while adding the metadata
+    if type(img_added) == Exception:
+        logger.error(
+            "Failed to add metadata due to exception: {}".format(img_added))
+
     # Show the written stuff in a better format
     prepend.PREPEND(1)
     print('================================')