On Thu, Aug 31, 2023 at 6:04 AM Juraj Linkeš wrote: > WIP: only one module is reformatted to serve as a demonstration. > > The google format is documented here [0]. > > [0]: https://google.github.io/styleguide/pyguide.html > > Signed-off-by: Juraj Linkeš > --- > dts/framework/testbed_model/node.py | 171 +++++++++++++++++++--------- > 1 file changed, 118 insertions(+), 53 deletions(-) > > diff --git a/dts/framework/testbed_model/node.py > b/dts/framework/testbed_model/node.py > index 23efa79c50..619743ebe7 100644 > --- a/dts/framework/testbed_model/node.py > +++ b/dts/framework/testbed_model/node.py > @@ -3,8 +3,13 @@ > # Copyright(c) 2022-2023 PANTHEON.tech s.r.o. > # Copyright(c) 2022-2023 University of New Hampshire > > -""" > -A node is a generic host that DTS connects to and manages. > +"""Common functionality for node management. > + > +There's a base class, Node, that's supposed to be extended by other > classes > +with functionality specific to that node type. > +The only part that can be used standalone is the Node.skip_setup static > method, > +which is a decorator used to skip method execution if skip_setup is passed > +by the user on the cmdline or in an env variable. > """ > > from abc import ABC > @@ -35,10 +40,26 @@ > > > class Node(ABC): > - """ > - Basic class for node management. This class implements methods that > - manage a node, such as information gathering (of CPU/PCI/NIC) and > - environment setup. > + """The base class for node management. > + > + It shouldn't be instantiated, but rather extended. > + It implements common methods to manage any node: > + > + * connection to the node > + * information gathering of CPU > + * hugepages setup > + > + Arguments: > My only comment would be we might want to make this Args instead of arguments just to line up with the rest of the comments, but like you said this is just a proof of concept really. Acked-by: Jeremy Spweock