From patchwork Wed Jan 15 20:29:56 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Anna Schumaker X-Patchwork-Id: 13940902 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 6F7831D9A7D for ; Wed, 15 Jan 2025 20:30:02 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1736973002; cv=none; b=G06Y6u4CoY51Uq5+W6LCcQ0eFAaAkjRZWkCcEvBxJThCPLmxQK0YO7+WtqnU8YaKNdH92JfdMkDOh063wjmm753e/9LOVQMvYQvh2NQ69KESN+jXxFzvqLHLKDhKVsJjVIMRIJTZbk1wxBFuNL/WRb9Avzbe+x2ZC5zkFuGoqXg= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1736973002; c=relaxed/simple; bh=5OsjFvU0tnvh9ALhRSGUnAbO4RpCWKUTxxN5Y9WxHjg=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=I6b1IL8O/maz9U/0oj2k78jGuqUfTE7c2AqihCRihJ/WCeozYYJAHAx0Uxc6TLzuTWoJenY+pmbF9PZNpaJxBgFShjcdvO0dGPXpalv1t84m9LUn+DHfR5LJZm4EfADK1tFlV+IUfKomj/mNstJlitU4/0F21w9ElgwoKLzDHNU= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=We4iX5bu; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="We4iX5bu" Received: by smtp.kernel.org (Postfix) with ESMTPSA id EBC10C4CEE4; Wed, 15 Jan 2025 20:30:01 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1736973002; bh=5OsjFvU0tnvh9ALhRSGUnAbO4RpCWKUTxxN5Y9WxHjg=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=We4iX5buVTtGLRwx0u+c2EmMJ6yYIETHfNInWBnaDMUCPjXKaA5VxcSu6GL5aFKpF HQ/MI1pH/LhCZb7F8AHTlY78MTC+9l+TeZdMqhCFAjJ7KiRldQZ+jKF6gCyQSBljMt u+scQE/S3hD6Et3lcK9lh2C3nrlK+uQtwGebhbxVE7Sv0Eo8uv7bXePMAV6htRRTm5 4lBmYo9hbPKrhSNLZ3BZgmLvRE5qlnsHyOHEJVNN095IJEBv2Y9VUu4pNEg/LPB67e gx8NaD9HSbFltjs5MGzrUWkD9a6m6oHcStUsT3CbAKKFt4Gn1GMOdk2ffrUflxw2of 1y9Hmrdwi/cLQ== From: Anna Schumaker To: linux-nfs@vger.kernel.org, steved@redhat.com Cc: anna@kernel.org Subject: [PATCH nfs-utils v3 7/7] rpcctl: Add remaining missing docstrings Date: Wed, 15 Jan 2025 15:29:56 -0500 Message-ID: <20250115202957.113352-8-anna@kernel.org> X-Mailer: git-send-email 2.48.1 In-Reply-To: <20250115202957.113352-1-anna@kernel.org> References: <20250115202957.113352-1-anna@kernel.org> Precedence: bulk X-Mailing-List: linux-nfs@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 From: Anna Schumaker Signed-off-by: Anna Schumaker --- tools/rpcctl/rpcctl.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/tools/rpcctl/rpcctl.py b/tools/rpcctl/rpcctl.py index adeb26d51f0e..0221fbb68be1 100755 --- a/tools/rpcctl/rpcctl.py +++ b/tools/rpcctl/rpcctl.py @@ -1,4 +1,5 @@ #!/usr/bin/python3 +"""Utility for working with the sunrpc sysfs files.""" import argparse import collections import errno @@ -20,6 +21,7 @@ if not sunrpc.is_dir(): def read_addr_file(path): + """Read an xprt address file.""" try: with open(path, 'r') as f: return f.readline().strip() @@ -28,12 +30,14 @@ def read_addr_file(path): def write_addr_file(path, newaddr): + """Write a new address to an xprt address file.""" with open(path, 'w') as f: f.write(newaddr) return read_addr_file(path) def read_info_file(path): + """Read an xprt or xprt switch information file.""" res = collections.defaultdict(int) try: with open(path) as info: @@ -246,18 +250,24 @@ class XprtSwitch: class RpcClient: + """Represents an rpc client instance.""" + def __init__(self, path): + """Read in rpc client information from sysfs.""" self.path = path self.name = path.stem self.switch = XprtSwitch(path / (path / "switch").readlink(), sep=",") def __lt__(self, rhs): + """Compare the name of two rpc client instances.""" return self.name < rhs.name def __str__(self): + """Return a string representation of an rpc client.""" return f"{self.name}: {self.switch}" def add_command(subparser): + """Add parser options for the `rpcctl client` command.""" parser = subparser.add_parser("client", help="Commands for rpc clients") parser.set_defaults(func=RpcClient.show, client=None) @@ -269,12 +279,14 @@ class RpcClient: parser.set_defaults(func=RpcClient.show) def get_by_name(name): + """Find a (sorted) list of RpcClients matching the given name.""" rpc_clients = sunrpc / "rpc-clients" if name: return [RpcClient(rpc_clients / name)] return [RpcClient(f) for f in sorted(rpc_clients.iterdir())] def show(args): + """Handle the `rpcctl client show` command.""" for client in RpcClient.get_by_name(args.client): print(client) @@ -283,6 +295,7 @@ parser = argparse.ArgumentParser() def show_small_help(args): + """Show a one-line usage summary if no subcommand is given.""" parser.print_usage() print("sunrpc dir:", sunrpc)