pyx12.validation

X12 data element validation

Attributes

REGEX_MODE

rec_N

rec_R

rec_ID_E

rec_ID_E5

rec_ID_B

rec_DT

rec_TM

Functions

IsValidDataType(str_val, data_type[, charset, icvn])

Is str_val a valid X12 data value

match_re(short_data_type, val)

not_match_re(short_data_type, val[, charset, icvn])

is_valid_date(data_type, val)

is_valid_time(val)

contains_control_character(str_val[, charset, icvn])

Module Contents

pyx12.validation.REGEX_MODE = 272[source]
pyx12.validation.IsValidDataType(str_val, data_type, charset='B', icvn='00401')[source]

Is str_val a valid X12 data value

Parameters:

  • str_val (string) – data value to validate

  • data_type (string) – X12 data element identifier

  • charset (string) – [optional] - ‘B’ for Basic X12 character set, ‘E’ for extended

  • icvn (str)

Return type:

boolean

TODO: need to generalize control character validation

pyx12.validation.rec_N: re.Pattern[str][source]
pyx12.validation.rec_R: re.Pattern[str][source]
pyx12.validation.rec_ID_E: re.Pattern[str][source]
pyx12.validation.rec_ID_E5: re.Pattern[str][source]
pyx12.validation.rec_ID_B: re.Pattern[str][source]
pyx12.validation.rec_DT: re.Pattern[str][source]
pyx12.validation.rec_TM: re.Pattern[str][source]
pyx12.validation.match_re(short_data_type, val)[source]
Parameters:

  • short_data_type (string) – simplified data type

  • val (string) – data value to be verified

Returns:

True if matched, False if not

Return type:

boolean

Raises:

EngineError – If short_data_type is not ‘N’ or ‘R’

pyx12.validation.not_match_re(short_data_type, val, charset='B', icvn='00401')[source]
Parameters:

  • short_data_type (string) – simplified data type

  • val (string) – data value to be verified

  • charset (string) – [optional] - ‘B’ for Basic X12 character set, ‘E’ for extended, E5 for 5010 Extended

  • icvn (str)

Returns:

True if found invalid characters, False if none

Return type:

boolean

Raises:

EngineError – If short_data_type or charset is unrecognized

pyx12.validation.is_valid_date(data_type, val)[source]
Parameters:

  • data_type (string) – Date type

  • val (string) – data value to be verified

Returns:

True if valid, False if not

Return type:

boolean

pyx12.validation.is_valid_time(val)[source]
Parameters:

val (string) – time value to be verified

Return type:

boolean

pyx12.validation.contains_control_character(str_val, charset='B', icvn='00401')[source]
Parameters:
Return type:

tuple[bool, str | None]