Open and extract (unload) XMI/AWS/HET mainframe files.
You can install the xmi library from PyPI using:
python3 -m pip install xmi-reader
The most simple way to use this library is to import this module and use
xmi.open_file() to open an XMI, AWS, or HET file::
import xmi
xmi_obj = xmi.open_file("/path/to/file.xmi")
het_obj = xmi.open_file("/path/to/file.het")
aws_obj = xmi.open_file("/path/to/file.aws")To list all datasets and dataset members::
for f in het_obj.get_files():
if het_obj.is_pds(f):
for m in het_obj.get_members(f):
print("{}({})".format(f, m))
else:
print(f)Print JSON metatdata::
print(xmi_obj.get_json())
print(het_obj.get_json(text=True)) # Adds plaintext files to json output
print(aws_obj.get_json(indent=6)) # Increases the json indentSilently extract all files/folders to /tmp/xmi_files/::
aws_obj.set_output_folder("/tmp/xmi_files/")
aws_obj.set_quiet(True)
aws_obj.extract_all()Print detailed file information::
xmi_obj.print_details()
xmi_obj.print_xmit() # Same output as previous, print_xmit() is an alias to print_details()
het_obj.print_tape() # print_tape() is an alias to print_details()
aws_obj.print_tape(human=True) # Converts size to human readablePrint message:
if xmi_obj.has_message():
print(xmi_obj.get_message())
# or just
print(xmi_obj.get_message()) # Prints 'None' if no messageIf you you're having problems with the library or want to see whats happening behind the scenes you can enable debugging:
import logging
import xmi
xmi_obj = xmi.XMIT(filename="/path/to/file.xmi",loglevel=logging.DEBUG)
xmi_obj.open()After pip install xmi-reader two commands are available in your PATH.
extractxmi — open, list and extract XMI / AWS / HET files:
extractxmi -l FILE.XMI # list contents
extractxmi FILE.XMI # extract everything
extractxmi FILE.XMI "MY.PDS(MEMBER)" # extract one member
extractxmi -pH FILE.XMI # print detailed metadata
extractxmi FILE.XMI --outputdir /tmp/out/ # extract to a folder
extractxmi --help # full option listcreatexmi — create an XMI file from a local file or folder:
createxmi myfolder/ # folder → PDS XMI
createxmi myfolder/ -o MY.XMI --dsn MY.PDS # set output & DSN
createxmi myfolder/ -o MY.XMI --from-user IBMUSER # set ISPF owner
createxmi myfile.jcl -o SEQ.XMI --dsn MY.SEQ # file → sequential XMI
createxmi xmi_folder/ -o MULTI.XMI --dsn MULTI.PDS # XMI-in-XMI container
createxmi --help # full option list