statblk 1.44__tar.gz → 1.45__tar.gz

{statblk-1.44 → statblk-1.45}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: statblk
-Version: 1.44
+Version: 1.45
 Summary: Gather essential disk and partition info for block devices and print it in a nice table
 Home-page: https://github.com/yufei-pan/statblk
 Author: Yufei Pan
@@ -68,7 +68,7 @@ statblk 2                     # refresh every 2 seconds (watch mode)
 
 ## Output columns
 
-By default all columns are shown:
+By default every column that has data is shown (a column that is empty for every row, such as `LABEL` when nothing is labelled, is hidden from the table):
 
 | Column | Description |
 |--------|-------------|
@@ -86,7 +86,7 @@ By default all columns are shown:
 | `READ` | Current read throughput |
 | `WRITE` | Current write throughput |
 
-Use `-o` / `--output` to select columns (comma-separated) or `-x` / `--exclude` to omit columns.
+Use `-o` / `--output` to select columns (comma-separated) or `-x` / `--exclude` to omit columns. Columns named with `-o` are always shown, even when empty; `--show_empty_columns` keeps empty columns in the default view. JSON output (`-j` / `-J`) always includes every selected column.
 
 ## Options
 
@@ -99,8 +99,9 @@ Use `-o` / `--output` to select columns (comma-separated) or `-x` / `--exclude`
 | `-b`, `--bytes` | Print sizes and throughput as raw byte counts |
 | `-H`, `--si` | Use powers of 1000 (SI) instead of 1024 for sizes |
 | `-R`, `--full` | Do not truncate long values to terminal width |
-| `-o`, `--output` | Columns to include (default: all) |
+| `-o`, `--output` | Columns to include (default: all with data) |
 | `-x`, `--exclude` | Columns to omit |
+| `--show_empty_columns` | Keep columns that are empty for every row in the table |
 
 ### Filtering
 
@@ -152,7 +153,7 @@ statblk -w 0 nvme0 # same via flag
 
 Uses sysfs, `/proc/self/mountinfo`, `lsblk`, and optionally `smartctl`.
 
-- **SMART** requires `smartctl` (smartmontools). Use `--sudo` if permission is denied. It only runs against hardware-backed disks (not loop, dm, md, zram, nbd). Use `--debug` to see why the column is empty.
+- **SMART** requires `smartctl` (smartmontools). Use `--sudo` if permission is denied. It only runs against hardware-backed disks (not loop, dm, md, zram, nbd). The column is hidden when no disk reports SMART; use `-o` or `--show_empty_columns` to show it and `--debug` to see why it is empty.
 - **autofs** trigger mounts are ignored (stat-ing them would trigger the automount); the real filesystem appears once mounted.
 - **READ / WRITE** throughput comes from `/sys/class/block/*/stat` (always 512-byte sector units).
 - On a single-shot run (and the first row of watch mode), READ/WRITE are a lifetime busy-time average (bytes / time spent in I/O since boot). In watch mode, later refreshes are interval rates over the sleep period (Δbytes / wall clock).

{statblk-1.44 → statblk-1.45}/README.md

@@ -39,7 +39,7 @@ statblk 2                     # refresh every 2 seconds (watch mode)
 
 ## Output columns
 
-By default all columns are shown:
+By default every column that has data is shown (a column that is empty for every row, such as `LABEL` when nothing is labelled, is hidden from the table):
 
 | Column | Description |
 |--------|-------------|
@@ -57,7 +57,7 @@ By default all columns are shown:
 | `READ` | Current read throughput |
 | `WRITE` | Current write throughput |
 
-Use `-o` / `--output` to select columns (comma-separated) or `-x` / `--exclude` to omit columns.
+Use `-o` / `--output` to select columns (comma-separated) or `-x` / `--exclude` to omit columns. Columns named with `-o` are always shown, even when empty; `--show_empty_columns` keeps empty columns in the default view. JSON output (`-j` / `-J`) always includes every selected column.
 
 ## Options
 
@@ -70,8 +70,9 @@ Use `-o` / `--output` to select columns (comma-separated) or `-x` / `--exclude`
 | `-b`, `--bytes` | Print sizes and throughput as raw byte counts |
 | `-H`, `--si` | Use powers of 1000 (SI) instead of 1024 for sizes |
 | `-R`, `--full` | Do not truncate long values to terminal width |
-| `-o`, `--output` | Columns to include (default: all) |
+| `-o`, `--output` | Columns to include (default: all with data) |
 | `-x`, `--exclude` | Columns to omit |
+| `--show_empty_columns` | Keep columns that are empty for every row in the table |
 
 ### Filtering
 
@@ -123,7 +124,7 @@ statblk -w 0 nvme0 # same via flag
 
 Uses sysfs, `/proc/self/mountinfo`, `lsblk`, and optionally `smartctl`.
 
