Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/140009/?format=api
{ "id": 140009, "url": "http://patchwork.dpdk.org/api/patches/140009/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/patch/20240509112635.1170557-4-luca.vizzarro@arm.com/", "project": { "id": 1, "url": "http://patchwork.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20240509112635.1170557-4-luca.vizzarro@arm.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20240509112635.1170557-4-luca.vizzarro@arm.com", "date": "2024-05-09T11:26:33", "name": "[v2,3/5] dts: add parsing utility module", "commit_ref": null, "pull_url": null, "state": "new", "archived": false, "hash": "de883a4883a00995f647356ca033ea2de019e7f9", "submitter": { "id": 3197, "url": "http://patchwork.dpdk.org/api/people/3197/?format=api", "name": "Luca Vizzarro", "email": "luca.vizzarro@arm.com" }, "delegate": { "id": 1, "url": "http://patchwork.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "http://patchwork.dpdk.org/project/dpdk/patch/20240509112635.1170557-4-luca.vizzarro@arm.com/mbox/", "series": [ { "id": 31898, "url": "http://patchwork.dpdk.org/api/series/31898/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/list/?series=31898", "date": "2024-05-09T11:26:30", "name": "dts: testpmd show port info/stats", "version": 2, "mbox": "http://patchwork.dpdk.org/series/31898/mbox/" } ], "comments": "http://patchwork.dpdk.org/api/patches/140009/comments/", "check": "success", "checks": "http://patchwork.dpdk.org/api/patches/140009/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 4EF3743F7C;\n\tThu, 9 May 2024 13:27:05 +0200 (CEST)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 97ABF40A70;\n\tThu, 9 May 2024 13:26:52 +0200 (CEST)", "from foss.arm.com (foss.arm.com [217.140.110.172])\n by mails.dpdk.org (Postfix) with ESMTP id 939DE406BC\n for <dev@dpdk.org>; Thu, 9 May 2024 13:26:50 +0200 (CEST)", "from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14])\n by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 656CE12FC;\n Thu, 9 May 2024 04:27:15 -0700 (PDT)", "from localhost.localdomain (unknown [10.1.194.74])\n by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPA id 3E4B43F6A8;\n Thu, 9 May 2024 04:26:49 -0700 (PDT)" ], "From": "Luca Vizzarro <luca.vizzarro@arm.com>", "To": "dev@dpdk.org", "Cc": "=?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>,\n Jeremy Spewock <jspewock@iol.unh.edu>, Luca Vizzarro <luca.vizzarro@arm.com>,\n Paul Szczepanek <paul.szczepanek@arm.com>", "Subject": "[PATCH v2 3/5] dts: add parsing utility module", "Date": "Thu, 9 May 2024 12:26:33 +0100", "Message-Id": "<20240509112635.1170557-4-luca.vizzarro@arm.com>", "X-Mailer": "git-send-email 2.34.1", "In-Reply-To": "<20240509112635.1170557-1-luca.vizzarro@arm.com>", "References": "<20240412111136.3470304-1-luca.vizzarro@arm.com>\n <20240509112635.1170557-1-luca.vizzarro@arm.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "Adds parsing text into a custom dataclass. It provides a new\n`TextParser` dataclass to be inherited. This implements the `parse`\nmethod, which combined with the parser functions, it can automatically\nparse the value for each field.\n\nThis new utility will facilitate and simplify the parsing of complex\ncommand outputs, while ensuring that the codebase does not get bloated\nand stays flexible.\n\nSigned-off-by: Luca Vizzarro <luca.vizzarro@arm.com>\nReviewed-by: Paul Szczepanek <paul.szczepanek@arm.com>\n---\n dts/framework/parser.py | 199 ++++++++++++++++++++++++++++++++++++++++\n 1 file changed, 199 insertions(+)\n create mode 100644 dts/framework/parser.py", "diff": "diff --git a/dts/framework/parser.py b/dts/framework/parser.py\nnew file mode 100644\nindex 0000000000..5b4acddead\n--- /dev/null\n+++ b/dts/framework/parser.py\n@@ -0,0 +1,199 @@\n+# SPDX-License-Identifier: BSD-3-Clause\n+# Copyright(c) 2024 Arm Limited\n+\n+r\"\"\"Parsing utility module.\n+\n+This module provides :class:`~TextParser` which can be used to model any dataclass to a block of\n+text.\n+\n+Usage example::\n+..code:: python\n+\n+ from dataclasses import dataclass, field\n+ from enum import Enum\n+ from framework.parser import TextParser\n+\n+ class Colour(Enum):\n+ BLACK = 1\n+ WHITE = 2\n+\n+ @classmethod\n+ def from_str(cls, text: str):\n+ match text:\n+ case \"black\":\n+ return cls.BLACK\n+ case \"white\":\n+ return cls.WHITE\n+ case _:\n+ return None # unsupported colour\n+\n+ @classmethod\n+ def make_parser(cls):\n+ # make a parser function that finds a match and\n+ # then makes it a Colour object through Colour.from_str\n+ return TextParser.compose(cls.from_str, TextParser.find(r\"is a (\\w+)\"))\n+\n+ @dataclass\n+ class Animal(TextParser):\n+ kind: str = field(metadata=TextParser.find(r\"is a \\w+ (\\w+)\"))\n+ name: str = field(metadata=TextParser.find(r\"^(\\w+)\"))\n+ colour: Colour = field(metadata=Colour.make_parser())\n+ age: int = field(metadata=TextParser.find_int(r\"aged (\\d+)\"))\n+\n+ steph = Animal.parse(\"Stephanie is a white cat aged 10\")\n+ print(steph) # Animal(kind='cat', name='Stephanie', colour=<Colour.WHITE: 2>, age=10)\n+\"\"\"\n+\n+import re\n+from abc import ABC\n+from dataclasses import MISSING, dataclass, fields\n+from functools import partial\n+from typing import Any, Callable, TypedDict, cast\n+\n+from typing_extensions import Self\n+\n+\n+class ParserFn(TypedDict):\n+ \"\"\"Parser function in a dict compatible with the :func:`dataclasses.field` metadata param.\"\"\"\n+\n+ #:\n+ TextParser_fn: Callable[[str], Any]\n+\n+\n+@dataclass\n+class TextParser(ABC):\n+ \"\"\"Helper abstract dataclass that parses a text according to the fields' rules.\n+\n+ This class provides a selection of parser functions and a function to compose generic functions\n+ with parser functions. Parser functions are designed to be passed to the fields' metadata param\n+ to enable parsing.\n+ \"\"\"\n+\n+ \"\"\"============ BEGIN PARSER FUNCTIONS ============\"\"\"\n+\n+ @staticmethod\n+ def compose(f: Callable, parser_fn: ParserFn) -> ParserFn:\n+ \"\"\"Makes a composite parser function.\n+\n+ The parser function is run and if a non-None value was returned, f is called with it.\n+ Otherwise the function returns early with None.\n+\n+ Metadata modifier for :func:`dataclasses.field`.\n+\n+ Args:\n+ f: the function to apply to the parser's result\n+ parser_fn: the dictionary storing the parser function\n+ \"\"\"\n+ g = parser_fn[\"TextParser_fn\"]\n+\n+ def _composite_parser_fn(text: str) -> Any:\n+ intermediate_value = g(text)\n+ if intermediate_value is None:\n+ return None\n+ return f(intermediate_value)\n+\n+ return ParserFn(TextParser_fn=_composite_parser_fn)\n+\n+ @staticmethod\n+ def find(\n+ pattern: str | re.Pattern[str],\n+ flags: re.RegexFlag = re.RegexFlag(0),\n+ named: bool = False,\n+ ) -> ParserFn:\n+ \"\"\"Makes a parser function that finds a regular expression match in the text.\n+\n+ If the pattern has capturing groups, it returns None if no match was found. If the pattern\n+ has only one capturing group and a match was found, its value is returned. If the pattern\n+ has no capturing groups then either True or False is returned if the pattern had a match or\n+ not.\n+\n+ Metadata modifier for :func:`dataclasses.field`.\n+\n+ Args:\n+ pattern: the regular expression pattern\n+ flags: the regular expression flags. Not used if the given pattern is already compiled\n+ named: if set to True only the named capture groups will be returned as a dictionary\n+ \"\"\"\n+ if isinstance(pattern, str):\n+ pattern = re.compile(pattern, flags)\n+\n+ def _find(text: str) -> Any:\n+ m = pattern.search(text)\n+ if m is None:\n+ return None if pattern.groups > 0 else False\n+\n+ if pattern.groups == 0:\n+ return True\n+\n+ if named:\n+ return m.groupdict()\n+\n+ matches = m.groups()\n+ if len(matches) == 1:\n+ return matches[0]\n+\n+ return matches\n+\n+ return ParserFn(TextParser_fn=_find)\n+\n+ @classmethod\n+ def find_int(\n+ cls,\n+ pattern: str | re.Pattern[str],\n+ flags: re.RegexFlag = re.RegexFlag(0),\n+ int_base: int = 0,\n+ ) -> ParserFn:\n+ \"\"\"Makes a parser function that converts the match of :meth:`~find` to int.\n+\n+ This function is compatible only with a pattern containing one capturing group.\n+\n+ Metadata modifier for :func:`dataclasses.field`.\n+\n+ Args:\n+ pattern: the regular expression pattern\n+ flags: the regular expression flags\n+ int_base: the base of the number to convert from\n+ Raises:\n+ RuntimeError: if the pattern does not have exactly one capturing group\n+ \"\"\"\n+ if isinstance(pattern, str):\n+ pattern = re.compile(pattern, flags)\n+\n+ if pattern.groups != 1:\n+ raise RuntimeError(\"only one capturing group is allowed with this parser function\")\n+\n+ return cls.compose(partial(int, base=int_base), cls.find(pattern))\n+\n+ \"\"\"============ END PARSER FUNCTIONS ============\"\"\"\n+\n+ @classmethod\n+ def parse(cls, text: str) -> Self:\n+ \"\"\"Creates a new instance of the class from the given text.\n+\n+ A new class instance is created with all the fields that have a parser function in their\n+ metadata. Fields without one are ignored and are expected to have a default value, otherwise\n+ the class initialization will fail.\n+\n+ A field is populated with the value returned by its corresponding parser function.\n+\n+ Args:\n+ text: the text to parse\n+ Raises:\n+ RuntimeError: if the parser did not find a match and the field does not have a default\n+ value or default factory.\n+ \"\"\"\n+ fields_values = {}\n+ for field in fields(cls):\n+ parse = cast(ParserFn, field.metadata).get(\"TextParser_fn\")\n+ if parse is None:\n+ continue\n+\n+ value = parse(text)\n+ if value is not None:\n+ fields_values[field.name] = value\n+ elif field.default is MISSING and field.default_factory is MISSING:\n+ raise RuntimeError(\n+ f\"parser for field {field.name} returned None, but the field has no default\"\n+ )\n+\n+ return cls(**fields_values)\n", "prefixes": [ "v2", "3/5" ] }