Patch Detail
Show a patch.
GET /api/1.1/patches/20860/?format=api
{ "id": 20860, "url": "https://patchwork.libcamera.org/api/1.1/patches/20860/?format=api", "web_url": "https://patchwork.libcamera.org/patch/20860/", "project": { "id": 1, "url": "https://patchwork.libcamera.org/api/1.1/projects/1/?format=api", "name": "libcamera", "link_name": "libcamera", "list_id": "libcamera_core", "list_email": "libcamera-devel@lists.libcamera.org", "web_url": "", "scm_url": "", "webscm_url": "" }, "msgid": "<20240809005914.20662-11-laurent.pinchart@ideasonboard.com>", "date": "2024-08-09T00:59:14", "name": "[10/10] py: gen-py-controls: Convert to jinja2 templates", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": false, "hash": "dd3222d9e087a6091d30f6e43d2b693b3f92ef80", "submitter": { "id": 2, "url": "https://patchwork.libcamera.org/api/1.1/people/2/?format=api", "name": "Laurent Pinchart", "email": "laurent.pinchart@ideasonboard.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/20860/mbox/", "series": [ { "id": 4506, "url": "https://patchwork.libcamera.org/api/1.1/series/4506/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=4506", "date": "2024-08-09T00:59:04", "name": "libcamera: Improve code generation for controls", "version": 1, "mbox": "https://patchwork.libcamera.org/series/4506/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/20860/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/20860/checks/", "tags": {}, "headers": { "Return-Path": "<libcamera-devel-bounces@lists.libcamera.org>", "X-Original-To": "parsemail@patchwork.libcamera.org", "Delivered-To": "parsemail@patchwork.libcamera.org", "Received": [ "from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id B1573C324E\n\tfor <parsemail@patchwork.libcamera.org>;\n\tFri, 9 Aug 2024 00:59:58 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 4BC9E633B9;\n\tFri, 9 Aug 2024 02:59:58 +0200 (CEST)", "from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 93A17633CF\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri, 9 Aug 2024 02:59:53 +0200 (CEST)", "from pendragon.ideasonboard.com (81-175-209-231.bb.dnainternet.fi\n\t[81.175.209.231])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id AB482B7E\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri, 9 Aug 2024 02:58:59 +0200 (CEST)" ], "Authentication-Results": "lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"ssTniF5E\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1723165139;\n\tbh=tuKkHfuK0EwhaQlqsgtId1QaRGXsZiYe4uQdLq5do6Y=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=ssTniF5Ei5VwbVD85ts04dRYlgrDZ/zlXEgcNkSmRxlZFd7SOOAgzUipeDIfyzM8i\n\tfD2NBoU6JdlgypUHJ2lrmsjZ05NPe4/ndJ/mwhwTCJ+8EEIvjCFPkgrY4xwdQNJq5f\n\twaj3vZzxCBsHHZ7sNzkDtz5i9kHz9bT861S+RX0E=", "From": "Laurent Pinchart <laurent.pinchart@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Subject": "[PATCH 10/10] py: gen-py-controls: Convert to jinja2 templates", "Date": "Fri, 9 Aug 2024 03:59:14 +0300", "Message-ID": "<20240809005914.20662-11-laurent.pinchart@ideasonboard.com>", "X-Mailer": "git-send-email 2.44.2", "In-Reply-To": "<20240809005914.20662-1-laurent.pinchart@ideasonboard.com>", "References": "<20240809005914.20662-1-laurent.pinchart@ideasonboard.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "X-BeenThere": "libcamera-devel@lists.libcamera.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "<libcamera-devel.lists.libcamera.org>", "List-Unsubscribe": "<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>", "List-Archive": "<https://lists.libcamera.org/pipermail/libcamera-devel/>", "List-Post": "<mailto:libcamera-devel@lists.libcamera.org>", "List-Help": "<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>", "List-Subscribe": "<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>", "Errors-To": "libcamera-devel-bounces@lists.libcamera.org", "Sender": "\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>" }, "content": "Jinja2 templates help separating the logic related to the template from\nthe generation of the data. The python code gets much clearer as a\nresult.\n\nAs an added bonus, we can use a single template file for both controls\nand properties.\n\nSigned-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n---\n src/py/libcamera/gen-py-controls.py | 114 ++++++++----------\n src/py/libcamera/meson.build | 8 +-\n src/py/libcamera/py_controls_generated.cpp.in | 35 ++++--\n .../libcamera/py_properties_generated.cpp.in | 30 -----\n 4 files changed, 78 insertions(+), 109 deletions(-)\n delete mode 100644 src/py/libcamera/py_properties_generated.cpp.in", "diff": "diff --git a/src/py/libcamera/gen-py-controls.py b/src/py/libcamera/gen-py-controls.py\nindex a18dc5337090..cf09c146084d 100755\n--- a/src/py/libcamera/gen-py-controls.py\n+++ b/src/py/libcamera/gen-py-controls.py\n@@ -4,7 +4,7 @@\n # Generate Python bindings controls from YAML\n \n import argparse\n-import string\n+import jinja2\n import sys\n import yaml\n \n@@ -23,67 +23,39 @@ def find_common_prefix(strings):\n return prefix\n \n \n-def generate_py(controls, mode):\n- out = ''\n+def extend_control(ctrl, mode):\n+ if ctrl.vendor != 'libcamera':\n+ ctrl.klass = ctrl.vendor\n+ ctrl.namespace = f'{ctrl.vendor}::'\n+ else:\n+ ctrl.klass = mode\n+ ctrl.namespace = ''\n \n- vendors_class_def = []\n- vendor_defs = []\n- vendors = []\n- for vendor, ctrl_list in controls.items():\n- for ctrl in ctrl_list:\n- if vendor not in vendors and vendor != 'libcamera':\n- vendor_mode_str = f'{vendor.capitalize()}{mode.capitalize()}'\n- vendors_class_def.append('class Py{}\\n{{\\n}};\\n'.format(vendor_mode_str))\n- vendor_defs.append('\\tauto {} = py::class_<Py{}>(controls, \\\"{}\\\");'.format(vendor, vendor_mode_str, vendor))\n- vendors.append(vendor)\n+ if not ctrl.is_enum:\n+ return ctrl\n \n- if vendor != 'libcamera':\n- ns = 'libcamera::{}::{}::'.format(mode, vendor)\n- container = vendor\n- else:\n- ns = 'libcamera::{}::'.format(mode)\n- container = 'controls'\n+ if mode == 'controls':\n+ # Adjustments for controls\n+ if ctrl.name == 'LensShadingMapMode':\n+ prefix = 'LensShadingMapMode'\n+ else:\n+ prefix = find_common_prefix([e.name for e in ctrl.enum_values])\n+ else:\n+ # Adjustments for properties\n+ prefix = find_common_prefix([e.name for e in ctrl.enum_values])\n \n- out += f'\\t{container}.def_readonly_static(\"{ctrl.name}\", static_cast<const libcamera::ControlId *>(&{ns}{ctrl.name}));\\n\\n'\n+ for enum in ctrl.enum_values:\n+ enum.py_name = enum.name[len(prefix):]\n \n- if not ctrl.is_enum:\n- continue\n-\n- cpp_enum = ctrl.name + 'Enum'\n-\n- out += '\\tpy::enum_<{}{}>({}, \\\"{}\\\")\\n'.format(ns, cpp_enum, container, cpp_enum)\n-\n- if mode == 'controls':\n- # Adjustments for controls\n- if ctrl.name == 'LensShadingMapMode':\n- prefix = 'LensShadingMapMode'\n- else:\n- prefix = find_common_prefix([e.name for e in ctrl.enum_values])\n- else:\n- # Adjustments for properties\n- prefix = find_common_prefix([e.name for e in ctrl.enum_values])\n-\n- for entry in ctrl.enum_values:\n- cpp_enum = entry.name\n- py_enum = entry.name[len(prefix):]\n-\n- out += '\\t\\t.value(\\\"{}\\\", {}{})\\n'.format(py_enum, ns, cpp_enum)\n-\n- out += '\\t;\\n\\n'\n-\n- return {'controls': out,\n- 'vendors_class_def': '\\n'.join(vendors_class_def),\n- 'vendors_defs': '\\n'.join(vendor_defs)}\n-\n-\n-def fill_template(template, data):\n- template = open(template, 'rb').read()\n- template = template.decode('utf-8')\n- template = string.Template(template)\n- return template.substitute(data)\n+ return ctrl\n \n \n def main(argv):\n+ headers = {\n+ 'controls': 'control_ids.h',\n+ 'properties': 'property_ids.h',\n+ }\n+\n # Parse command line arguments\n parser = argparse.ArgumentParser()\n parser.add_argument('--mode', '-m', type=str, required=True,\n@@ -96,27 +68,41 @@ def main(argv):\n help='Input file name.')\n args = parser.parse_args(argv[1:])\n \n- if args.mode not in ['controls', 'properties']:\n+ if not headers.get(args.mode):\n print(f'Invalid mode option \"{args.mode}\"', file=sys.stderr)\n return -1\n \n- controls = {}\n+ controls = []\n+ vendors = []\n+\n for input in args.input:\n data = yaml.safe_load(open(input, 'rb').read())\n+\n vendor = data['vendor']\n- ctrls = data['controls']\n- controls[vendor] = [Control(*ctrl.popitem(), vendor) for ctrl in ctrls]\n+ if vendor != 'libcamera':\n+ vendors.append(vendor)\n \n- data = generate_py(controls, args.mode)\n+ for ctrl in data['controls']:\n+ ctrl = Control(*ctrl.popitem(), vendor)\n+ controls.append(extend_control(ctrl, args.mode))\n \n- data = fill_template(args.template, data)\n+ data = {\n+ 'mode': args.mode,\n+ 'header': headers[args.mode],\n+ 'vendors': vendors,\n+ 'controls': controls,\n+ }\n+\n+ env = jinja2.Environment()\n+ template = env.from_string(open(args.template, 'r', encoding='utf-8').read())\n+ string = template.render(data)\n \n if args.output:\n- output = open(args.output, 'wb')\n- output.write(data.encode('utf-8'))\n+ output = open(args.output, 'w', encoding='utf-8')\n+ output.write(string)\n output.close()\n else:\n- sys.stdout.write(data)\n+ sys.stdout.write(string)\n \n return 0\n \ndiff --git a/src/py/libcamera/meson.build b/src/py/libcamera/meson.build\nindex 6ad2d7713e4d..596a203ca4cc 100644\n--- a/src/py/libcamera/meson.build\n+++ b/src/py/libcamera/meson.build\n@@ -26,7 +26,7 @@ pycamera_sources = files([\n 'py_transform.cpp',\n ])\n \n-# Generate controls\n+# Generate controls and properties\n \n gen_py_controls_template = files('py_controls_generated.cpp.in')\n gen_py_controls = files('gen-py-controls.py')\n@@ -38,15 +38,11 @@ pycamera_sources += custom_target('py_gen_controls',\n '-t', gen_py_controls_template, '@INPUT@'],\n env : py_build_env)\n \n-# Generate properties\n-\n-gen_py_properties_template = files('py_properties_generated.cpp.in')\n-\n pycamera_sources += custom_target('py_gen_properties',\n input : properties_files,\n output : ['py_properties_generated.cpp'],\n command : [gen_py_controls, '--mode', 'properties', '-o', '@OUTPUT@',\n- '-t', gen_py_properties_template, '@INPUT@'],\n+ '-t', gen_py_controls_template, '@INPUT@'],\n env : py_build_env)\n \n # Generate formats\ndiff --git a/src/py/libcamera/py_controls_generated.cpp.in b/src/py/libcamera/py_controls_generated.cpp.in\nindex 26d5a104f209..22a132d19ea9 100644\n--- a/src/py/libcamera/py_controls_generated.cpp.in\n+++ b/src/py/libcamera/py_controls_generated.cpp.in\n@@ -2,12 +2,12 @@\n /*\n * Copyright (C) 2022, Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>\n *\n- * Python bindings - Auto-generated controls\n+ * Python bindings - Auto-generated {{mode}}\n *\n * This file is auto-generated. Do not edit.\n */\n \n-#include <libcamera/control_ids.h>\n+#include <libcamera/{{header}}>\n \n #include <pybind11/pybind11.h>\n \n@@ -15,16 +15,33 @@\n \n namespace py = pybind11;\n \n-class PyControls\n+class Py{{mode|capitalize}}\n {\n };\n \n-${vendors_class_def}\n-\n-void init_py_controls_generated(py::module& m)\n+{% for vendor in vendors -%}\n+class Py{{vendor|capitalize}}{{mode|capitalize}}\n {\n-\tauto controls = py::class_<PyControls>(m, \"controls\");\n-${vendors_defs}\n+};\n \n-${controls}\n+{% endfor -%}\n+\n+void init_py_{{mode}}_generated(py::module& m)\n+{\n+\tauto {{mode}} = py::class_<Py{{mode|capitalize}}>(m, \"{{mode}}\");\n+{%- for vendor in vendors %}\n+\tauto {{vendor}} = py::class_<Py{{vendor|capitalize}}{{mode|capitalize}}>({{mode}}, \"{{vendor}}\");\n+{%- endfor %}\n+\n+{% for ctrl in controls %}\n+ {{ctrl.klass}}.def_readonly_static(\"{{ctrl.name}}\", static_cast<const libcamera::ControlId *>(&libcamera::{{mode}}::{{ctrl.namespace}}{{ctrl.name}}));\n+{%- if ctrl.is_enum %}\n+\n+ py::enum_<libcamera::{{mode}}::{{ctrl.namespace}}{{ctrl.name}}Enum>({{ctrl.klass}}, \"{{ctrl.name}}Enum\")\n+{%- for enum in ctrl.enum_values %}\n+ .value(\"{{enum.py_name}}\", libcamera::{{mode}}::{{ctrl.namespace}}{{enum.name}})\n+{%- endfor %}\n+ ;\n+{%- endif %}\n+{% endfor -%}\n }\ndiff --git a/src/py/libcamera/py_properties_generated.cpp.in b/src/py/libcamera/py_properties_generated.cpp.in\ndeleted file mode 100644\nindex d28f1ab8b61a..000000000000\n--- a/src/py/libcamera/py_properties_generated.cpp.in\n+++ /dev/null\n@@ -1,30 +0,0 @@\n-/* SPDX-License-Identifier: LGPL-2.1-or-later */\n-/*\n- * Copyright (C) 2022, Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>\n- *\n- * Python bindings - Auto-generated properties\n- *\n- * This file is auto-generated. Do not edit.\n- */\n-\n-#include <libcamera/property_ids.h>\n-\n-#include <pybind11/pybind11.h>\n-\n-#include \"py_main.h\"\n-\n-namespace py = pybind11;\n-\n-class PyProperties\n-{\n-};\n-\n-${vendors_class_def}\n-\n-void init_py_properties_generated(py::module& m)\n-{\n-\tauto controls = py::class_<PyProperties>(m, \"properties\");\n-${vendors_defs}\n-\n-${controls}\n-}\n", "prefixes": [ "10/10" ] }