MODULE REFERENCE

platform

anomx.data.sources.platform

Dataset API semantics, kept separate from the generic HTTP transport.

PlatformDatasetClient

PlatformDatasetClient(client: PlatformClient, *, channels_path: str | None = None)

Adapt a generic PlatformClient to the data domain's DatasetClient contract.

Dataset resolution, versioned batches, channel loading, and response shapes belong here. The HTTP client only sends requests. Both unversioned /api and grouped /api/v1 routes are supported.

Signature parameters
Parameter	Type	Default
`client`	`PlatformClient`	`required`
`channels_path`keyword only	`str \| None`	`None`

Members

cache_namespaceproperty

# PlatformDatasetClient.cache_namespace Source ↗

cache_namespace: str

Partition cached data by server and authorization, without storing a token.

Returns str

describe_datasetmethod

# PlatformDatasetClient.describe_dataset Source ↗

describe_dataset(reference: str) -> dict[str, Any]

Resolve a dataset definition without loading its observations.

Signature parameters
Parameter	Type	Default
`reference`	`str`	`required`

Returns dict[str, Any]

describe_dataset_selectionmethod

# PlatformDatasetClient.describe_dataset_selection Source ↗

describe_dataset_selection(reference: str, *, selection: dict[str, Any]) -> dict[str, Any]

Resolve a server-filtered view and require explicit host support.

Older servers may ignore unknown query arguments. Never accept such a response as a filtered dataset: the capability and effective selection must be present before any observation request is sent.

Signature parameters
Parameter	Type	Default
`reference`	`str`	`required`
`selection`keyword only	`dict[str, Any]`	`required`

Returns dict[str, Any]

dataset_sourcesmethod

# PlatformDatasetClient.dataset_sources Source ↗

dataset_sources(reference: str, *, version: str, offset: int = 0, limit: int = 100) -> dict[str, Any]

Read one page of pinned source metadata, including named variables.

Signature parameters
Parameter	Type	Default
`reference`	`str`	`required`
`version`keyword only	`str`	`required`
`offset`keyword only	`int`	`0`
`limit`keyword only	`int`	`100`

Returns dict[str, Any]

read_datasetmethod

# PlatformDatasetClient.read_dataset Source ↗

read_dataset(reference: str, *, version: str, cursor: str | None = None, limit: int = 5000) -> dict[str, Any]

Read a bounded batch pinned to an explicitly resolved source version.

Signature parameters
Parameter	Type	Default
`reference`	`str`	`required`
`version`keyword only	`str`	`required`
`cursor`keyword only	`str \| None`	`None`
`limit`keyword only	`int`	`5000`

Returns dict[str, Any]

load_channelsmethod

# PlatformDatasetClient.load_channels Source ↗

load_channels(channels: Sequence[str], *, start: str | None = None, end: str | None = None, frequency: str | None = None) -> object

Load aligned channel records using the data domain's channel endpoint.

Signature parameters
Parameter	Type	Default
`channels`	`Sequence[str]`	`required`
`start`keyword only	`str \| None`	`None`
`end`keyword only	`str \| None`	`None`
`frequency`keyword only	`str \| None`	`None`

Returns object