1 from __future__ import unicode_literals
12 from .version import __version__
15 def parseOpts(overrideArguments=None):
16 def _readOptions(filename_bytes, default=[]):
18 optionf = open(filename_bytes)
20 return default # silently skip if file is not present
24 res += shlex.split(l, comments=True)
30 xdg_config_home = os.environ.get('XDG_CONFIG_HOME')
32 userConfFile = os.path.join(xdg_config_home, 'youtube-dl', 'config')
33 if not os.path.isfile(userConfFile):
34 userConfFile = os.path.join(xdg_config_home, 'youtube-dl.conf')
36 userConfFile = os.path.join(os.path.expanduser('~'), '.config', 'youtube-dl', 'config')
37 if not os.path.isfile(userConfFile):
38 userConfFile = os.path.join(os.path.expanduser('~'), '.config', 'youtube-dl.conf')
39 userConf = _readOptions(userConfFile, None)
42 appdata_dir = os.environ.get('appdata')
44 userConf = _readOptions(
45 os.path.join(appdata_dir, 'youtube-dl', 'config'),
48 userConf = _readOptions(
49 os.path.join(appdata_dir, 'youtube-dl', 'config.txt'),
53 userConf = _readOptions(
54 os.path.join(os.path.expanduser('~'), 'youtube-dl.conf'),
57 userConf = _readOptions(
58 os.path.join(os.path.expanduser('~'), 'youtube-dl.conf.txt'),
66 def _format_option_string(option):
67 ''' ('-o', '--option') -> -o, --format METAVAR'''
71 if option._short_opts:
72 opts.append(option._short_opts[0])
74 opts.append(option._long_opts[0])
78 if option.takes_value():
79 opts.append(' %s' % option.metavar)
83 def _comma_separated_values_options_callback(option, opt_str, value, parser):
84 setattr(parser.values, option.dest, value.split(','))
86 def _hide_login_info(opts):
88 for private_opt in ['-p', '--password', '-u', '--username', '--video-password']:
90 i = opts.index(private_opt)
91 opts[i + 1] = 'PRIVATE'
96 # No need to wrap help messages if we're on a wide console
97 columns = get_term_width()
98 max_width = columns if columns else 80
99 max_help_position = 80
101 fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position)
102 fmt.format_option_strings = _format_option_string
105 'version': __version__,
107 'usage': '%prog [options] url [url...]',
108 'conflict_handler': 'resolve',
111 parser = optparse.OptionParser(**kw)
113 general = optparse.OptionGroup(parser, 'General Options')
117 help='print this help text and exit')
121 help='print program version and exit')
124 action='store_true', dest='update_self',
125 help='update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
127 '-i', '--ignore-errors',
128 action='store_true', dest='ignoreerrors', default=False,
129 help='continue on download errors, for example to skip unavailable videos in a playlist')
132 action='store_false', dest='ignoreerrors',
133 help='Abort downloading of further videos (in the playlist or the command line) if an error occurs')
136 action='store_true', dest='dump_user_agent', default=False,
137 help='display the current browser identification')
140 action='store_true', dest='list_extractors', default=False,
141 help='List all supported extractors and the URLs they would handle')
143 '--extractor-descriptions',
144 action='store_true', dest='list_extractor_descriptions', default=False,
145 help='Output descriptions of all supported extractors')
147 '--proxy', dest='proxy',
148 default=None, metavar='URL',
149 help='Use the specified HTTP/HTTPS proxy. Pass in an empty string (--proxy "") for direct connection')
152 dest='socket_timeout', type=float, default=None,
153 help='Time to wait before giving up, in seconds')
156 dest='default_search', metavar='PREFIX',
157 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.')
161 help='Do not read configuration files. When given in the global configuration file /etc/youtube-dl.conf: do not read the user configuration in ~/.config/youtube-dl.conf (%APPDATA%/youtube-dl/config.txt on Windows)')
163 selection = optparse.OptionGroup(parser, 'Video Selection')
164 selection.add_option(
166 dest='playliststart', metavar='NUMBER', default=1, type=int,
167 help='playlist video to start at (default is %default)')
168 selection.add_option(
170 dest='playlistend', metavar='NUMBER', default=None, type=int,
171 help='playlist video to end at (default is last)')
172 selection.add_option(
174 dest='matchtitle', metavar='REGEX',
175 help='download only matching titles (regex or caseless sub-string)')
176 selection.add_option(
178 dest='rejecttitle', metavar='REGEX',
179 help='skip download for matching titles (regex or caseless sub-string)')
180 selection.add_option(
182 dest='max_downloads', metavar='NUMBER', type=int, default=None,
183 help='Abort after downloading NUMBER files')
184 selection.add_option(
186 metavar='SIZE', dest='min_filesize', default=None,
187 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
188 selection.add_option(
190 metavar='SIZE', dest='max_filesize', default=None,
191 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
192 selection.add_option(
194 metavar='DATE', dest='date', default=None,
195 help='download only videos uploaded in this date')
196 selection.add_option(
198 metavar='DATE', dest='datebefore', default=None,
199 help='download only videos uploaded on or before this date (i.e. inclusive)')
200 selection.add_option(
202 metavar='DATE', dest='dateafter', default=None,
203 help='download only videos uploaded on or after this date (i.e. inclusive)')
204 selection.add_option(
206 metavar='COUNT', dest='min_views', default=None, type=int,
207 help='Do not download any videos with less than COUNT views',)
208 selection.add_option(
210 metavar='COUNT', dest='max_views', default=None, type=int,
211 help='Do not download any videos with more than COUNT views')
212 selection.add_option(
214 action='store_true', dest='noplaylist', default=False,
215 help='download only the currently playing video')
216 selection.add_option(
218 metavar='YEARS', dest='age_limit', default=None, type=int,
219 help='download only videos suitable for the given age')
220 selection.add_option(
221 '--download-archive', metavar='FILE',
222 dest='download_archive',
223 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.')
224 selection.add_option(
226 dest='include_ads', action='store_true',
227 help='Download advertisements as well (experimental)')
228 selection.add_option(
229 '--youtube-include-dash-manifest',
230 action='store_true', dest='youtube_include_dash_manifest', default=False,
231 help='Try to download the DASH manifest on YouTube videos (experimental)')
233 authentication = optparse.OptionGroup(parser, 'Authentication Options')
234 authentication.add_option(
236 dest='username', metavar='USERNAME',
237 help='login with this account ID')
238 authentication.add_option(
240 dest='password', metavar='PASSWORD',
241 help='account password')
242 authentication.add_option(
244 dest='twofactor', metavar='TWOFACTOR',
245 help='two-factor auth code')
246 authentication.add_option(
248 action='store_true', dest='usenetrc', default=False,
249 help='use .netrc authentication data')
250 authentication.add_option(
252 dest='videopassword', metavar='PASSWORD',
253 help='video password (vimeo, smotri)')
255 video_format = optparse.OptionGroup(parser, 'Video Format Options')
256 video_format.add_option(
258 action='store', dest='format', metavar='FORMAT', default=None,
259 help='video format code, specify the order of preference using slashes: -f 22/17/18 . -f mp4 , -f m4a and -f flv are also supported. You can also use the special names "best", "bestvideo", "bestaudio", "worst", "worstvideo" and "worstaudio". By default, youtube-dl will pick the best quality. Use commas to download multiple audio formats, such as -f 136/137/mp4/bestvideo,140/m4a/bestaudio')
260 video_format.add_option(
262 action='store_const', dest='format', const='all',
263 help='download all available video formats')
264 video_format.add_option(
265 '--prefer-free-formats',
266 action='store_true', dest='prefer_free_formats', default=False,
267 help='prefer free video formats unless a specific one is requested')
268 video_format.add_option(
270 action='store', dest='format_limit', metavar='FORMAT',
271 help='highest quality format to download')
272 video_format.add_option(
273 '-F', '--list-formats',
274 action='store_true', dest='listformats',
275 help='list all available formats')
277 subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
278 subtitles.add_option(
279 '--write-sub', '--write-srt',
280 action='store_true', dest='writesubtitles', default=False,
281 help='write subtitle file')
282 subtitles.add_option(
283 '--write-auto-sub', '--write-automatic-sub',
284 action='store_true', dest='writeautomaticsub', default=False,
285 help='write automatic subtitle file (youtube only)')
286 subtitles.add_option(
288 action='store_true', dest='allsubtitles', default=False,
289 help='downloads all the available subtitles of the video')
290 subtitles.add_option(
292 action='store_true', dest='listsubtitles', default=False,
293 help='lists all available subtitles for the video')
294 subtitles.add_option(
296 action='store', dest='subtitlesformat', metavar='FORMAT', default='srt',
297 help='subtitle format (default=srt) ([sbv/vtt] youtube only)')
298 subtitles.add_option(
299 '--sub-lang', '--sub-langs', '--srt-lang',
300 action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
301 default=[], callback=_comma_separated_values_options_callback,
302 help='languages of the subtitles to download (optional) separated by commas, use IETF language tags like \'en,pt\'')
304 downloader = optparse.OptionGroup(parser, 'Download Options')
305 downloader.add_option(
306 '-r', '--rate-limit',
307 dest='ratelimit', metavar='LIMIT',
308 help='maximum download rate in bytes per second (e.g. 50K or 4.2M)')
309 downloader.add_option(
311 dest='retries', metavar='RETRIES', default=10,
312 help='number of retries (default is %default)')
313 downloader.add_option(
315 dest='buffersize', metavar='SIZE', default='1024',
316 help='size of download buffer (e.g. 1024 or 16K) (default is %default)')
317 downloader.add_option(
318 '--no-resize-buffer',
319 action='store_true', dest='noresizebuffer', default=False,
320 help='do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.')
321 downloader.add_option(
323 action='store_true', dest='test', default=False,
324 help=optparse.SUPPRESS_HELP)
326 workarounds = optparse.OptionGroup(parser, 'Workarounds')
327 workarounds.add_option(
329 dest='encoding', metavar='ENCODING',
330 help='Force the specified encoding (experimental)')
331 workarounds.add_option(
332 '--no-check-certificate',
333 action='store_true', dest='no_check_certificate', default=False,
334 help='Suppress HTTPS certificate validation.')
335 workarounds.add_option(
337 '--prefer-unsecure', action='store_true', dest='prefer_insecure',
338 help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)')
339 workarounds.add_option(
341 metavar='UA', dest='user_agent',
342 help='specify a custom user agent')
343 workarounds.add_option(
345 metavar='URL', dest='referer', default=None,
346 help='specify a custom referer, use if the video access is restricted to one domain',
348 workarounds.add_option(
350 metavar='FIELD:VALUE', dest='headers', action='append',
351 help='specify a custom HTTP header and its value, separated by a colon \':\'. You can use this option multiple times',
353 workarounds.add_option(
355 dest='bidi_workaround', action='store_true',
356 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
358 verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
359 verbosity.add_option(
361 action='store_true', dest='quiet', default=False,
362 help='activates quiet mode')
363 verbosity.add_option(
365 dest='no_warnings', action='store_true', default=False,
366 help='Ignore warnings')
367 verbosity.add_option(
369 action='store_true', dest='simulate', default=False,
370 help='do not download the video and do not write anything to disk',)
371 verbosity.add_option(
373 action='store_true', dest='skip_download', default=False,
374 help='do not download the video',)
375 verbosity.add_option(
377 action='store_true', dest='geturl', default=False,
378 help='simulate, quiet but print URL')
379 verbosity.add_option(
381 action='store_true', dest='gettitle', default=False,
382 help='simulate, quiet but print title')
383 verbosity.add_option(
385 action='store_true', dest='getid', default=False,
386 help='simulate, quiet but print id')
387 verbosity.add_option(
389 action='store_true', dest='getthumbnail', default=False,
390 help='simulate, quiet but print thumbnail URL')
391 verbosity.add_option(
393 action='store_true', dest='getdescription', default=False,
394 help='simulate, quiet but print video description')
395 verbosity.add_option(
397 action='store_true', dest='getduration', default=False,
398 help='simulate, quiet but print video length')
399 verbosity.add_option(
401 action='store_true', dest='getfilename', default=False,
402 help='simulate, quiet but print output filename')
403 verbosity.add_option(
405 action='store_true', dest='getformat', default=False,
406 help='simulate, quiet but print output format')
407 verbosity.add_option(
409 action='store_true', dest='dumpjson', default=False,
410 help='simulate, quiet but print JSON information. See --output for a description of available keys.')
411 verbosity.add_option(
413 action='store_true', dest='progress_with_newline', default=False,
414 help='output progress bar as new lines')
415 verbosity.add_option(
417 action='store_true', dest='noprogress', default=False,
418 help='do not print progress bar')
419 verbosity.add_option(
421 action='store_true', dest='consoletitle', default=False,
422 help='display progress in console titlebar')
423 verbosity.add_option(
425 action='store_true', dest='verbose', default=False,
426 help='print various debugging information')
427 verbosity.add_option(
428 '--dump-intermediate-pages',
429 action='store_true', dest='dump_intermediate_pages', default=False,
430 help='print downloaded pages to debug problems (very verbose)')
431 verbosity.add_option(
433 action='store_true', dest='write_pages', default=False,
434 help='Write downloaded intermediary pages to files in the current directory to debug problems')
435 verbosity.add_option(
436 '--youtube-print-sig-code',
437 action='store_true', dest='youtube_print_sig_code', default=False,
438 help=optparse.SUPPRESS_HELP)
439 verbosity.add_option(
441 dest='debug_printtraffic', action='store_true', default=False,
442 help='Display sent and read HTTP traffic')
444 filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
445 filesystem.add_option(
446 '-a', '--batch-file',
447 dest='batchfile', metavar='FILE',
448 help='file containing URLs to download (\'-\' for stdin)')
449 filesystem.add_option(
450 '--id', default=False,
451 action='store_true', dest='useid', help='use only video ID in file name')
452 filesystem.add_option(
453 '-A', '--auto-number',
454 action='store_true', dest='autonumber', default=False,
455 help='number downloaded files starting from 00000')
456 filesystem.add_option(
458 dest='outtmpl', metavar='TEMPLATE',
459 help=('output filename template. Use %(title)s to get the title, '
460 '%(uploader)s for the uploader name, %(uploader_id)s for the uploader nickname if different, '
461 '%(autonumber)s to get an automatically incremented number, '
462 '%(ext)s for the filename extension, '
463 '%(format)s for the format description (like "22 - 1280x720" or "HD"), '
464 '%(format_id)s for the unique id of the format (like Youtube\'s itags: "137"), '
465 '%(upload_date)s for the upload date (YYYYMMDD), '
466 '%(extractor)s for the provider (youtube, metacafe, etc), '
467 '%(id)s for the video id, %(playlist)s for the playlist the video is in, '
468 '%(playlist_index)s for the position in the playlist and %% for a literal percent. '
469 '%(height)s and %(width)s for the width and height of the video format. '
470 '%(resolution)s for a textual description of the resolution of the video format. '
471 'Use - to output to stdout. Can also be used to download to a different directory, '
472 'for example with -o \'/my/downloads/%(uploader)s/%(title)s-%(id)s.%(ext)s\' .'))
473 filesystem.add_option(
475 dest='autonumber_size', metavar='NUMBER',
476 help='Specifies the number of digits in %(autonumber)s when it is present in output filename template or --auto-number option is given')
477 filesystem.add_option(
478 '--restrict-filenames',
479 action='store_true', dest='restrictfilenames', default=False,
480 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
481 filesystem.add_option(
483 action='store_true', dest='usetitle', default=False,
484 help='[deprecated] use title in file name (default)')
485 filesystem.add_option(
486 '-l', '--literal', default=False,
487 action='store_true', dest='usetitle',
488 help='[deprecated] alias of --title')
489 filesystem.add_option(
490 '-w', '--no-overwrites',
491 action='store_true', dest='nooverwrites', default=False,
492 help='do not overwrite files')
493 filesystem.add_option(
495 action='store_true', dest='continue_dl', default=True,
496 help='force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.')
497 filesystem.add_option(
499 action='store_false', dest='continue_dl',
500 help='do not resume partially downloaded files (restart from beginning)')
501 filesystem.add_option(
503 action='store_true', dest='nopart', default=False,
504 help='do not use .part files - write directly into output file')
505 filesystem.add_option(
507 action='store_false', dest='updatetime', default=True,
508 help='do not use the Last-modified header to set the file modification time')
509 filesystem.add_option(
510 '--write-description',
511 action='store_true', dest='writedescription', default=False,
512 help='write video description to a .description file')
513 filesystem.add_option(
515 action='store_true', dest='writeinfojson', default=False,
516 help='write video metadata to a .info.json file')
517 filesystem.add_option(
518 '--write-annotations',
519 action='store_true', dest='writeannotations', default=False,
520 help='write video annotations to a .annotation file')
521 filesystem.add_option(
523 action='store_true', dest='writethumbnail', default=False,
524 help='write thumbnail image to disk')
525 filesystem.add_option(
527 dest='load_info_filename', metavar='FILE',
528 help='json file containing the video information (created with the "--write-json" option)')
529 filesystem.add_option(
531 dest='cookiefile', metavar='FILE',
532 help='file to read cookies from and dump cookie jar in')
533 filesystem.add_option(
534 '--cache-dir', dest='cachedir', default=None, metavar='DIR',
535 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.')
536 filesystem.add_option(
537 '--no-cache-dir', action='store_const', const=False, dest='cachedir',
538 help='Disable filesystem caching')
539 filesystem.add_option(
541 action='store_true', dest='rm_cachedir',
542 help='Delete all filesystem cache files')
544 postproc = optparse.OptionGroup(parser, 'Post-processing Options')
546 '-x', '--extract-audio',
547 action='store_true', dest='extractaudio', default=False,
548 help='convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)')
550 '--audio-format', metavar='FORMAT', dest='audioformat', default='best',
551 help='"best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; "%default" by default')
553 '--audio-quality', metavar='QUALITY',
554 dest='audioquality', default='5',
555 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)')
558 metavar='FORMAT', dest='recodevideo', default=None,
559 help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv)')
561 '-k', '--keep-video',
562 action='store_true', dest='keepvideo', default=False,
563 help='keeps the video file on disk after the post-processing; the video is erased by default')
565 '--no-post-overwrites',
566 action='store_true', dest='nopostoverwrites', default=False,
567 help='do not overwrite post-processed files; the post-processed files are overwritten by default')
570 action='store_true', dest='embedsubtitles', default=False,
571 help='embed subtitles in the video (only for mp4 videos)')
574 action='store_true', dest='embedthumbnail', default=False,
575 help='embed thumbnail in the audio as cover art')
578 action='store_true', dest='addmetadata', default=False,
579 help='write metadata to the video file')
582 action='store_true', dest='xattrs', default=False,
583 help='write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
586 action='store_false', dest='prefer_ffmpeg',
587 help='Prefer avconv over ffmpeg for running the postprocessors (default)')
590 action='store_true', dest='prefer_ffmpeg',
591 help='Prefer ffmpeg over avconv for running the postprocessors')
594 metavar='CMD', dest='exec_cmd',
595 help='Execute a command on the file after downloading, similar to find\'s -exec syntax. Example: --exec \'adb push {} /sdcard/Music/ && rm {}\'' )
597 parser.add_option_group(general)
598 parser.add_option_group(selection)
599 parser.add_option_group(downloader)
600 parser.add_option_group(filesystem)
601 parser.add_option_group(verbosity)
602 parser.add_option_group(workarounds)
603 parser.add_option_group(video_format)
604 parser.add_option_group(subtitles)
605 parser.add_option_group(authentication)
606 parser.add_option_group(postproc)
608 if overrideArguments is not None:
609 opts, args = parser.parse_args(overrideArguments)
611 write_string('[debug] Override config: ' + repr(overrideArguments) + '\n')
613 commandLineConf = sys.argv[1:]
614 if '--ignore-config' in commandLineConf:
618 systemConf = _readOptions('/etc/youtube-dl.conf')
619 if '--ignore-config' in systemConf:
622 userConf = _readUserConf()
623 argv = systemConf + userConf + commandLineConf
625 opts, args = parser.parse_args(argv)
627 write_string('[debug] System config: ' + repr(_hide_login_info(systemConf)) + '\n')
628 write_string('[debug] User config: ' + repr(_hide_login_info(userConf)) + '\n')
629 write_string('[debug] Command-line args: ' + repr(_hide_login_info(commandLineConf)) + '\n')
631 return parser, opts, args