From: "Juraj Linkeš" <juraj.linkes@pantheon.tech>
To: Jeremy Spewock <jspewock@iol.unh.edu>
Cc: thomas@monjalon.net, Honnappa.Nagarahalli@arm.com,
probb@iol.unh.edu, paul.szczepanek@arm.com,
Luca.Vizzarro@arm.com, dev@dpdk.org
Subject: Re: [PATCH v1] dts: strip whitespaces from stdout and stderr
Date: Tue, 13 Feb 2024 12:06:44 +0100 [thread overview]
Message-ID: <CAOb5WZawdgmJzEHCoBq0hgikZs98u0tb8PH=g0XAfNPpJ-7xBg@mail.gmail.com> (raw)
In-Reply-To: <CAAA20UQ6PnVCapMDOyRE8D3u+OE+3bv87VZRxVHfELdjOqeyHA@mail.gmail.com>
On Mon, Feb 12, 2024 at 5:49 PM Jeremy Spewock <jspewock@iol.unh.edu> wrote:
>
> On Wed, Feb 7, 2024 at 7:16 AM Juraj Linkeš <juraj.linkes@pantheon.tech> wrote:
> >
> > There could be a newline at the end of stdout or stderr of a remotely
> > executed command. These cause issues when used later, such as when
> > joining paths from such commands - a newline in the middle of a path is
> > not valid.
> >
> > Fixes: ad80f550dbc5 ("dts: add SSH command verification")
> > Signed-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech>
> > ---
> > .../remote_session/remote_session.py | 24 +++++++++++++++----
> > 1 file changed, 20 insertions(+), 4 deletions(-)
> >
> > diff --git a/dts/framework/remote_session/remote_session.py b/dts/framework/remote_session/remote_session.py
> > index 2059f9a981..6bea1a2306 100644
> > --- a/dts/framework/remote_session/remote_session.py
> > +++ b/dts/framework/remote_session/remote_session.py
> > @@ -10,8 +10,8 @@
> > """
> >
> >
> > -import dataclasses
> > from abc import ABC, abstractmethod
> > +from dataclasses import InitVar, dataclass, field
> > from pathlib import PurePath
> >
> > from framework.config import NodeConfiguration
> > @@ -20,7 +20,7 @@
> > from framework.settings import SETTINGS
> >
> >
> > -@dataclasses.dataclass(slots=True, frozen=True)
> > +@dataclass(slots=True, frozen=True)
> > class CommandResult:
> > """The result of remote execution of a command.
> >
> > @@ -34,9 +34,25 @@ class CommandResult:
> >
> > name: str
> > command: str
> > - stdout: str
> > - stderr: str
> > + init_stdout: InitVar[str]
> > + init_stderr: InitVar[str]
> > return_code: int
> > + stdout: str = field(init=False)
> > + stderr: str = field(init=False)
> > +
> > + def __post_init__(self, init_stdout, init_stderr):
>
> Are the typehints skipped deliberately here because it's redundant? We
> might want to include them anyway just for better typehint coverage.
>
It's a method defined by the dataclasses module so I guess I didn't
feel the need to include the typehints because of that. No harm in
adding them though, I'll send a new version.
> > + """Strip the whitespaces from stdout and stderr.
> > +
> > + The generated __init__ method uses object.__setattr__() when the dataclass is frozen,
> > + so that's what we use here as well.
> > +
> > + In order to get access to dataclass fields in the __post_init__ method,
> > + we have to type them as InitVars. These InitVars are included in the __init__ method's
> > + signature, so we have to exclude the actual stdout and stderr fields
> > + from the __init__ method's signature, so that we have the proper number of arguments.
> > + """
> > + object.__setattr__(self, "stdout", init_stdout.strip())
> > + object.__setattr__(self, "stderr", init_stderr.strip())
> >
> > def __str__(self) -> str:
> > """Format the command outputs."""
> > --
> > 2.34.1
> >
prev parent reply other threads:[~2024-02-13 11:06 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-07 12:16 Juraj Linkeš
2024-02-12 16:49 ` Jeremy Spewock
2024-02-13 11:06 ` Juraj Linkeš [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAOb5WZawdgmJzEHCoBq0hgikZs98u0tb8PH=g0XAfNPpJ-7xBg@mail.gmail.com' \
--to=juraj.linkes@pantheon.tech \
--cc=Honnappa.Nagarahalli@arm.com \
--cc=Luca.Vizzarro@arm.com \
--cc=dev@dpdk.org \
--cc=jspewock@iol.unh.edu \
--cc=paul.szczepanek@arm.com \
--cc=probb@iol.unh.edu \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).