1 from __future__ import unicode_literals
17 from .version import __version__
20 def parseOpts(overrideArguments=None):
21 def _readOptions(filename_bytes, default=[]):
23 optionf = open(filename_bytes)
25 return default # silently skip if file is not present
29 res += shlex.split(l, comments=True)
35 xdg_config_home = compat_getenv('XDG_CONFIG_HOME')
37 userConfFile = os.path.join(xdg_config_home, 'youtube-dl', 'config')
38 if not os.path.isfile(userConfFile):
39 userConfFile = os.path.join(xdg_config_home, 'youtube-dl.conf')
41 userConfFile = os.path.join(compat_expanduser('~'), '.config', 'youtube-dl', 'config')
42 if not os.path.isfile(userConfFile):
43 userConfFile = os.path.join(compat_expanduser('~'), '.config', 'youtube-dl.conf')
44 userConf = _readOptions(userConfFile, None)
47 appdata_dir = compat_getenv('appdata')
49 userConf = _readOptions(
50 os.path.join(appdata_dir, 'youtube-dl', 'config'),
53 userConf = _readOptions(
54 os.path.join(appdata_dir, 'youtube-dl', 'config.txt'),
58 userConf = _readOptions(
59 os.path.join(compat_expanduser('~'), 'youtube-dl.conf'),
62 userConf = _readOptions(
63 os.path.join(compat_expanduser('~'), 'youtube-dl.conf.txt'),
71 def _format_option_string(option):
72 ''' ('-o', '--option') -> -o, --format METAVAR'''
76 if option._short_opts:
77 opts.append(option._short_opts[0])
79 opts.append(option._long_opts[0])
83 if option.takes_value():
84 opts.append(' %s' % option.metavar)
88 def _comma_separated_values_options_callback(option, opt_str, value, parser):
89 setattr(parser.values, option.dest, value.split(','))
91 def _hide_login_info(opts):
93 for private_opt in ['-p', '--password', '-u', '--username', '--video-password']:
95 i = opts.index(private_opt)
96 opts[i + 1] = 'PRIVATE'
101 # No need to wrap help messages if we're on a wide console
102 columns = get_term_width()
103 max_width = columns if columns else 80
104 max_help_position = 80
106 fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position)
107 fmt.format_option_strings = _format_option_string
110 'version': __version__,
112 'usage': '%prog [options] url [url...]',
113 'conflict_handler': 'resolve',
116 parser = optparse.OptionParser(**compat_kwargs(kw))
118 general = optparse.OptionGroup(parser, 'General Options')
122 help='print this help text and exit')
126 help='print program version and exit')
129 action='store_true', dest='update_self',
130 help='update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
132 '-i', '--ignore-errors',
133 action='store_true', dest='ignoreerrors', default=False,
134 help='continue on download errors, for example to skip unavailable videos in a playlist')
137 action='store_false', dest='ignoreerrors',
138 help='Abort downloading of further videos (in the playlist or the command line) if an error occurs')
141 action='store_true', dest='dump_user_agent', default=False,
142 help='display the current browser identification')
145 action='store_true', dest='list_extractors', default=False,
146 help='List all supported extractors and the URLs they would handle')
148 '--extractor-descriptions',
149 action='store_true', dest='list_extractor_descriptions', default=False,
150 help='Output descriptions of all supported extractors')
152 '--proxy', dest='proxy',
153 default=None, metavar='URL',
154 help='Use the specified HTTP/HTTPS proxy. Pass in an empty string (--proxy "") for direct connection')
157 dest='socket_timeout', type=float, default=None,
158 help='Time to wait before giving up, in seconds')
161 dest='default_search', metavar='PREFIX',
162 help='Use this prefix for unqualified URLs. For example "gvsearch2:" downloads two videos from google videos for youtube-dl "large apple". Use the value "auto" to let youtube-dl guess ("auto_warning" to emit a warning when guessing). "error" just throws an error. The default value "fixup_error" repairs broken URLs, but emits an error if this is not possible instead of searching.')
166 help='Do not read configuration files. '
167 'When given in the global configuration file /etc/youtube-dl.conf: '
168 'Do not read the user configuration in ~/.config/youtube-dl/config '
169 '(%APPDATA%/youtube-dl/config.txt on Windows)')
172 action='store_const', dest='extract_flat', const='in_playlist',
174 help='Do not extract the videos of a playlist, only list them.')
176 selection = optparse.OptionGroup(parser, 'Video Selection')
177 selection.add_option(
179 dest='playliststart', metavar='NUMBER', default=1, type=int,
180 help='playlist video to start at (default is %default)')
181 selection.add_option(
183 dest='playlistend', metavar='NUMBER', default=None, type=int,
184 help='playlist video to end at (default is last)')
185 selection.add_option(
187 dest='matchtitle', metavar='REGEX',
188 help='download only matching titles (regex or caseless sub-string)')
189 selection.add_option(
191 dest='rejecttitle', metavar='REGEX',
192 help='skip download for matching titles (regex or caseless sub-string)')
193 selection.add_option(
195 dest='max_downloads', metavar='NUMBER', type=int, default=None,
196 help='Abort after downloading NUMBER files')
197 selection.add_option(
199 metavar='SIZE', dest='min_filesize', default=None,
200 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
201 selection.add_option(
203 metavar='SIZE', dest='max_filesize', default=None,
204 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
205 selection.add_option(
207 metavar='DATE', dest='date', default=None,
208 help='download only videos uploaded in this date')
209 selection.add_option(
211 metavar='DATE', dest='datebefore', default=None,
212 help='download only videos uploaded on or before this date (i.e. inclusive)')
213 selection.add_option(
215 metavar='DATE', dest='dateafter', default=None,
216 help='download only videos uploaded on or after this date (i.e. inclusive)')
217 selection.add_option(
219 metavar='COUNT', dest='min_views', default=None, type=int,
220 help='Do not download any videos with less than COUNT views',)
221 selection.add_option(
223 metavar='COUNT', dest='max_views', default=None, type=int,
224 help='Do not download any videos with more than COUNT views')
225 selection.add_option(
227 action='store_true', dest='noplaylist', default=False,
228 help='If the URL refers to a video and a playlist, download only the video.')
229 selection.add_option(
231 metavar='YEARS', dest='age_limit', default=None, type=int,
232 help='download only videos suitable for the given age')
233 selection.add_option(
234 '--download-archive', metavar='FILE',
235 dest='download_archive',
236 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.')
237 selection.add_option(
239 dest='include_ads', action='store_true',
240 help='Download advertisements as well (experimental)')
242 authentication = optparse.OptionGroup(parser, 'Authentication Options')
243 authentication.add_option(
245 dest='username', metavar='USERNAME',
246 help='login with this account ID')
247 authentication.add_option(
249 dest='password', metavar='PASSWORD',
250 help='account password')
251 authentication.add_option(
253 dest='twofactor', metavar='TWOFACTOR',
254 help='two-factor auth code')
255 authentication.add_option(
257 action='store_true', dest='usenetrc', default=False,
258 help='use .netrc authentication data')
259 authentication.add_option(
261 dest='videopassword', metavar='PASSWORD',
262 help='video password (vimeo, smotri)')
264 video_format = optparse.OptionGroup(parser, 'Video Format Options')
265 video_format.add_option(
267 action='store', dest='format', metavar='FORMAT', default=None,
269 'video format code, specify the order of preference using'
270 ' slashes: -f 22/17/18 . -f mp4 , -f m4a and -f flv are also'
271 ' supported. You can also use the special names "best",'
272 ' "bestvideo", "bestaudio", "worst", "worstvideo" and'
273 ' "worstaudio". By default, youtube-dl will pick the best quality.'
274 ' Use commas to download multiple audio formats, such as'
275 ' -f 136/137/mp4/bestvideo,140/m4a/bestaudio.'
276 ' You can merge the video and audio of two formats into a single'
277 ' file using -f <video-format>+<audio-format> (requires ffmpeg or'
278 ' avconv), for example -f bestvideo+bestaudio.'))
279 video_format.add_option(
281 action='store_const', dest='format', const='all',
282 help='download all available video formats')
283 video_format.add_option(
284 '--prefer-free-formats',
285 action='store_true', dest='prefer_free_formats', default=False,
286 help='prefer free video formats unless a specific one is requested')
287 video_format.add_option(
289 action='store', dest='format_limit', metavar='FORMAT',
290 help='highest quality format to download')
291 video_format.add_option(
292 '-F', '--list-formats',
293 action='store_true', dest='listformats',
294 help='list all available formats')
295 video_format.add_option(
296 '--youtube-include-dash-manifest',
297 action='store_true', dest='youtube_include_dash_manifest', default=True,
298 help=optparse.SUPPRESS_HELP)
299 video_format.add_option(
300 '--youtube-skip-dash-manifest',
301 action='store_false', dest='youtube_include_dash_manifest',
302 help='Do not download the DASH manifest on YouTube videos')
304 subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
305 subtitles.add_option(
306 '--write-sub', '--write-srt',
307 action='store_true', dest='writesubtitles', default=False,
308 help='write subtitle file')
309 subtitles.add_option(
310 '--write-auto-sub', '--write-automatic-sub',
311 action='store_true', dest='writeautomaticsub', default=False,
312 help='write automatic subtitle file (youtube only)')
313 subtitles.add_option(
315 action='store_true', dest='allsubtitles', default=False,
316 help='downloads all the available subtitles of the video')
317 subtitles.add_option(
319 action='store_true', dest='listsubtitles', default=False,
320 help='lists all available subtitles for the video')
321 subtitles.add_option(
323 action='store', dest='subtitlesformat', metavar='FORMAT', default='srt',
324 help='subtitle format (default=srt) ([sbv/vtt] youtube only)')
325 subtitles.add_option(
326 '--sub-lang', '--sub-langs', '--srt-lang',
327 action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
328 default=[], callback=_comma_separated_values_options_callback,
329 help='languages of the subtitles to download (optional) separated by commas, use IETF language tags like \'en,pt\'')
331 downloader = optparse.OptionGroup(parser, 'Download Options')
332 downloader.add_option(
333 '-r', '--rate-limit',
334 dest='ratelimit', metavar='LIMIT',
335 help='maximum download rate in bytes per second (e.g. 50K or 4.2M)')
336 downloader.add_option(
338 dest='retries', metavar='RETRIES', default=10,
339 help='number of retries (default is %default)')
340 downloader.add_option(
342 dest='buffersize', metavar='SIZE', default='1024',
343 help='size of download buffer (e.g. 1024 or 16K) (default is %default)')
344 downloader.add_option(
345 '--no-resize-buffer',
346 action='store_true', dest='noresizebuffer', default=False,
347 help='do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.')
348 downloader.add_option(
350 action='store_true', dest='test', default=False,
351 help=optparse.SUPPRESS_HELP)
353 workarounds = optparse.OptionGroup(parser, 'Workarounds')
354 workarounds.add_option(
356 dest='encoding', metavar='ENCODING',
357 help='Force the specified encoding (experimental)')
358 workarounds.add_option(
359 '--no-check-certificate',
360 action='store_true', dest='no_check_certificate', default=False,
361 help='Suppress HTTPS certificate validation.')
362 workarounds.add_option(
364 '--prefer-unsecure', action='store_true', dest='prefer_insecure',
365 help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)')
366 workarounds.add_option(
368 metavar='UA', dest='user_agent',
369 help='specify a custom user agent')
370 workarounds.add_option(
372 metavar='URL', dest='referer', default=None,
373 help='specify a custom referer, use if the video access is restricted to one domain',
375 workarounds.add_option(
377 metavar='FIELD:VALUE', dest='headers', action='append',
378 help='specify a custom HTTP header and its value, separated by a colon \':\'. You can use this option multiple times',
380 workarounds.add_option(
382 dest='bidi_workaround', action='store_true',
383 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
385 verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
386 verbosity.add_option(
388 action='store_true', dest='quiet', default=False,
389 help='activates quiet mode')
390 verbosity.add_option(
392 dest='no_warnings', action='store_true', default=False,
393 help='Ignore warnings')
394 verbosity.add_option(
396 action='store_true', dest='simulate', default=False,
397 help='do not download the video and do not write anything to disk',)
398 verbosity.add_option(
400 action='store_true', dest='skip_download', default=False,
401 help='do not download the video',)
402 verbosity.add_option(
404 action='store_true', dest='geturl', default=False,
405 help='simulate, quiet but print URL')
406 verbosity.add_option(
408 action='store_true', dest='gettitle', default=False,
409 help='simulate, quiet but print title')
410 verbosity.add_option(
412 action='store_true', dest='getid', default=False,
413 help='simulate, quiet but print id')
414 verbosity.add_option(
416 action='store_true', dest='getthumbnail', default=False,
417 help='simulate, quiet but print thumbnail URL')
418 verbosity.add_option(
420 action='store_true', dest='getdescription', default=False,
421 help='simulate, quiet but print video description')
422 verbosity.add_option(
424 action='store_true', dest='getduration', default=False,
425 help='simulate, quiet but print video length')
426 verbosity.add_option(
428 action='store_true', dest='getfilename', default=False,
429 help='simulate, quiet but print output filename')
430 verbosity.add_option(
432 action='store_true', dest='getformat', default=False,
433 help='simulate, quiet but print output format')
434 verbosity.add_option(
436 action='store_true', dest='dumpjson', default=False,
437 help='simulate, quiet but print JSON information. See --output for a description of available keys.')
438 verbosity.add_option(
439 '-J', '--dump-single-json',
440 action='store_true', dest='dump_single_json', default=False,
441 help='simulate, quiet but print JSON information for each command-line argument. If the URL refers to a playlist, dump the whole playlist information in a single line.')
442 verbosity.add_option(
444 action='store_true', dest='progress_with_newline', default=False,
445 help='output progress bar as new lines')
446 verbosity.add_option(
448 action='store_true', dest='noprogress', default=False,
449 help='do not print progress bar')
450 verbosity.add_option(
452 action='store_true', dest='consoletitle', default=False,
453 help='display progress in console titlebar')
454 verbosity.add_option(
456 action='store_true', dest='verbose', default=False,
457 help='print various debugging information')
458 verbosity.add_option(
459 '--dump-intermediate-pages',
460 action='store_true', dest='dump_intermediate_pages', default=False,
461 help='print downloaded pages to debug problems (very verbose)')
462 verbosity.add_option(
464 action='store_true', dest='write_pages', default=False,
465 help='Write downloaded intermediary pages to files in the current directory to debug problems')
466 verbosity.add_option(
467 '--youtube-print-sig-code',
468 action='store_true', dest='youtube_print_sig_code', default=False,
469 help=optparse.SUPPRESS_HELP)
470 verbosity.add_option(
472 dest='debug_printtraffic', action='store_true', default=False,
473 help='Display sent and read HTTP traffic')
475 filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
476 filesystem.add_option(
477 '-a', '--batch-file',
478 dest='batchfile', metavar='FILE',
479 help='file containing URLs to download (\'-\' for stdin)')
480 filesystem.add_option(
481 '--id', default=False,
482 action='store_true', dest='useid', help='use only video ID in file name')
483 filesystem.add_option(
484 '-A', '--auto-number',
485 action='store_true', dest='autonumber', default=False,
486 help='number downloaded files starting from 00000')
487 filesystem.add_option(
489 dest='outtmpl', metavar='TEMPLATE',
490 help=('output filename template. Use %(title)s to get the title, '
491 '%(uploader)s for the uploader name, %(uploader_id)s for the uploader nickname if different, '
492 '%(autonumber)s to get an automatically incremented number, '
493 '%(ext)s for the filename extension, '
494 '%(format)s for the format description (like "22 - 1280x720" or "HD"), '
495 '%(format_id)s for the unique id of the format (like Youtube\'s itags: "137"), '
496 '%(upload_date)s for the upload date (YYYYMMDD), '
497 '%(extractor)s for the provider (youtube, metacafe, etc), '
498 '%(id)s for the video id, '
499 '%(playlist_title)s, %(playlist_id)s, or %(playlist)s (=title if present, ID otherwise) for the playlist the video is in, '
500 '%(playlist_index)s for the position in the playlist. '
501 '%(height)s and %(width)s for the width and height of the video format. '
502 '%(resolution)s for a textual description of the resolution of the video format. '
503 '%% for a literal percent. '
504 'Use - to output to stdout. Can also be used to download to a different directory, '
505 'for example with -o \'/my/downloads/%(uploader)s/%(title)s-%(id)s.%(ext)s\' .'))
506 filesystem.add_option(
508 dest='autonumber_size', metavar='NUMBER',
509 help='Specifies the number of digits in %(autonumber)s when it is present in output filename template or --auto-number option is given')
510 filesystem.add_option(
511 '--restrict-filenames',
512 action='store_true', dest='restrictfilenames', default=False,
513 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
514 filesystem.add_option(
516 action='store_true', dest='usetitle', default=False,
517 help='[deprecated] use title in file name (default)')
518 filesystem.add_option(
519 '-l', '--literal', default=False,
520 action='store_true', dest='usetitle',
521 help='[deprecated] alias of --title')
522 filesystem.add_option(
523 '-w', '--no-overwrites',
524 action='store_true', dest='nooverwrites', default=False,
525 help='do not overwrite files')
526 filesystem.add_option(
528 action='store_true', dest='continue_dl', default=True,
529 help='force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.')
530 filesystem.add_option(
532 action='store_false', dest='continue_dl',
533 help='do not resume partially downloaded files (restart from beginning)')
534 filesystem.add_option(
536 action='store_true', dest='nopart', default=False,
537 help='do not use .part files - write directly into output file')
538 filesystem.add_option(
540 action='store_false', dest='updatetime', default=True,
541 help='do not use the Last-modified header to set the file modification time')
542 filesystem.add_option(
543 '--write-description',
544 action='store_true', dest='writedescription', default=False,
545 help='write video description to a .description file')
546 filesystem.add_option(
548 action='store_true', dest='writeinfojson', default=False,
549 help='write video metadata to a .info.json file')
550 filesystem.add_option(
551 '--write-annotations',
552 action='store_true', dest='writeannotations', default=False,
553 help='write video annotations to a .annotation file')
554 filesystem.add_option(
556 action='store_true', dest='writethumbnail', default=False,
557 help='write thumbnail image to disk')
558 filesystem.add_option(
560 dest='load_info_filename', metavar='FILE',
561 help='json file containing the video information (created with the "--write-json" option)')
562 filesystem.add_option(
564 dest='cookiefile', metavar='FILE',
565 help='file to read cookies from and dump cookie jar in')
566 filesystem.add_option(
567 '--cache-dir', dest='cachedir', default=None, metavar='DIR',
568 help='Location in the filesystem where youtube-dl can store some downloaded information permanently. By default $XDG_CACHE_HOME/youtube-dl or ~/.cache/youtube-dl . At the moment, only YouTube player files (for videos with obfuscated signatures) are cached, but that may change.')
569 filesystem.add_option(
570 '--no-cache-dir', action='store_const', const=False, dest='cachedir',
571 help='Disable filesystem caching')
572 filesystem.add_option(
574 action='store_true', dest='rm_cachedir',
575 help='Delete all filesystem cache files')
577 postproc = optparse.OptionGroup(parser, 'Post-processing Options')
579 '-x', '--extract-audio',
580 action='store_true', dest='extractaudio', default=False,
581 help='convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)')
583 '--audio-format', metavar='FORMAT', dest='audioformat', default='best',
584 help='"best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; "%default" by default')
586 '--audio-quality', metavar='QUALITY',
587 dest='audioquality', default='5',
588 help='ffmpeg/avconv audio quality specification, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default %default)')
591 metavar='FORMAT', dest='recodevideo', default=None,
592 help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv)')
594 '-k', '--keep-video',
595 action='store_true', dest='keepvideo', default=False,
596 help='keeps the video file on disk after the post-processing; the video is erased by default')
598 '--no-post-overwrites',
599 action='store_true', dest='nopostoverwrites', default=False,
600 help='do not overwrite post-processed files; the post-processed files are overwritten by default')
603 action='store_true', dest='embedsubtitles', default=False,
604 help='embed subtitles in the video (only for mp4 videos)')
607 action='store_true', dest='embedthumbnail', default=False,
608 help='embed thumbnail in the audio as cover art')
611 action='store_true', dest='addmetadata', default=False,
612 help='write metadata to the video file')
615 action='store_true', dest='xattrs', default=False,
616 help='write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
619 action='store_false', dest='prefer_ffmpeg',
620 help='Prefer avconv over ffmpeg for running the postprocessors (default)')
623 action='store_true', dest='prefer_ffmpeg',
624 help='Prefer ffmpeg over avconv for running the postprocessors')
627 metavar='CMD', dest='exec_cmd',
628 help='Execute a command on the file after downloading, similar to find\'s -exec syntax. Example: --exec \'adb push {} /sdcard/Music/ && rm {}\'')
630 parser.add_option_group(general)
631 parser.add_option_group(selection)
632 parser.add_option_group(downloader)
633 parser.add_option_group(filesystem)
634 parser.add_option_group(verbosity)
635 parser.add_option_group(workarounds)
636 parser.add_option_group(video_format)
637 parser.add_option_group(subtitles)
638 parser.add_option_group(authentication)
639 parser.add_option_group(postproc)
641 if overrideArguments is not None:
642 opts, args = parser.parse_args(overrideArguments)
644 write_string('[debug] Override config: ' + repr(overrideArguments) + '\n')
646 commandLineConf = sys.argv[1:]
647 if '--ignore-config' in commandLineConf:
651 systemConf = _readOptions('/etc/youtube-dl.conf')
652 if '--ignore-config' in systemConf:
655 userConf = _readUserConf()
656 argv = systemConf + userConf + commandLineConf
658 opts, args = parser.parse_args(argv)
660 write_string('[debug] System config: ' + repr(_hide_login_info(systemConf)) + '\n')
661 write_string('[debug] User config: ' + repr(_hide_login_info(userConf)) + '\n')
662 write_string('[debug] Command-line args: ' + repr(_hide_login_info(commandLineConf)) + '\n')
664 return parser, opts, args