Welcome to pyzfile’s documentation!

Contents:

Prerequisites

IBM Python SDK for z/OS v3.10

Installation

Install from PyPi:

pip install pyzfile

Building from source

To build from source you must have Python 3.10 and the IBM xlclang++ compiler installed.:

git clone git@github.com:daveyc/pyzfile.git
cd pyzfile
git submodule update --init
pip install .

If you do not have access to the internet from you z/OS system use the following instructions to install the package.

  • From the repository in the Github UI enter the dist directory and click on the pyzfile *.whl file. A download button with appear.

  • Click the button to download the file to your PC

  • Use FTP to upload the file in binary mode to your z/OS system UNIX file system

  • From a UNIX shell use pip to install the package using the wheel file, for example:

    pip install pyzfile-1.0.0.post2-py3-none-any.whl

Building the doc

The documentation is built using Sphinx. See the instructions on how to Install Sphinx for your OS.:

# download the 'Press' theme
pip install sphinx-press-theme

# build the doc
cd doc
make html

Examples

The Python SDK for z/OS uses enhanced ASCII so conversions to/from EBCDIC code pages are required to process text files or string fields from binary files in the UTF-8 codeset.

Read a text file using BSAM

MVS text files will almost certainly be encoding in EBCDIC. Specify the encoding parameter to decode the EBCDIC file to UTF-8.

from pyzfile import *
try:
    with ZFile("//'USERID.CNTL(JCL)'", "rb,type=record",encoding='cp1047') as file:
        for rec in file:
            print(rec)
except ZFileError as e:
    print(e)

Write to a text file using QSAM

from pyzfile import *
recs = ['record number one', 'record number two', 'record number three']
try:
    with ZFile("//'USERID.CNTL(JCL)'", "wb,type=record,noseek", encoding='cp1047') as file:
        for rec in recs:
            file.write(rec)
except ZFileError as e:
    print(e)

Read a binary file using QSAM

from pyzfile import *
try:
    with ZFile("//'SYSTEM.DAILY.SMF'", "rb,type=record,noseek") as file:
        for rec in file:
            pass
except ZFileError as e:
    print(e)

Parse a YAML text file from a PDS member

Note

This example uses a third party package for parsing YAML which can be installed using pip install ruamel.yaml.

from pyzfile import *
from ruamel.yaml import YAML

yaml = YAML()

try:
    with ZFile("//CNTL(YAML)", "rt", encoding='cp1047') as file:
        print(yaml.load(file.reads()))
except ZFileError as e:
    print(e)

Indices and tables