ds_provider_xledger_py_lib.serde.deserializer

File: deserializer.py Region: ds_provider_xledger_py_lib/serde

Description

Deserialize GraphQL responses into tabular dataframe outputs.

Classes

XledgerDeserializer

Parse GraphQL responses into dataframes using operation metadata.

Functions

_root_payload(→ Any)	Extract operation root payload under data[metadata.name].
_connection_payload(→ dict[str, Any])	Extract standardized connection payload for read operations.
_resolve_output_columns(→ list[str])	Resolve output columns from operation settings and metadata.

Module Contents

class ds_provider_xledger_py_lib.serde.deserializer.XledgerDeserializer

Bases: ds_resource_plugin_py_lib.common.serde.deserialize.base.DataDeserializer

Parse GraphQL responses into dataframes using operation metadata.

__call__(value: Any, **kwargs: Any) → pandas.DataFrame

Deserialize a GraphQL response body.

Parameters:

• value – GraphQL response body.

• **kwargs – Compatibility kwargs. Requires metadata and operation_settings.

Returns:

Parsed dataframe output.

get_next(value: Any, **kwargs: Any) → bool

Return hasNextPage from a read response payload.

Parameters:

• value – GraphQL response body.

• **kwargs – Compatibility kwargs. Requires metadata.

Returns:

True when there is a next page.

get_end_cursor(value: Any, **kwargs: Any) → str | None

Return last edge cursor from a read response payload.

Parameters:

• value – GraphQL response body.

• **kwargs – Compatibility kwargs. Requires metadata.

Returns:

Last cursor when available, otherwise None.

get_incremental_watermark(value: Any, *, metadata: ds_provider_xledger_py_lib.utils.introspection.MetaData) → Any

Return the highest incremental field value from a read response.

Uses metadata.incremental for the node field name and strategy (kind). When read metadata has no incremental section, returns None without inspecting the payload.

Parameters:

• value – GraphQL response body.

• metadata – Read operation metadata.

Returns:

The highest field value found in the current page, or None when incremental is not configured or the page has no comparable values.

Raises:

• IncrementalFieldMissingException – If rows are present but the incremental field is missing from every returned node.

• InvalidIncrementalWatermarkException – If watermark values are invalid for the configured strategy (via greatest_incremental_value).

• UnsupportedIncrementalKindException – If incremental kind is not supported (via greatest_incremental_value).

ds_provider_xledger_py_lib.serde.deserializer._root_payload(*, payload: dict[str, Any], metadata: ds_provider_xledger_py_lib.utils.introspection.MetaData) → Any

Extract operation root payload under data[metadata.name].

Parameters:

• payload – GraphQL response payload.

• metadata – Operation metadata carrying the root field name.

Returns:

Root payload object when present; otherwise None.

ds_provider_xledger_py_lib.serde.deserializer._connection_payload(*, payload: dict[str, Any], metadata: ds_provider_xledger_py_lib.utils.introspection.MetaData) → dict[str, Any]

Extract standardized connection payload for read operations.

Parameters:

• payload – GraphQL response payload.

• metadata – Read operation metadata.

Returns:

Connection object when found; otherwise an empty dictionary.

ds_provider_xledger_py_lib.serde.deserializer._resolve_output_columns(*, metadata: ds_provider_xledger_py_lib.utils.introspection.MetaData, operation_settings: Any) → list[str]

Resolve output columns from operation settings and metadata.

Parameters:

• metadata – Loaded operation metadata.

• operation_settings – Operation settings object.

Returns:

Ordered output columns to apply in dataframe construction.