datagraphs.Dataset

class documentation

class Dataset:

Constructors: Dataset.create_from(data), Dataset(name, project, account, is_private, ...)

Represents a dataset within a DataGraphs project.

Static Method	`create_from`	Create a `Dataset` instance from a dictionary.
Method	`__eq__`	Undocumented
Method	`__init__`	Create a new dataset.
Method	`__ne__`	Undocumented
Method	`classes.setter`	Undocumented
Method	`is_private.setter`	Undocumented
Method	`is_restricted.setter`	Undocumented
Method	`to_dict`	Convert the dataset to a dictionary suitable for API requests.
Property	`account`	The account name.
Property	`classes`	The class names belonging to this dataset.
Property	`id`	The auto-generated URN identifier (e.g. `'urn:project:dataset-slug'`).
Property	`is_private`	Whether the dataset is private.
Property	`is_restricted`	Whether the dataset has restricted access.
Property	`name`	The dataset name.
Property	`project`	The project name.
Property	`slug`	The slug portion of the dataset ID.
Method	`_sanitise_name`	Undocumented
Instance Variable	`_account`	Undocumented
Instance Variable	`_classes`	Undocumented
Instance Variable	`_is_private`	Undocumented
Instance Variable	`_is_restricted`	Undocumented
Instance Variable	`_name`	Undocumented
Instance Variable	`_project`	Undocumented

@staticmethod

def create_from(data: dict) -> Dataset: ¶

Create a Dataset instance from a dictionary.

Parameters
data:`dict`	Dictionary with dataset fields.

Returns
`Dataset`	A new `Dataset` instance.

def __eq__(self, other: object) -> bool: ¶

Undocumented

def __init__(self, name: str, project: str, account: str = '', is_private: bool = True, is_restricted: bool = False, classes: list[str] | None = None): ¶

Create a new dataset.

Parameters
name:`str`	Dataset name.
project:`str`	Project name.
account:`str`	Account name.
is_private:`bool`	Whether the dataset is private.
is_restricted:`bool`	Whether the dataset has restricted access.
classes:`list[str] \| None`	List of class names belonging to this dataset.

def __ne__(self, other: object) -> bool: ¶

Undocumented

@classes.setter

def classes(self, value: list[str]): ¶

Undocumented

@is_private.setter

def is_private(self, value: bool): ¶

Undocumented

@is_restricted.setter

def is_restricted(self, value: bool): ¶

Undocumented

def to_dict(self) -> dict: ¶

Convert the dataset to a dictionary suitable for API requests.

Returns
`dict`	A dict representation of the dataset.

@property

account: str = ¶

The account name.

@property

classes: list[str] = ¶

The class names belonging to this dataset.

@property

id: str = ¶

The auto-generated URN identifier (e.g. 'urn:project:dataset-slug').

@property

is_private: bool = ¶

Whether the dataset is private.

@property

is_restricted: bool = ¶

Whether the dataset has restricted access.

@property

name: str = ¶

The dataset name.

@property

project: str = ¶

The project name.

@property

slug: str = ¶

The slug portion of the dataset ID.

def _sanitise_name(self, value: str) -> str: ¶

Undocumented

_account = ¶

Undocumented

_classes = ¶

Undocumented

_is_private = ¶

Undocumented

_is_restricted = ¶

Undocumented

_name = ¶

Undocumented

_project = ¶

Undocumented