pyx12.x12file

Interface to an X12 data stream.

• Efficiently handles large files.

• Tracks end of explicit loops.

• Tracks segment/line/loop counts.

• Tracks some transaction specific counters: 837 2400/LX 837 HL tree

Attributes

X12file

Classes

X12Base	Base class of X12 Reader and X12 Writer
X12Reader	Read an X12 data file
X12Writer	X12 file and stream writer

Module Contents

class pyx12.x12file.X12Base

Base class of X12 Reader and X12 Writer Common X12 validation

Initialize the X12 file

err_list: list[_ErrTuple]

loops: list[_LoopTuple]

hl_stack: list[int]

gs_count: int

st_count: int

hl_count: int

seg_count: int

cur_line: int

isa_ids: list[str | None]

gs_ids: list[str | None]

st_ids: list[str | None]

lx_count: int

check_837_lx: bool

isa_usage: str | None

seg_term: str | None

ele_term: str | None

subele_term: str | None

repetition_term: str | None

Close()

Complete any outstanding tasks

Return type:

None

pop_errors()

Pop error list :return: List of errors

Return type:

list[_ErrTuple]

get_isa_id()

Get the current ISA identifier

Return type:

string

get_gs_id()

Get the current GS identifier

Return type:

string

get_st_id()

Get the current ST identifier

Return type:

string

get_ls_id()

Get the current LS identifier

Return type:

string

get_seg_count()

Get the current segment count

Return type:

int

get_cur_line()

Get the current line

Return type:

int

get_term()

Get the original terminators

Return type:

tuple(string, string, string, string)

class pyx12.x12file.X12Reader(src_file_obj)

Bases: X12Base

Read an X12 data file

Errors found when reading the segment such as loop counting or ID errors can be retrieved using the pop_errors function

Initialize the file X12 file reader

Parameters:

src_file_obj (string or open file object) – absolute path of source file or an open, readable file object

fd_in: TextIO

need_to_close: bool

raw: pyx12.rawx12file.RawX12File

icvn: str

seg_term

ele_term

subele_term

repetition_term

close()

Close the underlying file if X12Reader opened it itself. Idempotent.

Return type:

None

cleanup()

At EOF, check for missing loop trailers

Return type:

None

pyx12.x12file.X12file

class pyx12.x12file.X12Writer(src_file_obj, seg_term='~', ele_term='*', subele_term='\\', eol='\n', repetition_term='^')

Bases: X12Base

X12 file and stream writer

Initialize the file X12 file writer

Parameters:

• src_file_obj (string or open file object) – absolute path of source file or an open, readable file object

• seg_term (str)

• ele_term (str)

• subele_term (str)

• eol (str)

• repetition_term (str)

fd_out: TextIO

need_to_close: bool

eol: str

seg_term = '~'

ele_term = '*'

subele_term = '\\'

repetition_term = '^'

close()

Flush trailing loops and close the underlying file if X12Writer opened it itself. Idempotent.

Return type:

None

Close()

Backwards-compatible alias for close().

Return type:

None

Write(seg_data)

Write the segment to the stream given current separators

Parameters:

seg_data (L{segment<segment.Segment>}) – Segment data instance

Return type:

None