File

class labstep.entities.file.model.File(data, user)
getData()

Retrieve the contents of a File for manipulation within Python.

Example

entities = user.getFiles(search_query='bacteria')
file = entities[0]
data = file.getData()
save(folder=OPTIONAL, name=OPTIONAL)

Save a Labstep file to the local filesystem.

Parameters:
  • folder (str) – The path to the folder where the file should be saved (defaults to the current working directory).

  • name (str) – Optionally give the file a new name.

Return type:

None

Example

entities = user.getFiles(search_query='bacteria')
file = entities[0]
file.save()
export(path)

Export the file to the directory specified.

Parameters:

path (str) – The path to the directory to save the file.

Example

file = user.getFile(17000)
file.export('/my_folder')