From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
by inbox.dpdk.org (Postfix) with ESMTP id 307B1433AC;
Thu, 23 Nov 2023 16:13:49 +0100 (CET)
Received: from mails.dpdk.org (localhost [127.0.0.1])
by mails.dpdk.org (Postfix) with ESMTP id C94CC42F76;
Thu, 23 Nov 2023 16:13:48 +0100 (CET)
Received: from mail-wr1-f53.google.com (mail-wr1-f53.google.com
[209.85.221.53]) by mails.dpdk.org (Postfix) with ESMTP id 086E042F73
for <dev@dpdk.org>; Thu, 23 Nov 2023 16:13:47 +0100 (CET)
Received: by mail-wr1-f53.google.com with SMTP id
ffacd0b85a97d-332d2948170so626587f8f.2
for <dev@dpdk.org>; Thu, 23 Nov 2023 07:13:47 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=pantheon.tech; s=google; t=1700752427; x=1701357227; darn=dpdk.org;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:from:to:cc:subject:date
:message-id:reply-to;
bh=jwv+ImpkZqqHi2lma0SSh5YrT62IenTzDQzebxdA3Qc=;
b=pnv+eietRalucj9pUiKFmwyJQZHtBEgk08p6ZTDLa7PqfXgAz5SF1LeqmzlE0JfPln
r0jIsSI3jqhJgOP1QV2L2NW+bkdNA2w/GTy/Nj1muDhjiX5t4uS7+mtRNlOpkC3giMla
AEy/O6tvs9UdrBE4T3upI14zto2v+2ahLkgiA0f1w85RjLh74lsiAN8D7v6h+5ISAf9m
Uce26fY4bcfq6D9OANnhV4Twk5JDm8VjQLhWXyabREicXbY/O+ErxJlcxrMmfktvP083
gy7PuCl2nfVX0mJT0OQFc+Yl2+hEDpuhXvc7lgU+9c0tnksI3x5sHyYoawL3Qqk00RH1
4/lA==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20230601; t=1700752427; x=1701357227;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc
:subject:date:message-id:reply-to;
bh=jwv+ImpkZqqHi2lma0SSh5YrT62IenTzDQzebxdA3Qc=;
b=pd8DoYnpCYoFGMWsT2FJvtZxiEkJdkaGy1XHPG1ONcfIi8HuV49AjpPjLbUSak9YRx
KASGiuzlyfNcocbRUVbc83Ozwwcxup3AcwzIksvqMES64QYGDCHi3jeuZL6KaHu8Z5Z2
1dvKaLxBXDfuuzIHmNjd35FtYIv7mqVzCklJgDupAJrZeN9E0xOdN5QYmrnU2k2qHgau
svEXgkQcPA8PmfTFmYwIoHSl36drfG2NRDhv5l5Cd6woKvjZaPj53ym3TPizo4IjFM+M
R975ZLJNo5jCEru8oZrprOXBFdWfsGPDPioGw8H3gqmFIW1mB6EfMk34QSk1SvC1ierY
s+Fw==
X-Gm-Message-State: AOJu0YyJeXMr9AOdd7eHB6t2If6PgfJ2CKS3GN2Lf9tKDIg+VJx2d/nB
SbLWXe8UMlC0za2OTV1t/JUi6w==
X-Google-Smtp-Source: AGHT+IEH3DqK83ssDsElkyjjJfcp0GG5DpleE5medtssq3FtVzjrDqnoh3/zP6bPGskGmVP0HipgeA==
X-Received: by 2002:a5d:64e8:0:b0:332:ca14:f589 with SMTP id
g8-20020a5d64e8000000b00332ca14f589mr4429057wri.12.1700752426364;
Thu, 23 Nov 2023 07:13:46 -0800 (PST)
Received: from jlinkes-PT-Latitude-5530.. ([84.245.121.10])
by smtp.gmail.com with ESMTPSA id
q4-20020adfea04000000b003296b488961sm1870143wrm.31.2023.11.23.07.13.44
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Thu, 23 Nov 2023 07:13:45 -0800 (PST)
From: =?UTF-8?q?Juraj=20Linke=C5=A1?= <juraj.linkes@pantheon.tech>
To: thomas@monjalon.net, Honnappa.Nagarahalli@arm.com, jspewock@iol.unh.edu,
probb@iol.unh.edu, paul.szczepanek@arm.com, yoan.picchi@foss.arm.com,
Luca.Vizzarro@arm.com
Cc: dev@dpdk.org, =?UTF-8?q?Juraj=20Linke=C5=A1?= <juraj.linkes@pantheon.tech>
Subject: [PATCH v8 00/21] dts: docstrings update
Date: Thu, 23 Nov 2023 16:13:23 +0100
Message-Id: <20231123151344.162812-1-juraj.linkes@pantheon.tech>
X-Mailer: git-send-email 2.34.1
In-Reply-To: <20231115130959.39420-1-juraj.linkes@pantheon.tech>
References: <20231115130959.39420-1-juraj.linkes@pantheon.tech>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
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>,
<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>,
<mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
The first commit makes changes to the code. These code changes mainly
change the structure of the code so that the actual API docs generation
works. There are also some code changes which get reflected in the
documentation, such as making functions/methods/attributes private or
public.
The rest of the commits deal with the actual docstring documentation
(from which the API docs are generated). The format of the docstrings
is the Google format [0] with PEP257 [1] and some guidelines captured
in the last commit of this group covering what the Google format
doesn't.
The docstring updates are split into many commits to make review
possible. When accepted, they may be squashed.
The docstrings have been composed in anticipation of [2], adhering to
maximum line length of 100. We don't have a tool for automatic docstring
formatting, hence the usage of 100 right away to save time.
NOTE: The logger.py module is not fully documented, as it's being
refactored and the refactor will be submitted in the near future.
Documenting it now seems unnecessary.
[0] https://google.github.io/styleguide/pyguide.html#s3.8.4-comments-in-classes
[1] https://peps.python.org/pep-0257/
[2] https://patches.dpdk.org/project/dpdk/list/?series=29844
v7:
Split the series into docstrings and api docs generation and addressed
comments.
v8:
Addressed review comments, all of which were pretty minor - small
gramatical changes, a little bit of rewording to remove confusion here
and there, additional explanations and so on.
Juraj Linkeš (21):
dts: code adjustments for doc generation
dts: add docstring checker
dts: add basic developer docs
dts: exceptions docstring update
dts: settings docstring update
dts: logger and utils docstring update
dts: dts runner and main docstring update
dts: test suite docstring update
dts: test result docstring update
dts: config docstring update
dts: remote session docstring update
dts: interactive remote session docstring update
dts: port and virtual device docstring update
dts: cpu docstring update
dts: os session docstring update
dts: posix and linux sessions docstring update
dts: node docstring update
dts: sut and tg nodes docstring update
dts: base traffic generators docstring update
dts: scapy tg docstring update
dts: test suites docstring update
doc/guides/tools/dts.rst | 73 +++
dts/framework/__init__.py | 12 +-
dts/framework/config/__init__.py | 375 +++++++++++++---
dts/framework/config/types.py | 132 ++++++
dts/framework/dts.py | 162 +++++--
dts/framework/exception.py | 156 ++++---
dts/framework/logger.py | 72 ++-
dts/framework/remote_session/__init__.py | 80 ++--
.../interactive_remote_session.py | 36 +-
.../remote_session/interactive_shell.py | 150 +++++++
dts/framework/remote_session/os_session.py | 284 ------------
dts/framework/remote_session/python_shell.py | 32 ++
.../remote_session/remote/__init__.py | 27 --
.../remote/interactive_shell.py | 131 ------
.../remote_session/remote/python_shell.py | 12 -
.../remote_session/remote/remote_session.py | 168 -------
.../remote_session/remote/testpmd_shell.py | 45 --
.../remote_session/remote_session.py | 230 ++++++++++
.../{remote => }/ssh_session.py | 28 +-
dts/framework/remote_session/testpmd_shell.py | 83 ++++
dts/framework/settings.py | 188 ++++++--
dts/framework/test_result.py | 301 ++++++++++---
dts/framework/test_suite.py | 236 +++++++---
dts/framework/testbed_model/__init__.py | 29 +-
dts/framework/testbed_model/{hw => }/cpu.py | 209 ++++++---
dts/framework/testbed_model/hw/__init__.py | 27 --
dts/framework/testbed_model/hw/port.py | 60 ---
.../testbed_model/hw/virtual_device.py | 16 -
.../linux_session.py | 70 ++-
dts/framework/testbed_model/node.py | 214 ++++++---
dts/framework/testbed_model/os_session.py | 422 ++++++++++++++++++
dts/framework/testbed_model/port.py | 93 ++++
.../posix_session.py | 85 +++-
dts/framework/testbed_model/sut_node.py | 238 ++++++----
dts/framework/testbed_model/tg_node.py | 69 ++-
.../testbed_model/traffic_generator.py | 72 ---
.../traffic_generator/__init__.py | 43 ++
.../capturing_traffic_generator.py | 49 +-
.../{ => traffic_generator}/scapy.py | 110 +++--
.../traffic_generator/traffic_generator.py | 85 ++++
dts/framework/testbed_model/virtual_device.py | 29 ++
dts/framework/utils.py | 122 ++---
dts/main.py | 19 +-
dts/poetry.lock | 12 +-
dts/pyproject.toml | 6 +-
dts/tests/TestSuite_hello_world.py | 16 +-
dts/tests/TestSuite_os_udp.py | 20 +-
dts/tests/TestSuite_smoke_tests.py | 61 ++-
48 files changed, 3506 insertions(+), 1683 deletions(-)
create mode 100644 dts/framework/config/types.py
rename dts/framework/remote_session/{remote => }/interactive_remote_session.py (76%)
create mode 100644 dts/framework/remote_session/interactive_shell.py
delete mode 100644 dts/framework/remote_session/os_session.py
create mode 100644 dts/framework/remote_session/python_shell.py
delete mode 100644 dts/framework/remote_session/remote/__init__.py
delete mode 100644 dts/framework/remote_session/remote/interactive_shell.py
delete mode 100644 dts/framework/remote_session/remote/python_shell.py
delete mode 100644 dts/framework/remote_session/remote/remote_session.py
delete mode 100644 dts/framework/remote_session/remote/testpmd_shell.py
create mode 100644 dts/framework/remote_session/remote_session.py
rename dts/framework/remote_session/{remote => }/ssh_session.py (82%)
create mode 100644 dts/framework/remote_session/testpmd_shell.py
rename dts/framework/testbed_model/{hw => }/cpu.py (50%)
delete mode 100644 dts/framework/testbed_model/hw/__init__.py
delete mode 100644 dts/framework/testbed_model/hw/port.py
delete mode 100644 dts/framework/testbed_model/hw/virtual_device.py
rename dts/framework/{remote_session => testbed_model}/linux_session.py (77%)
create mode 100644 dts/framework/testbed_model/os_session.py
create mode 100644 dts/framework/testbed_model/port.py
rename dts/framework/{remote_session => testbed_model}/posix_session.py (73%)
delete mode 100644 dts/framework/testbed_model/traffic_generator.py
create mode 100644 dts/framework/testbed_model/traffic_generator/__init__.py
rename dts/framework/testbed_model/{ => traffic_generator}/capturing_traffic_generator.py (68%)
rename dts/framework/testbed_model/{ => traffic_generator}/scapy.py (71%)
create mode 100644 dts/framework/testbed_model/traffic_generator/traffic_generator.py
create mode 100644 dts/framework/testbed_model/virtual_device.py
--
2.34.1