]>
Commit | Line | Data |
---|---|---|
1 | import collections | |
2 | import contextlib | |
3 | import optparse | |
4 | import os.path | |
5 | import re | |
6 | import shlex | |
7 | import shutil | |
8 | import string | |
9 | import sys | |
10 | ||
11 | from .compat import compat_expanduser | |
12 | from .cookies import SUPPORTED_BROWSERS, SUPPORTED_KEYRINGS | |
13 | from .downloader.external import list_external_downloaders | |
14 | from .postprocessor import ( | |
15 | FFmpegExtractAudioPP, | |
16 | FFmpegMergerPP, | |
17 | FFmpegSubtitlesConvertorPP, | |
18 | FFmpegThumbnailsConvertorPP, | |
19 | FFmpegVideoRemuxerPP, | |
20 | SponsorBlockPP, | |
21 | ) | |
22 | from .postprocessor.modify_chapters import DEFAULT_SPONSORBLOCK_CHAPTER_TITLE | |
23 | from .update import UPDATE_SOURCES, detect_variant, is_non_updateable | |
24 | from .utils import ( | |
25 | OUTTMPL_TYPES, | |
26 | POSTPROCESS_WHEN, | |
27 | Config, | |
28 | deprecation_warning, | |
29 | expand_path, | |
30 | format_field, | |
31 | get_executable_path, | |
32 | get_system_config_dirs, | |
33 | get_user_config_dirs, | |
34 | join_nonempty, | |
35 | orderedSet_from_options, | |
36 | remove_end, | |
37 | variadic, | |
38 | write_string, | |
39 | ) | |
40 | from .version import CHANNEL, __version__ | |
41 | ||
42 | ||
43 | def parseOpts(overrideArguments=None, ignore_config_files='if_override'): | |
44 | PACKAGE_NAME = 'yt-dlp' | |
45 | ||
46 | root = Config(create_parser()) | |
47 | if ignore_config_files == 'if_override': | |
48 | ignore_config_files = overrideArguments is not None | |
49 | ||
50 | def read_config(*paths): | |
51 | path = os.path.join(*paths) | |
52 | conf = Config.read_file(path, default=None) | |
53 | if conf is not None: | |
54 | return conf, path | |
55 | ||
56 | def _load_from_config_dirs(config_dirs): | |
57 | for config_dir in config_dirs: | |
58 | head, tail = os.path.split(config_dir) | |
59 | assert tail == PACKAGE_NAME or config_dir == os.path.join(compat_expanduser('~'), f'.{PACKAGE_NAME}') | |
60 | ||
61 | yield read_config(head, f'{PACKAGE_NAME}.conf') | |
62 | if tail.startswith('.'): # ~/.PACKAGE_NAME | |
63 | yield read_config(head, f'{PACKAGE_NAME}.conf.txt') | |
64 | yield read_config(config_dir, 'config') | |
65 | yield read_config(config_dir, 'config.txt') | |
66 | ||
67 | def add_config(label, path=None, func=None): | |
68 | """ Adds config and returns whether to continue """ | |
69 | if root.parse_known_args()[0].ignoreconfig: | |
70 | return False | |
71 | elif func: | |
72 | assert path is None | |
73 | args, current_path = next( | |
74 | filter(None, _load_from_config_dirs(func(PACKAGE_NAME))), (None, None)) | |
75 | else: | |
76 | current_path = os.path.join(path, 'yt-dlp.conf') | |
77 | args = Config.read_file(current_path, default=None) | |
78 | if args is not None: | |
79 | root.append_config(args, current_path, label=label) | |
80 | return True | |
81 | ||
82 | def load_configs(): | |
83 | yield not ignore_config_files | |
84 | yield add_config('Portable', get_executable_path()) | |
85 | yield add_config('Home', expand_path(root.parse_known_args()[0].paths.get('home', '')).strip()) | |
86 | yield add_config('User', func=get_user_config_dirs) | |
87 | yield add_config('System', func=get_system_config_dirs) | |
88 | ||
89 | opts = optparse.Values({'verbose': True, 'print_help': False}) | |
90 | try: | |
91 | try: | |
92 | if overrideArguments is not None: | |
93 | root.append_config(overrideArguments, label='Override') | |
94 | else: | |
95 | root.append_config(sys.argv[1:], label='Command-line') | |
96 | loaded_all_configs = all(load_configs()) | |
97 | except ValueError as err: | |
98 | raise root.parser.error(err) | |
99 | ||
100 | if loaded_all_configs: | |
101 | # If ignoreconfig is found inside the system configuration file, | |
102 | # the user configuration is removed | |
103 | if root.parse_known_args()[0].ignoreconfig: | |
104 | user_conf = next((i for i, conf in enumerate(root.configs) if conf.label == 'User'), None) | |
105 | if user_conf is not None: | |
106 | root.configs.pop(user_conf) | |
107 | ||
108 | try: | |
109 | root.configs[0].load_configs() # Resolve any aliases using --config-location | |
110 | except ValueError as err: | |
111 | raise root.parser.error(err) | |
112 | ||
113 | opts, args = root.parse_args() | |
114 | except optparse.OptParseError: | |
115 | with contextlib.suppress(optparse.OptParseError): | |
116 | opts, _ = root.parse_known_args(strict=False) | |
117 | raise | |
118 | except (SystemExit, KeyboardInterrupt): | |
119 | opts.verbose = False | |
120 | raise | |
121 | finally: | |
122 | verbose = opts.verbose and f'\n{root}'.replace('\n| ', '\n[debug] ')[1:] | |
123 | if verbose: | |
124 | write_string(f'{verbose}\n') | |
125 | if opts.print_help: | |
126 | if verbose: | |
127 | write_string('\n') | |
128 | root.parser.print_help() | |
129 | if opts.print_help: | |
130 | sys.exit() | |
131 | return root.parser, opts, args | |
132 | ||
133 | ||
134 | class _YoutubeDLHelpFormatter(optparse.IndentedHelpFormatter): | |
135 | def __init__(self): | |
136 | # No need to wrap help messages if we're on a wide console | |
137 | max_width = shutil.get_terminal_size().columns or 80 | |
138 | # The % is chosen to get a pretty output in README.md | |
139 | super().__init__(width=max_width, max_help_position=int(0.45 * max_width)) | |
140 | ||
141 | @staticmethod | |
142 | def format_option_strings(option): | |
143 | """ ('-o', '--option') -> -o, --format METAVAR """ | |
144 | opts = join_nonempty( | |
145 | option._short_opts and option._short_opts[0], | |
146 | option._long_opts and option._long_opts[0], | |
147 | delim=', ') | |
148 | if option.takes_value(): | |
149 | opts += f' {option.metavar}' | |
150 | return opts | |
151 | ||
152 | ||
153 | class _YoutubeDLOptionParser(optparse.OptionParser): | |
154 | # optparse is deprecated since Python 3.2. So assume a stable interface even for private methods | |
155 | ALIAS_DEST = '_triggered_aliases' | |
156 | ALIAS_TRIGGER_LIMIT = 100 | |
157 | ||
158 | def __init__(self): | |
159 | super().__init__( | |
160 | prog='yt-dlp' if detect_variant() == 'source' else None, | |
161 | version=__version__, | |
162 | usage='%prog [OPTIONS] URL [URL...]', | |
163 | epilog='See full documentation at https://github.com/yt-dlp/yt-dlp#readme', | |
164 | formatter=_YoutubeDLHelpFormatter(), | |
165 | conflict_handler='resolve', | |
166 | ) | |
167 | self.set_default(self.ALIAS_DEST, collections.defaultdict(int)) | |
168 | ||
169 | _UNKNOWN_OPTION = (optparse.BadOptionError, optparse.AmbiguousOptionError) | |
170 | _BAD_OPTION = optparse.OptionValueError | |
171 | ||
172 | def parse_known_args(self, args=None, values=None, strict=True): | |
173 | """Same as parse_args, but ignore unknown switches. Similar to argparse.parse_known_args""" | |
174 | self.rargs, self.largs = self._get_args(args), [] | |
175 | self.values = values or self.get_default_values() | |
176 | while self.rargs: | |
177 | arg = self.rargs[0] | |
178 | try: | |
179 | if arg == '--': | |
180 | del self.rargs[0] | |
181 | break | |
182 | elif arg.startswith('--'): | |
183 | self._process_long_opt(self.rargs, self.values) | |
184 | elif arg.startswith('-') and arg != '-': | |
185 | self._process_short_opts(self.rargs, self.values) | |
186 | elif self.allow_interspersed_args: | |
187 | self.largs.append(self.rargs.pop(0)) | |
188 | else: | |
189 | break | |
190 | except optparse.OptParseError as err: | |
191 | if isinstance(err, self._UNKNOWN_OPTION): | |
192 | self.largs.append(err.opt_str) | |
193 | elif strict: | |
194 | if isinstance(err, self._BAD_OPTION): | |
195 | self.error(str(err)) | |
196 | raise | |
197 | return self.check_values(self.values, self.largs) | |
198 | ||
199 | def _generate_error_message(self, msg): | |
200 | msg = f'{self.get_prog_name()}: error: {str(msg).strip()}\n' | |
201 | return f'{self.get_usage()}\n{msg}' if self.usage else msg | |
202 | ||
203 | def error(self, msg): | |
204 | raise optparse.OptParseError(self._generate_error_message(msg)) | |
205 | ||
206 | def _get_args(self, args): | |
207 | return sys.argv[1:] if args is None else list(args) | |
208 | ||
209 | def _match_long_opt(self, opt): | |
210 | """Improve ambiguous argument resolution by comparing option objects instead of argument strings""" | |
211 | try: | |
212 | return super()._match_long_opt(opt) | |
213 | except optparse.AmbiguousOptionError as e: | |
214 | if len({self._long_opt[p] for p in e.possibilities}) == 1: | |
215 | return e.possibilities[0] | |
216 | raise | |
217 | ||
218 | ||
219 | def create_parser(): | |
220 | def _list_from_options_callback(option, opt_str, value, parser, append=True, delim=',', process=str.strip): | |
221 | # append can be True, False or -1 (prepend) | |
222 | current = list(getattr(parser.values, option.dest)) if append else [] | |
223 | value = list(filter(None, [process(value)] if delim is None else map(process, value.split(delim)))) | |
224 | setattr( | |
225 | parser.values, option.dest, | |
226 | current + value if append is True else value + current) | |
227 | ||
228 | def _set_from_options_callback( | |
229 | option, opt_str, value, parser, allowed_values, delim=',', aliases={}, | |
230 | process=lambda x: x.lower().strip()): | |
231 | values = [process(value)] if delim is None else map(process, value.split(delim)) | |
232 | try: | |
233 | requested = orderedSet_from_options(values, collections.ChainMap(aliases, {'all': allowed_values}), | |
234 | start=getattr(parser.values, option.dest)) | |
235 | except ValueError as e: | |
236 | raise optparse.OptionValueError(f'wrong {option.metavar} for {opt_str}: {e.args[0]}') | |
237 | ||
238 | setattr(parser.values, option.dest, set(requested)) | |
239 | ||
240 | def _dict_from_options_callback( | |
241 | option, opt_str, value, parser, | |
242 | allowed_keys=r'[\w-]+', delimiter=':', default_key=None, process=None, multiple_keys=True, | |
243 | process_key=str.lower, append=False): | |
244 | ||
245 | out_dict = dict(getattr(parser.values, option.dest)) | |
246 | multiple_args = not isinstance(value, str) | |
247 | if multiple_keys: | |
248 | allowed_keys = fr'({allowed_keys})(,({allowed_keys}))*' | |
249 | mobj = re.match( | |
250 | fr'(?is)(?P<keys>{allowed_keys}){delimiter}(?P<val>.*)$', | |
251 | value[0] if multiple_args else value) | |
252 | if mobj is not None: | |
253 | keys, val = mobj.group('keys').split(','), mobj.group('val') | |
254 | if multiple_args: | |
255 | val = [val, *value[1:]] | |
256 | elif default_key is not None: | |
257 | keys, val = variadic(default_key), value | |
258 | else: | |
259 | raise optparse.OptionValueError( | |
260 | f'wrong {opt_str} formatting; it should be {option.metavar}, not "{value}"') | |
261 | try: | |
262 | keys = map(process_key, keys) if process_key else keys | |
263 | val = process(val) if process else val | |
264 | except Exception as err: | |
265 | raise optparse.OptionValueError(f'wrong {opt_str} formatting; {err}') | |
266 | for key in keys: | |
267 | out_dict[key] = out_dict.get(key, []) + [val] if append else val | |
268 | setattr(parser.values, option.dest, out_dict) | |
269 | ||
270 | def when_prefix(default): | |
271 | return { | |
272 | 'default': {}, | |
273 | 'type': 'str', | |
274 | 'action': 'callback', | |
275 | 'callback': _dict_from_options_callback, | |
276 | 'callback_kwargs': { | |
277 | 'allowed_keys': '|'.join(map(re.escape, POSTPROCESS_WHEN)), | |
278 | 'default_key': default, | |
279 | 'multiple_keys': False, | |
280 | 'append': True, | |
281 | }, | |
282 | } | |
283 | ||
284 | parser = _YoutubeDLOptionParser() | |
285 | alias_group = optparse.OptionGroup(parser, 'Aliases') | |
286 | Formatter = string.Formatter() | |
287 | ||
288 | def _create_alias(option, opt_str, value, parser): | |
289 | aliases, opts = value | |
290 | try: | |
291 | nargs = len({i if f == '' else f | |
292 | for i, (_, f, _, _) in enumerate(Formatter.parse(opts)) if f is not None}) | |
293 | opts.format(*map(str, range(nargs))) # validate | |
294 | except Exception as err: | |
295 | raise optparse.OptionValueError(f'wrong {opt_str} OPTIONS formatting; {err}') | |
296 | if alias_group not in parser.option_groups: | |
297 | parser.add_option_group(alias_group) | |
298 | ||
299 | aliases = (x if x.startswith('-') else f'--{x}' for x in map(str.strip, aliases.split(','))) | |
300 | try: | |
301 | args = [f'ARG{i}' for i in range(nargs)] | |
302 | alias_group.add_option( | |
303 | *aliases, nargs=nargs, dest=parser.ALIAS_DEST, type='str' if nargs else None, | |
304 | metavar=' '.join(args), help=opts.format(*args), action='callback', | |
305 | callback=_alias_callback, callback_kwargs={'opts': opts, 'nargs': nargs}) | |
306 | except Exception as err: | |
307 | raise optparse.OptionValueError(f'wrong {opt_str} formatting; {err}') | |
308 | ||
309 | def _alias_callback(option, opt_str, value, parser, opts, nargs): | |
310 | counter = getattr(parser.values, option.dest) | |
311 | counter[opt_str] += 1 | |
312 | if counter[opt_str] > parser.ALIAS_TRIGGER_LIMIT: | |
313 | raise optparse.OptionValueError(f'Alias {opt_str} exceeded invocation limit') | |
314 | if nargs == 1: | |
315 | value = [value] | |
316 | assert (nargs == 0 and value is None) or len(value) == nargs | |
317 | parser.rargs[:0] = shlex.split( | |
318 | opts if value is None else opts.format(*map(shlex.quote, value))) | |
319 | ||
320 | general = optparse.OptionGroup(parser, 'General Options') | |
321 | general.add_option( | |
322 | '-h', '--help', dest='print_help', action='store_true', | |
323 | help='Print this help text and exit') | |
324 | general.add_option( | |
325 | '--version', | |
326 | action='version', | |
327 | help='Print program version and exit') | |
328 | general.add_option( | |
329 | '-U', '--update', | |
330 | action='store_const', dest='update_self', const=CHANNEL, | |
331 | help=format_field( | |
332 | is_non_updateable(), None, 'Check if updates are available. %s', | |
333 | default=f'Update this program to the latest {CHANNEL} version')) | |
334 | general.add_option( | |
335 | '--no-update', | |
336 | action='store_false', dest='update_self', | |
337 | help='Do not check for updates (default)') | |
338 | general.add_option( | |
339 | '--update-to', | |
340 | action='store', dest='update_self', metavar='[CHANNEL]@[TAG]', | |
341 | help=( | |
342 | 'Upgrade/downgrade to a specific version. CHANNEL can be a repository as well. ' | |
343 | f'CHANNEL and TAG default to "{CHANNEL.partition("@")[0]}" and "latest" respectively if omitted; ' | |
344 | f'See "UPDATE" for details. Supported channels: {", ".join(UPDATE_SOURCES)}')) | |
345 | general.add_option( | |
346 | '-i', '--ignore-errors', | |
347 | action='store_true', dest='ignoreerrors', | |
348 | help='Ignore download and postprocessing errors. The download will be considered successful even if the postprocessing fails') | |
349 | general.add_option( | |
350 | '--no-abort-on-error', | |
351 | action='store_const', dest='ignoreerrors', const='only_download', | |
352 | help='Continue with next video on download errors; e.g. to skip unavailable videos in a playlist (default)') | |
353 | general.add_option( | |
354 | '--abort-on-error', '--no-ignore-errors', | |
355 | action='store_false', dest='ignoreerrors', | |
356 | help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)') | |
357 | general.add_option( | |
358 | '--dump-user-agent', | |
359 | action='store_true', dest='dump_user_agent', default=False, | |
360 | help='Display the current user-agent and exit') | |
361 | general.add_option( | |
362 | '--list-extractors', | |
363 | action='store_true', dest='list_extractors', default=False, | |
364 | help='List all supported extractors and exit') | |
365 | general.add_option( | |
366 | '--extractor-descriptions', | |
367 | action='store_true', dest='list_extractor_descriptions', default=False, | |
368 | help='Output descriptions of all supported extractors and exit') | |
369 | general.add_option( | |
370 | '--use-extractors', '--ies', | |
371 | action='callback', dest='allowed_extractors', metavar='NAMES', type='str', | |
372 | default=[], callback=_list_from_options_callback, | |
373 | help=( | |
374 | 'Extractor names to use separated by commas. ' | |
375 | 'You can also use regexes, "all", "default" and "end" (end URL matching); ' | |
376 | 'e.g. --ies "holodex.*,end,youtube". ' | |
377 | 'Prefix the name with a "-" to exclude it, e.g. --ies default,-generic. ' | |
378 | 'Use --list-extractors for a list of extractor names. (Alias: --ies)')) | |
379 | general.add_option( | |
380 | '--force-generic-extractor', | |
381 | action='store_true', dest='force_generic_extractor', default=False, | |
382 | help=optparse.SUPPRESS_HELP) | |
383 | general.add_option( | |
384 | '--default-search', | |
385 | dest='default_search', metavar='PREFIX', | |
386 | help=( | |
387 | 'Use this prefix for unqualified URLs. ' | |
388 | 'E.g. "gvsearch2:python" downloads two videos from google videos for the search term "python". ' | |
389 | 'Use the value "auto" to let yt-dlp guess ("auto_warning" to emit a warning when guessing). ' | |
390 | '"error" just throws an error. The default value "fixup_error" repairs broken URLs, ' | |
391 | 'but emits an error if this is not possible instead of searching')) | |
392 | general.add_option( | |
393 | '--ignore-config', '--no-config', | |
394 | action='store_true', dest='ignoreconfig', | |
395 | help=( | |
396 | 'Don\'t load any more configuration files except those given to --config-locations. ' | |
397 | 'For backward compatibility, if this option is found inside the system configuration file, the user configuration is not loaded. ' | |
398 | '(Alias: --no-config)')) | |
399 | general.add_option( | |
400 | '--no-config-locations', | |
401 | action='store_const', dest='config_locations', const=[], | |
402 | help=( | |
403 | 'Do not load any custom configuration files (default). When given inside a ' | |
404 | 'configuration file, ignore all previous --config-locations defined in the current file')) | |
405 | general.add_option( | |
406 | '--config-locations', | |
407 | dest='config_locations', metavar='PATH', action='append', | |
408 | help=( | |
409 | 'Location of the main configuration file; either the path to the config or its containing directory ' | |
410 | '("-" for stdin). Can be used multiple times and inside other configuration files')) | |
411 | general.add_option( | |
412 | '--flat-playlist', | |
413 | action='store_const', dest='extract_flat', const='in_playlist', default=False, | |
414 | help='Do not extract the videos of a playlist, only list them') | |
415 | general.add_option( | |
416 | '--no-flat-playlist', | |
417 | action='store_false', dest='extract_flat', | |
418 | help='Fully extract the videos of a playlist (default)') | |
419 | general.add_option( | |
420 | '--live-from-start', | |
421 | action='store_true', dest='live_from_start', | |
422 | help='Download livestreams from the start. Currently only supported for YouTube (Experimental)') | |
423 | general.add_option( | |
424 | '--no-live-from-start', | |
425 | action='store_false', dest='live_from_start', | |
426 | help='Download livestreams from the current time (default)') | |
427 | general.add_option( | |
428 | '--wait-for-video', | |
429 | dest='wait_for_video', metavar='MIN[-MAX]', default=None, | |
430 | help=( | |
431 | 'Wait for scheduled streams to become available. ' | |
432 | 'Pass the minimum number of seconds (or range) to wait between retries')) | |
433 | general.add_option( | |
434 | '--no-wait-for-video', | |
435 | dest='wait_for_video', action='store_const', const=None, | |
436 | help='Do not wait for scheduled streams (default)') | |
437 | general.add_option( | |
438 | '--mark-watched', | |
439 | action='store_true', dest='mark_watched', default=False, | |
440 | help='Mark videos watched (even with --simulate)') | |
441 | general.add_option( | |
442 | '--no-mark-watched', | |
443 | action='store_false', dest='mark_watched', | |
444 | help='Do not mark videos watched (default)') | |
445 | general.add_option( | |
446 | '--no-colors', '--no-colours', | |
447 | action='store_const', dest='color', const={ | |
448 | 'stdout': 'no_color', | |
449 | 'stderr': 'no_color', | |
450 | }, | |
451 | help=optparse.SUPPRESS_HELP) | |
452 | general.add_option( | |
453 | '--color', | |
454 | dest='color', metavar='[STREAM:]POLICY', default={}, type='str', | |
455 | action='callback', callback=_dict_from_options_callback, | |
456 | callback_kwargs={ | |
457 | 'allowed_keys': 'stdout|stderr', | |
458 | 'default_key': ['stdout', 'stderr'], | |
459 | 'process': str.strip, | |
460 | }, help=( | |
461 | 'Whether to emit color codes in output, optionally prefixed by ' | |
462 | 'the STREAM (stdout or stderr) to apply the setting to. ' | |
463 | 'Can be one of "always", "auto" (default), "never", or ' | |
464 | '"no_color" (use non color terminal sequences). ' | |
465 | 'Can be used multiple times')) | |
466 | general.add_option( | |
467 | '--compat-options', | |
468 | metavar='OPTS', dest='compat_opts', default=set(), type='str', | |
469 | action='callback', callback=_set_from_options_callback, | |
470 | callback_kwargs={ | |
471 | 'allowed_values': { | |
472 | 'filename', 'filename-sanitization', 'format-sort', 'abort-on-error', 'format-spec', 'no-playlist-metafiles', | |
473 | 'multistreams', 'no-live-chat', 'playlist-index', 'list-formats', 'no-direct-merge', 'playlist-match-filter', | |
474 | 'no-attach-info-json', 'embed-thumbnail-atomicparsley', 'no-external-downloader-progress', | |
475 | 'embed-metadata', 'seperate-video-versions', 'no-clean-infojson', 'no-keep-subs', 'no-certifi', | |
476 | 'no-youtube-channel-redirect', 'no-youtube-unavailable-videos', 'no-youtube-prefer-utc-upload-date', | |
477 | 'prefer-legacy-http-handler', 'manifest-filesize-approx' | |
478 | }, 'aliases': { | |
479 | 'youtube-dl': ['all', '-multistreams', '-playlist-match-filter', '-manifest-filesize-approx'], | |
480 | 'youtube-dlc': ['all', '-no-youtube-channel-redirect', '-no-live-chat', '-playlist-match-filter', '-manifest-filesize-approx'], | |
481 | '2021': ['2022', 'no-certifi', 'filename-sanitization', 'no-youtube-prefer-utc-upload-date'], | |
482 | '2022': ['2023', 'no-external-downloader-progress', 'playlist-match-filter', 'prefer-legacy-http-handler', 'manifest-filesize-approx'], | |
483 | '2023': [], | |
484 | } | |
485 | }, help=( | |
486 | 'Options that can help keep compatibility with youtube-dl or youtube-dlc ' | |
487 | 'configurations by reverting some of the changes made in yt-dlp. ' | |
488 | 'See "Differences in default behavior" for details')) | |
489 | general.add_option( | |
490 | '--alias', metavar='ALIASES OPTIONS', dest='_', type='str', nargs=2, | |
491 | action='callback', callback=_create_alias, | |
492 | help=( | |
493 | 'Create aliases for an option string. Unless an alias starts with a dash "-", it is prefixed with "--". ' | |
494 | 'Arguments are parsed according to the Python string formatting mini-language. ' | |
495 | 'E.g. --alias get-audio,-X "-S=aext:{0},abr -x --audio-format {0}" creates options ' | |
496 | '"--get-audio" and "-X" that takes an argument (ARG0) and expands to ' | |
497 | '"-S=aext:ARG0,abr -x --audio-format ARG0". All defined aliases are listed in the --help output. ' | |
498 | 'Alias options can trigger more aliases; so be careful to avoid defining recursive options. ' | |
499 | f'As a safety measure, each alias may be triggered a maximum of {_YoutubeDLOptionParser.ALIAS_TRIGGER_LIMIT} times. ' | |
500 | 'This option can be used multiple times')) | |
501 | ||
502 | network = optparse.OptionGroup(parser, 'Network Options') | |
503 | network.add_option( | |
504 | '--proxy', dest='proxy', | |
505 | default=None, metavar='URL', | |
506 | help=( | |
507 | 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable SOCKS proxy, specify a proper scheme, ' | |
508 | 'e.g. socks5://user:pass@127.0.0.1:1080/. Pass in an empty string (--proxy "") for direct connection')) | |
509 | network.add_option( | |
510 | '--socket-timeout', | |
511 | dest='socket_timeout', type=float, default=None, metavar='SECONDS', | |
512 | help='Time to wait before giving up, in seconds') | |
513 | network.add_option( | |
514 | '--source-address', | |
515 | metavar='IP', dest='source_address', default=None, | |
516 | help='Client-side IP address to bind to', | |
517 | ) | |
518 | network.add_option( | |
519 | '--impersonate', | |
520 | metavar='CLIENT[:OS]', dest='impersonate', default=None, | |
521 | help=( | |
522 | 'Client to impersonate for requests. E.g. chrome, chrome-110, chrome:windows-10. ' | |
523 | 'Pass --impersonate="" to impersonate any client.'), | |
524 | ) | |
525 | network.add_option( | |
526 | '--list-impersonate-targets', | |
527 | dest='list_impersonate_targets', default=False, action='store_true', | |
528 | help='List available clients to impersonate.', | |
529 | ) | |
530 | network.add_option( | |
531 | '-4', '--force-ipv4', | |
532 | action='store_const', const='0.0.0.0', dest='source_address', | |
533 | help='Make all connections via IPv4', | |
534 | ) | |
535 | network.add_option( | |
536 | '-6', '--force-ipv6', | |
537 | action='store_const', const='::', dest='source_address', | |
538 | help='Make all connections via IPv6', | |
539 | ) | |
540 | network.add_option( | |
541 | '--enable-file-urls', action='store_true', | |
542 | dest='enable_file_urls', default=False, | |
543 | help='Enable file:// URLs. This is disabled by default for security reasons.' | |
544 | ) | |
545 | ||
546 | geo = optparse.OptionGroup(parser, 'Geo-restriction') | |
547 | geo.add_option( | |
548 | '--geo-verification-proxy', | |
549 | dest='geo_verification_proxy', default=None, metavar='URL', | |
550 | help=( | |
551 | 'Use this proxy to verify the IP address for some geo-restricted sites. ' | |
552 | 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading')) | |
553 | geo.add_option( | |
554 | '--cn-verification-proxy', | |
555 | dest='cn_verification_proxy', default=None, metavar='URL', | |
556 | help=optparse.SUPPRESS_HELP) | |
557 | geo.add_option( | |
558 | '--xff', metavar='VALUE', | |
559 | dest='geo_bypass', default='default', | |
560 | help=( | |
561 | 'How to fake X-Forwarded-For HTTP header to try bypassing geographic restriction. ' | |
562 | 'One of "default" (only when known to be useful), "never", ' | |
563 | 'an IP block in CIDR notation, or a two-letter ISO 3166-2 country code')) | |
564 | geo.add_option( | |
565 | '--geo-bypass', | |
566 | action='store_const', dest='geo_bypass', const='default', | |
567 | help=optparse.SUPPRESS_HELP) | |
568 | geo.add_option( | |
569 | '--no-geo-bypass', | |
570 | action='store_const', dest='geo_bypass', const='never', | |
571 | help=optparse.SUPPRESS_HELP) | |
572 | geo.add_option( | |
573 | '--geo-bypass-country', metavar='CODE', dest='geo_bypass', | |
574 | help=optparse.SUPPRESS_HELP) | |
575 | geo.add_option( | |
576 | '--geo-bypass-ip-block', metavar='IP_BLOCK', dest='geo_bypass', | |
577 | help=optparse.SUPPRESS_HELP) | |
578 | ||
579 | selection = optparse.OptionGroup(parser, 'Video Selection') | |
580 | selection.add_option( | |
581 | '--playlist-start', | |
582 | dest='playliststart', metavar='NUMBER', default=1, type=int, | |
583 | help=optparse.SUPPRESS_HELP) | |
584 | selection.add_option( | |
585 | '--playlist-end', | |
586 | dest='playlistend', metavar='NUMBER', default=None, type=int, | |
587 | help=optparse.SUPPRESS_HELP) | |
588 | selection.add_option( | |
589 | '-I', '--playlist-items', | |
590 | dest='playlist_items', metavar='ITEM_SPEC', default=None, | |
591 | help=( | |
592 | 'Comma separated playlist_index of the items to download. ' | |
593 | 'You can specify a range using "[START]:[STOP][:STEP]". For backward compatibility, START-STOP is also supported. ' | |
594 | 'Use negative indices to count from the right and negative STEP to download in reverse order. ' | |
595 | 'E.g. "-I 1:3,7,-5::2" used on a playlist of size 15 will download the items at index 1,2,3,7,11,13,15')) | |
596 | selection.add_option( | |
597 | '--match-title', | |
598 | dest='matchtitle', metavar='REGEX', | |
599 | help=optparse.SUPPRESS_HELP) | |
600 | selection.add_option( | |
601 | '--reject-title', | |
602 | dest='rejecttitle', metavar='REGEX', | |
603 | help=optparse.SUPPRESS_HELP) | |
604 | selection.add_option( | |
605 | '--min-filesize', | |
606 | metavar='SIZE', dest='min_filesize', default=None, | |
607 | help='Abort download if filesize is smaller than SIZE, e.g. 50k or 44.6M') | |
608 | selection.add_option( | |
609 | '--max-filesize', | |
610 | metavar='SIZE', dest='max_filesize', default=None, | |
611 | help='Abort download if filesize is larger than SIZE, e.g. 50k or 44.6M') | |
612 | selection.add_option( | |
613 | '--date', | |
614 | metavar='DATE', dest='date', default=None, | |
615 | help=( | |
616 | 'Download only videos uploaded on this date. ' | |
617 | 'The date can be "YYYYMMDD" or in the format [now|today|yesterday][-N[day|week|month|year]]. ' | |
618 | 'E.g. "--date today-2weeks" downloads only videos uploaded on the same day two weeks ago')) | |
619 | selection.add_option( | |
620 | '--datebefore', | |
621 | metavar='DATE', dest='datebefore', default=None, | |
622 | help=( | |
623 | 'Download only videos uploaded on or before this date. ' | |
624 | 'The date formats accepted is the same as --date')) | |
625 | selection.add_option( | |
626 | '--dateafter', | |
627 | metavar='DATE', dest='dateafter', default=None, | |
628 | help=( | |
629 | 'Download only videos uploaded on or after this date. ' | |
630 | 'The date formats accepted is the same as --date')) | |
631 | selection.add_option( | |
632 | '--min-views', | |
633 | metavar='COUNT', dest='min_views', default=None, type=int, | |
634 | help=optparse.SUPPRESS_HELP) | |
635 | selection.add_option( | |
636 | '--max-views', | |
637 | metavar='COUNT', dest='max_views', default=None, type=int, | |
638 | help=optparse.SUPPRESS_HELP) | |
639 | selection.add_option( | |
640 | '--match-filters', | |
641 | metavar='FILTER', dest='match_filter', action='append', | |
642 | help=( | |
643 | 'Generic video filter. Any "OUTPUT TEMPLATE" field can be compared with a ' | |
644 | 'number or a string using the operators defined in "Filtering Formats". ' | |
645 | 'You can also simply specify a field to match if the field is present, ' | |
646 | 'use "!field" to check if the field is not present, and "&" to check multiple conditions. ' | |
647 | 'Use a "\\" to escape "&" or quotes if needed. If used multiple times, ' | |
648 | 'the filter matches if atleast one of the conditions are met. E.g. --match-filter ' | |
649 | '!is_live --match-filter "like_count>?100 & description~=\'(?i)\\bcats \\& dogs\\b\'" ' | |
650 | 'matches only videos that are not live OR those that have a like count more than 100 ' | |
651 | '(or the like field is not available) and also has a description ' | |
652 | 'that contains the phrase "cats & dogs" (caseless). ' | |
653 | 'Use "--match-filter -" to interactively ask whether to download each video')) | |
654 | selection.add_option( | |
655 | '--no-match-filters', | |
656 | dest='match_filter', action='store_const', const=None, | |
657 | help='Do not use any --match-filter (default)') | |
658 | selection.add_option( | |
659 | '--break-match-filters', | |
660 | metavar='FILTER', dest='breaking_match_filter', action='append', | |
661 | help='Same as "--match-filters" but stops the download process when a video is rejected') | |
662 | selection.add_option( | |
663 | '--no-break-match-filters', | |
664 | dest='breaking_match_filter', action='store_const', const=None, | |
665 | help='Do not use any --break-match-filters (default)') | |
666 | selection.add_option( | |
667 | '--no-playlist', | |
668 | action='store_true', dest='noplaylist', default=False, | |
669 | help='Download only the video, if the URL refers to a video and a playlist') | |
670 | selection.add_option( | |
671 | '--yes-playlist', | |
672 | action='store_false', dest='noplaylist', | |
673 | help='Download the playlist, if the URL refers to a video and a playlist') | |
674 | selection.add_option( | |
675 | '--age-limit', | |
676 | metavar='YEARS', dest='age_limit', default=None, type=int, | |
677 | help='Download only videos suitable for the given age') | |
678 | selection.add_option( | |
679 | '--download-archive', metavar='FILE', | |
680 | dest='download_archive', | |
681 | help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it') | |
682 | selection.add_option( | |
683 | '--no-download-archive', | |
684 | dest='download_archive', action="store_const", const=None, | |
685 | help='Do not use archive file (default)') | |
686 | selection.add_option( | |
687 | '--max-downloads', | |
688 | dest='max_downloads', metavar='NUMBER', type=int, default=None, | |
689 | help='Abort after downloading NUMBER files') | |
690 | selection.add_option( | |
691 | '--break-on-existing', | |
692 | action='store_true', dest='break_on_existing', default=False, | |
693 | help='Stop the download process when encountering a file that is in the archive') | |
694 | selection.add_option( | |
695 | '--no-break-on-existing', | |
696 | action='store_false', dest='break_on_existing', | |
697 | help='Do not stop the download process when encountering a file that is in the archive (default)') | |
698 | selection.add_option( | |
699 | '--break-on-reject', | |
700 | action='store_true', dest='break_on_reject', default=False, | |
701 | help=optparse.SUPPRESS_HELP) | |
702 | selection.add_option( | |
703 | '--break-per-input', | |
704 | action='store_true', dest='break_per_url', default=False, | |
705 | help='Alters --max-downloads, --break-on-existing, --break-match-filter, and autonumber to reset per input URL') | |
706 | selection.add_option( | |
707 | '--no-break-per-input', | |
708 | action='store_false', dest='break_per_url', | |
709 | help='--break-on-existing and similar options terminates the entire download queue') | |
710 | selection.add_option( | |
711 | '--skip-playlist-after-errors', metavar='N', | |
712 | dest='skip_playlist_after_errors', default=None, type=int, | |
713 | help='Number of allowed failures until the rest of the playlist is skipped') | |
714 | selection.add_option( | |
715 | '--include-ads', | |
716 | dest='include_ads', action='store_true', | |
717 | help=optparse.SUPPRESS_HELP) | |
718 | selection.add_option( | |
719 | '--no-include-ads', | |
720 | dest='include_ads', action='store_false', | |
721 | help=optparse.SUPPRESS_HELP) | |
722 | ||
723 | authentication = optparse.OptionGroup(parser, 'Authentication Options') | |
724 | authentication.add_option( | |
725 | '-u', '--username', | |
726 | dest='username', metavar='USERNAME', | |
727 | help='Login with this account ID') | |
728 | authentication.add_option( | |
729 | '-p', '--password', | |
730 | dest='password', metavar='PASSWORD', | |
731 | help='Account password. If this option is left out, yt-dlp will ask interactively') | |
732 | authentication.add_option( | |
733 | '-2', '--twofactor', | |
734 | dest='twofactor', metavar='TWOFACTOR', | |
735 | help='Two-factor authentication code') | |
736 | authentication.add_option( | |
737 | '-n', '--netrc', | |
738 | action='store_true', dest='usenetrc', default=False, | |
739 | help='Use .netrc authentication data') | |
740 | authentication.add_option( | |
741 | '--netrc-location', | |
742 | dest='netrc_location', metavar='PATH', | |
743 | help='Location of .netrc authentication data; either the path or its containing directory. Defaults to ~/.netrc') | |
744 | authentication.add_option( | |
745 | '--netrc-cmd', | |
746 | dest='netrc_cmd', metavar='NETRC_CMD', | |
747 | help='Command to execute to get the credentials for an extractor.') | |
748 | authentication.add_option( | |
749 | '--video-password', | |
750 | dest='videopassword', metavar='PASSWORD', | |
751 | help='Video-specific password') | |
752 | authentication.add_option( | |
753 | '--ap-mso', | |
754 | dest='ap_mso', metavar='MSO', | |
755 | help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs') | |
756 | authentication.add_option( | |
757 | '--ap-username', | |
758 | dest='ap_username', metavar='USERNAME', | |
759 | help='Multiple-system operator account login') | |
760 | authentication.add_option( | |
761 | '--ap-password', | |
762 | dest='ap_password', metavar='PASSWORD', | |
763 | help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively') | |
764 | authentication.add_option( | |
765 | '--ap-list-mso', | |
766 | action='store_true', dest='ap_list_mso', default=False, | |
767 | help='List all supported multiple-system operators') | |
768 | authentication.add_option( | |
769 | '--client-certificate', | |
770 | dest='client_certificate', metavar='CERTFILE', | |
771 | help='Path to client certificate file in PEM format. May include the private key') | |
772 | authentication.add_option( | |
773 | '--client-certificate-key', | |
774 | dest='client_certificate_key', metavar='KEYFILE', | |
775 | help='Path to private key file for client certificate') | |
776 | authentication.add_option( | |
777 | '--client-certificate-password', | |
778 | dest='client_certificate_password', metavar='PASSWORD', | |
779 | help='Password for client certificate private key, if encrypted. ' | |
780 | 'If not provided, and the key is encrypted, yt-dlp will ask interactively') | |
781 | ||
782 | video_format = optparse.OptionGroup(parser, 'Video Format Options') | |
783 | video_format.add_option( | |
784 | '-f', '--format', | |
785 | action='store', dest='format', metavar='FORMAT', default=None, | |
786 | help='Video format code, see "FORMAT SELECTION" for more details') | |
787 | video_format.add_option( | |
788 | '-S', '--format-sort', metavar='SORTORDER', | |
789 | dest='format_sort', default=[], type='str', action='callback', | |
790 | callback=_list_from_options_callback, callback_kwargs={'append': -1}, | |
791 | help='Sort the formats by the fields given, see "Sorting Formats" for more details') | |
792 | video_format.add_option( | |
793 | '--format-sort-force', '--S-force', | |
794 | action='store_true', dest='format_sort_force', metavar='FORMAT', default=False, | |
795 | help=( | |
796 | 'Force user specified sort order to have precedence over all fields, ' | |
797 | 'see "Sorting Formats" for more details (Alias: --S-force)')) | |
798 | video_format.add_option( | |
799 | '--no-format-sort-force', | |
800 | action='store_false', dest='format_sort_force', metavar='FORMAT', default=False, | |
801 | help='Some fields have precedence over the user specified sort order (default)') | |
802 | video_format.add_option( | |
803 | '--video-multistreams', | |
804 | action='store_true', dest='allow_multiple_video_streams', default=None, | |
805 | help='Allow multiple video streams to be merged into a single file') | |
806 | video_format.add_option( | |
807 | '--no-video-multistreams', | |
808 | action='store_false', dest='allow_multiple_video_streams', | |
809 | help='Only one video stream is downloaded for each output file (default)') | |
810 | video_format.add_option( | |
811 | '--audio-multistreams', | |
812 | action='store_true', dest='allow_multiple_audio_streams', default=None, | |
813 | help='Allow multiple audio streams to be merged into a single file') | |
814 | video_format.add_option( | |
815 | '--no-audio-multistreams', | |
816 | action='store_false', dest='allow_multiple_audio_streams', | |
817 | help='Only one audio stream is downloaded for each output file (default)') | |
818 | video_format.add_option( | |
819 | '--all-formats', | |
820 | action='store_const', dest='format', const='all', | |
821 | help=optparse.SUPPRESS_HELP) | |
822 | video_format.add_option( | |
823 | '--prefer-free-formats', | |
824 | action='store_true', dest='prefer_free_formats', default=False, | |
825 | help=( | |
826 | 'Prefer video formats with free containers over non-free ones of same quality. ' | |
827 | 'Use with "-S ext" to strictly prefer free containers irrespective of quality')) | |
828 | video_format.add_option( | |
829 | '--no-prefer-free-formats', | |
830 | action='store_false', dest='prefer_free_formats', default=False, | |
831 | help="Don't give any special preference to free containers (default)") | |
832 | video_format.add_option( | |
833 | '--check-formats', | |
834 | action='store_const', const='selected', dest='check_formats', default=None, | |
835 | help='Make sure formats are selected only from those that are actually downloadable') | |
836 | video_format.add_option( | |
837 | '--check-all-formats', | |
838 | action='store_true', dest='check_formats', | |
839 | help='Check all formats for whether they are actually downloadable') | |
840 | video_format.add_option( | |
841 | '--no-check-formats', | |
842 | action='store_false', dest='check_formats', | |
843 | help='Do not check that the formats are actually downloadable') | |
844 | video_format.add_option( | |
845 | '-F', '--list-formats', | |
846 | action='store_true', dest='listformats', | |
847 | help='List available formats of each video. Simulate unless --no-simulate is used') | |
848 | video_format.add_option( | |
849 | '--list-formats-as-table', | |
850 | action='store_true', dest='listformats_table', default=True, | |
851 | help=optparse.SUPPRESS_HELP) | |
852 | video_format.add_option( | |
853 | '--list-formats-old', '--no-list-formats-as-table', | |
854 | action='store_false', dest='listformats_table', | |
855 | help=optparse.SUPPRESS_HELP) | |
856 | video_format.add_option( | |
857 | '--merge-output-format', | |
858 | action='store', dest='merge_output_format', metavar='FORMAT', default=None, | |
859 | help=( | |
860 | 'Containers that may be used when merging formats, separated by "/", e.g. "mp4/mkv". ' | |
861 | 'Ignored if no merge is required. ' | |
862 | f'(currently supported: {", ".join(sorted(FFmpegMergerPP.SUPPORTED_EXTS))})')) | |
863 | video_format.add_option( | |
864 | '--allow-unplayable-formats', | |
865 | action='store_true', dest='allow_unplayable_formats', default=False, | |
866 | help=optparse.SUPPRESS_HELP) | |
867 | video_format.add_option( | |
868 | '--no-allow-unplayable-formats', | |
869 | action='store_false', dest='allow_unplayable_formats', | |
870 | help=optparse.SUPPRESS_HELP) | |
871 | ||
872 | subtitles = optparse.OptionGroup(parser, 'Subtitle Options') | |
873 | subtitles.add_option( | |
874 | '--write-subs', '--write-srt', | |
875 | action='store_true', dest='writesubtitles', default=False, | |
876 | help='Write subtitle file') | |
877 | subtitles.add_option( | |
878 | '--no-write-subs', '--no-write-srt', | |
879 | action='store_false', dest='writesubtitles', | |
880 | help='Do not write subtitle file (default)') | |
881 | subtitles.add_option( | |
882 | '--write-auto-subs', '--write-automatic-subs', | |
883 | action='store_true', dest='writeautomaticsub', default=False, | |
884 | help='Write automatically generated subtitle file (Alias: --write-automatic-subs)') | |
885 | subtitles.add_option( | |
886 | '--no-write-auto-subs', '--no-write-automatic-subs', | |
887 | action='store_false', dest='writeautomaticsub', default=False, | |
888 | help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)') | |
889 | subtitles.add_option( | |
890 | '--all-subs', | |
891 | action='store_true', dest='allsubtitles', default=False, | |
892 | help=optparse.SUPPRESS_HELP) | |
893 | subtitles.add_option( | |
894 | '--list-subs', | |
895 | action='store_true', dest='listsubtitles', default=False, | |
896 | help='List available subtitles of each video. Simulate unless --no-simulate is used') | |
897 | subtitles.add_option( | |
898 | '--sub-format', | |
899 | action='store', dest='subtitlesformat', metavar='FORMAT', default='best', | |
900 | help='Subtitle format; accepts formats preference, e.g. "srt" or "ass/srt/best"') | |
901 | subtitles.add_option( | |
902 | '--sub-langs', '--srt-langs', | |
903 | action='callback', dest='subtitleslangs', metavar='LANGS', type='str', | |
904 | default=[], callback=_list_from_options_callback, | |
905 | help=( | |
906 | 'Languages of the subtitles to download (can be regex) or "all" separated by commas, e.g. --sub-langs "en.*,ja". ' | |
907 | 'You can prefix the language code with a "-" to exclude it from the requested languages, e.g. --sub-langs all,-live_chat. ' | |
908 | 'Use --list-subs for a list of available language tags')) | |
909 | ||
910 | downloader = optparse.OptionGroup(parser, 'Download Options') | |
911 | downloader.add_option( | |
912 | '-N', '--concurrent-fragments', | |
913 | dest='concurrent_fragment_downloads', metavar='N', default=1, type=int, | |
914 | help='Number of fragments of a dash/hlsnative video that should be downloaded concurrently (default is %default)') | |
915 | downloader.add_option( | |
916 | '-r', '--limit-rate', '--rate-limit', | |
917 | dest='ratelimit', metavar='RATE', | |
918 | help='Maximum download rate in bytes per second, e.g. 50K or 4.2M') | |
919 | downloader.add_option( | |
920 | '--throttled-rate', | |
921 | dest='throttledratelimit', metavar='RATE', | |
922 | help='Minimum download rate in bytes per second below which throttling is assumed and the video data is re-extracted, e.g. 100K') | |
923 | downloader.add_option( | |
924 | '-R', '--retries', | |
925 | dest='retries', metavar='RETRIES', default=10, | |
926 | help='Number of retries (default is %default), or "infinite"') | |
927 | downloader.add_option( | |
928 | '--file-access-retries', | |
929 | dest='file_access_retries', metavar='RETRIES', default=3, | |
930 | help='Number of times to retry on file access error (default is %default), or "infinite"') | |
931 | downloader.add_option( | |
932 | '--fragment-retries', | |
933 | dest='fragment_retries', metavar='RETRIES', default=10, | |
934 | help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)') | |
935 | downloader.add_option( | |
936 | '--retry-sleep', | |
937 | dest='retry_sleep', metavar='[TYPE:]EXPR', default={}, type='str', | |
938 | action='callback', callback=_dict_from_options_callback, | |
939 | callback_kwargs={ | |
940 | 'allowed_keys': 'http|fragment|file_access|extractor', | |
941 | 'default_key': 'http', | |
942 | }, help=( | |
943 | 'Time to sleep between retries in seconds (optionally) prefixed by the type of retry ' | |
944 | '(http (default), fragment, file_access, extractor) to apply the sleep to. ' | |
945 | 'EXPR can be a number, linear=START[:END[:STEP=1]] or exp=START[:END[:BASE=2]]. ' | |
946 | 'This option can be used multiple times to set the sleep for the different retry types, ' | |
947 | 'e.g. --retry-sleep linear=1::2 --retry-sleep fragment:exp=1:20')) | |
948 | downloader.add_option( | |
949 | '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragments', | |
950 | action='store_true', dest='skip_unavailable_fragments', default=True, | |
951 | help='Skip unavailable fragments for DASH, hlsnative and ISM downloads (default) (Alias: --no-abort-on-unavailable-fragments)') | |
952 | downloader.add_option( | |
953 | '--abort-on-unavailable-fragments', '--no-skip-unavailable-fragments', | |
954 | action='store_false', dest='skip_unavailable_fragments', | |
955 | help='Abort download if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)') | |
956 | downloader.add_option( | |
957 | '--keep-fragments', | |
958 | action='store_true', dest='keep_fragments', default=False, | |
959 | help='Keep downloaded fragments on disk after downloading is finished') | |
960 | downloader.add_option( | |
961 | '--no-keep-fragments', | |
962 | action='store_false', dest='keep_fragments', | |
963 | help='Delete downloaded fragments after downloading is finished (default)') | |
964 | downloader.add_option( | |
965 | '--buffer-size', | |
966 | dest='buffersize', metavar='SIZE', default='1024', | |
967 | help='Size of download buffer, e.g. 1024 or 16K (default is %default)') | |
968 | downloader.add_option( | |
969 | '--resize-buffer', | |
970 | action='store_false', dest='noresizebuffer', | |
971 | help='The buffer size is automatically resized from an initial value of --buffer-size (default)') | |
972 | downloader.add_option( | |
973 | '--no-resize-buffer', | |
974 | action='store_true', dest='noresizebuffer', default=False, | |
975 | help='Do not automatically adjust the buffer size') | |
976 | downloader.add_option( | |
977 | '--http-chunk-size', | |
978 | dest='http_chunk_size', metavar='SIZE', default=None, | |
979 | help=( | |
980 | 'Size of a chunk for chunk-based HTTP downloading, e.g. 10485760 or 10M (default is disabled). ' | |
981 | 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)')) | |
982 | downloader.add_option( | |
983 | '--test', | |
984 | action='store_true', dest='test', default=False, | |
985 | help=optparse.SUPPRESS_HELP) | |
986 | downloader.add_option( | |
987 | '--playlist-reverse', | |
988 | action='store_true', dest='playlist_reverse', | |
989 | help=optparse.SUPPRESS_HELP) | |
990 | downloader.add_option( | |
991 | '--no-playlist-reverse', | |
992 | action='store_false', dest='playlist_reverse', | |
993 | help=optparse.SUPPRESS_HELP) | |
994 | downloader.add_option( | |
995 | '--playlist-random', | |
996 | action='store_true', dest='playlist_random', | |
997 | help='Download playlist videos in random order') | |
998 | downloader.add_option( | |
999 | '--lazy-playlist', | |
1000 | action='store_true', dest='lazy_playlist', | |
1001 | help='Process entries in the playlist as they are received. This disables n_entries, --playlist-random and --playlist-reverse') | |
1002 | downloader.add_option( | |
1003 | '--no-lazy-playlist', | |
1004 | action='store_false', dest='lazy_playlist', | |
1005 | help='Process videos in the playlist only after the entire playlist is parsed (default)') | |
1006 | downloader.add_option( | |
1007 | '--xattr-set-filesize', | |
1008 | dest='xattr_set_filesize', action='store_true', | |
1009 | help='Set file xattribute ytdl.filesize with expected file size') | |
1010 | downloader.add_option( | |
1011 | '--hls-prefer-native', | |
1012 | dest='hls_prefer_native', action='store_true', default=None, | |
1013 | help=optparse.SUPPRESS_HELP) | |
1014 | downloader.add_option( | |
1015 | '--hls-prefer-ffmpeg', | |
1016 | dest='hls_prefer_native', action='store_false', default=None, | |
1017 | help=optparse.SUPPRESS_HELP) | |
1018 | downloader.add_option( | |
1019 | '--hls-use-mpegts', | |
1020 | dest='hls_use_mpegts', action='store_true', default=None, | |
1021 | help=( | |
1022 | 'Use the mpegts container for HLS videos; ' | |
1023 | 'allowing some players to play the video while downloading, ' | |
1024 | 'and reducing the chance of file corruption if download is interrupted. ' | |
1025 | 'This is enabled by default for live streams')) | |
1026 | downloader.add_option( | |
1027 | '--no-hls-use-mpegts', | |
1028 | dest='hls_use_mpegts', action='store_false', | |
1029 | help=( | |
1030 | 'Do not use the mpegts container for HLS videos. ' | |
1031 | 'This is default when not downloading live streams')) | |
1032 | downloader.add_option( | |
1033 | '--download-sections', | |
1034 | metavar='REGEX', dest='download_ranges', action='append', | |
1035 | help=( | |
1036 | 'Download only chapters that match the regular expression. ' | |
1037 | 'A "*" prefix denotes time-range instead of chapter. Negative timestamps are calculated from the end. ' | |
1038 | '"*from-url" can be used to download between the "start_time" and "end_time" extracted from the URL. ' | |
1039 | 'Needs ffmpeg. This option can be used multiple times to download multiple sections, ' | |
1040 | 'e.g. --download-sections "*10:15-inf" --download-sections "intro"')) | |
1041 | downloader.add_option( | |
1042 | '--downloader', '--external-downloader', | |
1043 | dest='external_downloader', metavar='[PROTO:]NAME', default={}, type='str', | |
1044 | action='callback', callback=_dict_from_options_callback, | |
1045 | callback_kwargs={ | |
1046 | 'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms', | |
1047 | 'default_key': 'default', | |
1048 | 'process': str.strip | |
1049 | }, help=( | |
1050 | 'Name or path of the external downloader to use (optionally) prefixed by ' | |
1051 | 'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. ' | |
1052 | f'Currently supports native, {", ".join(sorted(list_external_downloaders()))}. ' | |
1053 | 'You can use this option multiple times to set different downloaders for different protocols. ' | |
1054 | 'E.g. --downloader aria2c --downloader "dash,m3u8:native" will use ' | |
1055 | 'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads ' | |
1056 | '(Alias: --external-downloader)')) | |
1057 | downloader.add_option( | |
1058 | '--downloader-args', '--external-downloader-args', | |
1059 | metavar='NAME:ARGS', dest='external_downloader_args', default={}, type='str', | |
1060 | action='callback', callback=_dict_from_options_callback, | |
1061 | callback_kwargs={ | |
1062 | 'allowed_keys': r'ffmpeg_[io]\d*|%s' % '|'.join(map(re.escape, list_external_downloaders())), | |
1063 | 'default_key': 'default', | |
1064 | 'process': shlex.split | |
1065 | }, help=( | |
1066 | 'Give these arguments to the external downloader. ' | |
1067 | 'Specify the downloader name and the arguments separated by a colon ":". ' | |
1068 | 'For ffmpeg, arguments can be passed to different positions using the same syntax as --postprocessor-args. ' | |
1069 | 'You can use this option multiple times to give different arguments to different downloaders ' | |
1070 | '(Alias: --external-downloader-args)')) | |
1071 | ||
1072 | workarounds = optparse.OptionGroup(parser, 'Workarounds') | |
1073 | workarounds.add_option( | |
1074 | '--encoding', | |
1075 | dest='encoding', metavar='ENCODING', | |
1076 | help='Force the specified encoding (experimental)') | |
1077 | workarounds.add_option( | |
1078 | '--legacy-server-connect', | |
1079 | action='store_true', dest='legacy_server_connect', default=False, | |
1080 | help='Explicitly allow HTTPS connection to servers that do not support RFC 5746 secure renegotiation') | |
1081 | workarounds.add_option( | |
1082 | '--no-check-certificates', | |
1083 | action='store_true', dest='no_check_certificate', default=False, | |
1084 | help='Suppress HTTPS certificate validation') | |
1085 | workarounds.add_option( | |
1086 | '--prefer-insecure', '--prefer-unsecure', | |
1087 | action='store_true', dest='prefer_insecure', | |
1088 | help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)') | |
1089 | workarounds.add_option( | |
1090 | '--user-agent', | |
1091 | metavar='UA', dest='user_agent', | |
1092 | help=optparse.SUPPRESS_HELP) | |
1093 | workarounds.add_option( | |
1094 | '--referer', | |
1095 | metavar='URL', dest='referer', default=None, | |
1096 | help=optparse.SUPPRESS_HELP) | |
1097 | workarounds.add_option( | |
1098 | '--add-headers', | |
1099 | metavar='FIELD:VALUE', dest='headers', default={}, type='str', | |
1100 | action='callback', callback=_dict_from_options_callback, | |
1101 | callback_kwargs={'multiple_keys': False}, | |
1102 | help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times', | |
1103 | ) | |
1104 | workarounds.add_option( | |
1105 | '--bidi-workaround', | |
1106 | dest='bidi_workaround', action='store_true', | |
1107 | help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH') | |
1108 | workarounds.add_option( | |
1109 | '--sleep-requests', metavar='SECONDS', | |
1110 | dest='sleep_interval_requests', type=float, | |
1111 | help='Number of seconds to sleep between requests during data extraction') | |
1112 | workarounds.add_option( | |
1113 | '--sleep-interval', '--min-sleep-interval', metavar='SECONDS', | |
1114 | dest='sleep_interval', type=float, | |
1115 | help=( | |
1116 | 'Number of seconds to sleep before each download. ' | |
1117 | 'This is the minimum time to sleep when used along with --max-sleep-interval ' | |
1118 | '(Alias: --min-sleep-interval)')) | |
1119 | workarounds.add_option( | |
1120 | '--max-sleep-interval', metavar='SECONDS', | |
1121 | dest='max_sleep_interval', type=float, | |
1122 | help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval') | |
1123 | workarounds.add_option( | |
1124 | '--sleep-subtitles', metavar='SECONDS', | |
1125 | dest='sleep_interval_subtitles', default=0, type=int, | |
1126 | help='Number of seconds to sleep before each subtitle download') | |
1127 | ||
1128 | verbosity = optparse.OptionGroup(parser, 'Verbosity and Simulation Options') | |
1129 | verbosity.add_option( | |
1130 | '-q', '--quiet', | |
1131 | action='store_true', dest='quiet', default=None, | |
1132 | help='Activate quiet mode. If used with --verbose, print the log to stderr') | |
1133 | verbosity.add_option( | |
1134 | '--no-quiet', | |
1135 | action='store_false', dest='quiet', | |
1136 | help='Deactivate quiet mode. (Default)') | |
1137 | verbosity.add_option( | |
1138 | '--no-warnings', | |
1139 | dest='no_warnings', action='store_true', default=False, | |
1140 | help='Ignore warnings') | |
1141 | verbosity.add_option( | |
1142 | '-s', '--simulate', | |
1143 | action='store_true', dest='simulate', default=None, | |
1144 | help='Do not download the video and do not write anything to disk') | |
1145 | verbosity.add_option( | |
1146 | '--no-simulate', | |
1147 | action='store_false', dest='simulate', | |
1148 | help='Download the video even if printing/listing options are used') | |
1149 | verbosity.add_option( | |
1150 | '--ignore-no-formats-error', | |
1151 | action='store_true', dest='ignore_no_formats_error', default=False, | |
1152 | help=( | |
1153 | 'Ignore "No video formats" error. Useful for extracting metadata ' | |
1154 | 'even if the videos are not actually available for download (experimental)')) | |
1155 | verbosity.add_option( | |
1156 | '--no-ignore-no-formats-error', | |
1157 | action='store_false', dest='ignore_no_formats_error', | |
1158 | help='Throw error when no downloadable video formats are found (default)') | |
1159 | verbosity.add_option( | |
1160 | '--skip-download', '--no-download', | |
1161 | action='store_true', dest='skip_download', default=False, | |
1162 | help='Do not download the video but write all related files (Alias: --no-download)') | |
1163 | verbosity.add_option( | |
1164 | '-O', '--print', | |
1165 | metavar='[WHEN:]TEMPLATE', dest='forceprint', **when_prefix('video'), | |
1166 | help=( | |
1167 | 'Field name or output template to print to screen, optionally prefixed with when to print it, separated by a ":". ' | |
1168 | 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: video). ' | |
1169 | 'Implies --quiet. Implies --simulate unless --no-simulate or later stages of WHEN are used. ' | |
1170 | 'This option can be used multiple times')) | |
1171 | verbosity.add_option( | |
1172 | '--print-to-file', | |
1173 | metavar='[WHEN:]TEMPLATE FILE', dest='print_to_file', nargs=2, **when_prefix('video'), | |
1174 | help=( | |
1175 | 'Append given template to the file. The values of WHEN and TEMPLATE are same as that of --print. ' | |
1176 | 'FILE uses the same syntax as the output template. This option can be used multiple times')) | |
1177 | verbosity.add_option( | |
1178 | '-g', '--get-url', | |
1179 | action='store_true', dest='geturl', default=False, | |
1180 | help=optparse.SUPPRESS_HELP) | |
1181 | verbosity.add_option( | |
1182 | '-e', '--get-title', | |
1183 | action='store_true', dest='gettitle', default=False, | |
1184 | help=optparse.SUPPRESS_HELP) | |
1185 | verbosity.add_option( | |
1186 | '--get-id', | |
1187 | action='store_true', dest='getid', default=False, | |
1188 | help=optparse.SUPPRESS_HELP) | |
1189 | verbosity.add_option( | |
1190 | '--get-thumbnail', | |
1191 | action='store_true', dest='getthumbnail', default=False, | |
1192 | help=optparse.SUPPRESS_HELP) | |
1193 | verbosity.add_option( | |
1194 | '--get-description', | |
1195 | action='store_true', dest='getdescription', default=False, | |
1196 | help=optparse.SUPPRESS_HELP) | |
1197 | verbosity.add_option( | |
1198 | '--get-duration', | |
1199 | action='store_true', dest='getduration', default=False, | |
1200 | help=optparse.SUPPRESS_HELP) | |
1201 | verbosity.add_option( | |
1202 | '--get-filename', | |
1203 | action='store_true', dest='getfilename', default=False, | |
1204 | help=optparse.SUPPRESS_HELP) | |
1205 | verbosity.add_option( | |
1206 | '--get-format', | |
1207 | action='store_true', dest='getformat', default=False, | |
1208 | help=optparse.SUPPRESS_HELP) | |
1209 | verbosity.add_option( | |
1210 | '-j', '--dump-json', | |
1211 | action='store_true', dest='dumpjson', default=False, | |
1212 | help=( | |
1213 | 'Quiet, but print JSON information for each video. Simulate unless --no-simulate is used. ' | |
1214 | 'See "OUTPUT TEMPLATE" for a description of available keys')) | |
1215 | verbosity.add_option( | |
1216 | '-J', '--dump-single-json', | |
1217 | action='store_true', dest='dump_single_json', default=False, | |
1218 | help=( | |
1219 | 'Quiet, but print JSON information for each url or infojson passed. Simulate unless --no-simulate is used. ' | |
1220 | 'If the URL refers to a playlist, the whole playlist information is dumped in a single line')) | |
1221 | verbosity.add_option( | |
1222 | '--print-json', | |
1223 | action='store_true', dest='print_json', default=False, | |
1224 | help=optparse.SUPPRESS_HELP) | |
1225 | verbosity.add_option( | |
1226 | '--force-write-archive', '--force-write-download-archive', '--force-download-archive', | |
1227 | action='store_true', dest='force_write_download_archive', default=False, | |
1228 | help=( | |
1229 | 'Force download archive entries to be written as far as no errors occur, ' | |
1230 | 'even if -s or another simulation option is used (Alias: --force-download-archive)')) | |
1231 | verbosity.add_option( | |
1232 | '--newline', | |
1233 | action='store_true', dest='progress_with_newline', default=False, | |
1234 | help='Output progress bar as new lines') | |
1235 | verbosity.add_option( | |
1236 | '--no-progress', | |
1237 | action='store_true', dest='noprogress', default=None, | |
1238 | help='Do not print progress bar') | |
1239 | verbosity.add_option( | |
1240 | '--progress', | |
1241 | action='store_false', dest='noprogress', | |
1242 | help='Show progress bar, even if in quiet mode') | |
1243 | verbosity.add_option( | |
1244 | '--console-title', | |
1245 | action='store_true', dest='consoletitle', default=False, | |
1246 | help='Display progress in console titlebar') | |
1247 | verbosity.add_option( | |
1248 | '--progress-template', | |
1249 | metavar='[TYPES:]TEMPLATE', dest='progress_template', default={}, type='str', | |
1250 | action='callback', callback=_dict_from_options_callback, | |
1251 | callback_kwargs={ | |
1252 | 'allowed_keys': '(download|postprocess)(-title)?', | |
1253 | 'default_key': 'download' | |
1254 | }, help=( | |
1255 | 'Template for progress outputs, optionally prefixed with one of "download:" (default), ' | |
1256 | '"download-title:" (the console title), "postprocess:", or "postprocess-title:". ' | |
1257 | 'The video\'s fields are accessible under the "info" key and ' | |
1258 | 'the progress attributes are accessible under "progress" key. E.g. ' | |
1259 | # TODO: Document the fields inside "progress" | |
1260 | '--console-title --progress-template "download-title:%(info.id)s-%(progress.eta)s"')) | |
1261 | verbosity.add_option( | |
1262 | '--progress-delta', | |
1263 | metavar='SECONDS', action='store', dest='progress_delta', type=float, default=0, | |
1264 | help='Time between progress output (default: 0)') | |
1265 | verbosity.add_option( | |
1266 | '-v', '--verbose', | |
1267 | action='store_true', dest='verbose', default=False, | |
1268 | help='Print various debugging information') | |
1269 | verbosity.add_option( | |
1270 | '--dump-pages', '--dump-intermediate-pages', | |
1271 | action='store_true', dest='dump_intermediate_pages', default=False, | |
1272 | help='Print downloaded pages encoded using base64 to debug problems (very verbose)') | |
1273 | verbosity.add_option( | |
1274 | '--write-pages', | |
1275 | action='store_true', dest='write_pages', default=False, | |
1276 | help='Write downloaded intermediary pages to files in the current directory to debug problems') | |
1277 | verbosity.add_option( | |
1278 | '--load-pages', | |
1279 | action='store_true', dest='load_pages', default=False, | |
1280 | help=optparse.SUPPRESS_HELP) | |
1281 | verbosity.add_option( | |
1282 | '--youtube-print-sig-code', | |
1283 | action='store_true', dest='youtube_print_sig_code', default=False, | |
1284 | help=optparse.SUPPRESS_HELP) | |
1285 | verbosity.add_option( | |
1286 | '--print-traffic', '--dump-headers', | |
1287 | dest='debug_printtraffic', action='store_true', default=False, | |
1288 | help='Display sent and read HTTP traffic') | |
1289 | verbosity.add_option( | |
1290 | '-C', '--call-home', | |
1291 | dest='call_home', action='store_true', default=False, | |
1292 | # help='Contact the yt-dlp server for debugging') | |
1293 | help=optparse.SUPPRESS_HELP) | |
1294 | verbosity.add_option( | |
1295 | '--no-call-home', | |
1296 | dest='call_home', action='store_false', | |
1297 | # help='Do not contact the yt-dlp server for debugging (default)') | |
1298 | help=optparse.SUPPRESS_HELP) | |
1299 | ||
1300 | filesystem = optparse.OptionGroup(parser, 'Filesystem Options') | |
1301 | filesystem.add_option( | |
1302 | '-a', '--batch-file', | |
1303 | dest='batchfile', metavar='FILE', | |
1304 | help=( | |
1305 | 'File containing URLs to download ("-" for stdin), one URL per line. ' | |
1306 | 'Lines starting with "#", ";" or "]" are considered as comments and ignored')) | |
1307 | filesystem.add_option( | |
1308 | '--no-batch-file', | |
1309 | dest='batchfile', action='store_const', const=None, | |
1310 | help='Do not read URLs from batch file (default)') | |
1311 | filesystem.add_option( | |
1312 | '--id', default=False, | |
1313 | action='store_true', dest='useid', help=optparse.SUPPRESS_HELP) | |
1314 | filesystem.add_option( | |
1315 | '-P', '--paths', | |
1316 | metavar='[TYPES:]PATH', dest='paths', default={}, type='str', | |
1317 | action='callback', callback=_dict_from_options_callback, | |
1318 | callback_kwargs={ | |
1319 | 'allowed_keys': 'home|temp|%s' % '|'.join(map(re.escape, OUTTMPL_TYPES.keys())), | |
1320 | 'default_key': 'home' | |
1321 | }, help=( | |
1322 | 'The paths where the files should be downloaded. ' | |
1323 | 'Specify the type of file and the path separated by a colon ":". ' | |
1324 | 'All the same TYPES as --output are supported. ' | |
1325 | 'Additionally, you can also provide "home" (default) and "temp" paths. ' | |
1326 | 'All intermediary files are first downloaded to the temp path and ' | |
1327 | 'then the final files are moved over to the home path after download is finished. ' | |
1328 | 'This option is ignored if --output is an absolute path')) | |
1329 | filesystem.add_option( | |
1330 | '-o', '--output', | |
1331 | metavar='[TYPES:]TEMPLATE', dest='outtmpl', default={}, type='str', | |
1332 | action='callback', callback=_dict_from_options_callback, | |
1333 | callback_kwargs={ | |
1334 | 'allowed_keys': '|'.join(map(re.escape, OUTTMPL_TYPES.keys())), | |
1335 | 'default_key': 'default' | |
1336 | }, help='Output filename template; see "OUTPUT TEMPLATE" for details') | |
1337 | filesystem.add_option( | |
1338 | '--output-na-placeholder', | |
1339 | dest='outtmpl_na_placeholder', metavar='TEXT', default='NA', | |
1340 | help=('Placeholder for unavailable fields in --output (default: "%default")')) | |
1341 | filesystem.add_option( | |
1342 | '--autonumber-size', | |
1343 | dest='autonumber_size', metavar='NUMBER', type=int, | |
1344 | help=optparse.SUPPRESS_HELP) | |
1345 | filesystem.add_option( | |
1346 | '--autonumber-start', | |
1347 | dest='autonumber_start', metavar='NUMBER', default=1, type=int, | |
1348 | help=optparse.SUPPRESS_HELP) | |
1349 | filesystem.add_option( | |
1350 | '--restrict-filenames', | |
1351 | action='store_true', dest='restrictfilenames', default=False, | |
1352 | help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames') | |
1353 | filesystem.add_option( | |
1354 | '--no-restrict-filenames', | |
1355 | action='store_false', dest='restrictfilenames', | |
1356 | help='Allow Unicode characters, "&" and spaces in filenames (default)') | |
1357 | filesystem.add_option( | |
1358 | '--windows-filenames', | |
1359 | action='store_true', dest='windowsfilenames', default=False, | |
1360 | help='Force filenames to be Windows-compatible') | |
1361 | filesystem.add_option( | |
1362 | '--no-windows-filenames', | |
1363 | action='store_false', dest='windowsfilenames', | |
1364 | help='Make filenames Windows-compatible only if using Windows (default)') | |
1365 | filesystem.add_option( | |
1366 | '--trim-filenames', '--trim-file-names', metavar='LENGTH', | |
1367 | dest='trim_file_name', default=0, type=int, | |
1368 | help='Limit the filename length (excluding extension) to the specified number of characters') | |
1369 | filesystem.add_option( | |
1370 | '-w', '--no-overwrites', | |
1371 | action='store_false', dest='overwrites', default=None, | |
1372 | help='Do not overwrite any files') | |
1373 | filesystem.add_option( | |
1374 | '--force-overwrites', '--yes-overwrites', | |
1375 | action='store_true', dest='overwrites', | |
1376 | help='Overwrite all video and metadata files. This option includes --no-continue') | |
1377 | filesystem.add_option( | |
1378 | '--no-force-overwrites', | |
1379 | action='store_const', dest='overwrites', const=None, | |
1380 | help='Do not overwrite the video, but overwrite related files (default)') | |
1381 | filesystem.add_option( | |
1382 | '-c', '--continue', | |
1383 | action='store_true', dest='continue_dl', default=True, | |
1384 | help='Resume partially downloaded files/fragments (default)') | |
1385 | filesystem.add_option( | |
1386 | '--no-continue', | |
1387 | action='store_false', dest='continue_dl', | |
1388 | help=( | |
1389 | 'Do not resume partially downloaded fragments. ' | |
1390 | 'If the file is not fragmented, restart download of the entire file')) | |
1391 | filesystem.add_option( | |
1392 | '--part', | |
1393 | action='store_false', dest='nopart', default=False, | |
1394 | help='Use .part files instead of writing directly into output file (default)') | |
1395 | filesystem.add_option( | |
1396 | '--no-part', | |
1397 | action='store_true', dest='nopart', | |
1398 | help='Do not use .part files - write directly into output file') | |
1399 | filesystem.add_option( | |
1400 | '--mtime', | |
1401 | action='store_true', dest='updatetime', default=True, | |
1402 | help='Use the Last-modified header to set the file modification time (default)') | |
1403 | filesystem.add_option( | |
1404 | '--no-mtime', | |
1405 | action='store_false', dest='updatetime', | |
1406 | help='Do not use the Last-modified header to set the file modification time') | |
1407 | filesystem.add_option( | |
1408 | '--write-description', | |
1409 | action='store_true', dest='writedescription', default=False, | |
1410 | help='Write video description to a .description file') | |
1411 | filesystem.add_option( | |
1412 | '--no-write-description', | |
1413 | action='store_false', dest='writedescription', | |
1414 | help='Do not write video description (default)') | |
1415 | filesystem.add_option( | |
1416 | '--write-info-json', | |
1417 | action='store_true', dest='writeinfojson', default=None, | |
1418 | help='Write video metadata to a .info.json file (this may contain personal information)') | |
1419 | filesystem.add_option( | |
1420 | '--no-write-info-json', | |
1421 | action='store_false', dest='writeinfojson', | |
1422 | help='Do not write video metadata (default)') | |
1423 | filesystem.add_option( | |
1424 | '--write-annotations', | |
1425 | action='store_true', dest='writeannotations', default=False, | |
1426 | help=optparse.SUPPRESS_HELP) | |
1427 | filesystem.add_option( | |
1428 | '--no-write-annotations', | |
1429 | action='store_false', dest='writeannotations', | |
1430 | help=optparse.SUPPRESS_HELP) | |
1431 | filesystem.add_option( | |
1432 | '--write-playlist-metafiles', | |
1433 | action='store_true', dest='allow_playlist_files', default=None, | |
1434 | help=( | |
1435 | 'Write playlist metadata in addition to the video metadata ' | |
1436 | 'when using --write-info-json, --write-description etc. (default)')) | |
1437 | filesystem.add_option( | |
1438 | '--no-write-playlist-metafiles', | |
1439 | action='store_false', dest='allow_playlist_files', | |
1440 | help='Do not write playlist metadata when using --write-info-json, --write-description etc.') | |
1441 | filesystem.add_option( | |
1442 | '--clean-info-json', '--clean-infojson', | |
1443 | action='store_true', dest='clean_infojson', default=None, | |
1444 | help=( | |
1445 | 'Remove some internal metadata such as filenames from the infojson (default)')) | |
1446 | filesystem.add_option( | |
1447 | '--no-clean-info-json', '--no-clean-infojson', | |
1448 | action='store_false', dest='clean_infojson', | |
1449 | help='Write all fields to the infojson') | |
1450 | filesystem.add_option( | |
1451 | '--write-comments', '--get-comments', | |
1452 | action='store_true', dest='getcomments', default=False, | |
1453 | help=( | |
1454 | 'Retrieve video comments to be placed in the infojson. ' | |
1455 | 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)')) | |
1456 | filesystem.add_option( | |
1457 | '--no-write-comments', '--no-get-comments', | |
1458 | action='store_false', dest='getcomments', | |
1459 | help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)') | |
1460 | filesystem.add_option( | |
1461 | '--load-info-json', '--load-info', | |
1462 | dest='load_info_filename', metavar='FILE', | |
1463 | help='JSON file containing the video information (created with the "--write-info-json" option)') | |
1464 | filesystem.add_option( | |
1465 | '--cookies', | |
1466 | dest='cookiefile', metavar='FILE', | |
1467 | help='Netscape formatted file to read cookies from and dump cookie jar in') | |
1468 | filesystem.add_option( | |
1469 | '--no-cookies', | |
1470 | action='store_const', const=None, dest='cookiefile', metavar='FILE', | |
1471 | help='Do not read/dump cookies from/to file (default)') | |
1472 | filesystem.add_option( | |
1473 | '--cookies-from-browser', | |
1474 | dest='cookiesfrombrowser', metavar='BROWSER[+KEYRING][:PROFILE][::CONTAINER]', | |
1475 | help=( | |
1476 | 'The name of the browser to load cookies from. ' | |
1477 | f'Currently supported browsers are: {", ".join(sorted(SUPPORTED_BROWSERS))}. ' | |
1478 | 'Optionally, the KEYRING used for decrypting Chromium cookies on Linux, ' | |
1479 | 'the name/path of the PROFILE to load cookies from, ' | |
1480 | 'and the CONTAINER name (if Firefox) ("none" for no container) ' | |
1481 | 'can be given with their respective seperators. ' | |
1482 | 'By default, all containers of the most recently accessed profile are used. ' | |
1483 | f'Currently supported keyrings are: {", ".join(map(str.lower, sorted(SUPPORTED_KEYRINGS)))}')) | |
1484 | filesystem.add_option( | |
1485 | '--no-cookies-from-browser', | |
1486 | action='store_const', const=None, dest='cookiesfrombrowser', | |
1487 | help='Do not load cookies from browser (default)') | |
1488 | filesystem.add_option( | |
1489 | '--cache-dir', dest='cachedir', default=None, metavar='DIR', | |
1490 | help=( | |
1491 | 'Location in the filesystem where yt-dlp can store some downloaded information ' | |
1492 | '(such as client ids and signatures) permanently. By default ${XDG_CACHE_HOME}/yt-dlp')) | |
1493 | filesystem.add_option( | |
1494 | '--no-cache-dir', action='store_false', dest='cachedir', | |
1495 | help='Disable filesystem caching') | |
1496 | filesystem.add_option( | |
1497 | '--rm-cache-dir', | |
1498 | action='store_true', dest='rm_cachedir', | |
1499 | help='Delete all filesystem cache files') | |
1500 | ||
1501 | thumbnail = optparse.OptionGroup(parser, 'Thumbnail Options') | |
1502 | thumbnail.add_option( | |
1503 | '--write-thumbnail', | |
1504 | action='callback', dest='writethumbnail', default=False, | |
1505 | # Should override --no-write-thumbnail, but not --write-all-thumbnail | |
1506 | callback=lambda option, _, __, parser: setattr( | |
1507 | parser.values, option.dest, getattr(parser.values, option.dest) or True), | |
1508 | help='Write thumbnail image to disk') | |
1509 | thumbnail.add_option( | |
1510 | '--no-write-thumbnail', | |
1511 | action='store_false', dest='writethumbnail', | |
1512 | help='Do not write thumbnail image to disk (default)') | |
1513 | thumbnail.add_option( | |
1514 | '--write-all-thumbnails', | |
1515 | action='store_const', dest='writethumbnail', const='all', | |
1516 | help='Write all thumbnail image formats to disk') | |
1517 | thumbnail.add_option( | |
1518 | '--list-thumbnails', | |
1519 | action='store_true', dest='list_thumbnails', default=False, | |
1520 | help='List available thumbnails of each video. Simulate unless --no-simulate is used') | |
1521 | ||
1522 | link = optparse.OptionGroup(parser, 'Internet Shortcut Options') | |
1523 | link.add_option( | |
1524 | '--write-link', | |
1525 | action='store_true', dest='writelink', default=False, | |
1526 | help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS') | |
1527 | link.add_option( | |
1528 | '--write-url-link', | |
1529 | action='store_true', dest='writeurllink', default=False, | |
1530 | help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path') | |
1531 | link.add_option( | |
1532 | '--write-webloc-link', | |
1533 | action='store_true', dest='writewebloclink', default=False, | |
1534 | help='Write a .webloc macOS internet shortcut') | |
1535 | link.add_option( | |
1536 | '--write-desktop-link', | |
1537 | action='store_true', dest='writedesktoplink', default=False, | |
1538 | help='Write a .desktop Linux internet shortcut') | |
1539 | ||
1540 | postproc = optparse.OptionGroup(parser, 'Post-Processing Options') | |
1541 | postproc.add_option( | |
1542 | '-x', '--extract-audio', | |
1543 | action='store_true', dest='extractaudio', default=False, | |
1544 | help='Convert video files to audio-only files (requires ffmpeg and ffprobe)') | |
1545 | postproc.add_option( | |
1546 | '--audio-format', metavar='FORMAT', dest='audioformat', default='best', | |
1547 | help=( | |
1548 | 'Format to convert the audio to when -x is used. ' | |
1549 | f'(currently supported: best (default), {", ".join(sorted(FFmpegExtractAudioPP.SUPPORTED_EXTS))}). ' | |
1550 | 'You can specify multiple rules using similar syntax as --remux-video')) | |
1551 | postproc.add_option( | |
1552 | '--audio-quality', metavar='QUALITY', | |
1553 | dest='audioquality', default='5', | |
1554 | help=( | |
1555 | 'Specify ffmpeg audio quality to use when converting the audio with -x. ' | |
1556 | 'Insert a value between 0 (best) and 10 (worst) for VBR or a specific bitrate like 128K (default %default)')) | |
1557 | postproc.add_option( | |
1558 | '--remux-video', | |
1559 | metavar='FORMAT', dest='remuxvideo', default=None, | |
1560 | help=( | |
1561 | 'Remux the video into another container if necessary ' | |
1562 | f'(currently supported: {", ".join(FFmpegVideoRemuxerPP.SUPPORTED_EXTS)}). ' | |
1563 | 'If target container does not support the video/audio codec, remuxing will fail. You can specify multiple rules; ' | |
1564 | 'e.g. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 and anything else to mkv')) | |
1565 | postproc.add_option( | |
1566 | '--recode-video', | |
1567 | metavar='FORMAT', dest='recodevideo', default=None, | |
1568 | help='Re-encode the video into another format if necessary. The syntax and supported formats are the same as --remux-video') | |
1569 | postproc.add_option( | |
1570 | '--postprocessor-args', '--ppa', | |
1571 | metavar='NAME:ARGS', dest='postprocessor_args', default={}, type='str', | |
1572 | action='callback', callback=_dict_from_options_callback, | |
1573 | callback_kwargs={ | |
1574 | 'allowed_keys': r'\w+(?:\+\w+)?', | |
1575 | 'default_key': 'default-compat', | |
1576 | 'process': shlex.split, | |
1577 | 'multiple_keys': False | |
1578 | }, help=( | |
1579 | 'Give these arguments to the postprocessors. ' | |
1580 | 'Specify the postprocessor/executable name and the arguments separated by a colon ":" ' | |
1581 | 'to give the argument to the specified postprocessor/executable. Supported PP are: ' | |
1582 | 'Merger, ModifyChapters, SplitChapters, ExtractAudio, VideoRemuxer, VideoConvertor, ' | |
1583 | 'Metadata, EmbedSubtitle, EmbedThumbnail, SubtitlesConvertor, ThumbnailsConvertor, ' | |
1584 | 'FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. ' | |
1585 | 'The supported executables are: AtomicParsley, FFmpeg and FFprobe. ' | |
1586 | 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable ' | |
1587 | 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, ' | |
1588 | '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument ' | |
1589 | 'before the specified input/output file, e.g. --ppa "Merger+ffmpeg_i1:-v quiet". ' | |
1590 | 'You can use this option multiple times to give different arguments to different ' | |
1591 | 'postprocessors. (Alias: --ppa)')) | |
1592 | postproc.add_option( | |
1593 | '-k', '--keep-video', | |
1594 | action='store_true', dest='keepvideo', default=False, | |
1595 | help='Keep the intermediate video file on disk after post-processing') | |
1596 | postproc.add_option( | |
1597 | '--no-keep-video', | |
1598 | action='store_false', dest='keepvideo', | |
1599 | help='Delete the intermediate video file after post-processing (default)') | |
1600 | postproc.add_option( | |
1601 | '--post-overwrites', | |
1602 | action='store_false', dest='nopostoverwrites', | |
1603 | help='Overwrite post-processed files (default)') | |
1604 | postproc.add_option( | |
1605 | '--no-post-overwrites', | |
1606 | action='store_true', dest='nopostoverwrites', default=False, | |
1607 | help='Do not overwrite post-processed files') | |
1608 | postproc.add_option( | |
1609 | '--embed-subs', | |
1610 | action='store_true', dest='embedsubtitles', default=False, | |
1611 | help='Embed subtitles in the video (only for mp4, webm and mkv videos)') | |
1612 | postproc.add_option( | |
1613 | '--no-embed-subs', | |
1614 | action='store_false', dest='embedsubtitles', | |
1615 | help='Do not embed subtitles (default)') | |
1616 | postproc.add_option( | |
1617 | '--embed-thumbnail', | |
1618 | action='store_true', dest='embedthumbnail', default=False, | |
1619 | help='Embed thumbnail in the video as cover art') | |
1620 | postproc.add_option( | |
1621 | '--no-embed-thumbnail', | |
1622 | action='store_false', dest='embedthumbnail', | |
1623 | help='Do not embed thumbnail (default)') | |
1624 | postproc.add_option( | |
1625 | '--embed-metadata', '--add-metadata', | |
1626 | action='store_true', dest='addmetadata', default=False, | |
1627 | help=( | |
1628 | 'Embed metadata to the video file. Also embeds chapters/infojson if present ' | |
1629 | 'unless --no-embed-chapters/--no-embed-info-json are used (Alias: --add-metadata)')) | |
1630 | postproc.add_option( | |
1631 | '--no-embed-metadata', '--no-add-metadata', | |
1632 | action='store_false', dest='addmetadata', | |
1633 | help='Do not add metadata to file (default) (Alias: --no-add-metadata)') | |
1634 | postproc.add_option( | |
1635 | '--embed-chapters', '--add-chapters', | |
1636 | action='store_true', dest='addchapters', default=None, | |
1637 | help='Add chapter markers to the video file (Alias: --add-chapters)') | |
1638 | postproc.add_option( | |
1639 | '--no-embed-chapters', '--no-add-chapters', | |
1640 | action='store_false', dest='addchapters', | |
1641 | help='Do not add chapter markers (default) (Alias: --no-add-chapters)') | |
1642 | postproc.add_option( | |
1643 | '--embed-info-json', | |
1644 | action='store_true', dest='embed_infojson', default=None, | |
1645 | help='Embed the infojson as an attachment to mkv/mka video files') | |
1646 | postproc.add_option( | |
1647 | '--no-embed-info-json', | |
1648 | action='store_false', dest='embed_infojson', | |
1649 | help='Do not embed the infojson as an attachment to the video file') | |
1650 | postproc.add_option( | |
1651 | '--metadata-from-title', | |
1652 | metavar='FORMAT', dest='metafromtitle', | |
1653 | help=optparse.SUPPRESS_HELP) | |
1654 | postproc.add_option( | |
1655 | '--parse-metadata', | |
1656 | metavar='[WHEN:]FROM:TO', dest='parse_metadata', **when_prefix('pre_process'), | |
1657 | help=( | |
1658 | 'Parse additional metadata like title/artist from other fields; see "MODIFYING METADATA" for details. ' | |
1659 | 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: pre_process)')) | |
1660 | postproc.add_option( | |
1661 | '--replace-in-metadata', | |
1662 | dest='parse_metadata', metavar='[WHEN:]FIELDS REGEX REPLACE', nargs=3, **when_prefix('pre_process'), | |
1663 | help=( | |
1664 | 'Replace text in a metadata field using the given regex. This option can be used multiple times. ' | |
1665 | 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: pre_process)')) | |
1666 | postproc.add_option( | |
1667 | '--xattrs', '--xattr', | |
1668 | action='store_true', dest='xattrs', default=False, | |
1669 | help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)') | |
1670 | postproc.add_option( | |
1671 | '--concat-playlist', | |
1672 | metavar='POLICY', dest='concat_playlist', default='multi_video', | |
1673 | choices=('never', 'always', 'multi_video'), | |
1674 | help=( | |
1675 | 'Concatenate videos in a playlist. One of "never", "always", or ' | |
1676 | '"multi_video" (default; only when the videos form a single show). ' | |
1677 | 'All the video files must have same codecs and number of streams to be concatable. ' | |
1678 | 'The "pl_video:" prefix can be used with "--paths" and "--output" to ' | |
1679 | 'set the output filename for the concatenated files. See "OUTPUT TEMPLATE" for details')) | |
1680 | postproc.add_option( | |
1681 | '--fixup', | |
1682 | metavar='POLICY', dest='fixup', default=None, | |
1683 | choices=('never', 'ignore', 'warn', 'detect_or_warn', 'force'), | |
1684 | help=( | |
1685 | 'Automatically correct known faults of the file. ' | |
1686 | 'One of never (do nothing), warn (only emit a warning), ' | |
1687 | 'detect_or_warn (the default; fix file if we can, warn otherwise), ' | |
1688 | 'force (try fixing even if file already exists)')) | |
1689 | postproc.add_option( | |
1690 | '--prefer-avconv', '--no-prefer-ffmpeg', | |
1691 | action='store_false', dest='prefer_ffmpeg', | |
1692 | help=optparse.SUPPRESS_HELP) | |
1693 | postproc.add_option( | |
1694 | '--prefer-ffmpeg', '--no-prefer-avconv', | |
1695 | action='store_true', dest='prefer_ffmpeg', default=True, | |
1696 | help=optparse.SUPPRESS_HELP) | |
1697 | postproc.add_option( | |
1698 | '--ffmpeg-location', '--avconv-location', metavar='PATH', | |
1699 | dest='ffmpeg_location', | |
1700 | help='Location of the ffmpeg binary; either the path to the binary or its containing directory') | |
1701 | postproc.add_option( | |
1702 | '--exec', | |
1703 | metavar='[WHEN:]CMD', dest='exec_cmd', **when_prefix('after_move'), | |
1704 | help=( | |
1705 | 'Execute a command, optionally prefixed with when to execute it, separated by a ":". ' | |
1706 | 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: after_move). ' | |
1707 | 'Same syntax as the output template can be used to pass any field as arguments to the command. ' | |
1708 | 'If no fields are passed, %(filepath,_filename|)q is appended to the end of the command. ' | |
1709 | 'This option can be used multiple times')) | |
1710 | postproc.add_option( | |
1711 | '--no-exec', | |
1712 | action='store_const', dest='exec_cmd', const={}, | |
1713 | help='Remove any previously defined --exec') | |
1714 | postproc.add_option( | |
1715 | '--exec-before-download', metavar='CMD', | |
1716 | action='append', dest='exec_before_dl_cmd', | |
1717 | help=optparse.SUPPRESS_HELP) | |
1718 | postproc.add_option( | |
1719 | '--no-exec-before-download', | |
1720 | action='store_const', dest='exec_before_dl_cmd', const=None, | |
1721 | help=optparse.SUPPRESS_HELP) | |
1722 | postproc.add_option( | |
1723 | '--convert-subs', '--convert-sub', '--convert-subtitles', | |
1724 | metavar='FORMAT', dest='convertsubtitles', default=None, | |
1725 | help=( | |
1726 | 'Convert the subtitles to another format (currently supported: %s) ' | |
1727 | '(Alias: --convert-subtitles)' % ', '.join(sorted(FFmpegSubtitlesConvertorPP.SUPPORTED_EXTS)))) | |
1728 | postproc.add_option( | |
1729 | '--convert-thumbnails', | |
1730 | metavar='FORMAT', dest='convertthumbnails', default=None, | |
1731 | help=( | |
1732 | 'Convert the thumbnails to another format ' | |
1733 | f'(currently supported: {", ".join(sorted(FFmpegThumbnailsConvertorPP.SUPPORTED_EXTS))}). ' | |
1734 | 'You can specify multiple rules using similar syntax as --remux-video')) | |
1735 | postproc.add_option( | |
1736 | '--split-chapters', '--split-tracks', | |
1737 | dest='split_chapters', action='store_true', default=False, | |
1738 | help=( | |
1739 | 'Split video into multiple files based on internal chapters. ' | |
1740 | 'The "chapter:" prefix can be used with "--paths" and "--output" to ' | |
1741 | 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details')) | |
1742 | postproc.add_option( | |
1743 | '--no-split-chapters', '--no-split-tracks', | |
1744 | dest='split_chapters', action='store_false', | |
1745 | help='Do not split video based on chapters (default)') | |
1746 | postproc.add_option( | |
1747 | '--remove-chapters', | |
1748 | metavar='REGEX', dest='remove_chapters', action='append', | |
1749 | help=( | |
1750 | 'Remove chapters whose title matches the given regular expression. ' | |
1751 | 'The syntax is the same as --download-sections. This option can be used multiple times')) | |
1752 | postproc.add_option( | |
1753 | '--no-remove-chapters', dest='remove_chapters', action='store_const', const=None, | |
1754 | help='Do not remove any chapters from the file (default)') | |
1755 | postproc.add_option( | |
1756 | '--force-keyframes-at-cuts', | |
1757 | action='store_true', dest='force_keyframes_at_cuts', default=False, | |
1758 | help=( | |
1759 | 'Force keyframes at cuts when downloading/splitting/removing sections. ' | |
1760 | 'This is slow due to needing a re-encode, but the resulting video may have fewer artifacts around the cuts')) | |
1761 | postproc.add_option( | |
1762 | '--no-force-keyframes-at-cuts', | |
1763 | action='store_false', dest='force_keyframes_at_cuts', | |
1764 | help='Do not force keyframes around the chapters when cutting/splitting (default)') | |
1765 | _postprocessor_opts_parser = lambda key, val='': ( | |
1766 | *(item.split('=', 1) for item in (val.split(';') if val else [])), | |
1767 | ('key', remove_end(key, 'PP'))) | |
1768 | postproc.add_option( | |
1769 | '--use-postprocessor', | |
1770 | metavar='NAME[:ARGS]', dest='add_postprocessors', default=[], type='str', | |
1771 | action='callback', callback=_list_from_options_callback, | |
1772 | callback_kwargs={ | |
1773 | 'delim': None, | |
1774 | 'process': lambda val: dict(_postprocessor_opts_parser(*val.split(':', 1))) | |
1775 | }, help=( | |
1776 | 'The (case sensitive) name of plugin postprocessors to be enabled, ' | |
1777 | 'and (optionally) arguments to be passed to it, separated by a colon ":". ' | |
1778 | 'ARGS are a semicolon ";" delimited list of NAME=VALUE. ' | |
1779 | 'The "when" argument determines when the postprocessor is invoked. ' | |
1780 | 'It can be one of "pre_process" (after video extraction), "after_filter" (after video passes filter), ' | |
1781 | '"video" (after --format; before --print/--output), "before_dl" (before each video download), ' | |
1782 | '"post_process" (after each video download; default), ' | |
1783 | '"after_move" (after moving video file to it\'s final locations), ' | |
1784 | '"after_video" (after downloading and processing all formats of a video), ' | |
1785 | 'or "playlist" (at end of playlist). ' | |
1786 | 'This option can be used multiple times to add different postprocessors')) | |
1787 | ||
1788 | sponsorblock = optparse.OptionGroup(parser, 'SponsorBlock Options', description=( | |
1789 | 'Make chapter entries for, or remove various segments (sponsor, introductions, etc.) ' | |
1790 | 'from downloaded YouTube videos using the SponsorBlock API (https://sponsor.ajay.app)')) | |
1791 | sponsorblock.add_option( | |
1792 | '--sponsorblock-mark', metavar='CATS', | |
1793 | dest='sponsorblock_mark', default=set(), action='callback', type='str', | |
1794 | callback=_set_from_options_callback, callback_kwargs={ | |
1795 | 'allowed_values': SponsorBlockPP.CATEGORIES.keys(), | |
1796 | 'aliases': {'default': ['all']} | |
1797 | }, help=( | |
1798 | 'SponsorBlock categories to create chapters for, separated by commas. ' | |
1799 | f'Available categories are {", ".join(SponsorBlockPP.CATEGORIES.keys())}, all and default (=all). ' | |
1800 | 'You can prefix the category with a "-" to exclude it. See [1] for description of the categories. ' | |
1801 | 'E.g. --sponsorblock-mark all,-preview [1] https://wiki.sponsor.ajay.app/w/Segment_Categories')) | |
1802 | sponsorblock.add_option( | |
1803 | '--sponsorblock-remove', metavar='CATS', | |
1804 | dest='sponsorblock_remove', default=set(), action='callback', type='str', | |
1805 | callback=_set_from_options_callback, callback_kwargs={ | |
1806 | 'allowed_values': set(SponsorBlockPP.CATEGORIES.keys()) - set(SponsorBlockPP.NON_SKIPPABLE_CATEGORIES.keys()), | |
1807 | # Note: From https://wiki.sponsor.ajay.app/w/Types: | |
1808 | # The filler category is very aggressive. | |
1809 | # It is strongly recommended to not use this in a client by default. | |
1810 | 'aliases': {'default': ['all', '-filler']} | |
1811 | }, help=( | |
1812 | 'SponsorBlock categories to be removed from the video file, separated by commas. ' | |
1813 | 'If a category is present in both mark and remove, remove takes precedence. ' | |
1814 | 'The syntax and available categories are the same as for --sponsorblock-mark ' | |
1815 | 'except that "default" refers to "all,-filler" ' | |
1816 | f'and {", ".join(SponsorBlockPP.NON_SKIPPABLE_CATEGORIES.keys())} are not available')) | |
1817 | sponsorblock.add_option( | |
1818 | '--sponsorblock-chapter-title', metavar='TEMPLATE', | |
1819 | default=DEFAULT_SPONSORBLOCK_CHAPTER_TITLE, dest='sponsorblock_chapter_title', | |
1820 | help=( | |
1821 | 'An output template for the title of the SponsorBlock chapters created by --sponsorblock-mark. ' | |
1822 | 'The only available fields are start_time, end_time, category, categories, name, category_names. ' | |
1823 | 'Defaults to "%default"')) | |
1824 | sponsorblock.add_option( | |
1825 | '--no-sponsorblock', default=False, | |
1826 | action='store_true', dest='no_sponsorblock', | |
1827 | help='Disable both --sponsorblock-mark and --sponsorblock-remove') | |
1828 | sponsorblock.add_option( | |
1829 | '--sponsorblock-api', metavar='URL', | |
1830 | default='https://sponsor.ajay.app', dest='sponsorblock_api', | |
1831 | help='SponsorBlock API location, defaults to %default') | |
1832 | ||
1833 | sponsorblock.add_option( | |
1834 | '--sponskrub', | |
1835 | action='store_true', dest='sponskrub', default=False, | |
1836 | help=optparse.SUPPRESS_HELP) | |
1837 | sponsorblock.add_option( | |
1838 | '--no-sponskrub', | |
1839 | action='store_false', dest='sponskrub', | |
1840 | help=optparse.SUPPRESS_HELP) | |
1841 | sponsorblock.add_option( | |
1842 | '--sponskrub-cut', default=False, | |
1843 | action='store_true', dest='sponskrub_cut', | |
1844 | help=optparse.SUPPRESS_HELP) | |
1845 | sponsorblock.add_option( | |
1846 | '--no-sponskrub-cut', | |
1847 | action='store_false', dest='sponskrub_cut', | |
1848 | help=optparse.SUPPRESS_HELP) | |
1849 | sponsorblock.add_option( | |
1850 | '--sponskrub-force', default=False, | |
1851 | action='store_true', dest='sponskrub_force', | |
1852 | help=optparse.SUPPRESS_HELP) | |
1853 | sponsorblock.add_option( | |
1854 | '--no-sponskrub-force', | |
1855 | action='store_true', dest='sponskrub_force', | |
1856 | help=optparse.SUPPRESS_HELP) | |
1857 | sponsorblock.add_option( | |
1858 | '--sponskrub-location', metavar='PATH', | |
1859 | dest='sponskrub_path', default='', | |
1860 | help=optparse.SUPPRESS_HELP) | |
1861 | sponsorblock.add_option( | |
1862 | '--sponskrub-args', dest='sponskrub_args', metavar='ARGS', | |
1863 | help=optparse.SUPPRESS_HELP) | |
1864 | ||
1865 | extractor = optparse.OptionGroup(parser, 'Extractor Options') | |
1866 | extractor.add_option( | |
1867 | '--extractor-retries', | |
1868 | dest='extractor_retries', metavar='RETRIES', default=3, | |
1869 | help='Number of retries for known extractor errors (default is %default), or "infinite"') | |
1870 | extractor.add_option( | |
1871 | '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd', | |
1872 | action='store_true', dest='dynamic_mpd', default=True, | |
1873 | help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)') | |
1874 | extractor.add_option( | |
1875 | '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd', | |
1876 | action='store_false', dest='dynamic_mpd', | |
1877 | help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)') | |
1878 | extractor.add_option( | |
1879 | '--hls-split-discontinuity', | |
1880 | dest='hls_split_discontinuity', action='store_true', default=False, | |
1881 | help='Split HLS playlists to different formats at discontinuities such as ad breaks' | |
1882 | ) | |
1883 | extractor.add_option( | |
1884 | '--no-hls-split-discontinuity', | |
1885 | dest='hls_split_discontinuity', action='store_false', | |
1886 | help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)') | |
1887 | _extractor_arg_parser = lambda key, vals='': (key.strip().lower().replace('-', '_'), [ | |
1888 | val.replace(r'\,', ',').strip() for val in re.split(r'(?<!\\),', vals)]) | |
1889 | extractor.add_option( | |
1890 | '--extractor-args', | |
1891 | metavar='IE_KEY:ARGS', dest='extractor_args', default={}, type='str', | |
1892 | action='callback', callback=_dict_from_options_callback, | |
1893 | callback_kwargs={ | |
1894 | 'multiple_keys': False, | |
1895 | 'process': lambda val: dict( | |
1896 | _extractor_arg_parser(*arg.split('=', 1)) for arg in val.split(';')) | |
1897 | }, help=( | |
1898 | 'Pass ARGS arguments to the IE_KEY extractor. See "EXTRACTOR ARGUMENTS" for details. ' | |
1899 | 'You can use this option multiple times to give arguments for different extractors')) | |
1900 | extractor.add_option( | |
1901 | '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest', | |
1902 | action='store_true', dest='youtube_include_dash_manifest', default=True, | |
1903 | help=optparse.SUPPRESS_HELP) | |
1904 | extractor.add_option( | |
1905 | '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest', | |
1906 | action='store_false', dest='youtube_include_dash_manifest', | |
1907 | help=optparse.SUPPRESS_HELP) | |
1908 | extractor.add_option( | |
1909 | '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest', | |
1910 | action='store_true', dest='youtube_include_hls_manifest', default=True, | |
1911 | help=optparse.SUPPRESS_HELP) | |
1912 | extractor.add_option( | |
1913 | '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest', | |
1914 | action='store_false', dest='youtube_include_hls_manifest', | |
1915 | help=optparse.SUPPRESS_HELP) | |
1916 | ||
1917 | parser.add_option_group(general) | |
1918 | parser.add_option_group(network) | |
1919 | parser.add_option_group(geo) | |
1920 | parser.add_option_group(selection) | |
1921 | parser.add_option_group(downloader) | |
1922 | parser.add_option_group(filesystem) | |
1923 | parser.add_option_group(thumbnail) | |
1924 | parser.add_option_group(link) | |
1925 | parser.add_option_group(verbosity) | |
1926 | parser.add_option_group(workarounds) | |
1927 | parser.add_option_group(video_format) | |
1928 | parser.add_option_group(subtitles) | |
1929 | parser.add_option_group(authentication) | |
1930 | parser.add_option_group(postproc) | |
1931 | parser.add_option_group(sponsorblock) | |
1932 | parser.add_option_group(extractor) | |
1933 | ||
1934 | return parser | |
1935 | ||
1936 | ||
1937 | def _hide_login_info(opts): | |
1938 | deprecation_warning(f'"{__name__}._hide_login_info" is deprecated and may be removed ' | |
1939 | 'in a future version. Use "yt_dlp.utils.Config.hide_login_info" instead') | |
1940 | return Config.hide_login_info(opts) |