pycsamt.api.view.result

General result container for public pyCSAMT APIs.

Functions

wrap_result(result, *[, name, kind, meta, ...])

Wrap a mapping of result parts as an APIResult.

Classes

APIResult(**items)

Container for named result parts, including one or more tables.

class pycsamt.api.view.result.APIResult(**items)

Bases: PyCSAMTObject

Container for named result parts, including one or more tables.

Parameters:

items (Any)

property keys: tuple[str, ...]

Return stored item names.

items()

Return (name, value) pairs.

tables()

Return only table-like result parts.

Return type:

dict[str, APIFrame]

update_meta(**kwargs)

Update metadata in-place and return self.

Parameters:

kwargs (Any)

Return type:

APIResult

pycsamt.api.view.result.wrap_result(result, *, name='result', kind=None, meta=None, wrap_tables=True)

Wrap a mapping of result parts as an APIResult.

Parameters:

• result (Mapping[str, Any])

• name (str)

• kind (str | None)

• meta (Mapping[str, Any] | None)

• wrap_tables (bool)

Return type:

APIResult