1 from __future__
import unicode_literals
8 from .downloader
.external
import list_external_downloaders
11 compat_get_terminal_size
,
24 from .version
import __version__
27 def _hide_login_info(opts
):
28 PRIVATE_OPTS
= set(['-p', '--password', '-u', '--username', '--video-password', '--ap-password', '--ap-username'])
29 eqre
= re
.compile('^(?P<key>' + ('|'.join(re
.escape(po
) for po
in PRIVATE_OPTS
)) + ')=.+$')
34 return m
.group('key') + '=PRIVATE'
38 opts
= list(map(_scrub_eq
, opts
))
39 for idx
, opt
in enumerate(opts
):
40 if opt
in PRIVATE_OPTS
and idx
+ 1 < len(opts
):
41 opts
[idx
+ 1] = 'PRIVATE'
45 def parseOpts(overrideArguments
=None):
46 def _readOptions(filename_bytes
, default
=[]):
48 optionf
= open(filename_bytes
)
50 return default
# silently skip if file is not present
52 # FIXME: https://github.com/ytdl-org/youtube-dl/commit/dfe5fa49aed02cf36ba9f743b11b0903554b5e56
53 contents
= optionf
.read()
54 if sys
.version_info
< (3,):
55 contents
= contents
.decode(preferredencoding())
56 res
= compat_shlex_split(contents
, comments
=True)
61 def _readUserConf(package_name
, default
=[]):
63 xdg_config_home
= compat_getenv('XDG_CONFIG_HOME') or compat_expanduser('~/.config')
64 userConfFile
= os
.path
.join(xdg_config_home
, package_name
, 'config')
65 if not os
.path
.isfile(userConfFile
):
66 userConfFile
= os
.path
.join(xdg_config_home
, '%s.conf' % package_name
)
67 userConf
= _readOptions(userConfFile
, default
=None)
68 if userConf
is not None:
69 return userConf
, userConfFile
72 appdata_dir
= compat_getenv('appdata')
74 userConfFile
= os
.path
.join(appdata_dir
, package_name
, 'config')
75 userConf
= _readOptions(userConfFile
, default
=None)
77 userConfFile
+= '.txt'
78 userConf
= _readOptions(userConfFile
, default
=None)
79 if userConf
is not None:
80 return userConf
, userConfFile
83 userConfFile
= os
.path
.join(compat_expanduser('~'), '%s.conf' % package_name
)
84 userConf
= _readOptions(userConfFile
, default
=None)
86 userConfFile
+= '.txt'
87 userConf
= _readOptions(userConfFile
, default
=None)
88 if userConf
is not None:
89 return userConf
, userConfFile
93 def _format_option_string(option
):
94 ''' ('-o', '--option') -> -o, --format METAVAR'''
98 if option
._short
_opts
:
99 opts
.append(option
._short
_opts
[0])
100 if option
._long
_opts
:
101 opts
.append(option
._long
_opts
[0])
105 if option
.takes_value():
106 opts
.append(' %s' % option
.metavar
)
110 def _comma_separated_values_options_callback(option
, opt_str
, value
, parser
):
111 setattr(parser
.values
, option
.dest
, value
.split(','))
113 def _dict_from_multiple_values_options_callback(
114 option
, opt_str
, value
, parser
, allowed_keys
=r
'[\w-]+', delimiter
=':', default_key
=None, process
=None):
116 out_dict
= getattr(parser
.values
, option
.dest
)
117 mobj
= re
.match(r
'(?i)(?P<key>%s)%s(?P<val>.*)$' % (allowed_keys
, delimiter
), value
)
119 key
, val
= mobj
.group('key').lower(), mobj
.group('val')
120 elif default_key
is not None:
121 key
, val
= default_key
, value
123 raise optparse
.OptionValueError(
124 'wrong %s formatting; it should be %s, not "%s"' % (opt_str
, option
.metavar
, value
))
125 out_dict
[key
] = process(val
) if callable(process
) else val
127 # No need to wrap help messages if we're on a wide console
128 columns
= compat_get_terminal_size().columns
129 max_width
= columns
if columns
else 80
130 max_help_position
= 80
132 fmt
= optparse
.IndentedHelpFormatter(width
=max_width
, max_help_position
=max_help_position
)
133 fmt
.format_option_strings
= _format_option_string
136 'version': __version__
,
138 'usage': '%prog [OPTIONS] URL [URL...]',
139 'conflict_handler': 'resolve',
142 parser
= optparse
.OptionParser(**compat_kwargs(kw
))
144 general
= optparse
.OptionGroup(parser
, 'General Options')
148 help='Print this help text and exit')
152 help='Print program version and exit')
155 action
='store_true', dest
='update_self',
156 help='Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
158 '-i', '--ignore-errors', '--no-abort-on-error',
159 action
='store_true', dest
='ignoreerrors', default
=True,
160 help='Continue on download errors, for example to skip unavailable videos in a playlist (default) (Alias: --no-abort-on-error)')
162 '--abort-on-error', '--no-ignore-errors',
163 action
='store_false', dest
='ignoreerrors',
164 help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
167 action
='store_true', dest
='dump_user_agent', default
=False,
168 help='Display the current browser identification')
171 action
='store_true', dest
='list_extractors', default
=False,
172 help='List all supported extractors')
174 '--extractor-descriptions',
175 action
='store_true', dest
='list_extractor_descriptions', default
=False,
176 help='Output descriptions of all supported extractors')
178 '--force-generic-extractor',
179 action
='store_true', dest
='force_generic_extractor', default
=False,
180 help='Force extraction to use the generic extractor')
183 dest
='default_search', metavar
='PREFIX',
184 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')
186 '--ignore-config', '--no-config',
189 'Disable loading any configuration files except the one provided by --config-location. '
190 'When given inside a configuration file, no further configuration files are loaded. '
191 'Additionally, (for backward compatibility) if this option is found inside the '
192 'system configuration file, the user configuration is not loaded'))
195 dest
='config_location', metavar
='PATH',
196 help='Location of the main configuration file; either the path to the config or its containing directory')
199 action
='store_const', dest
='extract_flat', const
='in_playlist', default
=False,
200 help='Do not extract the videos of a playlist, only list them')
203 action
='store_true', dest
='extract_flat',
204 help='Do not resolve the video urls')
206 '--no-flat-playlist',
207 action
='store_false', dest
='extract_flat',
208 help='Extract the videos of a playlist')
211 action
='store_true', dest
='mark_watched', default
=False,
212 help='Mark videos watched (YouTube only)')
215 action
='store_false', dest
='mark_watched', default
=False,
216 help='Do not mark videos watched')
219 action
='store_true', dest
='no_color',
221 help='Do not emit color codes in output')
223 network
= optparse
.OptionGroup(parser
, 'Network Options')
225 '--proxy', dest
='proxy',
226 default
=None, metavar
='URL',
228 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable '
229 'SOCKS proxy, specify a proper scheme. For example '
230 'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") '
231 'for direct connection'))
234 dest
='socket_timeout', type=float, default
=None, metavar
='SECONDS',
235 help='Time to wait before giving up, in seconds')
238 metavar
='IP', dest
='source_address', default
=None,
239 help='Client-side IP address to bind to',
242 '-4', '--force-ipv4',
243 action
='store_const', const
='0.0.0.0', dest
='source_address',
244 help='Make all connections via IPv4',
247 '-6', '--force-ipv6',
248 action
='store_const', const
='::', dest
='source_address',
249 help='Make all connections via IPv6',
252 geo
= optparse
.OptionGroup(parser
, 'Geo Restriction')
254 '--geo-verification-proxy',
255 dest
='geo_verification_proxy', default
=None, metavar
='URL',
257 'Use this proxy to verify the IP address for some geo-restricted sites. '
258 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
260 '--cn-verification-proxy',
261 dest
='cn_verification_proxy', default
=None, metavar
='URL',
262 help=optparse
.SUPPRESS_HELP
)
265 action
='store_true', dest
='geo_bypass', default
=True,
266 help='Bypass geographic restriction via faking X-Forwarded-For HTTP header')
269 action
='store_false', dest
='geo_bypass', default
=True,
270 help='Do not bypass geographic restriction via faking X-Forwarded-For HTTP header')
272 '--geo-bypass-country', metavar
='CODE',
273 dest
='geo_bypass_country', default
=None,
274 help='Force bypass geographic restriction with explicitly provided two-letter ISO 3166-2 country code')
276 '--geo-bypass-ip-block', metavar
='IP_BLOCK',
277 dest
='geo_bypass_ip_block', default
=None,
278 help='Force bypass geographic restriction with explicitly provided IP block in CIDR notation')
280 selection
= optparse
.OptionGroup(parser
, 'Video Selection')
281 selection
.add_option(
283 dest
='playliststart', metavar
='NUMBER', default
=1, type=int,
284 help='Playlist video to start at (default is %default)')
285 selection
.add_option(
287 dest
='playlistend', metavar
='NUMBER', default
=None, type=int,
288 help='Playlist video to end at (default is last)')
289 selection
.add_option(
291 dest
='playlist_items', metavar
='ITEM_SPEC', default
=None,
292 help='Playlist video items to download. Specify indices of the videos in the playlist separated by commas like: "--playlist-items 1,2,5,8" if you want to download videos indexed 1, 2, 5, 8 in the playlist. You can specify range: "--playlist-items 1-3,7,10-13", it will download the videos at index 1, 2, 3, 7, 10, 11, 12 and 13')
293 selection
.add_option(
295 dest
='matchtitle', metavar
='REGEX',
296 help='Download only matching titles (regex or caseless sub-string)')
297 selection
.add_option(
299 dest
='rejecttitle', metavar
='REGEX',
300 help='Skip download for matching titles (regex or caseless sub-string)')
301 selection
.add_option(
303 dest
='max_downloads', metavar
='NUMBER', type=int, default
=None,
304 help='Abort after downloading NUMBER files')
305 selection
.add_option(
307 metavar
='SIZE', dest
='min_filesize', default
=None,
308 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
309 selection
.add_option(
311 metavar
='SIZE', dest
='max_filesize', default
=None,
312 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
313 selection
.add_option(
315 metavar
='DATE', dest
='date', default
=None,
317 'Download only videos uploaded in this date. '
318 'The date can be "YYYYMMDD" or in the format '
319 '"(now|today)[+-][0-9](day|week|month|year)(s)?"'))
320 selection
.add_option(
322 metavar
='DATE', dest
='datebefore', default
=None,
324 'Download only videos uploaded on or before this date. '
325 'The date formats accepted is the same as --date'))
326 selection
.add_option(
328 metavar
='DATE', dest
='dateafter', default
=None,
330 'Download only videos uploaded on or after this date. '
331 'The date formats accepted is the same as --date'))
332 selection
.add_option(
334 metavar
='COUNT', dest
='min_views', default
=None, type=int,
335 help='Do not download any videos with less than COUNT views')
336 selection
.add_option(
338 metavar
='COUNT', dest
='max_views', default
=None, type=int,
339 help='Do not download any videos with more than COUNT views')
340 selection
.add_option(
342 metavar
='FILTER', dest
='match_filter', default
=None,
344 'Generic video filter. '
345 'Specify any key (see "OUTPUT TEMPLATE" for a list of available keys) to '
346 'match if the key is present, '
347 '!key to check if the key is not present, '
348 'key>NUMBER (like "comment_count > 12", also works with '
349 '>=, <, <=, !=, =) to compare against a number, '
350 'key = \'LITERAL\' (like "uploader = \'Mike Smith\'", also works with !=) '
351 'to match against a string literal '
352 'and & to require multiple matches. '
353 'Values which are not known are excluded unless you '
354 'put a question mark (?) after the operator. '
355 'For example, to only match videos that have been liked more than '
356 '100 times and disliked less than 50 times (or the dislike '
357 'functionality is not available at the given service), but who '
358 'also have a description, use --match-filter '
359 '"like_count > 100 & dislike_count <? 50 & description"'))
360 selection
.add_option(
362 metavar
='FILTER', dest
='match_filter', action
='store_const', const
=None,
363 help='Do not use generic video filter (default)')
364 selection
.add_option(
366 action
='store_true', dest
='noplaylist', default
=False,
367 help='Download only the video, if the URL refers to a video and a playlist')
368 selection
.add_option(
370 action
='store_false', dest
='noplaylist', default
=False,
371 help='Download the playlist, if the URL refers to a video and a playlist')
372 selection
.add_option(
374 metavar
='YEARS', dest
='age_limit', default
=None, type=int,
375 help='Download only videos suitable for the given age')
376 selection
.add_option(
377 '--download-archive', metavar
='FILE',
378 dest
='download_archive',
379 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
380 selection
.add_option(
381 '--break-on-existing',
382 action
='store_true', dest
='break_on_existing', default
=False,
383 help='Stop the download process when encountering a file that is in the archive')
384 selection
.add_option(
386 action
='store_true', dest
='break_on_reject', default
=False,
387 help='Stop the download process when encountering a file that has been filtered out')
388 selection
.add_option(
389 '--no-download-archive',
390 dest
='download_archive', action
="store_const", const
=None,
391 help='Do not use archive file (default)')
392 selection
.add_option(
394 dest
='include_ads', action
='store_true',
395 help='Download advertisements as well (experimental)')
396 selection
.add_option(
398 dest
='include_ads', action
='store_false',
399 help='Do not download advertisements (default)')
401 authentication
= optparse
.OptionGroup(parser
, 'Authentication Options')
402 authentication
.add_option(
404 dest
='username', metavar
='USERNAME',
405 help='Login with this account ID')
406 authentication
.add_option(
408 dest
='password', metavar
='PASSWORD',
409 help='Account password. If this option is left out, youtube-dlc will ask interactively')
410 authentication
.add_option(
412 dest
='twofactor', metavar
='TWOFACTOR',
413 help='Two-factor authentication code')
414 authentication
.add_option(
416 action
='store_true', dest
='usenetrc', default
=False,
417 help='Use .netrc authentication data')
418 authentication
.add_option(
420 dest
='videopassword', metavar
='PASSWORD',
421 help='Video password (vimeo, youku)')
423 adobe_pass
= optparse
.OptionGroup(parser
, 'Adobe Pass Options')
424 adobe_pass
.add_option(
426 dest
='ap_mso', metavar
='MSO',
427 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
428 adobe_pass
.add_option(
430 dest
='ap_username', metavar
='USERNAME',
431 help='Multiple-system operator account login')
432 adobe_pass
.add_option(
434 dest
='ap_password', metavar
='PASSWORD',
435 help='Multiple-system operator account password. If this option is left out, youtube-dlc will ask interactively')
436 adobe_pass
.add_option(
438 action
='store_true', dest
='ap_list_mso', default
=False,
439 help='List all supported multiple-system operators')
441 video_format
= optparse
.OptionGroup(parser
, 'Video Format Options')
442 video_format
.add_option(
444 action
='store', dest
='format', metavar
='FORMAT', default
=None,
445 help='Video format code, see "FORMAT SELECTION" for more details')
446 video_format
.add_option(
447 '-S', '--format-sort', metavar
='SORTORDER',
448 dest
='format_sort', default
=[],
449 action
='callback', callback
=_comma_separated_values_options_callback
, type='str',
450 help='Sort the formats by the fields given, see "Sorting Formats" for more details')
451 video_format
.add_option(
452 '--format-sort-force', '--S-force',
453 action
='store_true', dest
='format_sort_force', metavar
='FORMAT', default
=False,
455 'Force user specified sort order to have precedence over all fields, '
456 'see "Sorting Formats" for more details'))
457 video_format
.add_option(
458 '--no-format-sort-force',
459 action
='store_false', dest
='format_sort_force', metavar
='FORMAT', default
=False,
461 'Some fields have precedence over the user specified sort order (default), '
462 'see "Sorting Formats" for more details'))
463 video_format
.add_option(
464 '--video-multistreams',
465 action
='store_true', dest
='allow_multiple_video_streams', default
=False,
466 help='Allow multiple video streams to be merged into a single file')
467 video_format
.add_option(
468 '--no-video-multistreams',
469 action
='store_false', dest
='allow_multiple_video_streams',
470 help='Only one video stream is downloaded for each output file (default)')
471 video_format
.add_option(
472 '--audio-multistreams',
473 action
='store_true', dest
='allow_multiple_audio_streams', default
=False,
474 help='Allow multiple audio streams to be merged into a single file')
475 video_format
.add_option(
476 '--no-audio-multistreams',
477 action
='store_false', dest
='allow_multiple_audio_streams',
478 help='Only one audio stream is downloaded for each output file (default)')
479 video_format
.add_option(
481 action
='store_const', dest
='format', const
='all',
482 help='Download all available video formats')
483 video_format
.add_option(
484 '--prefer-free-formats',
485 action
='store_true', dest
='prefer_free_formats', default
=False,
486 help='Prefer free video formats over non-free formats of same quality')
487 video_format
.add_option(
488 '-F', '--list-formats',
489 action
='store_true', dest
='listformats',
490 help='List all available formats of requested videos')
491 video_format
.add_option(
492 '--list-formats-as-table',
493 action
='store_true', dest
='listformats_table', default
=True,
494 help='Present the output of -F in tabular form (default)')
495 video_format
.add_option(
496 '--list-formats-old', '--no-list-formats-as-table',
497 action
='store_false', dest
='listformats_table',
498 help='Present the output of -F in the old form (Alias: --no-list-formats-as-table)')
499 video_format
.add_option(
500 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
501 action
='store_true', dest
='youtube_include_dash_manifest', default
=True,
502 help='Download the DASH manifests and related data on YouTube videos (default) (Alias: --no-youtube-skip-dash-manifest)')
503 video_format
.add_option(
504 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
505 action
='store_false', dest
='youtube_include_dash_manifest',
506 help='Do not download the DASH manifests and related data on YouTube videos (Alias: --no-youtube-include-dash-manifest)')
507 video_format
.add_option(
508 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
509 action
='store_true', dest
='youtube_include_hls_manifest', default
=True,
510 help='Download the HLS manifests and related data on YouTube videos (default) (Alias: --no-youtube-skip-hls-manifest)')
511 video_format
.add_option(
512 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
513 action
='store_false', dest
='youtube_include_hls_manifest',
514 help='Do not download the HLS manifests and related data on YouTube videos (Alias: --no-youtube-include-hls-manifest)')
515 video_format
.add_option(
516 '--merge-output-format',
517 action
='store', dest
='merge_output_format', metavar
='FORMAT', default
=None,
519 'If a merge is required (e.g. bestvideo+bestaudio), '
520 'output to given container format. One of mkv, mp4, ogg, webm, flv. '
521 'Ignored if no merge is required'))
522 video_format
.add_option(
523 '--allow-unplayable-formats',
524 action
='store_true', dest
='allow_unplayable_formats', default
=False,
526 'Allow unplayable formats to be listed and downloaded. '
527 'All video postprocessing will also be turned off'))
528 video_format
.add_option(
529 '--no-allow-unplayable-formats',
530 action
='store_false', dest
='allow_unplayable_formats',
531 help='Do not allow unplayable formats to be listed or downloaded (default)')
533 subtitles
= optparse
.OptionGroup(parser
, 'Subtitle Options')
534 subtitles
.add_option(
535 '--write-subs', '--write-srt',
536 action
='store_true', dest
='writesubtitles', default
=False,
537 help='Write subtitle file')
538 subtitles
.add_option(
539 '--no-write-subs', '--no-write-srt',
540 action
='store_false', dest
='writesubtitles',
541 help='Do not write subtitle file (default)')
542 subtitles
.add_option(
543 '--write-auto-subs', '--write-automatic-subs',
544 action
='store_true', dest
='writeautomaticsub', default
=False,
545 help='Write automatically generated subtitle file (YouTube only)')
546 subtitles
.add_option(
547 '--no-write-auto-subs', '--no-write-automatic-subs',
548 action
='store_false', dest
='writeautomaticsub', default
=False,
549 help='Do not write automatically generated subtitle file (default)')
550 subtitles
.add_option(
552 action
='store_true', dest
='allsubtitles', default
=False,
553 help='Download all the available subtitles of the video')
554 subtitles
.add_option(
556 action
='store_true', dest
='listsubtitles', default
=False,
557 help='List all available subtitles for the video')
558 subtitles
.add_option(
560 action
='store', dest
='subtitlesformat', metavar
='FORMAT', default
='best',
561 help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
562 subtitles
.add_option(
563 '--sub-lang', '--sub-langs', '--srt-lang',
564 action
='callback', dest
='subtitleslangs', metavar
='LANGS', type='str',
565 default
=[], callback
=_comma_separated_values_options_callback
,
566 help='Languages of the subtitles to download (optional) separated by commas, use --list-subs for available language tags')
568 downloader
= optparse
.OptionGroup(parser
, 'Download Options')
569 downloader
.add_option(
570 '-r', '--limit-rate', '--rate-limit',
571 dest
='ratelimit', metavar
='RATE',
572 help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
573 downloader
.add_option(
575 dest
='retries', metavar
='RETRIES', default
=10,
576 help='Number of retries (default is %default), or "infinite"')
577 downloader
.add_option(
578 '--fragment-retries',
579 dest
='fragment_retries', metavar
='RETRIES', default
=10,
580 help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
581 downloader
.add_option(
582 '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment',
583 action
='store_true', dest
='skip_unavailable_fragments', default
=True,
584 help='Skip unavailable fragments for DASH, hlsnative and ISM (default) (Alias: --no-abort-on-unavailable-fragment)')
585 downloader
.add_option(
586 '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments',
587 action
='store_false', dest
='skip_unavailable_fragments',
588 help='Abort downloading if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
589 downloader
.add_option(
591 action
='store_true', dest
='keep_fragments', default
=False,
592 help='Keep downloaded fragments on disk after downloading is finished')
593 downloader
.add_option(
594 '--no-keep-fragments',
595 action
='store_false', dest
='keep_fragments',
596 help='Delete downloaded fragments after downloading is finished (default)')
597 downloader
.add_option(
599 dest
='buffersize', metavar
='SIZE', default
='1024',
600 help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
601 downloader
.add_option(
603 action
='store_false', dest
='noresizebuffer',
604 help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
605 downloader
.add_option(
606 '--no-resize-buffer',
607 action
='store_true', dest
='noresizebuffer', default
=False,
608 help='Do not automatically adjust the buffer size')
609 downloader
.add_option(
611 dest
='http_chunk_size', metavar
='SIZE', default
=None,
613 'Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). '
614 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
615 downloader
.add_option(
617 action
='store_true', dest
='test', default
=False,
618 help=optparse
.SUPPRESS_HELP
)
619 downloader
.add_option(
620 '--playlist-reverse',
622 help='Download playlist videos in reverse order')
623 downloader
.add_option(
624 '--no-playlist-reverse',
625 action
='store_false', dest
='playlist_reverse',
626 help='Download playlist videos in default order (default)')
627 downloader
.add_option(
630 help='Download playlist videos in random order')
631 downloader
.add_option(
632 '--xattr-set-filesize',
633 dest
='xattr_set_filesize', action
='store_true',
634 help='Set file xattribute ytdl.filesize with expected file size')
635 downloader
.add_option(
636 '--hls-prefer-native',
637 dest
='hls_prefer_native', action
='store_true', default
=None,
638 help='Use the native HLS downloader instead of ffmpeg')
639 downloader
.add_option(
640 '--hls-prefer-ffmpeg',
641 dest
='hls_prefer_native', action
='store_false', default
=None,
642 help='Use ffmpeg instead of the native HLS downloader')
643 downloader
.add_option(
645 dest
='hls_use_mpegts', action
='store_true',
647 'Use the mpegts container for HLS videos, allowing to play the '
648 'video while downloading (some players may not be able to play it)'))
649 downloader
.add_option(
650 '--external-downloader',
651 dest
='external_downloader', metavar
='NAME',
653 'Use the specified external downloader. '
654 'Currently supports %s' % ', '.join(list_external_downloaders())))
655 downloader
.add_option(
656 '--downloader-args', '--external-downloader-args',
657 metavar
='NAME:ARGS', dest
='external_downloader_args', default
={}, type='str',
658 action
='callback', callback
=_dict_from_multiple_values_options_callback
,
660 'allowed_keys': '|'.join(list_external_downloaders()),
661 'default_key': 'default', 'process': compat_shlex_split
},
663 'Give these arguments to the external downloader. '
664 'Specify the downloader name and the arguments separated by a colon ":". '
665 'You can use this option multiple times (Alias: --external-downloader-args)'))
667 workarounds
= optparse
.OptionGroup(parser
, 'Workarounds')
668 workarounds
.add_option(
670 dest
='encoding', metavar
='ENCODING',
671 help='Force the specified encoding (experimental)')
672 workarounds
.add_option(
673 '--no-check-certificate',
674 action
='store_true', dest
='no_check_certificate', default
=False,
675 help='Suppress HTTPS certificate validation')
676 workarounds
.add_option(
677 '--prefer-insecure', '--prefer-unsecure',
678 action
='store_true', dest
='prefer_insecure',
679 help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)')
680 workarounds
.add_option(
682 metavar
='UA', dest
='user_agent',
683 help='Specify a custom user agent')
684 workarounds
.add_option(
686 metavar
='URL', dest
='referer', default
=None,
687 help='Specify a custom referer, use if the video access is restricted to one domain',
689 workarounds
.add_option(
691 metavar
='FIELD:VALUE', dest
='headers', default
={}, type='str',
692 action
='callback', callback
=_dict_from_multiple_values_options_callback
,
693 help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
695 workarounds
.add_option(
697 dest
='bidi_workaround', action
='store_true',
698 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
699 workarounds
.add_option(
700 '--sleep-interval', '--min-sleep-interval', metavar
='SECONDS',
701 dest
='sleep_interval', type=float,
703 'Number of seconds to sleep before each download when used alone '
704 'or a lower bound of a range for randomized sleep before each download '
705 '(minimum possible number of seconds to sleep) when used along with '
706 '--max-sleep-interval'))
707 workarounds
.add_option(
708 '--max-sleep-interval', metavar
='SECONDS',
709 dest
='max_sleep_interval', type=float,
711 'Upper bound of a range for randomized sleep before each download '
712 '(maximum possible number of seconds to sleep). Must only be used '
713 'along with --min-sleep-interval'))
714 workarounds
.add_option(
715 '--sleep-subtitles', metavar
='SECONDS',
716 dest
='sleep_interval_subtitles', default
=0, type=int,
717 help='Enforce sleep interval on subtitles as well')
719 verbosity
= optparse
.OptionGroup(parser
, 'Verbosity / Simulation Options')
720 verbosity
.add_option(
722 action
='store_true', dest
='quiet', default
=False,
723 help='Activate quiet mode')
724 verbosity
.add_option(
726 dest
='no_warnings', action
='store_true', default
=False,
727 help='Ignore warnings')
728 verbosity
.add_option(
730 action
='store_true', dest
='simulate', default
=False,
731 help='Do not download the video and do not write anything to disk')
732 verbosity
.add_option(
733 '--skip-download', '--no-download',
734 action
='store_true', dest
='skip_download', default
=False,
735 help='Do not download the video')
736 verbosity
.add_option(
738 action
='store_true', dest
='geturl', default
=False,
739 help='Simulate, quiet but print URL')
740 verbosity
.add_option(
742 action
='store_true', dest
='gettitle', default
=False,
743 help='Simulate, quiet but print title')
744 verbosity
.add_option(
746 action
='store_true', dest
='getid', default
=False,
747 help='Simulate, quiet but print id')
748 verbosity
.add_option(
750 action
='store_true', dest
='getthumbnail', default
=False,
751 help='Simulate, quiet but print thumbnail URL')
752 verbosity
.add_option(
754 action
='store_true', dest
='getdescription', default
=False,
755 help='Simulate, quiet but print video description')
756 verbosity
.add_option(
758 action
='store_true', dest
='getduration', default
=False,
759 help='Simulate, quiet but print video length')
760 verbosity
.add_option(
762 action
='store_true', dest
='getfilename', default
=False,
763 help='Simulate, quiet but print output filename')
764 verbosity
.add_option(
766 action
='store_true', dest
='getformat', default
=False,
767 help='Simulate, quiet but print output format')
768 verbosity
.add_option(
770 action
='store_true', dest
='dumpjson', default
=False,
771 help='Simulate, quiet but print JSON information. See "OUTPUT TEMPLATE" for a description of available keys')
772 verbosity
.add_option(
773 '-J', '--dump-single-json',
774 action
='store_true', dest
='dump_single_json', default
=False,
776 'Simulate, quiet but print JSON information for each command-line argument. '
777 'If the URL refers to a playlist, dump the whole playlist information in a single line'))
778 verbosity
.add_option(
780 action
='store_true', dest
='print_json', default
=False,
781 help='Be quiet and print the video information as JSON (video is still being downloaded)')
782 verbosity
.add_option(
783 '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
784 action
='store_true', dest
='force_write_download_archive', default
=False,
786 'Force download archive entries to be written as far as no errors occur,'
787 'even if -s or another simulation switch is used (Alias: --force-download-archive)'))
788 verbosity
.add_option(
790 action
='store_true', dest
='progress_with_newline', default
=False,
791 help='Output progress bar as new lines')
792 verbosity
.add_option(
794 action
='store_true', dest
='noprogress', default
=False,
795 help='Do not print progress bar')
796 verbosity
.add_option(
798 action
='store_true', dest
='consoletitle', default
=False,
799 help='Display progress in console titlebar')
800 verbosity
.add_option(
802 action
='store_true', dest
='verbose', default
=False,
803 help='Print various debugging information')
804 verbosity
.add_option(
805 '--dump-pages', '--dump-intermediate-pages',
806 action
='store_true', dest
='dump_intermediate_pages', default
=False,
807 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
808 verbosity
.add_option(
810 action
='store_true', dest
='write_pages', default
=False,
811 help='Write downloaded intermediary pages to files in the current directory to debug problems')
812 verbosity
.add_option(
813 '--youtube-print-sig-code',
814 action
='store_true', dest
='youtube_print_sig_code', default
=False,
815 help=optparse
.SUPPRESS_HELP
)
816 verbosity
.add_option(
817 '--print-traffic', '--dump-headers',
818 dest
='debug_printtraffic', action
='store_true', default
=False,
819 help='Display sent and read HTTP traffic')
820 verbosity
.add_option(
822 dest
='call_home', action
='store_true', default
=False,
823 # help='[Broken] Contact the youtube-dlc server for debugging')
824 help=optparse
.SUPPRESS_HELP
)
825 verbosity
.add_option(
827 dest
='call_home', action
='store_false',
828 # help='Do not contact the youtube-dlc server for debugging (default)')
829 help=optparse
.SUPPRESS_HELP
)
831 filesystem
= optparse
.OptionGroup(parser
, 'Filesystem Options')
832 filesystem
.add_option(
833 '-a', '--batch-file',
834 dest
='batchfile', metavar
='FILE',
835 help="File containing URLs to download ('-' for stdin), one URL per line. "
836 "Lines starting with '#', ';' or ']' are considered as comments and ignored")
837 filesystem
.add_option(
838 '--id', default
=False,
839 action
='store_true', dest
='useid', help=optparse
.SUPPRESS_HELP
)
840 filesystem
.add_option(
842 metavar
='TYPE:PATH', dest
='paths', default
={}, type='str',
843 action
='callback', callback
=_dict_from_multiple_values_options_callback
,
845 'allowed_keys': 'home|temp|%s' % '|'.join(OUTTMPL_TYPES
.keys()),
846 'process': lambda x
: x
.strip()},
848 'The paths where the files should be downloaded. '
849 'Specify the type of file and the path separated by a colon ":". '
850 'All the same types as --output are supported. '
851 'Additionally, you can also provide "home" and "temp" paths. '
852 'All intermediary files are first downloaded to the temp path and '
853 'then the final files are moved over to the home path after download is finished. '
854 'This option is ignored if --output is an absolute path'))
855 filesystem
.add_option(
857 metavar
='[TYPE:]TEMPLATE', dest
='outtmpl', default
={}, type='str',
858 action
='callback', callback
=_dict_from_multiple_values_options_callback
,
860 'allowed_keys': '|'.join(OUTTMPL_TYPES
.keys()),
861 'default_key': 'default', 'process': lambda x
: x
.strip()},
862 help='Output filename template, see "OUTPUT TEMPLATE" for details')
863 filesystem
.add_option(
864 '--output-na-placeholder',
865 dest
='outtmpl_na_placeholder', metavar
='TEXT', default
='NA',
866 help=('Placeholder value for unavailable meta fields in output filename template (default: "%default")'))
867 filesystem
.add_option(
869 dest
='autonumber_size', metavar
='NUMBER', type=int,
870 help=optparse
.SUPPRESS_HELP
)
871 filesystem
.add_option(
872 '--autonumber-start',
873 dest
='autonumber_start', metavar
='NUMBER', default
=1, type=int,
874 help='Specify the start value for %(autonumber)s (default is %default)')
875 filesystem
.add_option(
876 '--restrict-filenames',
877 action
='store_true', dest
='restrictfilenames', default
=False,
878 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
879 filesystem
.add_option(
880 '--no-restrict-filenames',
881 action
='store_false', dest
='restrictfilenames', default
=False,
882 help='Allow Unicode characters, "&" and spaces in filenames (default)')
883 filesystem
.add_option(
884 '-A', '--auto-number',
885 action
='store_true', dest
='autonumber', default
=False,
886 help=optparse
.SUPPRESS_HELP
)
887 filesystem
.add_option(
889 action
='store_true', dest
='usetitle', default
=False,
890 help=optparse
.SUPPRESS_HELP
)
891 filesystem
.add_option(
892 '-l', '--literal', default
=False,
893 action
='store_true', dest
='usetitle',
894 help=optparse
.SUPPRESS_HELP
)
895 filesystem
.add_option(
896 '-w', '--no-overwrites',
897 action
='store_false', dest
='overwrites', default
=None,
898 help='Do not overwrite any files')
899 filesystem
.add_option(
900 '--force-overwrites', '--yes-overwrites',
901 action
='store_true', dest
='overwrites',
902 help='Overwrite all video and metadata files. This option includes --no-continue')
903 filesystem
.add_option(
904 '--no-force-overwrites',
905 action
='store_const', dest
='overwrites', const
=None,
906 help='Do not overwrite the video, but overwrite related files (default)')
907 filesystem
.add_option(
909 action
='store_true', dest
='continue_dl', default
=True,
910 help='Resume partially downloaded files/fragments (default)')
911 filesystem
.add_option(
913 action
='store_false', dest
='continue_dl',
915 'Do not resume partially downloaded fragments. '
916 'If the file is unfragmented, restart download of the entire file'))
917 filesystem
.add_option(
919 action
='store_false', dest
='nopart', default
=False,
920 help='Use .part files instead of writing directly into output file (default)')
921 filesystem
.add_option(
923 action
='store_true', dest
='nopart',
924 help='Do not use .part files - write directly into output file')
925 filesystem
.add_option(
927 action
='store_true', dest
='updatetime', default
=True,
928 help='Use the Last-modified header to set the file modification time (default)')
929 filesystem
.add_option(
931 action
='store_false', dest
='updatetime',
932 help='Do not use the Last-modified header to set the file modification time')
933 filesystem
.add_option(
934 '--write-description',
935 action
='store_true', dest
='writedescription', default
=False,
936 help='Write video description to a .description file')
937 filesystem
.add_option(
938 '--no-write-description',
939 action
='store_false', dest
='writedescription',
940 help='Do not write video description (default)')
941 filesystem
.add_option(
943 action
='store_true', dest
='writeinfojson', default
=False,
944 help='Write video metadata to a .info.json file (this may contain personal information)')
945 filesystem
.add_option(
946 '--no-write-info-json',
947 action
='store_false', dest
='writeinfojson',
948 help='Do not write video metadata (default)')
949 filesystem
.add_option(
950 '--write-annotations',
951 action
='store_true', dest
='writeannotations', default
=False,
952 help='Write video annotations to a .annotations.xml file')
953 filesystem
.add_option(
954 '--no-write-annotations',
955 action
='store_false', dest
='writeannotations',
956 help='Do not write video annotations (default)')
957 filesystem
.add_option(
958 '--write-playlist-metafiles',
959 action
='store_true', dest
='allow_playlist_files', default
=True,
961 'Write playlist metadata in addition to the video metadata '
962 'when using --write-info-json, --write-description etc. (default)'))
963 filesystem
.add_option(
964 '--no-write-playlist-metafiles',
965 action
='store_false', dest
='allow_playlist_files',
967 'Do not write playlist metadata when using '
968 '--write-info-json, --write-description etc.'))
969 filesystem
.add_option(
971 action
='store_true', dest
='getcomments', default
=False,
972 help='Retrieve video comments to be placed in the .info.json file')
973 filesystem
.add_option(
974 '--load-info-json', '--load-info',
975 dest
='load_info_filename', metavar
='FILE',
976 help='JSON file containing the video information (created with the "--write-info-json" option)')
977 filesystem
.add_option(
979 dest
='cookiefile', metavar
='FILE',
980 help='File to read cookies from and dump cookie jar in')
981 filesystem
.add_option(
983 action
='store_const', const
=None, dest
='cookiefile', metavar
='FILE',
984 help='Do not read/dump cookies (default)')
985 filesystem
.add_option(
986 '--cache-dir', dest
='cachedir', default
=None, metavar
='DIR',
987 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')
988 filesystem
.add_option(
989 '--no-cache-dir', action
='store_false', dest
='cachedir',
990 help='Disable filesystem caching')
991 filesystem
.add_option(
993 action
='store_true', dest
='rm_cachedir',
994 help='Delete all filesystem cache files')
995 filesystem
.add_option(
996 '--trim-file-name', metavar
='LENGTH',
997 dest
='trim_file_name', default
=0, type=int,
998 help='Limit the filename length (extension excluded)')
1000 thumbnail
= optparse
.OptionGroup(parser
, 'Thumbnail Images')
1001 thumbnail
.add_option(
1002 '--write-thumbnail',
1003 action
='store_true', dest
='writethumbnail', default
=False,
1004 help='Write thumbnail image to disk')
1005 thumbnail
.add_option(
1006 '--no-write-thumbnail',
1007 action
='store_false', dest
='writethumbnail',
1008 help='Do not write thumbnail image to disk (default)')
1009 thumbnail
.add_option(
1010 '--write-all-thumbnails',
1011 action
='store_true', dest
='write_all_thumbnails', default
=False,
1012 help='Write all thumbnail image formats to disk')
1013 thumbnail
.add_option(
1014 '--list-thumbnails',
1015 action
='store_true', dest
='list_thumbnails', default
=False,
1016 help='Simulate and list all available thumbnail formats')
1018 link
= optparse
.OptionGroup(parser
, 'Internet Shortcut Options')
1021 action
='store_true', dest
='writelink', default
=False,
1022 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1025 action
='store_true', dest
='writeurllink', default
=False,
1026 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1028 '--write-webloc-link',
1029 action
='store_true', dest
='writewebloclink', default
=False,
1030 help='Write a .webloc macOS internet shortcut')
1032 '--write-desktop-link',
1033 action
='store_true', dest
='writedesktoplink', default
=False,
1034 help='Write a .desktop Linux internet shortcut')
1036 postproc
= optparse
.OptionGroup(parser
, 'Post-Processing Options')
1037 postproc
.add_option(
1038 '-x', '--extract-audio',
1039 action
='store_true', dest
='extractaudio', default
=False,
1040 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1041 postproc
.add_option(
1042 '--audio-format', metavar
='FORMAT', dest
='audioformat', default
='best',
1043 help='Specify audio format: "best", "aac", "flac", "mp3", "m4a", "opus", "vorbis", or "wav"; "%default" by default; No effect without -x')
1044 postproc
.add_option(
1045 '--audio-quality', metavar
='QUALITY',
1046 dest
='audioquality', default
='5',
1047 help='Specify ffmpeg audio quality, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default %default)')
1048 postproc
.add_option(
1050 metavar
='FORMAT', dest
='remuxvideo', default
=None,
1052 'Remux the video into another container if necessary (currently supported: %s). '
1053 'If target container does not support the video/audio codec, remuxing will fail. '
1054 'You can specify multiple rules; eg. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 '
1055 'and anything else to mkv.' % '|'.join(REMUX_EXTENSIONS
)))
1056 postproc
.add_option(
1058 metavar
='FORMAT', dest
='recodevideo', default
=None,
1060 'Re-encode the video into another format if re-encoding is necessary. '
1061 'The supported formats are the same as --remux-video'))
1062 postproc
.add_option(
1063 '--postprocessor-args', '--ppa',
1064 metavar
='NAME:ARGS', dest
='postprocessor_args', default
={}, type='str',
1065 action
='callback', callback
=_dict_from_multiple_values_options_callback
,
1066 callback_kwargs
={'default_key': 'default-compat', 'allowed_keys': r'\w+(?:\+\w+)?', 'process': compat_shlex_split}
,
1068 'Give these arguments to the postprocessors. '
1069 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1070 'to give the argument to the specified postprocessor/executable. Supported postprocessors are: '
1071 'SponSkrub, ExtractAudio, VideoRemuxer, VideoConvertor, EmbedSubtitle, Metadata, Merger, '
1072 'FixupStretched, FixupM4a, FixupM3u8, SubtitlesConvertor and EmbedThumbnail. '
1073 'The supported executables are: SponSkrub, FFmpeg, FFprobe, and AtomicParsley. '
1074 'You can use this option multiple times to give different arguments to different postprocessors. '
1075 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1076 'only when being used by the specified postprocessor. '
1077 'You can use this option multiple times (Alias: --ppa)'))
1078 postproc
.add_option(
1079 '-k', '--keep-video',
1080 action
='store_true', dest
='keepvideo', default
=False,
1081 help='Keep the intermediate video file on disk after post-processing')
1082 postproc
.add_option(
1084 action
='store_false', dest
='keepvideo',
1085 help='Delete the intermediate video file after post-processing (default)')
1086 postproc
.add_option(
1087 '--post-overwrites',
1088 action
='store_false', dest
='nopostoverwrites',
1089 help='Overwrite post-processed files (default)')
1090 postproc
.add_option(
1091 '--no-post-overwrites',
1092 action
='store_true', dest
='nopostoverwrites', default
=False,
1093 help='Do not overwrite post-processed files')
1094 postproc
.add_option(
1096 action
='store_true', dest
='embedsubtitles', default
=False,
1097 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1098 postproc
.add_option(
1100 action
='store_false', dest
='embedsubtitles',
1101 help='Do not embed subtitles (default)')
1102 postproc
.add_option(
1103 '--embed-thumbnail',
1104 action
='store_true', dest
='embedthumbnail', default
=False,
1105 help='Embed thumbnail in the audio as cover art')
1106 postproc
.add_option(
1107 '--no-embed-thumbnail',
1108 action
='store_false', dest
='embedthumbnail',
1109 help='Do not embed thumbnail (default)')
1110 postproc
.add_option(
1112 action
='store_true', dest
='addmetadata', default
=False,
1113 help='Write metadata to the video file')
1114 postproc
.add_option(
1115 '--no-add-metadata',
1116 action
='store_false', dest
='addmetadata',
1117 help='Do not write metadata (default)')
1118 postproc
.add_option(
1119 '--metadata-from-title',
1120 metavar
='FORMAT', dest
='metafromtitle',
1121 help=optparse
.SUPPRESS_HELP
)
1122 postproc
.add_option(
1124 metavar
='FIELD:FORMAT', dest
='metafromfield', action
='append',
1126 'Parse additional metadata like title/artist from other fields. '
1127 'Give field name to extract data from, and format of the field seperated by a ":". '
1128 'Either regular expression with named capture groups or a '
1129 'similar syntax to the output template can also be used. '
1130 'The parsed parameters replace any existing values and can be use in output template'
1131 'This option can be used multiple times. '
1132 'Example: --parse-metadata "title:%(artist)s - %(title)s" matches a title like '
1133 '"Coldplay - Paradise". '
1134 'Example (regex): --parse-metadata "description:Artist - (?P<artist>.+?)"'))
1135 postproc
.add_option(
1137 action
='store_true', dest
='xattrs', default
=False,
1138 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
1139 postproc
.add_option(
1141 metavar
='POLICY', dest
='fixup', default
='detect_or_warn',
1143 'Automatically correct known faults of the file. '
1144 'One of never (do nothing), warn (only emit a warning), '
1145 'detect_or_warn (the default; fix file if we can, warn otherwise)'))
1146 postproc
.add_option(
1147 '--prefer-avconv', '--no-prefer-ffmpeg',
1148 action
='store_false', dest
='prefer_ffmpeg',
1149 help=optparse
.SUPPRESS_HELP
)
1150 postproc
.add_option(
1151 '--prefer-ffmpeg', '--no-prefer-avconv',
1152 action
='store_true', dest
='prefer_ffmpeg', default
=True,
1153 help=optparse
.SUPPRESS_HELP
)
1154 postproc
.add_option(
1155 '--ffmpeg-location', '--avconv-location', metavar
='PATH',
1156 dest
='ffmpeg_location',
1157 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1158 postproc
.add_option(
1160 metavar
='CMD', dest
='exec_cmd',
1161 help='Execute a command on the file after downloading and post-processing, similar to find\'s -exec syntax. Example: --exec \'adb push {} /sdcard/Music/ && rm {}\'')
1162 postproc
.add_option(
1163 '--convert-subs', '--convert-subtitles',
1164 metavar
='FORMAT', dest
='convertsubtitles', default
=None,
1165 help='Convert the subtitles to other format (currently supported: srt|ass|vtt|lrc)')
1167 sponskrub
= optparse
.OptionGroup(parser
, 'SponSkrub (SponsorBlock) Options', description
=(
1168 'SponSkrub (https://github.com/pukkandan/SponSkrub) is a utility to mark/remove sponsor segments '
1169 'from downloaded YouTube videos using SponsorBlock API (https://sponsor.ajay.app)'))
1170 sponskrub
.add_option(
1172 action
='store_true', dest
='sponskrub', default
=None,
1174 'Use sponskrub to mark sponsored sections. '
1175 'This is enabled by default if the sponskrub binary exists (Youtube only)'))
1176 sponskrub
.add_option(
1178 action
='store_false', dest
='sponskrub',
1179 help='Do not use sponskrub')
1180 sponskrub
.add_option(
1181 '--sponskrub-cut', default
=False,
1182 action
='store_true', dest
='sponskrub_cut',
1183 help='Cut out the sponsor sections instead of simply marking them')
1184 sponskrub
.add_option(
1185 '--no-sponskrub-cut',
1186 action
='store_false', dest
='sponskrub_cut',
1187 help='Simply mark the sponsor sections, not cut them out (default)')
1188 sponskrub
.add_option(
1189 '--sponskrub-force', default
=False,
1190 action
='store_true', dest
='sponskrub_force',
1191 help='Run sponskrub even if the video was already downloaded')
1192 sponskrub
.add_option(
1193 '--no-sponskrub-force',
1194 action
='store_true', dest
='sponskrub_force',
1195 help='Do not cut out the sponsor sections if the video was already downloaded (default)')
1196 sponskrub
.add_option(
1197 '--sponskrub-location', metavar
='PATH',
1198 dest
='sponskrub_path', default
='',
1199 help='Location of the sponskrub binary; either the path to the binary or its containing directory')
1200 sponskrub
.add_option(
1201 '--sponskrub-args', dest
='sponskrub_args', metavar
='ARGS',
1202 help=optparse
.SUPPRESS_HELP
)
1204 extractor
= optparse
.OptionGroup(parser
, 'Extractor Options')
1205 extractor
.add_option(
1206 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1207 action
='store_true', dest
='dynamic_mpd', default
=True,
1208 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1209 extractor
.add_option(
1210 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1211 action
='store_false', dest
='dynamic_mpd',
1212 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1214 parser
.add_option_group(general
)
1215 parser
.add_option_group(network
)
1216 parser
.add_option_group(geo
)
1217 parser
.add_option_group(selection
)
1218 parser
.add_option_group(downloader
)
1219 parser
.add_option_group(filesystem
)
1220 parser
.add_option_group(thumbnail
)
1221 parser
.add_option_group(link
)
1222 parser
.add_option_group(verbosity
)
1223 parser
.add_option_group(workarounds
)
1224 parser
.add_option_group(video_format
)
1225 parser
.add_option_group(subtitles
)
1226 parser
.add_option_group(authentication
)
1227 parser
.add_option_group(adobe_pass
)
1228 parser
.add_option_group(postproc
)
1229 parser
.add_option_group(sponskrub
)
1230 parser
.add_option_group(extractor
)
1232 if overrideArguments
is not None:
1233 opts
, args
= parser
.parse_args(overrideArguments
)
1235 write_string('[debug] Override config: ' + repr(overrideArguments
) + '\n')
1237 def compat_conf(conf
):
1238 if sys
.version_info
< (3,):
1239 return [a
.decode(preferredencoding(), 'replace') for a
in conf
]
1243 'command-line': compat_conf(sys
.argv
[1:]),
1244 'custom': [], 'home': [], 'portable': [], 'user': [], 'system': []}
1245 paths
= {'command-line': False}
1246 opts
, args
= parser
.parse_args(configs
['command-line'])
1249 if '--config-location' in configs
['command-line']:
1250 location
= compat_expanduser(opts
.config_location
)
1251 if os
.path
.isdir(location
):
1252 location
= os
.path
.join(location
, 'youtube-dlc.conf')
1253 if not os
.path
.exists(location
):
1254 parser
.error('config-location %s does not exist.' % location
)
1255 configs
['custom'] = _readOptions(location
, default
=None)
1256 if configs
['custom'] is None:
1257 configs
['custom'] = []
1259 paths
['custom'] = location
1260 if '--ignore-config' in configs
['command-line']:
1262 if '--ignore-config' in configs
['custom']:
1265 def read_options(path
, user
=False):
1266 for package
in ('yt-dlp', 'youtube-dlc'):
1268 config
, current_path
= _readUserConf(package
, default
=None)
1270 current_path
= os
.path
.join(path
, '%s.conf' % package
)
1271 config
= _readOptions(current_path
, default
=None)
1272 if config
is not None:
1273 return config
, current_path
1276 configs
['portable'], paths
['portable'] = read_options(get_executable_path())
1277 if '--ignore-config' in configs
['portable']:
1280 def get_home_path():
1281 opts
= parser
.parse_args(configs
['portable'] + configs
['custom'] + configs
['command-line'])[0]
1282 return expand_path(opts
.paths
.get('home', '')).strip()
1284 configs
['home'], paths
['home'] = read_options(get_home_path())
1285 if '--ignore-config' in configs
['home']:
1288 configs
['system'], paths
['system'] = read_options('/etc')
1289 if '--ignore-config' in configs
['system']:
1292 configs
['user'], paths
['user'] = read_options('', True)
1293 if '--ignore-config' in configs
['user']:
1294 configs
['system'], paths
['system'] = [], None
1297 argv
= configs
['system'] + configs
['user'] + configs
['home'] + configs
['portable'] + configs
['custom'] + configs
['command-line']
1298 opts
, args
= parser
.parse_args(argv
)
1300 for label
in ('System', 'User', 'Portable', 'Home', 'Custom', 'Command-line'):
1302 if paths
.get(key
) is None:
1305 write_string('[debug] %s config file: %s\n' % (label
, paths
[key
]))
1306 write_string('[debug] %s config: %s\n' % (label
, repr(_hide_login_info(configs
[key
]))))
1308 return parser
, opts
, args