Commit 5c6ca5b6 authored by Pawel Wodkowski's avatar Pawel Wodkowski Committed by Jim Harris
Browse files

jsonrpc: add Python with statement support 



The JSONRPCClient class now support the with statement. From now on the
__del__() method is changed to close() and user need to call it manually
at object disposal or use the 'with' Python statement.

Change-Id: I74afd93d411b9596ab8f9523c54a4a7523eec5e5
Signed-off-by: default avatarPawel Wodkowski <pawelx.wodkowski@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/444686


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarPawel Kaminski <pawelx.kaminski@intel.com>
parent a2825885

scripts/rpc.py

+8 −7
Original line number Diff line number Diff line
@@ -1737,8 +1737,9 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse 


    args = parser.parse_args()



    with rpc.client.JSONRPCClient(args.server_addr, args.port, args.timeout, log_level=getattr(logging, args.verbose.upper())) as client:

        try:

        args.client = rpc.client.JSONRPCClient(args.server_addr, args.port, args.timeout, log_level=getattr(logging, args.verbose.upper()))

            args.client = client

            args.func(args)

        except JSONRPCException as ex:

            print("Exception:")

scripts/rpc/client.py

+9 −1
Original line number Diff line number Diff line
@@ -48,6 +48,12 @@ class JSONRPCClient(object): 
            raise JSONRPCException("Error while connecting to %s\n"

                                   "Error details: %s" % (addr, ex))



    def __enter__(self):

        return self



    def __exit__(self, exception_type, exception_value, traceback):

        self.close()



    def get_logger(self):

        return self._logger
@@ -61,9 +67,11 @@ class JSONRPCClient(object): 
        self._logger.setLevel(lvl)

        self._logger.info("Log level set to %s", lvl)



    def __del__(self):

    def close(self):

        if getattr(self, "sock", None):

            self.sock.shutdown(socket.SHUT_RDWR)

            self.sock.close()

            self.sock = None



    def add_request(self, method, params):

        self._request_id += 1

scripts/spdkcli.py

+23 −21
Original line number Diff line number Diff line
@@ -6,6 +6,7 @@ from os import getuid 
from rpc.client import JSONRPCException

from configshell_fb import ConfigShell, shell, ExecutionError

from spdkcli import UIRoot

import rpc.client

from pyparsing import (alphanums, Optional, Suppress, Word, Regex,

                       removeQuotes, dblQuotedString, OneOrMore)
@@ -43,7 +44,8 @@ def main(): 
                        help="commands to execute by SPDKCli as one-line command")

    args = parser.parse_args()



    root_node = UIRoot(args.socket, spdk_shell)

    with rpc.client.JSONRPCClient(args.socket) as client:

        root_node = UIRoot(client, spdk_shell)

        root_node.verbose = args.verbose

        try:

            root_node.refresh()

scripts/spdkcli/ui_root.py

+4 −4
Original line number Diff line number Diff line
@@ -10,14 +10,14 @@ class UIRoot(UINode): 
    """

    Root node for CLI menu tree structure. Refreshes running config on startup.

    """

    def __init__(self, s, shell):

    def __init__(self, client, shell):

        UINode.__init__(self, "/", shell=shell)

        self.current_bdevs = []

        self.current_lvol_stores = []

        self.current_vhost_ctrls = []

        self.current_nvmf_transports = []

        self.current_nvmf_subsystems = []

        self.set_rpc_target(s)

        self.set_rpc_target(client)

        self.verbose = False

        self.is_init = self.check_init()

        self.methods = []
@@ -45,8 +45,8 @@ class UIRoot(UINode): 
        if self.has_subsystem("iscsi"):

            UIISCSI(self)



    def set_rpc_target(self, s):

        self.client = rpc.client.JSONRPCClient(s)

    def set_rpc_target(self, client):

        self.client = client



    def print_array(self, a):

        return " ".join(a)

test/json_config/clear_config.py

+7 −6
Original line number Diff line number Diff line
@@ -209,9 +209,10 @@ if __name__ == "__main__": 


    args = parser.parse_args()



    with rpc.client.JSONRPCClient(args.server_addr, args.port, args.timeout, log_level=getattr(logging, args.verbose.upper())) as client:

        try:

        args.client = rpc.client.JSONRPCClient(args.server_addr, args.port, args.timeout, log_level=getattr(logging, args.verbose.upper()))

            args.client = client

            args.func(args)

        except JSONRPCException as ex:

            print((ex.message))

            exit(1)
 
    args.func(args)