Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/140006/?format=api
{ "id": 140006, "url": "https://patches.dpdk.org/api/patches/140006/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/20240509112057.1167947-9-luca.vizzarro@arm.com/", "project": { "id": 1, "url": "https://patches.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": "<20240509112057.1167947-9-luca.vizzarro@arm.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20240509112057.1167947-9-luca.vizzarro@arm.com", "date": "2024-05-09T11:20:57", "name": "[v2,8/8] dts: use Unpack for type checking and hinting", "commit_ref": null, "pull_url": null, "state": "new", "archived": false, "hash": "5764cf3de3bb2c818cd6c1b4f6dcdebe27afa4bd", "submitter": { "id": 3197, "url": "https://patches.dpdk.org/api/people/3197/?format=api", "name": "Luca Vizzarro", "email": "luca.vizzarro@arm.com" }, "delegate": { "id": 1, "url": "https://patches.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "https://patches.dpdk.org/project/dpdk/patch/20240509112057.1167947-9-luca.vizzarro@arm.com/mbox/", "series": [ { "id": 31897, "url": "https://patches.dpdk.org/api/series/31897/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=31897", "date": "2024-05-09T11:20:49", "name": "dts: add testpmd params", "version": 2, "mbox": "https://patches.dpdk.org/series/31897/mbox/" } ], "comments": "https://patches.dpdk.org/api/patches/140006/comments/", "check": "warning", "checks": "https://patches.dpdk.org/api/patches/140006/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 9386F43F7C;\n\tThu, 9 May 2024 13:22:12 +0200 (CEST)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 47BFD40A89;\n\tThu, 9 May 2024 13:21:24 +0200 (CEST)", "from foss.arm.com (foss.arm.com [217.140.110.172])\n by mails.dpdk.org (Postfix) with ESMTP id 08804402F1\n for <dev@dpdk.org>; Thu, 9 May 2024 13:21:17 +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 1BEF4106F;\n Thu, 9 May 2024 04:21:42 -0700 (PDT)", "from localhost.localdomain (unknown [10.1.194.74])\n by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPA id E7E933F6A8;\n Thu, 9 May 2024 04:21:15 -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 8/8] dts: use Unpack for type checking and hinting", "Date": "Thu, 9 May 2024 12:20:57 +0100", "Message-Id": "<20240509112057.1167947-9-luca.vizzarro@arm.com>", "X-Mailer": "git-send-email 2.34.1", "In-Reply-To": "<20240509112057.1167947-1-luca.vizzarro@arm.com>", "References": "<20240326190422.577028-1-luca.vizzarro@arm.com>\n <20240509112057.1167947-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": "Interactive shells that inherit DPDKShell initialise their params\nclasses from a kwargs dict. Therefore, static type checking is\ndisabled. This change uses the functionality of Unpack added in\nPEP 692 to re-enable it. The disadvantage is that this functionality has\nbeen implemented only with TypedDict, forcing the creation of TypedDict\nmirrors of the Params classes.\n\nSigned-off-by: Luca Vizzarro <luca.vizzarro@arm.com>\nReviewed-by: Paul Szczepanek <paul.szczepanek@arm.com>\n---\n dts/framework/params/types.py | 133 ++++++++++++++++++\n dts/framework/remote_session/testpmd_shell.py | 5 +-\n 2 files changed, 137 insertions(+), 1 deletion(-)\n create mode 100644 dts/framework/params/types.py", "diff": "diff --git a/dts/framework/params/types.py b/dts/framework/params/types.py\nnew file mode 100644\nindex 0000000000..e668f658d8\n--- /dev/null\n+++ b/dts/framework/params/types.py\n@@ -0,0 +1,133 @@\n+# SPDX-License-Identifier: BSD-3-Clause\n+# Copyright(c) 2024 Arm Limited\n+\n+\"\"\"Module containing TypeDict-equivalents of Params classes for static typing and hinting.\n+\n+TypedDicts can be used in conjunction with Unpack and kwargs for type hinting on function calls.\n+\n+Example:\n+ ..code:: python\n+ def create_testpmd(**kwargs: Unpack[TestPmdParamsDict]):\n+ params = TestPmdParams(**kwargs)\n+\"\"\"\n+\n+from pathlib import PurePath\n+from typing import TypedDict\n+\n+from framework.params import Switch, YesNoSwitch\n+from framework.params.testpmd import (\n+ AnonMempoolAllocationMode,\n+ EthPeer,\n+ Event,\n+ FlowGenForwardingMode,\n+ HairpinMode,\n+ NoisyForwardingMode,\n+ Params,\n+ PortNUMAConfig,\n+ PortTopology,\n+ RingNUMAConfig,\n+ RSSSetting,\n+ RXMultiQueueMode,\n+ RXRingParams,\n+ SimpleForwardingModes,\n+ SimpleMempoolAllocationMode,\n+ TxIPAddrPair,\n+ TXOnlyForwardingMode,\n+ TXRingParams,\n+ TxUDPPortPair,\n+)\n+from framework.testbed_model.cpu import LogicalCoreList\n+from framework.testbed_model.port import Port\n+from framework.testbed_model.virtual_device import VirtualDevice\n+\n+\n+class EalParamsDict(TypedDict, total=False):\n+ \"\"\":class:`TypedDict` equivalent of :class:`~.eal.EalParams`.\"\"\"\n+\n+ lcore_list: LogicalCoreList | None\n+ memory_channels: int | None\n+ prefix: str\n+ no_pci: Switch\n+ vdevs: list[VirtualDevice] | None\n+ ports: list[Port] | None\n+ other_eal_param: Params | None\n+\n+\n+class TestPmdParamsDict(EalParamsDict, total=False):\n+ \"\"\":class:`TypedDict` equivalent of :class:`~.testpmd.TestPmdParams`.\"\"\"\n+\n+ interactive_mode: Switch\n+ auto_start: Switch\n+ tx_first: Switch\n+ stats_period: int | None\n+ display_xstats: list[str] | None\n+ nb_cores: int | None\n+ coremask: int | None\n+ nb_ports: int | None\n+ port_topology: PortTopology | None\n+ portmask: int | None\n+ portlist: str | None\n+ numa: YesNoSwitch\n+ socket_num: int | None\n+ port_numa_config: list[PortNUMAConfig] | None\n+ ring_numa_config: list[RingNUMAConfig] | None\n+ total_num_mbufs: int | None\n+ mbuf_size: list[int] | None\n+ mbcache: int | None\n+ max_pkt_len: int | None\n+ eth_peers_configfile: PurePath | None\n+ eth_peer: list[EthPeer] | None\n+ tx_ip: TxIPAddrPair | None\n+ tx_udp: TxUDPPortPair | None\n+ enable_lro: Switch\n+ max_lro_pkt_size: int | None\n+ disable_crc_strip: Switch\n+ enable_scatter: Switch\n+ enable_hw_vlan: Switch\n+ enable_hw_vlan_filter: Switch\n+ enable_hw_vlan_strip: Switch\n+ enable_hw_vlan_extend: Switch\n+ enable_hw_qinq_strip: Switch\n+ pkt_drop_enabled: Switch\n+ rss: RSSSetting | None\n+ forward_mode: (\n+ SimpleForwardingModes\n+ | FlowGenForwardingMode\n+ | TXOnlyForwardingMode\n+ | NoisyForwardingMode\n+ | None\n+ )\n+ hairpin_mode: HairpinMode | None\n+ hairpin_queues: int | None\n+ burst: int | None\n+ enable_rx_cksum: Switch\n+ rx_queues: int | None\n+ rx_ring: RXRingParams | None\n+ no_flush_rx: Switch\n+ rx_segments_offsets: list[int] | None\n+ rx_segments_length: list[int] | None\n+ multi_rx_mempool: Switch\n+ rx_shared_queue: Switch | int\n+ rx_offloads: int | None\n+ rx_mq_mode: RXMultiQueueMode | None\n+ tx_queues: int | None\n+ tx_ring: TXRingParams | None\n+ tx_offloads: int | None\n+ eth_link_speed: int | None\n+ disable_link_check: Switch\n+ disable_device_start: Switch\n+ no_lsc_interrupt: Switch\n+ no_rmv_interrupt: Switch\n+ bitrate_stats: int | None\n+ latencystats: int | None\n+ print_events: list[Event] | None\n+ mask_events: list[Event] | None\n+ flow_isolate_all: Switch\n+ disable_flow_flush: Switch\n+ hot_plug: Switch\n+ vxlan_gpe_port: int | None\n+ geneve_parsed_port: int | None\n+ lock_all_memory: YesNoSwitch\n+ mempool_allocation_mode: SimpleMempoolAllocationMode | AnonMempoolAllocationMode | None\n+ record_core_cycles: Switch\n+ record_burst_status: Switch\ndiff --git a/dts/framework/remote_session/testpmd_shell.py b/dts/framework/remote_session/testpmd_shell.py\nindex 92930d7fbb..5b3a7bb9ab 100644\n--- a/dts/framework/remote_session/testpmd_shell.py\n+++ b/dts/framework/remote_session/testpmd_shell.py\n@@ -18,8 +18,11 @@\n from pathlib import PurePath\n from typing import ClassVar\n \n+from typing_extensions import Unpack\n+\n from framework.exception import InteractiveCommandExecutionError\n from framework.params.testpmd import SimpleForwardingModes, TestPmdParams\n+from framework.params.types import TestPmdParamsDict\n from framework.remote_session.dpdk_shell import DPDKShell\n from framework.settings import SETTINGS\n from framework.testbed_model.cpu import LogicalCoreCount, LogicalCoreList\n@@ -76,7 +79,7 @@ def __init__(\n ascending_cores: bool = True,\n append_prefix_timestamp: bool = True,\n start_on_init: bool = True,\n- **app_params,\n+ **app_params: Unpack[TestPmdParamsDict],\n ) -> None:\n \"\"\"Overrides :meth:`~.dpdk_shell.DPDKShell.__init__`. Changes app_params to kwargs.\"\"\"\n super().__init__(\n", "prefixes": [ "v2", "8/8" ] }