yt_dlp/__init__.py

   1 #!/usr/bin/env python3
   2 # coding: utf-8
   3
   4 from __future__ import unicode_literals
   5
   6 __license__ = 'Public Domain'
   7
   8 import codecs
   9 import io
  10 import itertools
  11 import os
  12 import random
  13 import re
  14 import sys
  15
  16
  17 from .options import (
  18     parseOpts,
  19 )
  20 from .compat import (
  21     compat_getpass,
  22     compat_shlex_quote,
  23     workaround_optparse_bug9161,
  24 )
  25 from .cookies import SUPPORTED_BROWSERS
  26 from .utils import (
  27     DateRange,
  28     decodeOption,
  29     DownloadError,
  30     error_to_compat_str,
  31     ExistingVideoReached,
  32     expand_path,
  33     match_filter_func,
  34     MaxDownloadsReached,
  35     preferredencoding,
  36     read_batch_urls,
  37     RejectedVideoReached,
  38     render_table,
  39     SameFileError,
  40     setproctitle,
  41     std_headers,
  42     write_string,
  43 )
  44 from .update import run_update
  45 from .downloader import (
  46     FileDownloader,
  47 )
  48 from .extractor import gen_extractors, list_extractors
  49 from .extractor.common import InfoExtractor
  50 from .extractor.adobepass import MSO_INFO
  51 from .postprocessor import (
  52     FFmpegExtractAudioPP,
  53     FFmpegSubtitlesConvertorPP,
  54     FFmpegThumbnailsConvertorPP,
  55     FFmpegVideoConvertorPP,
  56     FFmpegVideoRemuxerPP,
  57     MetadataFromFieldPP,
  58     MetadataParserPP,
  59 )
  60 from .YoutubeDL import YoutubeDL
  61
  62
  63 def _real_main(argv=None):
  64     # Compatibility fixes for Windows
  65     if sys.platform == 'win32':
  66         # https://github.com/ytdl-org/youtube-dl/issues/820
  67         codecs.register(lambda name: codecs.lookup('utf-8') if name == 'cp65001' else None)
  68
  69     workaround_optparse_bug9161()
  70
  71     setproctitle('yt-dlp')
  72
  73     parser, opts, args = parseOpts(argv)
  74     warnings = []
  75
  76     # Set user agent
  77     if opts.user_agent is not None:
  78         std_headers['User-Agent'] = opts.user_agent
  79
  80     # Set referer
  81     if opts.referer is not None:
  82         std_headers['Referer'] = opts.referer
  83
  84     # Custom HTTP headers
  85     std_headers.update(opts.headers)
  86
  87     # Dump user agent
  88     if opts.dump_user_agent:
  89         write_string(std_headers['User-Agent'] + '\n', out=sys.stdout)
  90         sys.exit(0)
  91
  92     # Batch file verification
  93     batch_urls = []
  94     if opts.batchfile is not None:
  95         try:
  96             if opts.batchfile == '-':
  97                 batchfd = sys.stdin
  98             else:
  99                 batchfd = io.open(
 100                     expand_path(opts.batchfile),
 101                     'r', encoding='utf-8', errors='ignore')
 102             batch_urls = read_batch_urls(batchfd)
 103             if opts.verbose:
 104                 write_string('[debug] Batch file urls: ' + repr(batch_urls) + '\n')
 105         except IOError:
 106             sys.exit('ERROR: batch file %s could not be read' % opts.batchfile)
 107     all_urls = batch_urls + [url.strip() for url in args]  # batch_urls are already striped in read_batch_urls
 108     _enc = preferredencoding()
 109     all_urls = [url.decode(_enc, 'ignore') if isinstance(url, bytes) else url for url in all_urls]
 110
 111     if opts.list_extractors:
 112         for ie in list_extractors(opts.age_limit):
 113             write_string(ie.IE_NAME + (' (CURRENTLY BROKEN)' if not ie.working() else '') + '\n', out=sys.stdout)
 114             matchedUrls = [url for url in all_urls if ie.suitable(url)]
 115             for mu in matchedUrls:
 116                 write_string('  ' + mu + '\n', out=sys.stdout)
 117         sys.exit(0)
 118     if opts.list_extractor_descriptions:
 119         for ie in list_extractors(opts.age_limit):
 120             if not ie.working():
 121                 continue
 122             desc = getattr(ie, 'IE_DESC', ie.IE_NAME)
 123             if desc is False:
 124                 continue
 125             if hasattr(ie, 'SEARCH_KEY'):
 126                 _SEARCHES = ('cute kittens', 'slithering pythons', 'falling cat', 'angry poodle', 'purple fish', 'running tortoise', 'sleeping bunny', 'burping cow')
 127                 _COUNTS = ('', '5', '10', 'all')
 128                 desc += ' (Example: "%s%s:%s" )' % (ie.SEARCH_KEY, random.choice(_COUNTS), random.choice(_SEARCHES))
 129             write_string(desc + '\n', out=sys.stdout)
 130         sys.exit(0)
 131     if opts.ap_list_mso:
 132         table = [[mso_id, mso_info['name']] for mso_id, mso_info in MSO_INFO.items()]
 133         write_string('Supported TV Providers:\n' + render_table(['mso', 'mso name'], table) + '\n', out=sys.stdout)
 134         sys.exit(0)
 135
 136     # Conflicting, missing and erroneous options
 137     if opts.usenetrc and (opts.username is not None or opts.password is not None):
 138         parser.error('using .netrc conflicts with giving username/password')
 139     if opts.password is not None and opts.username is None:
 140         parser.error('account username missing\n')
 141     if opts.ap_password is not None and opts.ap_username is None:
 142         parser.error('TV Provider account username missing\n')
 143     if opts.autonumber_size is not None:
 144         if opts.autonumber_size <= 0:
 145             parser.error('auto number size must be positive')
 146     if opts.autonumber_start is not None:
 147         if opts.autonumber_start < 0:
 148             parser.error('auto number start must be positive or 0')
 149     if opts.username is not None and opts.password is None:
 150         opts.password = compat_getpass('Type account password and press [Return]: ')
 151     if opts.ap_username is not None and opts.ap_password is None:
 152         opts.ap_password = compat_getpass('Type TV provider account password and press [Return]: ')
 153     if opts.ratelimit is not None:
 154         numeric_limit = FileDownloader.parse_bytes(opts.ratelimit)
 155         if numeric_limit is None:
 156             parser.error('invalid rate limit specified')
 157         opts.ratelimit = numeric_limit
 158     if opts.throttledratelimit is not None:
 159         numeric_limit = FileDownloader.parse_bytes(opts.throttledratelimit)
 160         if numeric_limit is None:
 161             parser.error('invalid rate limit specified')
 162         opts.throttledratelimit = numeric_limit
 163     if opts.min_filesize is not None:
 164         numeric_limit = FileDownloader.parse_bytes(opts.min_filesize)
 165         if numeric_limit is None:
 166             parser.error('invalid min_filesize specified')
 167         opts.min_filesize = numeric_limit
 168     if opts.max_filesize is not None:
 169         numeric_limit = FileDownloader.parse_bytes(opts.max_filesize)
 170         if numeric_limit is None:
 171             parser.error('invalid max_filesize specified')
 172         opts.max_filesize = numeric_limit
 173     if opts.sleep_interval is not None:
 174         if opts.sleep_interval < 0:
 175             parser.error('sleep interval must be positive or 0')
 176     if opts.max_sleep_interval is not None:
 177         if opts.max_sleep_interval < 0:
 178             parser.error('max sleep interval must be positive or 0')
 179         if opts.sleep_interval is None:
 180             parser.error('min sleep interval must be specified, use --min-sleep-interval')
 181         if opts.max_sleep_interval < opts.sleep_interval:
 182             parser.error('max sleep interval must be greater than or equal to min sleep interval')
 183     else:
 184         opts.max_sleep_interval = opts.sleep_interval
 185     if opts.sleep_interval_subtitles is not None:
 186         if opts.sleep_interval_subtitles < 0:
 187             parser.error('subtitles sleep interval must be positive or 0')
 188     if opts.sleep_interval_requests is not None:
 189         if opts.sleep_interval_requests < 0:
 190             parser.error('requests sleep interval must be positive or 0')
 191     if opts.ap_mso and opts.ap_mso not in MSO_INFO:
 192         parser.error('Unsupported TV Provider, use --ap-list-mso to get a list of supported TV Providers')
 193     if opts.overwrites:  # --yes-overwrites implies --no-continue
 194         opts.continue_dl = False
 195     if opts.concurrent_fragment_downloads <= 0:
 196         raise ValueError('Concurrent fragments must be positive')
 197
 198     def parse_retries(retries, name=''):
 199         if retries in ('inf', 'infinite'):
 200             parsed_retries = float('inf')
 201         else:
 202             try:
 203                 parsed_retries = int(retries)
 204             except (TypeError, ValueError):
 205                 parser.error('invalid %sretry count specified' % name)
 206         return parsed_retries
 207     if opts.retries is not None:
 208         opts.retries = parse_retries(opts.retries)
 209     if opts.fragment_retries is not None:
 210         opts.fragment_retries = parse_retries(opts.fragment_retries, 'fragment ')
 211     if opts.extractor_retries is not None:
 212         opts.extractor_retries = parse_retries(opts.extractor_retries, 'extractor ')
 213     if opts.buffersize is not None:
 214         numeric_buffersize = FileDownloader.parse_bytes(opts.buffersize)
 215         if numeric_buffersize is None:
 216             parser.error('invalid buffer size specified')
 217         opts.buffersize = numeric_buffersize
 218     if opts.http_chunk_size is not None:
 219         numeric_chunksize = FileDownloader.parse_bytes(opts.http_chunk_size)
 220         if not numeric_chunksize:
 221             parser.error('invalid http chunk size specified')
 222         opts.http_chunk_size = numeric_chunksize
 223     if opts.playliststart <= 0:
 224         raise ValueError('Playlist start must be positive')
 225     if opts.playlistend not in (-1, None) and opts.playlistend < opts.playliststart:
 226         raise ValueError('Playlist end must be greater than playlist start')
 227     if opts.extractaudio:
 228         if opts.audioformat not in ['best'] + list(FFmpegExtractAudioPP.SUPPORTED_EXTS):
 229             parser.error('invalid audio format specified')
 230     if opts.audioquality:
 231         opts.audioquality = opts.audioquality.strip('k').strip('K')
 232         if not opts.audioquality.isdigit():
 233             parser.error('invalid audio quality specified')
 234     if opts.recodevideo is not None:
 235         opts.recodevideo = opts.recodevideo.replace(' ', '')
 236         if not re.match(FFmpegVideoConvertorPP.FORMAT_RE, opts.recodevideo):
 237             parser.error('invalid video remux format specified')
 238     if opts.remuxvideo is not None:
 239         opts.remuxvideo = opts.remuxvideo.replace(' ', '')
 240         if not re.match(FFmpegVideoRemuxerPP.FORMAT_RE, opts.remuxvideo):
 241             parser.error('invalid video remux format specified')
 242     if opts.convertsubtitles is not None:
 243         if opts.convertsubtitles not in FFmpegSubtitlesConvertorPP.SUPPORTED_EXTS:
 244             parser.error('invalid subtitle format specified')
 245     if opts.convertthumbnails is not None:
 246         if opts.convertthumbnails not in FFmpegThumbnailsConvertorPP.SUPPORTED_EXTS:
 247             parser.error('invalid thumbnail format specified')
 248
 249     if opts.cookiesfrombrowser is not None:
 250         opts.cookiesfrombrowser = [
 251             part.strip() or None for part in opts.cookiesfrombrowser.split(':', 1)]
 252         if opts.cookiesfrombrowser[0] not in SUPPORTED_BROWSERS:
 253             parser.error('unsupported browser specified for cookies')
 254
 255     if opts.date is not None:
 256         date = DateRange.day(opts.date)
 257     else:
 258         date = DateRange(opts.dateafter, opts.datebefore)
 259
 260     compat_opts = opts.compat_opts
 261
 262     def _unused_compat_opt(name):
 263         if name not in compat_opts:
 264             return False
 265         compat_opts.discard(name)
 266         compat_opts.update(['*%s' % name])
 267         return True
 268
 269     def set_default_compat(compat_name, opt_name, default=True, remove_compat=True):
 270         attr = getattr(opts, opt_name)
 271         if compat_name in compat_opts:
 272             if attr is None:
 273                 setattr(opts, opt_name, not default)
 274                 return True
 275             else:
 276                 if remove_compat:
 277                     _unused_compat_opt(compat_name)
 278                 return False
 279         elif attr is None:
 280             setattr(opts, opt_name, default)
 281         return None
 282
 283     set_default_compat('abort-on-error', 'ignoreerrors')
 284     set_default_compat('no-playlist-metafiles', 'allow_playlist_files')
 285     set_default_compat('no-clean-infojson', 'clean_infojson')
 286     if 'format-sort' in compat_opts:
 287         opts.format_sort.extend(InfoExtractor.FormatSort.ytdl_default)
 288     _video_multistreams_set = set_default_compat('multistreams', 'allow_multiple_video_streams', False, remove_compat=False)
 289     _audio_multistreams_set = set_default_compat('multistreams', 'allow_multiple_audio_streams', False, remove_compat=False)
 290     if _video_multistreams_set is False and _audio_multistreams_set is False:
 291         _unused_compat_opt('multistreams')
 292     outtmpl_default = opts.outtmpl.get('default')
 293     if 'filename' in compat_opts:
 294         if outtmpl_default is None:
 295             outtmpl_default = '%(title)s-%(id)s.%(ext)s'
 296             opts.outtmpl.update({'default': outtmpl_default})
 297         else:
 298             _unused_compat_opt('filename')
 299
 300     def validate_outtmpl(tmpl, msg):
 301         err = YoutubeDL.validate_outtmpl(tmpl)
 302         if err:
 303             parser.error('invalid %s %r: %s' % (msg, tmpl, error_to_compat_str(err)))
 304
 305     for k, tmpl in opts.outtmpl.items():
 306         validate_outtmpl(tmpl, '%s output template' % k)
 307     opts.forceprint = opts.forceprint or []
 308     for tmpl in opts.forceprint or []:
 309         validate_outtmpl(tmpl, 'print template')
 310
 311     if opts.extractaudio and not opts.keepvideo and opts.format is None:
 312         opts.format = 'bestaudio/best'
 313
 314     if outtmpl_default is not None and not os.path.splitext(outtmpl_default)[1] and opts.extractaudio:
 315         parser.error('Cannot download a video and extract audio into the same'
 316                      ' file! Use "{0}.%(ext)s" instead of "{0}" as the output'
 317                      ' template'.format(outtmpl_default))
 318
 319     for f in opts.format_sort:
 320         if re.match(InfoExtractor.FormatSort.regex, f) is None:
 321             parser.error('invalid format sort string "%s" specified' % f)
 322
 323     def metadataparser_actions(f):
 324         if isinstance(f, str):
 325             cmd = '--parse-metadata %s' % compat_shlex_quote(f)
 326             try:
 327                 actions = [MetadataFromFieldPP.to_action(f)]
 328             except Exception as err:
 329                 parser.error(f'{cmd} is invalid; {err}')
 330         else:
 331             cmd = '--replace-in-metadata %s' % ' '.join(map(compat_shlex_quote, f))
 332             actions = ((MetadataParserPP.Actions.REPLACE, x, *f[1:]) for x in f[0].split(','))
 333
 334         for action in actions:
 335             try:
 336                 MetadataParserPP.validate_action(*action)
 337             except Exception as err:
 338                 parser.error(f'{cmd} is invalid; {err}')
 339             yield action
 340
 341     if opts.parse_metadata is None:
 342         opts.parse_metadata = []
 343     if opts.metafromtitle is not None:
 344         opts.parse_metadata.append('title:%s' % opts.metafromtitle)
 345     opts.parse_metadata = list(itertools.chain(*map(metadataparser_actions, opts.parse_metadata)))
 346
 347     any_getting = opts.forceprint or opts.geturl or opts.gettitle or opts.getid or opts.getthumbnail or opts.getdescription or opts.getfilename or opts.getformat or opts.getduration or opts.dumpjson or opts.dump_single_json
 348     any_printing = opts.print_json
 349     download_archive_fn = expand_path(opts.download_archive) if opts.download_archive is not None else opts.download_archive
 350
 351     # If JSON is not printed anywhere, but comments are requested, save it to file
 352     printing_json = opts.dumpjson or opts.print_json or opts.dump_single_json
 353     if opts.getcomments and not printing_json:
 354         opts.writeinfojson = True
 355
 356     def report_conflict(arg1, arg2):
 357         warnings.append('%s is ignored since %s was given' % (arg2, arg1))
 358
 359     if opts.remuxvideo and opts.recodevideo:
 360         report_conflict('--recode-video', '--remux-video')
 361         opts.remuxvideo = False
 362     if opts.sponskrub_cut and opts.split_chapters and opts.sponskrub is not False:
 363         report_conflict('--split-chapter', '--sponskrub-cut')
 364         opts.sponskrub_cut = False
 365
 366     if opts.allow_unplayable_formats:
 367         if opts.extractaudio:
 368             report_conflict('--allow-unplayable-formats', '--extract-audio')
 369             opts.extractaudio = False
 370         if opts.remuxvideo:
 371             report_conflict('--allow-unplayable-formats', '--remux-video')
 372             opts.remuxvideo = False
 373         if opts.recodevideo:
 374             report_conflict('--allow-unplayable-formats', '--recode-video')
 375             opts.recodevideo = False
 376         if opts.addmetadata:
 377             report_conflict('--allow-unplayable-formats', '--add-metadata')
 378             opts.addmetadata = False
 379         if opts.embedsubtitles:
 380             report_conflict('--allow-unplayable-formats', '--embed-subs')
 381             opts.embedsubtitles = False
 382         if opts.embedthumbnail:
 383             report_conflict('--allow-unplayable-formats', '--embed-thumbnail')
 384             opts.embedthumbnail = False
 385         if opts.xattrs:
 386             report_conflict('--allow-unplayable-formats', '--xattrs')
 387             opts.xattrs = False
 388         if opts.fixup and opts.fixup.lower() not in ('never', 'ignore'):
 389             report_conflict('--allow-unplayable-formats', '--fixup')
 390         opts.fixup = 'never'
 391         if opts.sponskrub:
 392             report_conflict('--allow-unplayable-formats', '--sponskrub')
 393         opts.sponskrub = False
 394
 395     # PostProcessors
 396     postprocessors = []
 397     if opts.parse_metadata:
 398         postprocessors.append({
 399             'key': 'MetadataParser',
 400             'actions': opts.parse_metadata,
 401             # Run this immediately after extraction is complete
 402             'when': 'pre_process'
 403         })
 404     if opts.convertsubtitles:
 405         postprocessors.append({
 406             'key': 'FFmpegSubtitlesConvertor',
 407             'format': opts.convertsubtitles,
 408             # Run this before the actual video download
 409             'when': 'before_dl'
 410         })
 411     if opts.convertthumbnails:
 412         postprocessors.append({
 413             'key': 'FFmpegThumbnailsConvertor',
 414             'format': opts.convertthumbnails,
 415             # Run this before the actual video download
 416             'when': 'before_dl'
 417         })
 418     # Must be after all other before_dl
 419     if opts.exec_before_dl_cmd:
 420         postprocessors.append({
 421             'key': 'Exec',
 422             'exec_cmd': opts.exec_before_dl_cmd,
 423             'when': 'before_dl'
 424         })
 425     if opts.extractaudio:
 426         postprocessors.append({
 427             'key': 'FFmpegExtractAudio',
 428             'preferredcodec': opts.audioformat,
 429             'preferredquality': opts.audioquality,
 430             'nopostoverwrites': opts.nopostoverwrites,
 431         })
 432     if opts.remuxvideo:
 433         postprocessors.append({
 434             'key': 'FFmpegVideoRemuxer',
 435             'preferedformat': opts.remuxvideo,
 436         })
 437     if opts.recodevideo:
 438         postprocessors.append({
 439             'key': 'FFmpegVideoConvertor',
 440             'preferedformat': opts.recodevideo,
 441         })
 442     # FFmpegMetadataPP should be run after FFmpegVideoConvertorPP and
 443     # FFmpegExtractAudioPP as containers before conversion may not support
 444     # metadata (3gp, webm, etc.)
 445     # And this post-processor should be placed before other metadata
 446     # manipulating post-processors (FFmpegEmbedSubtitle) to prevent loss of
 447     # extra metadata. By default ffmpeg preserves metadata applicable for both
 448     # source and target containers. From this point the container won't change,
 449     # so metadata can be added here.
 450     if opts.addmetadata:
 451         postprocessors.append({'key': 'FFmpegMetadata'})
 452     if opts.embedsubtitles:
 453         already_have_subtitle = opts.writesubtitles and 'no-keep-subs' not in compat_opts
 454         postprocessors.append({
 455             'key': 'FFmpegEmbedSubtitle',
 456             # already_have_subtitle = True prevents the file from being deleted after embedding
 457             'already_have_subtitle': already_have_subtitle
 458         })
 459         if not opts.writeautomaticsub and 'no-keep-subs' not in compat_opts:
 460             opts.writesubtitles = True
 461     # --all-sub automatically sets --write-sub if --write-auto-sub is not given
 462     # this was the old behaviour if only --all-sub was given.
 463     if opts.allsubtitles and not opts.writeautomaticsub:
 464         opts.writesubtitles = True
 465     # This should be above EmbedThumbnail since sponskrub removes the thumbnail attachment
 466     # but must be below EmbedSubtitle and FFmpegMetadata
 467     # See https://github.com/yt-dlp/yt-dlp/issues/204 , https://github.com/faissaloo/SponSkrub/issues/29
 468     # If opts.sponskrub is None, sponskrub is used, but it silently fails if the executable can't be found
 469     if opts.sponskrub is not False:
 470         postprocessors.append({
 471             'key': 'SponSkrub',
 472             'path': opts.sponskrub_path,
 473             'args': opts.sponskrub_args,
 474             'cut': opts.sponskrub_cut,
 475             'force': opts.sponskrub_force,
 476             'ignoreerror': opts.sponskrub is None,
 477         })
 478     if opts.embedthumbnail:
 479         already_have_thumbnail = opts.writethumbnail or opts.write_all_thumbnails
 480         postprocessors.append({
 481             'key': 'EmbedThumbnail',
 482             # already_have_thumbnail = True prevents the file from being deleted after embedding
 483             'already_have_thumbnail': already_have_thumbnail
 484         })
 485         if not already_have_thumbnail:
 486             opts.writethumbnail = True
 487     if opts.split_chapters:
 488         postprocessors.append({'key': 'FFmpegSplitChapters'})
 489     # XAttrMetadataPP should be run after post-processors that may change file contents
 490     if opts.xattrs:
 491         postprocessors.append({'key': 'XAttrMetadata'})
 492     # Exec must be the last PP
 493     if opts.exec_cmd:
 494         postprocessors.append({
 495             'key': 'Exec',
 496             'exec_cmd': opts.exec_cmd,
 497             # Run this only after the files have been moved to their final locations
 498             'when': 'after_move'
 499         })
 500
 501     def report_args_compat(arg, name):
 502         warnings.append('%s given without specifying name. The arguments will be given to all %s' % (arg, name))
 503
 504     if 'default' in opts.external_downloader_args:
 505         report_args_compat('--downloader-args', 'external downloaders')
 506
 507     if 'default-compat' in opts.postprocessor_args and 'default' not in opts.postprocessor_args:
 508         report_args_compat('--post-processor-args', 'post-processors')
 509         opts.postprocessor_args.setdefault('sponskrub', [])
 510         opts.postprocessor_args['default'] = opts.postprocessor_args['default-compat']
 511
 512     final_ext = (
 513         opts.recodevideo if opts.recodevideo in FFmpegVideoConvertorPP.SUPPORTED_EXTS
 514         else opts.remuxvideo if opts.remuxvideo in FFmpegVideoRemuxerPP.SUPPORTED_EXTS
 515         else opts.audioformat if (opts.extractaudio and opts.audioformat != 'best')
 516         else None)
 517
 518     match_filter = (
 519         None if opts.match_filter is None
 520         else match_filter_func(opts.match_filter))
 521
 522     ydl_opts = {
 523         'usenetrc': opts.usenetrc,
 524         'username': opts.username,
 525         'password': opts.password,
 526         'twofactor': opts.twofactor,
 527         'videopassword': opts.videopassword,
 528         'ap_mso': opts.ap_mso,
 529         'ap_username': opts.ap_username,
 530         'ap_password': opts.ap_password,
 531         'quiet': (opts.quiet or any_getting or any_printing),
 532         'no_warnings': opts.no_warnings,
 533         'forceurl': opts.geturl,
 534         'forcetitle': opts.gettitle,
 535         'forceid': opts.getid,
 536         'forcethumbnail': opts.getthumbnail,
 537         'forcedescription': opts.getdescription,
 538         'forceduration': opts.getduration,
 539         'forcefilename': opts.getfilename,
 540         'forceformat': opts.getformat,
 541         'forceprint': opts.forceprint,
 542         'forcejson': opts.dumpjson or opts.print_json,
 543         'dump_single_json': opts.dump_single_json,
 544         'force_write_download_archive': opts.force_write_download_archive,
 545         'simulate': (any_getting or None) if opts.simulate is None else opts.simulate,
 546         'skip_download': opts.skip_download,
 547         'format': opts.format,
 548         'allow_unplayable_formats': opts.allow_unplayable_formats,
 549         'ignore_no_formats_error': opts.ignore_no_formats_error,
 550         'format_sort': opts.format_sort,
 551         'format_sort_force': opts.format_sort_force,
 552         'allow_multiple_video_streams': opts.allow_multiple_video_streams,
 553         'allow_multiple_audio_streams': opts.allow_multiple_audio_streams,
 554         'check_formats': opts.check_formats,
 555         'listformats': opts.listformats,
 556         'listformats_table': opts.listformats_table,
 557         'outtmpl': opts.outtmpl,
 558         'outtmpl_na_placeholder': opts.outtmpl_na_placeholder,
 559         'paths': opts.paths,
 560         'autonumber_size': opts.autonumber_size,
 561         'autonumber_start': opts.autonumber_start,
 562         'restrictfilenames': opts.restrictfilenames,
 563         'windowsfilenames': opts.windowsfilenames,
 564         'ignoreerrors': opts.ignoreerrors,
 565         'force_generic_extractor': opts.force_generic_extractor,
 566         'ratelimit': opts.ratelimit,
 567         'throttledratelimit': opts.throttledratelimit,
 568         'overwrites': opts.overwrites,
 569         'retries': opts.retries,
 570         'fragment_retries': opts.fragment_retries,
 571         'extractor_retries': opts.extractor_retries,
 572         'skip_unavailable_fragments': opts.skip_unavailable_fragments,
 573         'keep_fragments': opts.keep_fragments,
 574         'concurrent_fragment_downloads': opts.concurrent_fragment_downloads,
 575         'buffersize': opts.buffersize,
 576         'noresizebuffer': opts.noresizebuffer,
 577         'http_chunk_size': opts.http_chunk_size,
 578         'continuedl': opts.continue_dl,
 579         'noprogress': opts.noprogress,
 580         'progress_with_newline': opts.progress_with_newline,
 581         'playliststart': opts.playliststart,
 582         'playlistend': opts.playlistend,
 583         'playlistreverse': opts.playlist_reverse,
 584         'playlistrandom': opts.playlist_random,
 585         'noplaylist': opts.noplaylist,
 586         'logtostderr': outtmpl_default == '-',
 587         'consoletitle': opts.consoletitle,
 588         'nopart': opts.nopart,
 589         'updatetime': opts.updatetime,
 590         'writedescription': opts.writedescription,
 591         'writeannotations': opts.writeannotations,
 592         'writeinfojson': opts.writeinfojson,
 593         'allow_playlist_files': opts.allow_playlist_files,
 594         'clean_infojson': opts.clean_infojson,
 595         'getcomments': opts.getcomments,
 596         'writethumbnail': opts.writethumbnail,
 597         'write_all_thumbnails': opts.write_all_thumbnails,
 598         'writelink': opts.writelink,
 599         'writeurllink': opts.writeurllink,
 600         'writewebloclink': opts.writewebloclink,
 601         'writedesktoplink': opts.writedesktoplink,
 602         'writesubtitles': opts.writesubtitles,
 603         'writeautomaticsub': opts.writeautomaticsub,
 604         'allsubtitles': opts.allsubtitles,
 605         'listsubtitles': opts.listsubtitles,
 606         'subtitlesformat': opts.subtitlesformat,
 607         'subtitleslangs': opts.subtitleslangs,
 608         'matchtitle': decodeOption(opts.matchtitle),
 609         'rejecttitle': decodeOption(opts.rejecttitle),
 610         'max_downloads': opts.max_downloads,
 611         'prefer_free_formats': opts.prefer_free_formats,
 612         'trim_file_name': opts.trim_file_name,
 613         'verbose': opts.verbose,
 614         'dump_intermediate_pages': opts.dump_intermediate_pages,
 615         'write_pages': opts.write_pages,
 616         'test': opts.test,
 617         'keepvideo': opts.keepvideo,
 618         'min_filesize': opts.min_filesize,
 619         'max_filesize': opts.max_filesize,
 620         'min_views': opts.min_views,
 621         'max_views': opts.max_views,
 622         'daterange': date,
 623         'cachedir': opts.cachedir,
 624         'youtube_print_sig_code': opts.youtube_print_sig_code,
 625         'age_limit': opts.age_limit,
 626         'download_archive': download_archive_fn,
 627         'break_on_existing': opts.break_on_existing,
 628         'break_on_reject': opts.break_on_reject,
 629         'skip_playlist_after_errors': opts.skip_playlist_after_errors,
 630         'cookiefile': opts.cookiefile,
 631         'cookiesfrombrowser': opts.cookiesfrombrowser,
 632         'nocheckcertificate': opts.no_check_certificate,
 633         'prefer_insecure': opts.prefer_insecure,
 634         'proxy': opts.proxy,
 635         'socket_timeout': opts.socket_timeout,
 636         'bidi_workaround': opts.bidi_workaround,
 637         'debug_printtraffic': opts.debug_printtraffic,
 638         'prefer_ffmpeg': opts.prefer_ffmpeg,
 639         'include_ads': opts.include_ads,
 640         'default_search': opts.default_search,
 641         'dynamic_mpd': opts.dynamic_mpd,
 642         'extractor_args': opts.extractor_args,
 643         'youtube_include_dash_manifest': opts.youtube_include_dash_manifest,
 644         'youtube_include_hls_manifest': opts.youtube_include_hls_manifest,
 645         'encoding': opts.encoding,
 646         'extract_flat': opts.extract_flat,
 647         'mark_watched': opts.mark_watched,
 648         'merge_output_format': opts.merge_output_format,
 649         'final_ext': final_ext,
 650         'postprocessors': postprocessors,
 651         'fixup': opts.fixup,
 652         'source_address': opts.source_address,
 653         'call_home': opts.call_home,
 654         'sleep_interval_requests': opts.sleep_interval_requests,
 655         'sleep_interval': opts.sleep_interval,
 656         'max_sleep_interval': opts.max_sleep_interval,
 657         'sleep_interval_subtitles': opts.sleep_interval_subtitles,
 658         'external_downloader': opts.external_downloader,
 659         'list_thumbnails': opts.list_thumbnails,
 660         'playlist_items': opts.playlist_items,
 661         'xattr_set_filesize': opts.xattr_set_filesize,
 662         'match_filter': match_filter,
 663         'no_color': opts.no_color,
 664         'ffmpeg_location': opts.ffmpeg_location,
 665         'hls_prefer_native': opts.hls_prefer_native,
 666         'hls_use_mpegts': opts.hls_use_mpegts,
 667         'hls_split_discontinuity': opts.hls_split_discontinuity,
 668         'external_downloader_args': opts.external_downloader_args,
 669         'postprocessor_args': opts.postprocessor_args,
 670         'cn_verification_proxy': opts.cn_verification_proxy,
 671         'geo_verification_proxy': opts.geo_verification_proxy,
 672         'geo_bypass': opts.geo_bypass,
 673         'geo_bypass_country': opts.geo_bypass_country,
 674         'geo_bypass_ip_block': opts.geo_bypass_ip_block,
 675         'warnings': warnings,
 676         'compat_opts': compat_opts,
 677         # just for deprecation check
 678         'autonumber': opts.autonumber or None,
 679         'usetitle': opts.usetitle or None,
 680         'useid': opts.useid or None,
 681     }
 682
 683     with YoutubeDL(ydl_opts) as ydl:
 684         actual_use = len(all_urls) or opts.load_info_filename
 685
 686         # Remove cache dir
 687         if opts.rm_cachedir:
 688             ydl.cache.remove()
 689
 690         # Update version
 691         if opts.update_self:
 692             # If updater returns True, exit. Required for windows
 693             if run_update(ydl):
 694                 if actual_use:
 695                     sys.exit('ERROR: The program must exit for the update to complete')
 696                 sys.exit()
 697
 698         # Maybe do nothing
 699         if not actual_use:
 700             if opts.update_self or opts.rm_cachedir:
 701                 sys.exit()
 702
 703             ydl.warn_if_short_id(sys.argv[1:] if argv is None else argv)
 704             parser.error(
 705                 'You must provide at least one URL.\n'
 706                 'Type yt-dlp --help to see a list of all options.')
 707
 708         try:
 709             if opts.load_info_filename is not None:
 710                 retcode = ydl.download_with_info_file(expand_path(opts.load_info_filename))
 711             else:
 712                 retcode = ydl.download(all_urls)
 713         except (MaxDownloadsReached, ExistingVideoReached, RejectedVideoReached):
 714             ydl.to_screen('Aborting remaining downloads')
 715             retcode = 101
 716
 717     sys.exit(retcode)
 718
 719
 720 def main(argv=None):
 721     try:
 722         _real_main(argv)
 723     except DownloadError:
 724         sys.exit(1)
 725     except SameFileError:
 726         sys.exit('ERROR: fixed output name but more than one file to download')
 727     except KeyboardInterrupt:
 728         sys.exit('\nERROR: Interrupted by user')
 729     except BrokenPipeError:
 730         # https://docs.python.org/3/library/signal.html#note-on-sigpipe
 731         devnull = os.open(os.devnull, os.O_WRONLY)
 732         os.dup2(devnull, sys.stdout.fileno())
 733         sys.exit(r'\nERROR: {err}')
 734
 735
 736 __all__ = ['main', 'YoutubeDL', 'gen_extractors', 'list_extractors']