Cool_Tools/yt-dlp
1
0
Fork 0
mirror of https://github.com/yt-dlp/yt-dlp.git synced 2024-11-28 09:31:01 +01:00
Code Issues Packages Projects Releases Wiki Activity

[options] Consistent formatting and general niceness

Browse Source
This commit is contained in:
Philipp Hagemeister 2014-10-12 23:10:11 +02:00
parent b88b45e46c
commit 8450c15c25
1 changed files with 428 additions and 278 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

602
youtube_dl/options.py
View File

@ -75,7 +75,8 @@ def _format_option_string(option):
if len(opts) > 1: if len(opts) > 1:
opts.insert(1, ', ') opts.insert(1, ', ')
if option.takes_value(): opts.append(' %s' % option.metavar) if option.takes_value():
opts.append(' %s' % option.metavar)
return "".join(opts) return "".join(opts)
@ -92,12 +93,10 @@ def _hide_login_info(opts):
pass pass
return opts return opts
max_width = 80
max_help_position = 80
# No need to wrap help messages if we're on a wide console # No need to wrap help messages if we're on a wide console
columns = get_term_width() columns = get_term_width()
if columns: max_width = columns max_width = columns if columns else 80
max_help_position = 80
fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position) fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position)
fmt.format_option_strings = _format_option_string fmt.format_option_strings = _format_option_string
@ -111,44 +110,47 @@ def _hide_login_info(opts):
parser = optparse.OptionParser(**kw) parser = optparse.OptionParser(**kw)
# option groups
general = optparse.OptionGroup(parser, 'General Options') general = optparse.OptionGroup(parser, 'General Options')
selection = optparse.OptionGroup(parser, 'Video Selection') general.add_option(
authentication = optparse.OptionGroup(parser, 'Authentication Options') '-h', '--help',
video_format = optparse.OptionGroup(parser, 'Video Format Options') action='help',
subtitles = optparse.OptionGroup(parser, 'Subtitle Options') help='print this help text and exit')
downloader = optparse.OptionGroup(parser, 'Download Options') general.add_option(
postproc = optparse.OptionGroup(parser, 'Post-processing Options') '-v', '--version',
filesystem = optparse.OptionGroup(parser, 'Filesystem Options') action='version',
workarounds = optparse.OptionGroup(parser, 'Workarounds') help='print program version and exit')
verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options') general.add_option(
'-U', '--update',
general.add_option('-h', '--help', action='store_true', dest='update_self',
action='help', help='print this help text and exit') help='update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
general.add_option('-v', '--version', general.add_option(
action='version', help='print program version and exit') '-i', '--ignore-errors',
general.add_option('-U', '--update', action='store_true', dest='ignoreerrors', default=False,
action='store_true', dest='update_self', help='update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)') help='continue on download errors, for example to skip unavailable videos in a playlist')
general.add_option('-i', '--ignore-errors', general.add_option(
action='store_true', dest='ignoreerrors', help='continue on download errors, for example to skip unavailable videos in a playlist', default=False) '--abort-on-error',
general.add_option('--abort-on-error',
action='store_false', dest='ignoreerrors', action='store_false', dest='ignoreerrors',
help='Abort downloading of further videos (in the playlist or the command line) if an error occurs') help='Abort downloading of further videos (in the playlist or the command line) if an error occurs')
general.add_option('--dump-user-agent',
action='store_true', dest='dump_user_agent',
help='display the current browser identification', default=False)
general.add_option('--list-extractors',
action='store_true', dest='list_extractors',
help='List all supported extractors and the URLs they would handle', default=False)
general.add_option('--extractor-descriptions',
action='store_true', dest='list_extractor_descriptions',
help='Output descriptions of all supported extractors', default=False)
general.add_option( general.add_option(
'--proxy', dest='proxy', default=None, metavar='URL', '--dump-user-agent',
action='store_true', dest='dump_user_agent', default=False,
help='display the current browser identification')
general.add_option(
'--list-extractors',
action='store_true', dest='list_extractors', default=False,
help='List all supported extractors and the URLs they would handle')
general.add_option(
'--extractor-descriptions',
action='store_true', dest='list_extractor_descriptions', default=False,
help='Output descriptions of all supported extractors')
general.add_option(
'--proxy', dest='proxy',
default=None, metavar='URL',
help='Use the specified HTTP/HTTPS proxy. Pass in an empty string (--proxy "") for direct connection') help='Use the specified HTTP/HTTPS proxy. Pass in an empty string (--proxy "") for direct connection')
general.add_option( general.add_option(
'--socket-timeout', dest='socket_timeout', '--socket-timeout',
type=float, default=None, help=u'Time to wait before giving up, in seconds') dest='socket_timeout', type=float, default=None,
help='Time to wait before giving up, in seconds')
general.add_option( general.add_option(
'--default-search', '--default-search',
dest='default_search', metavar='PREFIX', dest='default_search', metavar='PREFIX',
@ -158,6 +160,7 @@ def _hide_login_info(opts):
action='store_true', action='store_true',
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)') 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)')
selection = optparse.OptionGroup(parser, 'Video Selection')
selection.add_option( selection.add_option(
'--playlist-start', '--playlist-start',
dest='playliststart', metavar='NUMBER', default=1, type=int, dest='playliststart', metavar='NUMBER', default=1, type=int,
@ -166,191 +169,292 @@ def _hide_login_info(opts):
'--playlist-end', '--playlist-end',
dest='playlistend', metavar='NUMBER', default=None, type=int, dest='playlistend', metavar='NUMBER', default=None, type=int,
help='playlist video to end at (default is last)') help='playlist video to end at (default is last)')
selection.add_option('--match-title', dest='matchtitle', metavar='REGEX',help='download only matching titles (regex or caseless sub-string)')
selection.add_option('--reject-title', dest='rejecttitle', metavar='REGEX',help='skip download for matching titles (regex or caseless sub-string)')
selection.add_option('--max-downloads', metavar='NUMBER',
dest='max_downloads', type=int, default=None,
help='Abort after downloading NUMBER files')
selection.add_option('--min-filesize', metavar='SIZE', dest='min_filesize', help="Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)", default=None)
selection.add_option('--max-filesize', metavar='SIZE', dest='max_filesize', help="Do not download any videos larger than SIZE (e.g. 50k or 44.6m)", default=None)
selection.add_option('--date', metavar='DATE', dest='date', help='download only videos uploaded in this date', default=None)
selection.add_option( selection.add_option(
'--datebefore', metavar='DATE', dest='datebefore', default=None, '--match-title',
dest='matchtitle', metavar='REGEX',
help='download only matching titles (regex or caseless sub-string)')
selection.add_option(
'--reject-title',
dest='rejecttitle', metavar='REGEX',
help='skip download for matching titles (regex or caseless sub-string)')
selection.add_option(
'--max-downloads',
dest='max_downloads', metavar='NUMBER', type=int, default=None,
help='Abort after downloading NUMBER files')
selection.add_option(
'--min-filesize',
metavar='SIZE', dest='min_filesize', default=None,
help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
selection.add_option(
'--max-filesize',
metavar='SIZE', dest='max_filesize', default=None,
help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
selection.add_option(
'--date',
metavar='DATE', dest='date', default=None,
help='download only videos uploaded in this date')
selection.add_option(
'--datebefore',
metavar='DATE', dest='datebefore', default=None,
help='download only videos uploaded on or before this date (i.e. inclusive)') help='download only videos uploaded on or before this date (i.e. inclusive)')
selection.add_option( selection.add_option(
'--dateafter', metavar='DATE', dest='dateafter', default=None, '--dateafter',
metavar='DATE', dest='dateafter', default=None,
help='download only videos uploaded on or after this date (i.e. inclusive)') help='download only videos uploaded on or after this date (i.e. inclusive)')
selection.add_option( selection.add_option(
'--min-views', metavar='COUNT', dest='min_views', '--min-views',
default=None, type=int, metavar='COUNT', dest='min_views', default=None, type=int,
help="Do not download any videos with less than COUNT views",) help='Do not download any videos with less than COUNT views',)
selection.add_option( selection.add_option(
'--max-views', metavar='COUNT', dest='max_views', '--max-views',
default=None, type=int, metavar='COUNT', dest='max_views', default=None, type=int,
help="Do not download any videos with more than COUNT views",) help='Do not download any videos with more than COUNT views')
selection.add_option('--no-playlist', action='store_true', dest='noplaylist', help='download only the currently playing video', default=False) selection.add_option(
selection.add_option('--age-limit', metavar='YEARS', dest='age_limit', '--no-playlist',
help='download only videos suitable for the given age', action='store_true', dest='noplaylist', default=False,
default=None, type=int) help='download only the currently playing video')
selection.add_option('--download-archive', metavar='FILE', selection.add_option(
'--age-limit',
metavar='YEARS', dest='age_limit', default=None, type=int,
help='download only videos suitable for the given age')
selection.add_option(
'--download-archive', metavar='FILE',
dest='download_archive', dest='download_archive',
help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.') help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.')
selection.add_option( selection.add_option(
'--include-ads', dest='include_ads', '--include-ads',
action='store_true', dest='include_ads', action='store_true',
help='Download advertisements as well (experimental)') help='Download advertisements as well (experimental)')
selection.add_option( selection.add_option(
'--youtube-include-dash-manifest', action='store_true', '--youtube-include-dash-manifest',
dest='youtube_include_dash_manifest', default=False, action='store_true', dest='youtube_include_dash_manifest', default=False,
help='Try to download the DASH manifest on YouTube videos (experimental)') help='Try to download the DASH manifest on YouTube videos (experimental)')
authentication.add_option('-u', '--username', authentication = optparse.OptionGroup(parser, 'Authentication Options')
dest='username', metavar='USERNAME', help='login with this account ID') authentication.add_option(
authentication.add_option('-p', '--password', '-u', '--username',
dest='password', metavar='PASSWORD', help='account password') dest='username', metavar='USERNAME',
authentication.add_option('-2', '--twofactor', help='login with this account ID')
dest='twofactor', metavar='TWOFACTOR', help='two-factor auth code') authentication.add_option(
authentication.add_option('-n', '--netrc', '-p', '--password',
action='store_true', dest='usenetrc', help='use .netrc authentication data', default=False) dest='password', metavar='PASSWORD',
authentication.add_option('--video-password', help='account password')
dest='videopassword', metavar='PASSWORD', help='video password (vimeo, smotri)') authentication.add_option(
'-2', '--twofactor',
dest='twofactor', metavar='TWOFACTOR',
help='two-factor auth code')
authentication.add_option(
'-n', '--netrc',
action='store_true', dest='usenetrc', default=False,
help='use .netrc authentication data')
authentication.add_option(
'--video-password',
dest='videopassword', metavar='PASSWORD',
help='video password (vimeo, smotri)')
video_format = optparse.OptionGroup(parser, 'Video Format Options')
video_format.add_option('-f', '--format', video_format.add_option(
'-f', '--format',
action='store', dest='format', metavar='FORMAT', default=None, action='store', dest='format', metavar='FORMAT', default=None,
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') 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')
video_format.add_option('--all-formats', video_format.add_option(
action='store_const', dest='format', help='download all available video formats', const='all') '--all-formats',
video_format.add_option('--prefer-free-formats', action='store_const', dest='format', const='all',
action='store_true', dest='prefer_free_formats', default=False, help='prefer free video formats unless a specific one is requested') help='download all available video formats')
video_format.add_option('--max-quality', video_format.add_option(
action='store', dest='format_limit', metavar='FORMAT', help='highest quality format to download') '--prefer-free-formats',
video_format.add_option('-F', '--list-formats', action='store_true', dest='prefer_free_formats', default=False,
action='store_true', dest='listformats', help='list all available formats') help='prefer free video formats unless a specific one is requested')
video_format.add_option(
'--max-quality',
action='store', dest='format_limit', metavar='FORMAT',
help='highest quality format to download')
video_format.add_option(
'-F', '--list-formats',
action='store_true', dest='listformats',
help='list all available formats')
subtitles.add_option('--write-sub', '--write-srt', subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
action='store_true', dest='writesubtitles', subtitles.add_option(
help='write subtitle file', default=False) '--write-sub', '--write-srt',
subtitles.add_option('--write-auto-sub', '--write-automatic-sub', action='store_true', dest='writesubtitles', default=False,
action='store_true', dest='writeautomaticsub', help='write subtitle file')
help='write automatic subtitle file (youtube only)', default=False) subtitles.add_option(
subtitles.add_option('--all-subs', '--write-auto-sub', '--write-automatic-sub',
action='store_true', dest='allsubtitles', action='store_true', dest='writeautomaticsub', default=False,
help='downloads all the available subtitles of the video', default=False) help='write automatic subtitle file (youtube only)')
subtitles.add_option('--list-subs', subtitles.add_option(
action='store_true', dest='listsubtitles', '--all-subs',
help='lists all available subtitles for the video', default=False) action='store_true', dest='allsubtitles', default=False,
subtitles.add_option('--sub-format', help='downloads all the available subtitles of the video')
action='store', dest='subtitlesformat', metavar='FORMAT', subtitles.add_option(
help='subtitle format (default=srt) ([sbv/vtt] youtube only)', default='srt') '--list-subs',
subtitles.add_option('--sub-lang', '--sub-langs', '--srt-lang', action='store_true', dest='listsubtitles', default=False,
help='lists all available subtitles for the video')
subtitles.add_option(
'--sub-format',
action='store', dest='subtitlesformat', metavar='FORMAT', default='srt',
help='subtitle format (default=srt) ([sbv/vtt] youtube only)')
subtitles.add_option(
'--sub-lang', '--sub-langs', '--srt-lang',
action='callback', dest='subtitleslangs', metavar='LANGS', type='str', action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
default=[], callback=_comma_separated_values_options_callback, default=[], callback=_comma_separated_values_options_callback,
help='languages of the subtitles to download (optional) separated by commas, use IETF language tags like \'en,pt\'') help='languages of the subtitles to download (optional) separated by commas, use IETF language tags like \'en,pt\'')
downloader.add_option('-r', '--rate-limit', downloader = optparse.OptionGroup(parser, 'Download Options')
dest='ratelimit', metavar='LIMIT', help='maximum download rate in bytes per second (e.g. 50K or 4.2M)') downloader.add_option(
downloader.add_option('-R', '--retries', '-r', '--rate-limit',
dest='retries', metavar='RETRIES', help='number of retries (default is %default)', default=10) dest='ratelimit', metavar='LIMIT',
downloader.add_option('--buffer-size', help='maximum download rate in bytes per second (e.g. 50K or 4.2M)')
dest='buffersize', metavar='SIZE', help='size of download buffer (e.g. 1024 or 16K) (default is %default)', default="1024") downloader.add_option(
downloader.add_option('--no-resize-buffer', '-R', '--retries',
action='store_true', dest='noresizebuffer', dest='retries', metavar='RETRIES', default=10,
help='do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.', default=False) help='number of retries (default is %default)')
downloader.add_option('--test', action='store_true', dest='test', default=False, help=optparse.SUPPRESS_HELP) downloader.add_option(
'--buffer-size',
dest='buffersize', metavar='SIZE', default='1024',
help='size of download buffer (e.g. 1024 or 16K) (default is %default)')
downloader.add_option(
'--no-resize-buffer',
action='store_true', dest='noresizebuffer', default=False,
help='do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.')
downloader.add_option(
'--test',
action='store_true', dest='test', default=False,
help=optparse.SUPPRESS_HELP)
workarounds = optparse.OptionGroup(parser, 'Workarounds')
workarounds.add_option( workarounds.add_option(
'--encoding', dest='encoding', metavar='ENCODING', '--encoding',
dest='encoding', metavar='ENCODING',
help='Force the specified encoding (experimental)') help='Force the specified encoding (experimental)')
workarounds.add_option( workarounds.add_option(
'--no-check-certificate', action='store_true', '--no-check-certificate',
dest='no_check_certificate', default=False, action='store_true', dest='no_check_certificate', default=False,
help='Suppress HTTPS certificate validation.') help='Suppress HTTPS certificate validation.')
workarounds.add_option( workarounds.add_option(
'--prefer-insecure', '--prefer-unsecure', action='store_true', dest='prefer_insecure', '--prefer-insecure',
'--prefer-unsecure', action='store_true', dest='prefer_insecure',
help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)') help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)')
workarounds.add_option( workarounds.add_option(
'--user-agent', metavar='UA', '--user-agent',
dest='user_agent', help='specify a custom user agent') metavar='UA', dest='user_agent',
help='specify a custom user agent')
workarounds.add_option( workarounds.add_option(
'--referer', metavar='REF', '--referer',
dest='referer', default=None, metavar='URL', dest='referer', default=None,
help='specify a custom referer, use if the video access is restricted to one domain', help='specify a custom referer, use if the video access is restricted to one domain',
) )
workarounds.add_option( workarounds.add_option(
'--add-header', metavar='FIELD:VALUE', '--add-header',
dest='headers', action='append', metavar='FIELD:VALUE', dest='headers', action='append',
help='specify a custom HTTP header and its value, separated by a colon \':\'. You can use this option multiple times', help='specify a custom HTTP header and its value, separated by a colon \':\'. You can use this option multiple times',
) )
workarounds.add_option( workarounds.add_option(
'--bidi-workaround', dest='bidi_workaround', action='store_true', '--bidi-workaround',
help=u'Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH') dest='bidi_workaround', action='store_true',
help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
verbosity.add_option('-q', '--quiet', verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
action='store_true', dest='quiet', help='activates quiet mode', default=False) verbosity.add_option(
'-q', '--quiet',
action='store_true', dest='quiet', default=False,
help='activates quiet mode')
verbosity.add_option( verbosity.add_option(
'--no-warnings', '--no-warnings',
dest='no_warnings', action='store_true', default=False, dest='no_warnings', action='store_true', default=False,
help='Ignore warnings') help='Ignore warnings')
verbosity.add_option('-s', '--simulate', verbosity.add_option(
action='store_true', dest='simulate', help='do not download the video and do not write anything to disk', default=False) '-s', '--simulate',
verbosity.add_option('--skip-download', action='store_true', dest='simulate', default=False,
action='store_true', dest='skip_download', help='do not download the video', default=False) help='do not download the video and do not write anything to disk',)
verbosity.add_option('-g', '--get-url', verbosity.add_option(
action='store_true', dest='geturl', help='simulate, quiet but print URL', default=False) '--skip-download',
verbosity.add_option('-e', '--get-title', action='store_true', dest='skip_download', default=False,
action='store_true', dest='gettitle', help='simulate, quiet but print title', default=False) help='do not download the video',)
verbosity.add_option('--get-id', verbosity.add_option(
action='store_true', dest='getid', help='simulate, quiet but print id', default=False) '-g', '--get-url',
verbosity.add_option('--get-thumbnail', action='store_true', dest='geturl', default=False,
action='store_true', dest='getthumbnail', help='simulate, quiet but print URL')
help='simulate, quiet but print thumbnail URL', default=False) verbosity.add_option(
verbosity.add_option('--get-description', '-e', '--get-title',
action='store_true', dest='getdescription', action='store_true', dest='gettitle', default=False,
help='simulate, quiet but print video description', default=False) help='simulate, quiet but print title')
verbosity.add_option('--get-duration', verbosity.add_option(
action='store_true', dest='getduration', '--get-id',
help='simulate, quiet but print video length', default=False) action='store_true', dest='getid', default=False,
verbosity.add_option('--get-filename', help='simulate, quiet but print id')
action='store_true', dest='getfilename', verbosity.add_option(
help='simulate, quiet but print output filename', default=False) '--get-thumbnail',
verbosity.add_option('--get-format', action='store_true', dest='getthumbnail', default=False,
action='store_true', dest='getformat', help='simulate, quiet but print thumbnail URL')
help='simulate, quiet but print output format', default=False) verbosity.add_option(
verbosity.add_option('-j', '--dump-json', '--get-description',
action='store_true', dest='dumpjson', action='store_true', dest='getdescription', default=False,
help='simulate, quiet but print JSON information. See --output for a description of available keys.', default=False) help='simulate, quiet but print video description')
verbosity.add_option('--newline', verbosity.add_option(
action='store_true', dest='progress_with_newline', help='output progress bar as new lines', default=False) '--get-duration',
verbosity.add_option('--no-progress', action='store_true', dest='getduration', default=False,
action='store_true', dest='noprogress', help='do not print progress bar', default=False) help='simulate, quiet but print video length')
verbosity.add_option('--console-title', verbosity.add_option(
action='store_true', dest='consoletitle', '--get-filename',
help='display progress in console titlebar', default=False) action='store_true', dest='getfilename', default=False,
verbosity.add_option('-v', '--verbose', help='simulate, quiet but print output filename')
action='store_true', dest='verbose', help='print various debugging information', default=False) verbosity.add_option(
verbosity.add_option('--dump-intermediate-pages', '--get-format',
action='store_true', dest='getformat', default=False,
help='simulate, quiet but print output format')
verbosity.add_option(
'-j', '--dump-json',
action='store_true', dest='dumpjson', default=False,
help='simulate, quiet but print JSON information. See --output for a description of available keys.')
verbosity.add_option(
'--newline',
action='store_true', dest='progress_with_newline', default=False,
help='output progress bar as new lines')
verbosity.add_option(
'--no-progress',
action='store_true', dest='noprogress', default=False,
help='do not print progress bar')
verbosity.add_option(
'--console-title',
action='store_true', dest='consoletitle', default=False,
help='display progress in console titlebar')
verbosity.add_option(
'-v', '--verbose',
action='store_true', dest='verbose', default=False,
help='print various debugging information')
verbosity.add_option(
'--dump-intermediate-pages',
action='store_true', dest='dump_intermediate_pages', default=False, action='store_true', dest='dump_intermediate_pages', default=False,
help='print downloaded pages to debug problems (very verbose)') help='print downloaded pages to debug problems (very verbose)')
verbosity.add_option('--write-pages', verbosity.add_option(
'--write-pages',
action='store_true', dest='write_pages', default=False, action='store_true', dest='write_pages', default=False,
help='Write downloaded intermediary pages to files in the current directory to debug problems') help='Write downloaded intermediary pages to files in the current directory to debug problems')
verbosity.add_option('--youtube-print-sig-code', verbosity.add_option(
'--youtube-print-sig-code',
action='store_true', dest='youtube_print_sig_code', default=False, action='store_true', dest='youtube_print_sig_code', default=False,
help=optparse.SUPPRESS_HELP) help=optparse.SUPPRESS_HELP)
verbosity.add_option('--print-traffic', verbosity.add_option(
'--print-traffic',
dest='debug_printtraffic', action='store_true', default=False, dest='debug_printtraffic', action='store_true', default=False,
help='Display sent and read HTTP traffic') help='Display sent and read HTTP traffic')
filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
filesystem.add_option('-a', '--batch-file', filesystem.add_option(
dest='batchfile', metavar='FILE', help='file containing URLs to download (\'-\' for stdin)') '-a', '--batch-file',
filesystem.add_option('--id', dest='batchfile', metavar='FILE',
action='store_true', dest='useid', help='use only video ID in file name', default=False) help='file containing URLs to download (\'-\' for stdin)')
filesystem.add_option('-A', '--auto-number', filesystem.add_option(
action='store_true', dest='autonumber', '--id', default=False,
help='number downloaded files starting from 00000', default=False) action='store_true', dest='useid', help='use only video ID in file name')
filesystem.add_option('-o', '--output', filesystem.add_option(
'-A', '--auto-number',
action='store_true', dest='autonumber', default=False,
help='number downloaded files starting from 00000')
filesystem.add_option(
'-o', '--output',
dest='outtmpl', metavar='TEMPLATE', dest='outtmpl', metavar='TEMPLATE',
help=('output filename template. Use %(title)s to get the title, ' help=('output filename template. Use %(title)s to get the title, '
'%(uploader)s for the uploader name, %(uploader_id)s for the uploader nickname if different, ' '%(uploader)s for the uploader name, %(uploader_id)s for the uploader nickname if different, '
@ -366,45 +470,66 @@ def _hide_login_info(opts):
'%(resolution)s for a textual description of the resolution of the video format. ' '%(resolution)s for a textual description of the resolution of the video format. '
'Use - to output to stdout. Can also be used to download to a different directory, ' 'Use - to output to stdout. Can also be used to download to a different directory, '
'for example with -o \'/my/downloads/%(uploader)s/%(title)s-%(id)s.%(ext)s\' .')) 'for example with -o \'/my/downloads/%(uploader)s/%(title)s-%(id)s.%(ext)s\' .'))
filesystem.add_option('--autonumber-size', filesystem.add_option(
'--autonumber-size',
dest='autonumber_size', metavar='NUMBER', dest='autonumber_size', metavar='NUMBER',
help='Specifies the number of digits in %(autonumber)s when it is present in output filename template or --auto-number option is given') help='Specifies the number of digits in %(autonumber)s when it is present in output filename template or --auto-number option is given')
filesystem.add_option('--restrict-filenames', filesystem.add_option(
action='store_true', dest='restrictfilenames', '--restrict-filenames',
help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames', default=False) action='store_true', dest='restrictfilenames', default=False,
filesystem.add_option('-t', '--title', help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
action='store_true', dest='usetitle', help='[deprecated] use title in file name (default)', default=False) filesystem.add_option(
filesystem.add_option('-l', '--literal', '-t', '--title',
action='store_true', dest='usetitle', help='[deprecated] alias of --title', default=False) action='store_true', dest='usetitle', default=False,
filesystem.add_option('-w', '--no-overwrites', help='[deprecated] use title in file name (default)')
action='store_true', dest='nooverwrites', help='do not overwrite files', default=False) filesystem.add_option(
filesystem.add_option('-c', '--continue', '-l', '--literal', default=False,
action='store_true', dest='continue_dl', help='force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.', default=True) action='store_true', dest='usetitle',
filesystem.add_option('--no-continue', help='[deprecated] alias of --title')
filesystem.add_option(
'-w', '--no-overwrites',
action='store_true', dest='nooverwrites', default=False,
help='do not overwrite files')
filesystem.add_option(
'-c', '--continue',
action='store_true', dest='continue_dl', default=True,
help='force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.')
filesystem.add_option(
'--no-continue',
action='store_false', dest='continue_dl', action='store_false', dest='continue_dl',
help='do not resume partially downloaded files (restart from beginning)') help='do not resume partially downloaded files (restart from beginning)')
filesystem.add_option('--no-part', filesystem.add_option(
action='store_true', dest='nopart', help='do not use .part files', default=False) '--no-part',
filesystem.add_option('--no-mtime', action='store_true', dest='nopart', default=False,
action='store_false', dest='updatetime', help='do not use .part files - write directly into output file')
help='do not use the Last-modified header to set the file modification time', default=True) filesystem.add_option(
filesystem.add_option('--write-description', '--no-mtime',
action='store_true', dest='writedescription', action='store_false', dest='updatetime', default=True,
help='write video description to a .description file', default=False) help='do not use the Last-modified header to set the file modification time')
filesystem.add_option('--write-info-json', filesystem.add_option(
action='store_true', dest='writeinfojson', '--write-description',
help='write video metadata to a .info.json file', default=False) action='store_true', dest='writedescription', default=False,
filesystem.add_option('--write-annotations', help='write video description to a .description file')
action='store_true', dest='writeannotations', filesystem.add_option(
help='write video annotations to a .annotation file', default=False) '--write-info-json',
filesystem.add_option('--write-thumbnail', action='store_true', dest='writeinfojson', default=False,
action='store_true', dest='writethumbnail', help='write video metadata to a .info.json file')
help='write thumbnail image to disk', default=False) filesystem.add_option(
filesystem.add_option('--load-info', '--write-annotations',
action='store_true', dest='writeannotations', default=False,
help='write video annotations to a .annotation file')
filesystem.add_option(
'--write-thumbnail',
action='store_true', dest='writethumbnail', default=False,
help='write thumbnail image to disk')
filesystem.add_option(
'--load-info',
dest='load_info_filename', metavar='FILE', dest='load_info_filename', metavar='FILE',
help='json file containing the video information (created with the "--write-json" option)') help='json file containing the video information (created with the "--write-json" option)')
filesystem.add_option('--cookies', filesystem.add_option(
dest='cookiefile', metavar='FILE', help='file to read cookies from and dump cookie jar in') '--cookies',
dest='cookiefile', metavar='FILE',
help='file to read cookies from and dump cookie jar in')
filesystem.add_option( filesystem.add_option(
'--cache-dir', dest='cachedir', default=None, metavar='DIR', '--cache-dir', dest='cachedir', default=None, metavar='DIR',
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.') 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.')
@ -412,36 +537,61 @@ def _hide_login_info(opts):
'--no-cache-dir', action='store_const', const=False, dest='cachedir', '--no-cache-dir', action='store_const', const=False, dest='cachedir',
help='Disable filesystem caching') help='Disable filesystem caching')
filesystem.add_option( filesystem.add_option(
'--rm-cache-dir', action='store_true', dest='rm_cachedir', '--rm-cache-dir',
action='store_true', dest='rm_cachedir',
help='Delete all filesystem cache files') help='Delete all filesystem cache files')
postproc = optparse.OptionGroup(parser, 'Post-processing Options')
postproc.add_option('-x', '--extract-audio', action='store_true', dest='extractaudio', default=False, postproc.add_option(
'-x', '--extract-audio',
action='store_true', dest='extractaudio', default=False,
help='convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)') help='convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)')
postproc.add_option('--audio-format', metavar='FORMAT', dest='audioformat', default='best', postproc.add_option(
help='"best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; best by default') '--audio-format', metavar='FORMAT', dest='audioformat', default='best',
postproc.add_option('--audio-quality', metavar='QUALITY', dest='audioquality', default='5', help='"best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; "%default" by default')
help='ffmpeg/avconv audio quality specification, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default 5)') postproc.add_option(
postproc.add_option('--recode-video', metavar='FORMAT', dest='recodevideo', default=None, '--audio-quality', metavar='QUALITY',
dest='audioquality', default='5',
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)')
postproc.add_option(
'--recode-video',
metavar='FORMAT', dest='recodevideo', default=None,
help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv)') help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv)')
postproc.add_option('-k', '--keep-video', action='store_true', dest='keepvideo', default=False, postproc.add_option(
'-k', '--keep-video',
action='store_true', dest='keepvideo', default=False,
help='keeps the video file on disk after the post-processing; the video is erased by default') help='keeps the video file on disk after the post-processing; the video is erased by default')
postproc.add_option('--no-post-overwrites', action='store_true', dest='nopostoverwrites', default=False, postproc.add_option(
'--no-post-overwrites',
action='store_true', dest='nopostoverwrites', default=False,
help='do not overwrite post-processed files; the post-processed files are overwritten by default') help='do not overwrite post-processed files; the post-processed files are overwritten by default')
postproc.add_option('--embed-subs', action='store_true', dest='embedsubtitles', default=False, postproc.add_option(
'--embed-subs',
action='store_true', dest='embedsubtitles', default=False,
help='embed subtitles in the video (only for mp4 videos)') help='embed subtitles in the video (only for mp4 videos)')
postproc.add_option('--embed-thumbnail', action='store_true', dest='embedthumbnail', default=False, postproc.add_option(
'--embed-thumbnail',
action='store_true', dest='embedthumbnail', default=False,
help='embed thumbnail in the audio as cover art') help='embed thumbnail in the audio as cover art')
postproc.add_option('--add-metadata', action='store_true', dest='addmetadata', default=False, postproc.add_option(
'--add-metadata',
action='store_true', dest='addmetadata', default=False,
help='write metadata to the video file') help='write metadata to the video file')
postproc.add_option('--xattrs', action='store_true', dest='xattrs', default=False, postproc.add_option(
'--xattrs',
action='store_true', dest='xattrs', default=False,
help='write metadata to the video file\'s xattrs (using dublin core and xdg standards)') help='write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
postproc.add_option('--prefer-avconv', action='store_false', dest='prefer_ffmpeg', postproc.add_option(
'--prefer-avconv',
action='store_false', dest='prefer_ffmpeg',
help='Prefer avconv over ffmpeg for running the postprocessors (default)') help='Prefer avconv over ffmpeg for running the postprocessors (default)')
postproc.add_option('--prefer-ffmpeg', action='store_true', dest='prefer_ffmpeg', postproc.add_option(
'--prefer-ffmpeg',
action='store_true', dest='prefer_ffmpeg',
help='Prefer ffmpeg over avconv for running the postprocessors') help='Prefer ffmpeg over avconv for running the postprocessors')
postproc.add_option( postproc.add_option(
'--exec', metavar='CMD', dest='exec_cmd', '--exec',
metavar='CMD', dest='exec_cmd',
help='Execute a command on the file after downloading, similar to find\'s -exec syntax. Example: --exec \'adb push {} /sdcard/Music/ && rm {}\'' ) help='Execute a command on the file after downloading, similar to find\'s -exec syntax. Example: --exec \'adb push {} /sdcard/Music/ && rm {}\'' )
parser.add_option_group(general) parser.add_option_group(general)
@ -458,7 +608,7 @@ def _hide_login_info(opts):
if overrideArguments is not None: if overrideArguments is not None:
opts, args = parser.parse_args(overrideArguments) opts, args = parser.parse_args(overrideArguments)
if opts.verbose: if opts.verbose:
write_string(u'[debug] Override config: ' + repr(overrideArguments) + '\n') write_string('[debug] Override config: ' + repr(overrideArguments) + '\n')
else: else:
commandLineConf = sys.argv[1:] commandLineConf = sys.argv[1:]
if '--ignore-config' in commandLineConf: if '--ignore-config' in commandLineConf:
@ -474,8 +624,8 @@ def _hide_login_info(opts):
opts, args = parser.parse_args(argv) opts, args = parser.parse_args(argv)
if opts.verbose: if opts.verbose:
write_string(u'[debug] System config: ' + repr(_hide_login_info(systemConf)) + '\n') write_string('[debug] System config: ' + repr(_hide_login_info(systemConf)) + '\n')
write_string(u'[debug] User config: ' + repr(_hide_login_info(userConf)) + '\n') write_string('[debug] User config: ' + repr(_hide_login_info(userConf)) + '\n')
write_string(u'[debug] Command-line args: ' + repr(_hide_login_info(commandLineConf)) + '\n') write_string('[debug] Command-line args: ' + repr(_hide_login_info(commandLineConf)) + '\n')
return parser, opts, args return parser, opts, args