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 re
  11
  12 from devscripts.utils import (
  13     get_filename_args,
  14     read_file,
  15     read_version,
  16     write_file,
  17 )
  18
  19 VERBOSE_TMPL = '''
  20   - type: checkboxes
  21     id: verbose
  22     attributes:
  23       label: Provide verbose output that clearly demonstrates the problem
  24       options:
  25         - label: Run **your** yt-dlp command with **-vU** flag added (`yt-dlp -vU <your command line>`)
  26           required: true
  27         - label: Copy the WHOLE output (starting with `[debug] Command-line config`) and insert it below
  28           required: true
  29   - type: textarea
  30     id: log
  31     attributes:
  32       label: Complete Verbose Output
  33       description: |
  34         It should start like this:
  35       placeholder: |
  36         [debug] Command-line config: ['-vU', 'test:youtube']
  37         [debug] Portable config "yt-dlp.conf": ['-i']
  38         [debug] Encodings: locale cp65001, fs utf-8, pref cp65001, out utf-8, error utf-8, screen utf-8
  39         [debug] yt-dlp version %(version)s [9d339c4] (win32_exe)
  40         [debug] Python 3.8.10 (CPython 64bit) - Windows-10-10.0.22000-SP0
  41         [debug] Checking exe version: ffmpeg -bsfs
  42         [debug] Checking exe version: ffprobe -bsfs
  43         [debug] exe versions: ffmpeg N-106550-g072101bd52-20220410 (fdk,setts), ffprobe N-106624-g391ce570c8-20220415, phantomjs 2.1.1
  44         [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
  45         [debug] Proxy map: {}
  46         [debug] Fetching release info: https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest
  47         Latest version: %(version)s, Current version: %(version)s
  48         yt-dlp is up to date (%(version)s)
  49         <more lines>
  50       render: shell
  51     validations:
  52       required: true
  53 '''.strip()
  54
  55 NO_SKIP = '''
  56   - type: checkboxes
  57     attributes:
  58       label: DO NOT REMOVE OR SKIP THE ISSUE TEMPLATE
  59       description: Fill all fields even if you think it is irrelevant for the issue
  60       options:
  61         - label: I understand that I will be **blocked** if I *intentionally* remove or skip any mandatory\\* field
  62           required: true
  63 '''.strip()
  64
  65
  66 def main():
  67     fields = {'version': read_version(), 'no_skip': NO_SKIP}
  68     fields['verbose'] = VERBOSE_TMPL % fields
  69     fields['verbose_optional'] = re.sub(r'(\n\s+validations:)?\n\s+required: true', '', fields['verbose'])
  70
  71     infile, outfile = get_filename_args(has_infile=True)
  72     write_file(outfile, read_file(infile) % fields)
  73
  74
  75 if __name__ == '__main__':
  76     main()