From da764bde486949506a07356d987d9ad3f12904ac Mon Sep 17 00:00:00 2001
From: Henning Glawe <glaweh@debian.org>
Date: Sun, 16 Mar 2025 11:12:50 +0100
Subject: [PATCH] introduce df_mountpoint()
---
src/mpsd_hpc_tools/quota.py | 65 ++++++++++---------------------------
1 file changed, 18 insertions(+), 47 deletions(-)
diff --git a/src/mpsd_hpc_tools/quota.py b/src/mpsd_hpc_tools/quota.py
index c561b9b..0b1d812 100644
--- a/src/mpsd_hpc_tools/quota.py
+++ b/src/mpsd_hpc_tools/quota.py
@@ -64,55 +64,27 @@ def df_ceph(path_obj: pathlib.Path) -> Tuple[int, int, int]:
return size, used, avail
-def get_df_output(path: str, output: str) -> int:
- """Return output of 'df --output=OUTPUT PATH' command.
-
- Parameters
- ----------
- path : str
- path to pass to df command, for example '/home/fangohr'
- output : str
- output understood by df, for example 'used' or 'available'
-
- Returns
- -------
- value : int
- value returned by df command (only integers support)
- """
-
- cmd = f"df --output={output} --block-size=KB {path}"
- stdout = subprocess.check_output(cmd.split()).decode()
- # Example call of df:
+def df_mountpoint(path_obj: pathlib.Path) -> Tuple[int, int, int]:
"""
- $ df --block-size=kB --output=used /home/fangohr
- Used
- 4552917kB
- """
- # get rid of "Used" header by looking at the second line
- data = stdout.split()[1]
- # get rid of "kB" by stripping of "kB" from the right
- assert "kB" in data # sanity check in case df changes its behaviour
- numberstring = int(data.rstrip("kB"))
- number = int(numberstring) * 1000 # kB == 1000
- return number
-
-
-def home_bytes_used_quota(path: str) -> Tuple[int, int]:
- """
- Return number of bytes used and available in /home .
+ Given a path (such as '/home/fangohr') return the number of bytes
+ (size, used, available).
- Given a path (such as '/home/fangohr') return the number of bytes used
- and number of bytes available based on output of 'df /home/fangohr'.
+ Assumes that path_obj is a distinct mountpoint.
Example:
- >>> home_bytes_used_quota("/home/fangohr")
- (4552917000, 102821266000)
-
+ >>> df("/home/fangohr")
+ (25000000000000, 1780686359, 24998219313641)
"""
- used = get_df_output(path, "used")
- avail = get_df_output(path, "avail")
- return used, avail
+ path = str(path_obj)
+ cmd = ["df", "--block-size=1", path]
+ df_run = subprocess.run(cmd, check=True, stdout=subprocess.PIPE, text=True)
+ for line in df_run.stdout.splitlines():
+ l = line.split()
+ if (l[0] == "Filesystem"):
+ continue
+ (size, used, avail) = [int(li) for li in l[1:4]]
+ return size, used, avail
def compose_quota_report(homedir=None, scratchdir=None, bytes=False) -> str:
@@ -150,8 +122,8 @@ def compose_quota_report(homedir=None, scratchdir=None, bytes=False) -> str:
if homedir:
# convert homedir into pathlib object
homedir = pathlib.Path(homedir)
- used_bytes, avail_bytes = home_bytes_used_quota(str(homedir))
- rel = used_bytes / (avail_bytes + used_bytes) * 100 # relative usage in percent
+ (size_bytes, used_bytes, avail_bytes) = df_mountpoint(homedir)
+ rel = 100.0 * used_bytes / size_bytes # relative usage in percent
if bytes:
used, avail = map(str, [used_bytes, avail_bytes])
else:
@@ -160,13 +132,12 @@ def compose_quota_report(homedir=None, scratchdir=None, bytes=False) -> str:
if scratchdir:
scratchdir = pathlib.Path(scratchdir)
- size_bytes, used_bytes, avail_bytes = df_ceph(scratchdir)
+ (size_bytes, used_bytes, avail_bytes) = df_ceph(scratchdir)
rel = 100.0 * used_bytes / size_bytes # relative usage in percent
if bytes:
used, avail = map(str, [used_bytes, avail_bytes])
else:
used, avail = map(humanise_size, [used_bytes, avail_bytes])
-
out += "\n" + format_string.format(str(scratchdir), used, avail, rel)
return out
--
GitLab