pycsamt.jones.base

Minimal bases for the Jones (J-format) subsystem.

Classes

BaseJones(*[, verbose])	Root base for all Jones objects.
JComponentBase(*[, verbose])	Common base for concrete components.

class pycsamt.jones.base.BaseJones(*, verbose=0)

Bases: object

Root base for all Jones objects.

Provides a common interface and light I/O hooks. Subclasses must implement from_lines, read and write.

Parameters:

verbose (int | bool)

classmethod from_file(obj, *, encoding='utf-8', verbose=0, **kws)

Parameters:

• obj (TextIOBase | str | Path)

• encoding (str)

• verbose (int | bool)

• kws (Any)

Return type:

BaseJones

classmethod from_lines(lines, *, verbose=0, **kws)

Parameters:

• lines (Iterable[str])

• verbose (int | bool)

• kws (Any)

Return type:

BaseJones

read(*args, **kws)

Parameters:

• args (Any)

• kws (Any)

Return type:

BaseJones

write(obj, *, encoding=None, **kws)

Parameters:

• obj (TextIOBase | str | Path)

• encoding (str | None)

• kws (Any)

Return type:

None

require_read(*, attributes=None, msg=None)

Parameters:

• attributes (str | list[str] | None)

• msg (str | None)

Return type:

None

to_dict()

Return type:

dict[str, Any]

summary()

Return type:

str

class pycsamt.jones.base.JComponentBase(*, verbose=0)

Bases: BaseJones

Common base for concrete components.

All components must accept verbose in __init__ and must implement from_file, from_lines, read and write.

Parameters:

verbose (int | bool)