#!/usr/bin/env python3 # # Copyright (C) 2019 Simmo Saan # Copyright (C) 2021 Sébastien Helleu # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . # """ Generate Python stub: API constants and functions, with type annotations. This script requires Python 3.6+. """ from pathlib import Path import re DOC_DIR = Path(__file__).resolve().parent / "en" STUB_HEADER = """\ # # WeeChat Python stub file, auto-generated by python_stub.py. # DO NOT EDIT BY HAND! # from typing import Dict """ CONSTANT_RE = r"""\ `(?PWEECHAT_[A-Z0-9_]+)` \((?P(string|integer))\)(?: \+)?\ """ FUNCTION_RE = r"""\ \[source,python\] ---- # prototype def (?P\w+)(?P[^)]*)(?P\) -> [^:]+:) \.\.\.\ """ def print_stub_constants() -> None: """Print constants, extracted from the Scripting guide.""" types = { "integer": "int", "string": "str", } constant_pattern = re.compile(CONSTANT_RE) with open(DOC_DIR / "weechat_scripting.en.adoc") as scripting_file: scripting = scripting_file.read() for match in constant_pattern.finditer(scripting): print(f'{match["constant"]}: {types[match["type"]]}') def print_stub_functions() -> None: """Print function prototypes, extracted from the Plugin API reference.""" function_pattern = re.compile(FUNCTION_RE, re.DOTALL) with open(DOC_DIR / "weechat_plugin_api.en.adoc") as api_doc_file: api_doc = api_doc_file.read() for match in function_pattern.finditer(api_doc): url = f'https://weechat.org/doc/api#_{match["function"]}' print( f"""\n def {match["function"]}{match["args"]}{match["return"]} \"""`{match["function"]} in WeeChat plugin API reference <{url}>`_\""" ...""" ) def stub_api() -> None: """Write Python stub file.""" print(STUB_HEADER) print_stub_constants() print_stub_functions() if __name__ == "__main__": stub_api()