Pattern Text Format¶

`graphqomb.ptn_format` module¶

Pattern text format (.ptn) module.

This module provides:

dump: Write a pattern to a .ptn file or string.
load: Read a pattern from a .ptn file or string.
dumps: Serialize a pattern to a .ptn format string.
loads: Deserialize a pattern from a .ptn format string.

graphqomb.ptn_format.dumps(pattern)[source]¶

Serialize a pattern to a .ptn format string.

Parameters:: pattern (Pattern) – The pattern to serialize.
Returns:: The .ptn format string.
Return type:: str

graphqomb.ptn_format.dump(pattern, file)[source]¶

Write a pattern to a .ptn file.

Parameters:

pattern (Pattern) – The pattern to write.
file (pathlib.Path | str) – The file path to write to.

graphqomb.ptn_format.loads(s)[source]¶

Deserialize a .ptn format string to a pattern.

Parameters:: s (str) – The .ptn format string.
Returns:: The loaded pattern.
Return type:: Pattern

See also

_Parser.parse: Internal parser that may raise ValueError for invalid input.

graphqomb.ptn_format.load(file)[source]¶

Read a pattern from a .ptn file.

Parameters:: file (pathlib.Path | str) – The file path to read from.
Returns:: The loaded pattern. See loads for details.
Return type:: Pattern