Show a patch.

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

{
    "id": 20859,
    "url": "https://patchwork.libcamera.org/api/1.1/patches/20859/?format=api",
    "web_url": "https://patchwork.libcamera.org/patch/20859/",
    "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-10-laurent.pinchart@ideasonboard.com>",
    "date": "2024-08-09T00:59:13",
    "name": "[09/10] py: gen-py-controls: Use Control class",
    "commit_ref": null,
    "pull_url": null,
    "state": "accepted",
    "archived": false,
    "hash": "a35a11373274f72ba67f685eeff0439a81b3c671",
    "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/20859/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/20859/comments/",
    "check": "pending",
    "checks": "https://patchwork.libcamera.org/api/patches/20859/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 77332C32D5\n\tfor <parsemail@patchwork.libcamera.org>;\n\tFri,  9 Aug 2024 00:59:57 +0000 (UTC)",
            "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id D2CE1633C9;\n\tFri,  9 Aug 2024 02:59:56 +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 234FD633CD\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri,  9 Aug 2024 02:59:52 +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 2B5BC83F\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri,  9 Aug 2024 02:58:58 +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=\"bTWLPzwM\"; dkim-atps=neutral",
        "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1723165138;\n\tbh=7fKKDaIFyyJ5HbNkseLGDiGUEMMyrsKzO/H3tnbmhcU=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=bTWLPzwM4baMKs5sUh/dDJS+4Blz2YNfs+fFF/XnG5GjXPiKqUfretZxz6K6tPIbA\n\tYWU03IPvMCuRcI/+D4t1QRz824a657i0znjtK+JpQB3x67GFncAXrLE2eX8rFaRcZT\n\tex6ZoRg7iOxoAsoaa5pgh8NNCCZRtk4FwU4dH7bE=",
        "From": "Laurent Pinchart <laurent.pinchart@ideasonboard.com>",
        "To": "libcamera-devel@lists.libcamera.org",
        "Subject": "[PATCH 09/10] py: gen-py-controls: Use Control class",
        "Date": "Fri,  9 Aug 2024 03:59:13 +0300",
        "Message-ID": "<20240809005914.20662-10-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": "Replace manual extraction of data from YAML with the Control helper\nclass. This centralizes YAML parsing and avoids manual mistakes.\n\nIn order to import the controls module, add the utils/codegen/ directory\nto the PYTHONPATH through the Python build environment.\n\nSigned-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n---\n src/py/libcamera/gen-py-controls.py | 32 ++++++++++++++---------------\n src/py/libcamera/meson.build        |  6 ++++--\n utils/codegen/meson.build           |  1 +\n 3 files changed, 21 insertions(+), 18 deletions(-)",
    "diff": "diff --git a/src/py/libcamera/gen-py-controls.py b/src/py/libcamera/gen-py-controls.py\nindex 8efbf95b9433..a18dc5337090 100755\n--- a/src/py/libcamera/gen-py-controls.py\n+++ b/src/py/libcamera/gen-py-controls.py\n@@ -8,6 +8,8 @@ import string\n import sys\n import yaml\n \n+from controls import Control\n+\n \n def find_common_prefix(strings):\n     prefix = strings[0]\n@@ -28,9 +30,7 @@ def generate_py(controls, mode):\n     vendor_defs = []\n     vendors = []\n     for vendor, ctrl_list in controls.items():\n-        for ctrls in ctrl_list:\n-            name, ctrl = ctrls.popitem()\n-\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@@ -44,29 +44,28 @@ def generate_py(controls, mode):\n                 ns = 'libcamera::{}::'.format(mode)\n                 container = 'controls'\n \n-            out += f'\\t{container}.def_readonly_static(\"{name}\", static_cast<const libcamera::ControlId *>(&{ns}{name}));\\n\\n'\n+            out += f'\\t{container}.def_readonly_static(\"{ctrl.name}\", static_cast<const libcamera::ControlId *>(&{ns}{ctrl.name}));\\n\\n'\n \n-            enum = ctrl.get('enum')\n-            if not enum:\n+            if not ctrl.is_enum:\n                 continue\n \n-            cpp_enum = name + 'Enum'\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 name == 'LensShadingMapMode':\n+                if ctrl.name == 'LensShadingMapMode':\n                     prefix = 'LensShadingMapMode'\n                 else:\n-                    prefix = find_common_prefix([e['name'] for e in enum])\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 enum])\n+                prefix = find_common_prefix([e.name for e in ctrl.enum_values])\n \n-            for entry in enum:\n-                cpp_enum = entry['name']\n-                py_enum = entry['name'][len(prefix):]\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@@ -103,9 +102,10 @@ def main(argv):\n \n     controls = {}\n     for input in args.input:\n-        data = open(input, 'rb').read()\n-        vendor = yaml.safe_load(data)['vendor']\n-        controls[vendor] = yaml.safe_load(data)['controls']\n+        data = yaml.safe_load(open(input, 'rb').read())\n+        vendor = data['vendor']\n+        ctrls = data['controls']\n+        controls[vendor] = [Control(*ctrl.popitem(), vendor) for ctrl in ctrls]\n \n     data = generate_py(controls, args.mode)\n \ndiff --git a/src/py/libcamera/meson.build b/src/py/libcamera/meson.build\nindex 2e67407598db..6ad2d7713e4d 100644\n--- a/src/py/libcamera/meson.build\n+++ b/src/py/libcamera/meson.build\n@@ -35,7 +35,8 @@ pycamera_sources += custom_target('py_gen_controls',\n                                   input : controls_files,\n                                   output : ['py_controls_generated.cpp'],\n                                   command : [gen_py_controls, '--mode', 'controls', '-o', '@OUTPUT@',\n-                                             '-t', gen_py_controls_template, '@INPUT@'])\n+                                             '-t', gen_py_controls_template, '@INPUT@'],\n+                                  env : py_build_env)\n \n # Generate properties\n \n@@ -45,7 +46,8 @@ 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_properties_template, '@INPUT@'],\n+                                  env : py_build_env)\n \n # Generate formats\n \ndiff --git a/utils/codegen/meson.build b/utils/codegen/meson.build\nindex fb2196ee0d20..adf33bbab9e1 100644\n--- a/utils/codegen/meson.build\n+++ b/utils/codegen/meson.build\n@@ -5,6 +5,7 @@\n py_build_env = environment()\n # \\todo Investigate usage of PYTHONPYCACHEPREFIX for Python >= 3.8\n py_build_env.set('PYTHONDONTWRITEBYTECODE', '1')\n+py_build_env.prepend('PYTHONPATH', meson.current_source_dir())\n \n py_modules += ['jinja2', 'yaml']\n \n",
    "prefixes": [
        "09/10"
    ]
}