API index
Fricon client library.
Classes:
| Name | Description |
|---|---|
Column |
Stored column metadata for dataset creation. |
Dataset |
A dataset. |
DatasetManager |
Manager of datasets in workspace. |
DatasetWriter |
Writer for newly created dataset. |
FriconDatasetError |
|
IndexAxis |
Unknown-length integer scan axis for dataset creation. |
Trace |
1-D list of values with optional x-axis values. |
Workspace |
A client of fricon workspace server. |
Column
Stored column metadata for dataset creation.
Attributes:
| Name | Type | Description |
|---|---|---|
chart_axis |
bool
|
|
dtype |
_DeclaredColumnDType | None
|
|
hidden_by_default |
bool
|
|
label |
str | None
|
|
unit |
str | None
|
|
chart_axis
property
dtype
property
hidden_by_default
property
label
property
unit
property
Dataset
A dataset.
Datasets can be created and opened using the
DatasetManager.
Methods:
| Name | Description |
|---|---|
to_arrow |
Load the dataset as an Arrow Table. |
to_polars |
Load the dataset as a polars LazyFrame. |
Attributes:
| Name | Type | Description |
|---|---|---|
created_at |
datetime
|
Creation date of the dataset. |
deleted_at |
datetime | None
|
Permanent deletion timestamp of the dataset payload, if any. |
description |
str
|
Description of the dataset. |
favorite |
bool
|
Favorite status of the dataset. |
id |
int
|
ID of the dataset. |
is_deleted |
bool
|
Whether the dataset payload has been permanently deleted. |
name |
str
|
Name of the dataset. |
path |
str
|
Path of the dataset. |
status |
Literal['writing', 'completed', 'aborted']
|
Status of the dataset. |
tags |
list[str]
|
Tags of the dataset. |
uid |
str
|
UID of the dataset. |
created_at
property
Creation date of the dataset.
deleted_at
property
Permanent deletion timestamp of the dataset payload, if any.
description
property
Description of the dataset.
favorite
property
Favorite status of the dataset.
id
property
ID of the dataset.
is_deleted
property
Whether the dataset payload has been permanently deleted.
name
property
Name of the dataset.
path
property
Path of the dataset.
status
property
Status of the dataset.
tags
property
Tags of the dataset.
uid
property
UID of the dataset.
to_arrow()
method descriptor
to_polars()
method descriptor
Load the dataset as a polars LazyFrame.
Returns:
| Type | Description |
|---|---|
LazyFrame
|
A polars LazyFrame. |
DatasetManager
Manager of datasets in workspace.
Methods:
| Name | Description |
|---|---|
create |
Create a new dataset. |
list_all |
List datasets in the workspace. |
open |
Open a dataset by id. |
create(name, *, description=None, tags=None, columns=None, scan=None)
method descriptor
Create a new dataset.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
Name of the dataset. |
required |
description
|
str | None
|
Description of the dataset. |
None
|
tags
|
Iterable[str] | None
|
Tags of the dataset. Duplicate tags will be added only once. |
None
|
columns
|
Mapping[str, _ColumnSpec] | None
|
Optional stored column declarations and metadata. |
None
|
Returns:
| Type | Description |
|---|---|
DatasetWriter
|
A writer of the newly created dataset. |
list_all(*, limit=None, offset=None)
method descriptor
open(dataset_id)
method descriptor
Open a dataset by id.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dataset_id
|
str | int
|
An integer |
required |
Returns:
| Type | Description |
|---|---|
Dataset
|
The requested dataset. |
Raises:
| Type | Description |
|---|---|
FriconDatasetError
|
Dataset not found or otherwise unavailable. |
DatasetWriter
Writer for newly created dataset.
Writers are constructed by calling
DatasetManager.create.
Methods:
| Name | Description |
|---|---|
abort |
Abort writing to dataset and return dataset metadata. |
close |
Finish writing to dataset. |
finish |
Finish writing to dataset and return dataset metadata. |
write |
Write a row of values to the dataset. |
write_dict |
Write a row of values to the dataset. |
Attributes:
| Name | Type | Description |
|---|---|---|
dataset |
Dataset
|
ID of the dataset. |
dataset
property
abort()
method descriptor
Abort writing to dataset and return dataset metadata.
close()
method descriptor
Finish writing to dataset.
finish()
method descriptor
Finish writing to dataset and return dataset metadata.
write(**kwargs)
method descriptor
Write a row of values to the dataset.
Rows are buffered client-side and flushed automatically every 200 ms or once 16 rows have accumulated.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
kwargs
|
_ColumnType
|
Names and values in the row. |
required |
write_dict(values, *, logical_indices=None)
method descriptor
FriconDatasetError
Bases: builtins.Exception
IndexAxis
Trace
1-D list of values with optional x-axis values.
Methods:
| Name | Description |
|---|---|
fixed_step |
Create a new trace with fixed x steps. |
variable_step |
Create a new trace with variable x steps. |
fixed_step(x0, step, y)
staticmethod
Create a new trace with fixed x steps.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x0
|
float
|
Starting x-axis value. |
required |
step
|
float
|
Step size of x-axis values. |
required |
y
|
Sequence[_ScalarT_co] | _ArrowAnyArray | _NumpyAnyArray
|
List of y-axis values. |
required |
Returns:
| Type | Description |
|---|---|
Trace
|
A fixed-step trace. |
variable_step(x, y)
staticmethod
Workspace
A client of fricon workspace server.
Methods:
| Name | Description |
|---|---|
connect |
Connect to a fricon server. |
Attributes:
| Name | Type | Description |
|---|---|---|
dataset_manager |
DatasetManager
|
A dataset manager for this workspace. |
dataset_manager
property
A dataset manager for this workspace.
connect(path)
staticmethod
Connect to a fricon server.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
StrPath
|
The path to the workspace. |
required |
Returns:
| Type | Description |
|---|---|
Workspace
|
A workspace client. |