devscripts/make_issue_template.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 import re
  12
  13
  14 def read(fname):
  15     with open(fname, encoding='utf-8') as f:
  16         return f.read()
  17
  18
  19 # Get the version without importing the package
  20 def read_version(fname):
  21     exec(compile(read(fname), fname, 'exec'))
  22     return locals()['__version__']
  23
  24
  25 VERBOSE_TMPL = '''
  26   - type: checkboxes
  27     id: verbose
  28     attributes:
  29       label: Provide verbose output that clearly demonstrates the problem
  30       options:
  31         - label: Run **your** yt-dlp command with **-vU** flag added (`yt-dlp -vU <your command line>`)
  32           required: true
  33         - label: Copy the WHOLE output (starting with `[debug] Command-line config`) and insert it below
  34           required: true
  35   - type: textarea
  36     id: log
  37     attributes:
  38       label: Complete Verbose Output
  39       description: |
  40         It should start like this:
  41       placeholder: |
  42         [debug] Command-line config: ['-vU', 'test:youtube']
  43         [debug] Portable config "yt-dlp.conf": ['-i']
  44         [debug] Encodings: locale cp65001, fs utf-8, pref cp65001, out utf-8, error utf-8, screen utf-8
  45         [debug] yt-dlp version %(version)s [9d339c4] (win32_exe)
  46         [debug] Python 3.8.10 (CPython 64bit) - Windows-10-10.0.22000-SP0
  47         [debug] Checking exe version: ffmpeg -bsfs
  48         [debug] Checking exe version: ffprobe -bsfs
  49         [debug] exe versions: ffmpeg N-106550-g072101bd52-20220410 (fdk,setts), ffprobe N-106624-g391ce570c8-20220415, phantomjs 2.1.1
  50         [debug] Optional libraries: Cryptodome-3.15.0, brotli-1.0.9, certifi-2022.06.15, mutagen-1.45.1, sqlite3-2.6.0, websockets-10.3
  51         [debug] Proxy map: {}
  52         [debug] Fetching release info: https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest
  53         Latest version: %(version)s, Current version: %(version)s
  54         yt-dlp is up to date (%(version)s)
  55         <more lines>
  56       render: shell
  57     validations:
  58       required: true
  59 '''.strip()
  60
  61
  62 def main():
  63     parser = optparse.OptionParser(usage='%prog INFILE OUTFILE')
  64     _, args = parser.parse_args()
  65     if len(args) != 2:
  66         parser.error('Expected an input and an output filename')
  67
  68     fields = {'version': read_version('yt_dlp/version.py')}
  69     fields['verbose'] = VERBOSE_TMPL % fields
  70     fields['verbose_optional'] = re.sub(r'(\n\s+validations:)?\n\s+required: true', '', fields['verbose'])
  71
  72     infile, outfile = args
  73     with open(outfile, 'w', encoding='utf-8') as outf:
  74         outf.write(read(infile) % fields)
  75
  76
  77 if __name__ == '__main__':
  78     main()