-- **SMART** requires `smartctl` (smartmontools). Use `--sudo` if permission is denied. It only runs against hardware-backed disks (not loop, dm, md, zram, nbd). Use `--debug` to see why the column is empty.
+- **SMART** requires `smartctl` (smartmontools). Use `--sudo` if permission is denied. It only runs against hardware-backed disks (not loop, dm, md, zram, nbd). The column is hidden when no disk reports SMART; use `-o` or `--show_empty_columns` to show it and `--debug` to see why it is empty.
 - **autofs** trigger mounts are ignored (stat-ing them would trigger the automount); the real filesystem appears once mounted.
 - **READ / WRITE** throughput comes from `/sys/class/block/*/stat` (always 512-byte sector units).
 - On a single-shot run (and the first row of watch mode), READ/WRITE are a lifetime busy-time average (bytes / time spent in I/O since boot). In watch mode, later refreshes are interval rates over the sleep period (Δbytes / wall clock).

{statblk-1.44 → statblk-1.45}/statblk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: statblk
-Version: 1.44
+Version: 1.45
 Summary: Gather essential disk and partition info for block devices and print it in a nice table
 Home-page: https://github.com/yufei-pan/statblk
 Author: Yufei Pan
@@ -68,7 +68,7 @@ statblk 2                     # refresh every 2 seconds (watch mode)
 
 ## Output columns
 
-By default all columns are shown:
+By default every column that has data is shown (a column that is empty for every row, such as `LABEL` when nothing is labelled, is hidden from the table):
 
 | Column | Description |
 |--------|-------------|
@@ -86,7 +86,7 @@ By default all columns are shown:
 | `READ` | Current read throughput |
 | `WRITE` | Current write throughput |
 
-Use `-o` / `--output` to select columns (comma-separated) or `-x` / `--exclude` to omit columns.
+Use `-o` / `--output` to select columns (comma-separated) or `-x` / `--exclude` to omit columns. Columns named with `-o` are always shown, even when empty; `--show_empty_columns` keeps empty columns in the default view. JSON output (`-j` / `-J`) always includes every selected column.
 
 ## Options
 
@@ -99,8 +99,9 @@ Use `-o` / `--output` to select columns (comma-separated) or `-x` / `--exclude`
 | `-b`, `--bytes` | Print sizes and throughput as raw byte counts |
 | `-H`, `--si` | Use powers of 1000 (SI) instead of 1024 for sizes |
 | `-R`, `--full` | Do not truncate long values to terminal width |
-| `-o`, `--output` | Columns to include (default: all) |
+| `-o`, `--output` | Columns to include (default: all with data) |
 | `-x`, `--exclude` | Columns to omit |
+| `--show_empty_columns` | Keep columns that are empty for every row in the table |
 
 ### Filtering
 
@@ -152,7 +153,7 @@ statblk -w 0 nvme0 # same via flag
 
 Uses sysfs, `/proc/self/mountinfo`, `lsblk`, and optionally `smartctl`.
 
-- **SMART** requires `smartctl` (smartmontools). Use `--sudo` if permission is denied. It only runs against hardware-backed disks (not loop, dm, md, zram, nbd). Use `--debug` to see why the column is empty.
+- **SMART** requires `smartctl` (smartmontools). Use `--sudo` if permission is denied. It only runs against hardware-backed disks (not loop, dm, md, zram, nbd). The column is hidden when no disk reports SMART; use `-o` or `--show_empty_columns` to show it and `--debug` to see why it is empty.
 - **autofs** trigger mounts are ignored (stat-ing them would trigger the automount); the real filesystem appears once mounted.
 - **READ / WRITE** throughput comes from `/sys/class/block/*/stat` (always 512-byte sector units).
 - On a single-shot run (and the first row of watch mode), READ/WRITE are a lifetime busy-time average (bytes / time spent in I/O since boot). In watch mode, later refreshes are interval rates over the sleep period (Δbytes / wall clock).

{statblk-1.44 → statblk-1.45}/statblk.py

@@ -154,7 +154,7 @@ def clear_caches():
 	for fn in _CACHED_FUNCTIONS:
 		fn.cache_clear()
 
-version = '1.44'
+version = '1.45'
 VERSION = version
 __version__ = version
 COMMIT_DATE = '2026-10-10'
@@ -1014,6 +1014,21 @@ def printable(text):
 			escaped.append('\\U%08x' % code)
 	return ''.join(escaped)
 
