mirror of https://github.com/yt-dlp/yt-dlp
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
121 lines
3.4 KiB
Python
121 lines
3.4 KiB
Python
#!/usr/bin/env python3
|
|
|
|
# Allow direct execution
|
|
import os
|
|
import sys
|
|
|
|
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
|
|
|
|
|
|
import os.path
|
|
import re
|
|
|
|
from devscripts.utils import (
|
|
compose_functions,
|
|
get_filename_args,
|
|
read_file,
|
|
write_file,
|
|
)
|
|
|
|
ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
|
|
README_FILE = os.path.join(ROOT_DIR, 'README.md')
|
|
|
|
PREFIX = r'''%yt-dlp(1)
|
|
|
|
# NAME
|
|
|
|
yt\-dlp \- A feature\-rich command\-line audio/video downloader
|
|
|
|
# SYNOPSIS
|
|
|
|
**yt-dlp** \[OPTIONS\] URL [URL...]
|
|
|
|
# DESCRIPTION
|
|
|
|
'''
|
|
|
|
|
|
def filter_excluded_sections(readme):
|
|
EXCLUDED_SECTION_BEGIN_STRING = re.escape('<!-- MANPAGE: BEGIN EXCLUDED SECTION -->')
|
|
EXCLUDED_SECTION_END_STRING = re.escape('<!-- MANPAGE: END EXCLUDED SECTION -->')
|
|
return re.sub(
|
|
rf'(?s){EXCLUDED_SECTION_BEGIN_STRING}.+?{EXCLUDED_SECTION_END_STRING}\n',
|
|
'', readme)
|
|
|
|
|
|
def _convert_code_blocks(readme):
|
|
current_code_block = None
|
|
|
|
for line in readme.splitlines(True):
|
|
if current_code_block:
|
|
if line == current_code_block:
|
|
current_code_block = None
|
|
yield '\n'
|
|
else:
|
|
yield f' {line}'
|
|
elif line.startswith('```'):
|
|
current_code_block = line.count('`') * '`' + '\n'
|
|
yield '\n'
|
|
else:
|
|
yield line
|
|
|
|
|
|
def convert_code_blocks(readme):
|
|
return ''.join(_convert_code_blocks(readme))
|
|
|
|
|
|
def move_sections(readme):
|
|
MOVE_TAG_TEMPLATE = '<!-- MANPAGE: MOVE "%s" SECTION HERE -->'
|
|
sections = re.findall(r'(?m)^%s$' % (
|
|
re.escape(MOVE_TAG_TEMPLATE).replace(r'\%', '%') % '(.+)'), readme)
|
|
|
|
for section_name in sections:
|
|
move_tag = MOVE_TAG_TEMPLATE % section_name
|
|
if readme.count(move_tag) > 1:
|
|
raise Exception(f'There is more than one occurrence of "{move_tag}". This is unexpected')
|
|
|
|
sections = re.findall(rf'(?sm)(^# {re.escape(section_name)}.+?)(?=^# )', readme)
|
|
if len(sections) < 1:
|
|
raise Exception(f'The section {section_name} does not exist')
|
|
elif len(sections) > 1:
|
|
raise Exception(f'There are multiple occurrences of section {section_name}, this is unhandled')
|
|
|
|
readme = readme.replace(sections[0], '', 1).replace(move_tag, sections[0], 1)
|
|
return readme
|
|
|
|
|
|
def filter_options(readme):
|
|
section = re.search(r'(?sm)^# USAGE AND OPTIONS\n.+?(?=^# )', readme).group(0)
|
|
section_new = section.replace('*', R'\*')
|
|
|
|
options = '# OPTIONS\n'
|
|
for line in section_new.split('\n')[1:]:
|
|
mobj = re.fullmatch(r'''(?x)
|
|
\s{4}(?P<opt>-(?:,\s|[^\s])+)
|
|
(?:\s(?P<meta>(?:[^\s]|\s(?!\s))+))?
|
|
(\s{2,}(?P<desc>.+))?
|
|
''', line)
|
|
if not mobj:
|
|
options += f'{line.lstrip()}\n'
|
|
continue
|
|
option, metavar, description = mobj.group('opt', 'meta', 'desc')
|
|
|
|
# Pandoc's definition_lists. See http://pandoc.org/README.html
|
|
option = f'{option} *{metavar}*' if metavar else option
|
|
description = f'{description}\n' if description else ''
|
|
options += f'\n{option}\n: {description}'
|
|
continue
|
|
|
|
return readme.replace(section, options, 1)
|
|
|
|
|
|
TRANSFORM = compose_functions(filter_excluded_sections, convert_code_blocks, move_sections, filter_options)
|
|
|
|
|
|
def main():
|
|
write_file(get_filename_args(), PREFIX + TRANSFORM(read_file(README_FILE)))
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|