CLI that shows the contents of a TRX

[arokem]

I.e. a call on my_file.trx would list what groups and what dpg/dps are stored in the file.

Could be a variation on https://stackoverflow.com/a/57922972/3532933

[mattcieslak]

Users will most likely want to know what's in a trx file before opening a python session, unzipping the trx or looking up how to list zip file contents. I was thinking it could be nice to have a command line tool that prints the contents of a trx file

[neurolabusc]

@arokem - as your link notes, since TRX is just a zip file, you can use several command line tools (unzip, zipinfo, bsdtar, als, python):

$ unzip -l dpsvZip64.trx 
Archive:  dpsvZip64.trx
  Length      Date    Time    Name
---------  ---------- -----   ----
        0  04-12-2022 08:45   dps/
     1840  04-08-2022 08:47   dps/DataSetID.float32
        0  04-12-2022 08:45   dpv/
   383460  04-12-2022 08:44   dpv/z.float32
      195  04-08-2022 08:47   header.json
     3680  04-08-2022 08:47   offsets.uint64
   575190  04-08-2022 08:47   positions.3.float16
---------                     -------
   964365                     7 files

$ zipinfo dpsvZip64.trx 
Archive:  dpsvZip64.trx
Zip file size: 626024 bytes, number of entries: 7
drwxr-xr-x  4.5 unx        0 bx stor 22-Apr-12 08:45 dps/
-rw-r--r--  4.5 unx     1840 bx defN 22-Apr-08 08:47 dps/DataSetID.float32
drwxr-xr-x  4.5 unx        0 bx stor 22-Apr-12 08:45 dpv/
-rw-r--r--  4.5 unx   383460 bx defN 22-Apr-12 08:44 dpv/z.float32
-rw-r--r--  4.5 unx      195 bx defN 22-Apr-08 08:47 header.json
-rw-r--r--  4.5 unx     3680 bx defN 22-Apr-08 08:47 offsets.uint64
-rw-r--r--  4.5 unx   575190 bx defN 22-Apr-08 08:47 positions.3.float16
7 files, 964365 bytes uncompressed, 624926 bytes compressed:  35.2%

$ bsdtar -tf dpsvZip64.trx 
dps/
dps/DataSetID.float32
dpv/
dpv/z.float32
header.json
offsets.uint64
positions.3.float16

$ als dpsvZip64.trx
als: dpsvZip64.trx: format not known, identifying using file
als: dpsvZip64.trx: format is `zip'
Archive:  dpsvZip64.trx
  Length      Date    Time    Name
---------  ---------- -----   ----
        0  04-12-2022 08:45   dps/
     1840  04-08-2022 08:47   dps/DataSetID.float32
        0  04-12-2022 08:45   dpv/
   383460  04-12-2022 08:44   dpv/z.float32
      195  04-08-2022 08:47   header.json
     3680  04-08-2022 08:47   offsets.uint64
   575190  04-08-2022 08:47   positions.3.float16
---------                     -------
   964365                     7 files

$ python list_zip.py dpsvZip64.trx 
dps/
dps/DataSetID.float32
dpv/
dpv/z.float32
header.json
offsets.uint64
positions.3.float16

A simple Python script would be:

import zipfile
import sys

def list_zip_contents(zip_path):
    try:
        with zipfile.ZipFile(zip_path, 'r') as zf:
            for name in zf.namelist():
                print(name)
    except zipfile.BadZipFile:
        print(f"Error: {zip_path} is not a valid ZIP file.")

if __name__ == "__main__":
    if len(sys.argv) < 2:
        print("Usage: python list_zip.py <zip_file>")
        sys.exit(1)

    list_zip_contents(sys.argv[1])