+def drop_empty_columns(rows):
+	"""Remove columns whose value is empty in every data row (e.g. LABEL when
+	no filesystem is labelled, SMART without smartctl). A header-only table is
+	returned unchanged.
+
+	>>> drop_empty_columns([['NAME', 'LABEL', 'SMART'], ['sda1', '', 'OK'], ['sda2', '', '']])
+	[['NAME', 'SMART'], ['sda1', 'OK'], ['sda2', '']]
+	>>> drop_empty_columns([['NAME', 'LABEL']])
+	[['NAME', 'LABEL']]
+	"""
+	if len(rows) < 2:
+		return rows
+	keep = [i for i in range(len(rows[0])) if any(str(row[i]).strip() for row in rows[1:])]
+	return [[row[i] for i in keep] for row in rows]
+
 def rows_to_objects(rows):
 	"""Turn get_drives_info(print_bytes=True) rows into one dict per row, with
 	SIZE/READ/WRITE as integer bytes and FSUSE% as an integer percent (None
@@ -1056,6 +1071,7 @@ def main():
 						help="Repeat output every SECONDS (watch mode). Equivalent to a trailing integer positional.")
 	parser.add_argument('--sudo', help="Run commands as root with sudo. Needed for querying SMART info.", action="store_true")
 	parser.add_argument('--show_zero_size_devices', help="Show devices with zero size", action="store_true")
+	parser.add_argument('--show_empty_columns', help="Keep table columns that are empty for every row (hidden by default unless named in -o)", action="store_true")
 	parser.add_argument('-D','--match_devname_only', help="Change filter pattern to match just the device names instead of the full line", action="store_true")
 	parser.add_argument('-v','--invert_match', help="Invert the filter match", action="store_true")
 	parser.add_argument('--debug', help="Print suppressed exceptions to stderr for troubleshooting", action="store_true")
@@ -1100,6 +1116,10 @@ def main():
 				import json
 				print(json.dumps(results, indent=1),flush=True)
 			else:
+				# Hide all-empty columns only for the default column set: an explicit
+				# -o asked for them, and JSON keeps a stable schema for scripts.
+				if args.output == "all" and not args.show_empty_columns:
+					results = drop_empty_columns(results)
 				# JSON output is already escaped by json.dumps; the table is not.
 				safe_rows = [[printable(str(value)) for value in row] for row in results]
 				print(multiCMD.pretty_format_table(safe_rows,full=args.full),flush=True)

{statblk-1.44 → statblk-1.45}/tests/test_cli.py

@@ -206,3 +206,52 @@ def test_json_output_keeps_values_but_no_raw_control_characters(monkeypatch, cap
     out = capsys.readouterr().out
     assert "\x1b" not in out
     assert json.loads(out)[1] == HOSTILE_ROWS[1]
+
+
+SPARSE_ROWS = [
+    ["NAME", "SMART", "LABEL", "MOUNTPOINT"],
+    ["sda1", "OK", "", "/data"],
+    ["sda2", "OK", "", ""],
+]
+
+
+def _captured_table(monkeypatch, argv, rows=SPARSE_ROWS):
+    tables = []
+    _patch_main_basics(monkeypatch, lambda **k: [list(r) for r in rows])
+    monkeypatch.setattr(statblk.multiCMD, "pretty_format_table", lambda r, **k: tables.append(r) or "T")
+    monkeypatch.setattr(statblk.sys, "argv", argv)
+    statblk.main()
+    return tables[0]
+
+
+def test_table_hides_empty_columns_by_default(monkeypatch):
+    assert _captured_table(monkeypatch, ["statblk"]) == [
+        ["NAME", "SMART", "MOUNTPOINT"],
+        ["sda1", "OK", "/data"],
+        ["sda2", "OK", ""],
+    ]
+
+
+def test_table_hides_empty_columns_with_exclude(monkeypatch):
+    assert _captured_table(monkeypatch, ["statblk", "-x", "SMART"])[0] == ["NAME", "SMART", "MOUNTPOINT"]
+
+
+@pytest.mark.parametrize("argv", [
+    ["statblk", "--show_empty_columns"],
+    ["statblk", "-o", "NAME,SMART,LABEL,MOUNTPOINT"],  # explicitly asked for LABEL
+])
+def test_table_keeps_empty_columns_when_asked(monkeypatch, argv):
+    assert _captured_table(monkeypatch, argv) == SPARSE_ROWS
+
+
+def test_table_keeps_header_when_no_rows(monkeypatch):
+    assert _captured_table(monkeypatch, ["statblk"], rows=[SPARSE_ROWS[0]]) == [SPARSE_ROWS[0]]
+
+
+@pytest.mark.parametrize("flag", ["-j", "-J"])
+def test_json_keeps_empty_columns(monkeypatch, capsys, flag):
+    _patch_main_basics(monkeypatch, lambda **k: [list(r) for r in SPARSE_ROWS])
+    monkeypatch.setattr(statblk.sys, "argv", ["statblk", flag])
+    statblk.main()
+    data = json.loads(capsys.readouterr().out)
+    assert "LABEL" in data[0]  # header row for -j, first object's keys for -J