nvidia-patch/tools/readme-autogen/readme_autogen.py

138 lines
6.3 KiB
Python
Executable File

#!/usr/bin/env python3
import argparse
import json
import os.path
from itertools import groupby
from constants import Product, WinSeries, DATAFILE_PATH, LINUX_README_PATH, \
WINDOWS_README_PATH, ENCODING, REPO_BASE
from utils import template, find_driver, linux_driver_key, windows_driver_key, \
version_key_fun
PRODUCT_LABELS = {
Product.GeForce: "GeForce",
Product.Quadro: "Quadro",
}
WIN_SERIES_LABELS = {
WinSeries.win10: "Windows 10, Windows 11",
WinSeries.win7: "Windows 7, Windows 8, Windows 8.1",
WinSeries.ws2012: "Windows Server 2008R2, 2012, 2012R2",
WinSeries.ws2016: "Windows Server 2016, 2019",
}
def linux_readme(data):
master_tmpl = template('linux_readme_master.tmpl')
row_tmpl = template('linux_driver_row.tmpl', True)
link_tmpl = template('markdown_link.tmpl', True)
md_true = template('markdown_true.tmpl', True).substitute()
md_false = template('markdown_false.tmpl', True).substitute()
drivers = sorted(data['drivers'], key=linux_driver_key)
def row_gen():
for drv in drivers:
driver_url = drv.get('driver_url')
if driver_url:
driver_link = link_tmpl.substitute(text="Driver link", url=driver_url)
else:
driver_link = ''
nvenc_patch = md_true if drv['nvenc_patch'] else md_false
nvfbc_patch = md_true if drv['nvfbc_patch'] else md_false
yield row_tmpl.substitute(version=drv['version'],
nvenc_patch=nvenc_patch,
nvfbc_patch=nvfbc_patch,
driver_link=driver_link)
version_list = "\n".join(row_gen())
latest_version = drivers[-1]['version']
example_driver = find_driver(drivers,
linux_driver_key(data['example']),
linux_driver_key)
example_driver_url = example_driver['driver_url']
return master_tmpl.substitute(version_list=version_list,
latest_version=latest_version,
example_driver_url=example_driver_url,
example_driver_version=example_driver['version'],
example_driver_file=os.path.basename(example_driver_url))
def windows_driver_rows(drivers, repo_base):
driver_row_tmpl = template('windows_driver_row.tmpl', True)
markdown_link_tmpl = template('markdown_link.tmpl', True)
def row_gen():
for d in drivers:
product = PRODUCT_LABELS[Product[d['product']]]
variant = d.get('variant')
version_variant = d['version']
version_variant += (" " + variant) if variant else ''
patch64_url = repo_base + d.get('patch64_url')
patch32_url = repo_base + d.get('patch32_url')
driver_url = d.get('driver_url')
patch64_link = markdown_link_tmpl.substitute(text="x64 library patch",
url=patch64_url) if patch64_url else ''
patch32_link = markdown_link_tmpl.substitute(text="x86 library patch",
url=patch32_url) if patch32_url else ''
driver_link = markdown_link_tmpl.substitute(text="Driver link",
url=driver_url) if driver_url else ''
yield driver_row_tmpl.substitute(product=product,
version_variant=version_variant,
patch64_link=patch64_link,
patch32_link=patch32_link,
driver_link=driver_link)
return "\n".join(row_gen())
def windows_product_sections(drivers, repo_base):
product_section_tmpl = template('windows_product_section.tmpl')
def section_gen():
for k, g in groupby(drivers, lambda d: Product[d['product']]):
driver_rows = windows_driver_rows(g, repo_base)
yield product_section_tmpl.substitute(driver_rows=driver_rows)
return '\n\n'.join(section_gen())
def windows_driver_table(drivers, repo_base):
os_section_tmpl = template('windows_os_section.tmpl', True)
def section_gen():
for k, g in groupby(drivers, lambda d: WinSeries[d['os']]):
os = WIN_SERIES_LABELS[k]
product_sections = windows_product_sections(g, repo_base)
yield os_section_tmpl.substitute(os=os,
product_sections=product_sections)
return '\n\n'.join(section_gen())
def windows_readme(data, repo_base):
master_tmpl = template('windows_readme_master.tmpl')
drivers = sorted(data['drivers'], key=windows_driver_key)
version_table = windows_driver_table(drivers, repo_base)
geforce_drivers = filter(lambda d: Product[d['product']] is Product.GeForce, drivers)
quadro_drivers = filter(lambda d: Product[d['product']] is Product.Quadro, drivers)
latest_geforce_version = max(geforce_drivers, default='xxx.xx',
key=lambda d: version_key_fun(d['version']))['version']
latest_quadro_version = max(quadro_drivers, default='xxx.xx',
key=lambda d: version_key_fun(d['version']))['version']
return master_tmpl.substitute(version_table=version_table,
latest_geforce_version=latest_geforce_version,
latest_quadro_version=latest_quadro_version)
def parse_args():
parser = argparse.ArgumentParser(
description="Generates markdown pages from repo data",
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
parser.add_argument("-R", "--repo-root",
help="repository web root URL",
default=REPO_BASE)
args = parser.parse_args()
return args
def main():
args = parse_args()
with open(DATAFILE_PATH) as data_file:
data = json.load(data_file)
res = linux_readme(data['linux']['x86_64'])
with open(LINUX_README_PATH, 'w', encoding=ENCODING) as out:
out.write(res)
res = windows_readme(data['win']['x86_64'], args.repo_root)
with open(WINDOWS_README_PATH, 'w', encoding=ENCODING) as out:
out.write(res)
if __name__ == '__main__':
main()