FolderMixin

class pydelfini.collections.FolderMixin(collection, full_path, core)

Bases: ABC

Folder interaction methods as a mixin class.

This class is used by DelfiniCollection and DelfiniFolder.

Attributes

id
path

Parameters:

• collection (DelfiniCollection)

• full_path (str | None)

• core (AuthenticatedClient)

__getitem__(item_path)

Retrieve an item in this folder.

Relative paths are supported, such as folder_a/folder_b/item_c.

Parameters:

item_path (str)

Return type:

DelfiniItem

__iter__()

Iterate over all items in this folder.

Return type:

Iterator[DelfiniItem]

folder(folder_name)

Open the named folder.

Parameters:

folder_name (str) – the name of the folder to open

Return type:

DelfiniFolder

get_table(item_path)

Retrieve the tabular contents of an item as a pd.DataFrame.

Parameters:

item_path (str) – The path to the item relative to the current folder. Accepts slashes (‘/’) for items in subfolders.

Return type:

DataFrame

new_empty_file(file_name)

Create a new, empty file.

Parameters:

file_name (str) – the name of the file to create

Return type:

DelfiniItem

new_folder(folder_name)

Create a new folder.

Parameters:

folder_name (str) – the name of the folder to create

Return type:

DelfiniFolder

new_link(target, link_name=None)

Create a new link pointing to a target.

Parameters:

• target (str) – the full URL of the target

• link_name (str) – the name of the newly created link. If not provided, the base name of the target will be used.

Return type:

DelfiniItem

walk()

Iterate over all items in this folder, and all subfolders.

Return type:

Iterator[DelfiniItem]

write_table(item_path, dataframe, format='csv', overwrite=False, **kwargs)

Write a pd.DataFrame to the named item.

If the item already exists and overwrite is False, an error is raised. If overwrite is True and the item exists, its data is overwritten.

Parameters:

• item_path (str) – The path to the item relative to the current folder. Accepts slashes (‘/’) for items in subfolders.

• dataframe (DataFrame) – The dataframe to be written.

• format (Literal['csv', 'parquet']) – One of the supported formats (csv or parquet).

• overwrite (bool) – If True, overwrite existing item data if it exists. If False (default), raises an error if item already exists.

• **kwargs (Any) – Any other arguments to be passed to the Pandas export function. See the documentation for pd.DataFrame.to_csv() or pd.DataFrame.to_parquet() for valid arguments.

Return type:

None