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     write_file,
  16 )
  17
  18 VERBOSE_TMPL = '''
  19   - type: checkboxes
  20     id: verbose
  21     attributes:
  22       label: Provide verbose output that clearly demonstrates the problem
  23       options:
  24         - label: Run **your** yt-dlp command with **-vU** flag added (`yt-dlp -vU <your command line>`)
  25           required: true
  26         - label: "If using API, add `'verbose': True` to `YoutubeDL` params instead"
  27           required: false
  28         - label: Copy the WHOLE output (starting with `[debug] Command-line config`) and insert it below
  29           required: true
  30   - type: textarea
  31     id: log
  32     attributes:
  33       label: Complete Verbose Output
  34       description: |
  35         It should start like this:
  36       placeholder: |
  37         [debug] Command-line config: ['-vU', 'https://www.youtube.com/watch?v=BaW_jenozKc']
  38         [debug] Encodings: locale cp65001, fs utf-8, pref cp65001, out utf-8, error utf-8, screen utf-8
  39         [debug] yt-dlp version nightly@... from yt-dlp/yt-dlp [b634ba742] (win_exe)
  40         [debug] Python 3.8.10 (CPython 64bit) - Windows-10-10.0.22000-SP0
  41         [debug] exe versions: ffmpeg N-106550-g072101bd52-20220410 (fdk,setts), ffprobe N-106624-g391ce570c8-20220415, phantomjs 2.1.1
  42         [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
  43         [debug] Proxy map: {}
  44         [debug] Request Handlers: urllib, requests
  45         [debug] Loaded 1893 extractors
  46         [debug] Fetching release info: https://api.github.com/repos/yt-dlp/yt-dlp-nightly-builds/releases/latest
  47         yt-dlp is up to date (nightly@... from yt-dlp/yt-dlp-nightly-builds)
  48         [youtube] Extracting URL: https://www.youtube.com/watch?v=BaW_jenozKc
  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 = {'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()