Show a patch.

GET /api/patches/15788/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 15788,
    "url": "https://patchwork.libcamera.org/api/patches/15788/?format=api",
    "web_url": "https://patchwork.libcamera.org/patch/15788/",
    "project": {
        "id": 1,
        "url": "https://patchwork.libcamera.org/api/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": "<20220505104104.70841-6-tomi.valkeinen@ideasonboard.com>",
    "date": "2022-05-05T10:40:56",
    "name": "[libcamera-devel,v7,05/13] py: generate control enums from yaml",
    "commit_ref": null,
    "pull_url": null,
    "state": "superseded",
    "archived": false,
    "hash": "44d334010a2cb5b5d3b1b0981af84ad2990c4a42",
    "submitter": {
        "id": 109,
        "url": "https://patchwork.libcamera.org/api/people/109/?format=api",
        "name": "Tomi Valkeinen",
        "email": "tomi.valkeinen@ideasonboard.com"
    },
    "delegate": null,
    "mbox": "https://patchwork.libcamera.org/patch/15788/mbox/",
    "series": [
        {
            "id": 3093,
            "url": "https://patchwork.libcamera.org/api/series/3093/?format=api",
            "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=3093",
            "date": "2022-05-05T10:40:51",
            "name": "Python bindings",
            "version": 7,
            "mbox": "https://patchwork.libcamera.org/series/3093/mbox/"
        }
    ],
    "comments": "https://patchwork.libcamera.org/api/patches/15788/comments/",
    "check": "pending",
    "checks": "https://patchwork.libcamera.org/api/patches/15788/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 37B87C326C\n\tfor <parsemail@patchwork.libcamera.org>;\n\tThu,  5 May 2022 10:41:35 +0000 (UTC)",
            "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 757946564D;\n\tThu,  5 May 2022 12:41:31 +0200 (CEST)",
            "from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id D1B5C65649\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tThu,  5 May 2022 12:41:27 +0200 (CEST)",
            "from deskari.lan (91-156-85-209.elisa-laajakaista.fi\n\t[91.156.85.209])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 4D658492;\n\tThu,  5 May 2022 12:41:27 +0200 (CEST)"
        ],
        "DKIM-Signature": [
            "v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1651747291;\n\tbh=drreAiTzVPj/8papvYf8Ka9q5BVWu4HwHS0fgUN0E98=;\n\th=To:Date:In-Reply-To:References:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:\n\tFrom;\n\tb=gT7b5PZGK0NsjEHODW0R6lUDh9U5FD5HItULVaY5IiXFvGDVyl8a9F2MnjtSy8W3+\n\tlQIFEHuBfGp2qge6w5p05YfErpN6BC1oTEkupEcAVpls9CKjp0UoRuxOIlAwH9Je0D\n\tpFzGYrGOEGl72BbzFh+dMnJmPbncLvz/2m/eHAm1ISyWzDQLhHekMuM4kpUQ160oLn\n\tLpXhYThsqE1EG7pqQTFSa+0AHm3q9tRxrNLoIIBs38LnQVT85W0g+JZic343YaY0Cs\n\tRs1JB92w6EEclZv/hsXCqwo2DEOrzdxWA5MNFJNK/wMKbjwt/UyaFFWhz77aqw4ylp\n\t4RkCrN2YA+0mQ==",
            "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1651747287;\n\tbh=drreAiTzVPj/8papvYf8Ka9q5BVWu4HwHS0fgUN0E98=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=GqT4NQpMjtvaN8AY8KJbWqeXFJjc1R4UBNKPxcX3FOYgDAk4Phgb9WBvJzVstUeJe\n\tqsKQBWfH3IOwHjopFv780TrwQuv5PCYrn1Z94YHN7wJeQaorpyvEwzOI2RGKywHm7n\n\tEjXt6V1SnE7R8ZCpZNiB3T0DfkClxmQIb+irnkD8="
        ],
        "Authentication-Results": "lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"GqT4NQpM\"; dkim-atps=neutral",
        "To": "libcamera-devel@lists.libcamera.org,\n\tDavid Plowman <david.plowman@raspberrypi.com>,\n\tKieran Bingham <kieran.bingham@ideasonboard.com>,\n\tLaurent Pinchart <laurent.pinchart@ideasonboard.com>,\n\tJacopo Mondi <jacopo@jmondi.org>",
        "Date": "Thu,  5 May 2022 13:40:56 +0300",
        "Message-Id": "<20220505104104.70841-6-tomi.valkeinen@ideasonboard.com>",
        "X-Mailer": "git-send-email 2.34.1",
        "In-Reply-To": "<20220505104104.70841-1-tomi.valkeinen@ideasonboard.com>",
        "References": "<20220505104104.70841-1-tomi.valkeinen@ideasonboard.com>",
        "MIME-Version": "1.0",
        "Content-Transfer-Encoding": "8bit",
        "Subject": "[libcamera-devel] [PATCH v7 05/13] py: generate control enums from\n\tyaml",
        "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>",
        "From": "Tomi Valkeinen via libcamera-devel\n\t<libcamera-devel@lists.libcamera.org>",
        "Reply-To": "Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>",
        "Errors-To": "libcamera-devel-bounces@lists.libcamera.org",
        "Sender": "\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"
    },
    "content": "Generate enums for controls from control_ids.yaml. The generator script\nhas some heuristics to generate nicer enum names. E.g. instead of having\n\"LensShadingMapMode.LensShadingMapModeOff\" we get\n\"LensShadingMapMode.Off\". This heuristics may need to be updated when\nthe yaml file is changed or new controls are added.\n\nSigned-off-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>\n---\n src/py/libcamera/gen-py-control-enums.py  | 95 +++++++++++++++++++++++\n src/py/libcamera/meson.build              |  9 +++\n src/py/libcamera/pyenums_generated.cpp.in | 21 +++++\n src/py/libcamera/pymain.cpp               |  2 +\n 4 files changed, 127 insertions(+)\n create mode 100755 src/py/libcamera/gen-py-control-enums.py\n create mode 100644 src/py/libcamera/pyenums_generated.cpp.in",
    "diff": "diff --git a/src/py/libcamera/gen-py-control-enums.py b/src/py/libcamera/gen-py-control-enums.py\nnew file mode 100755\nindex 00000000..f1b18389\n--- /dev/null\n+++ b/src/py/libcamera/gen-py-control-enums.py\n@@ -0,0 +1,95 @@\n+#!/usr/bin/env python3\n+# SPDX-License-Identifier: GPL-2.0-or-later\n+#\n+# Generate Python bindings enums for controls from YAML\n+\n+import argparse\n+import string\n+import sys\n+import yaml\n+\n+\n+def find_common_prefix(strings):\n+    prefix = strings[0]\n+\n+    for string in strings[1:]:\n+        while string[:len(prefix)] != prefix and prefix:\n+            prefix = prefix[:len(prefix) - 1]\n+        if not prefix:\n+            break\n+\n+    return prefix\n+\n+\n+def generate_py(controls):\n+    out = \"\"\n+\n+    for ctrl in controls:\n+        name, ctrl = ctrl.popitem()\n+\n+        enum = ctrl.get('enum')\n+        if not enum:\n+            continue\n+\n+        if ctrl.get('draft'):\n+            ns = \"libcamera::controls::draft::\"\n+        else:\n+            ns = \"libcamera::controls::\"\n+\n+        cpp_enum = name + \"Enum\"\n+\n+        out += \"\\tpy::enum_<{}{}>(m, \\\"{}\\\")\\n\".format(ns, cpp_enum, name)\n+\n+        if name == \"LensShadingMapMode\":\n+            prefix = \"LensShadingMapMode\"\n+        else:\n+            prefix = find_common_prefix([e[\"name\"] for e in enum])\n+\n+        for entry in enum:\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+    return {\"enums\": out}\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+\n+\n+def main(argv):\n+    # Parse command line arguments\n+    parser = argparse.ArgumentParser()\n+    parser.add_argument('-o', dest='output', metavar='file', type=str,\n+                        help='Output file name. Defaults to standard output if not specified.')\n+    parser.add_argument('input', type=str,\n+                        help='Input file name.')\n+    parser.add_argument('template', type=str,\n+                        help='Template file name.')\n+    args = parser.parse_args(argv[1:])\n+\n+    data = open(args.input, 'rb').read()\n+    controls = yaml.safe_load(data)['controls']\n+\n+    data = generate_py(controls)\n+\n+    data = fill_template(args.template, data)\n+\n+    if args.output:\n+        output = open(args.output, 'wb')\n+        output.write(data.encode('utf-8'))\n+        output.close()\n+    else:\n+        sys.stdout.write(data)\n+\n+    return 0\n+\n+\n+if __name__ == '__main__':\n+    sys.exit(main(sys.argv))\ndiff --git a/src/py/libcamera/meson.build b/src/py/libcamera/meson.build\nindex e1f5cf21..42988e55 100644\n--- a/src/py/libcamera/meson.build\n+++ b/src/py/libcamera/meson.build\n@@ -17,6 +17,15 @@ pycamera_sources = files([\n     'pyenums.cpp',\n ])\n \n+gen_input_files = [meson.project_source_root() / 'src/libcamera/control_ids.yaml', 'pyenums_generated.cpp.in']\n+\n+generated_sources = custom_target('py_gen_controls',\n+                                  input : gen_input_files,\n+                                  output : ['pyenums_generated.cpp'],\n+                                  command : ['gen-py-control-enums.py', '-o', '@OUTPUT@', '@INPUT@'])\n+\n+pycamera_sources += generated_sources\n+\n pycamera_deps = [\n     libcamera_public,\n     py3_dep,\ndiff --git a/src/py/libcamera/pyenums_generated.cpp.in b/src/py/libcamera/pyenums_generated.cpp.in\nnew file mode 100644\nindex 00000000..96daf257\n--- /dev/null\n+++ b/src/py/libcamera/pyenums_generated.cpp.in\n@@ -0,0 +1,21 @@\n+/* SPDX-License-Identifier: LGPL-2.1-or-later */\n+/*\n+ * Copyright (C) 2021, Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>\n+ *\n+ * Python bindings\n+ *\n+ * This file is auto-generated. Do not edit.\n+ */\n+\n+#include <libcamera/libcamera.h>\n+\n+#include <pybind11/smart_holder.h>\n+\n+namespace py = pybind11;\n+\n+using namespace libcamera;\n+\n+void init_pyenums_generated(py::module& m)\n+{\n+${enums}\n+}\ndiff --git a/src/py/libcamera/pymain.cpp b/src/py/libcamera/pymain.cpp\nindex 54674caf..81d48a20 100644\n--- a/src/py/libcamera/pymain.cpp\n+++ b/src/py/libcamera/pymain.cpp\n@@ -115,10 +115,12 @@ static void handleRequestCompleted(Request *req)\n }\n \n void init_pyenums(py::module &m);\n+void init_pyenums_generated(py::module &m);\n \n PYBIND11_MODULE(_libcamera, m)\n {\n \tinit_pyenums(m);\n+\tinit_pyenums_generated(m);\n \n \t/* Forward declarations */\n \n",
    "prefixes": [
        "libcamera-devel",
        "v7",
        "05/13"
    ]
}