devscripts/fish-completion.py

   1 #!/usr/bin/env python3
   2
   3 # Allow direct execution
   4 import os
   5 import sys
   6
   7 sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
   8
   9
  10 import optparse
  11
  12 import yt_dlp
  13 from yt_dlp.utils import shell_quote
  14
  15 FISH_COMPLETION_FILE = 'completions/fish/yt-dlp.fish'
  16 FISH_COMPLETION_TEMPLATE = 'devscripts/fish-completion.in'
  17
  18 EXTRA_ARGS = {
  19     'remux-video': ['--arguments', 'mp4 mkv', '--exclusive'],
  20     'recode-video': ['--arguments', 'mp4 flv ogg webm mkv', '--exclusive'],
  21
  22     # Options that need a file parameter
  23     'download-archive': ['--require-parameter'],
  24     'cookies': ['--require-parameter'],
  25     'load-info': ['--require-parameter'],
  26     'batch-file': ['--require-parameter'],
  27 }
  28
  29
  30 def build_completion(opt_parser):
  31     commands = []
  32
  33     for group in opt_parser.option_groups:
  34         for option in group.option_list:
  35             long_option = option.get_opt_string().strip('-')
  36             complete_cmd = ['complete', '--command', 'yt-dlp', '--long-option', long_option]
  37             if option._short_opts:
  38                 complete_cmd += ['--short-option', option._short_opts[0].strip('-')]
  39             if option.help != optparse.SUPPRESS_HELP:
  40                 complete_cmd += ['--description', option.help]
  41             complete_cmd.extend(EXTRA_ARGS.get(long_option, []))
  42             commands.append(shell_quote(complete_cmd))
  43
  44     with open(FISH_COMPLETION_TEMPLATE) as f:
  45         template = f.read()
  46     filled_template = template.replace('{{commands}}', '\n'.join(commands))
  47     with open(FISH_COMPLETION_FILE, 'w') as f:
  48         f.write(filled_template)
  49
  50
  51 parser = yt_dlp.parseOpts(ignore_config_files=True)[0]
  52 build_completion(parser)