FairDataPointItem

class fdp.fairdatapointitem.FairDataPointItem(fair_data_point: FairDataPoint = None)

Bases: object

Base class for all the Fair Data Point entities.

property tainted: bool

Whether the instance has been modified after creation/sync with the Fair Data Point.

property properties

The class properties.

Returns:

a list of class properties.

Return type:

list of str

publish(version, description: str = None)

property draft: str

The draft attribute.

Note

This attribute has no setter.

property latest: str

The latest attribute.

Note

This attribute has no setter.

property uuid: str

The uuid attribute.

Note

This attribute has no setter.

property fair_data_point

The dcterms:isPartOf (Catalog’s Fair Data Point) property.

create()

Creates a new Fair Data Point Item.

update(**kwargs)

Update an existing Fair Data Point Item.

delete()

Deletes a Fair Data Point Item from the Fair Data Point. On success, UUID attribute is set to None

get(uuid, **kwargs)

Retrieves all the Fair Data Point Item of the derived class from the Fair Data Point.

Parameters:

uuid (str) – the UUID of the Item to retrieve

Returns:

the Fair Data Point item

Raises:

• TypeError – if the uuid is None

• NotPresentError – if the uuid is not present in the Fair Data Point

get_all(**kwargs)

Retrieves all the Fair Data Point Item of the derived class from the Fair Data Point.

inspect(internals: bool = False)

Retrieves the value of the class properties.

Returns:

a dictionary with the class’s properties.

Return type:

dict

check_duplicates(ignore_case: bool = False)

Commodity function that checks if the given Item is already present in the Fair Data Point.

The check is performed against the name of the item.

Parameters:

ignore_case (bool) – wether or not match case

Returns:

True if an item with the same name is already present in the Fair Data Point, False otherwise

Return type:

bool