Skip to main content
delete_directory(directory_name=None, options=)[source]

Deletes a directory from KiFS.

Parameters

directory_name (str) –

Name of the directory in KiFS to be deleted. The directory must contain no files, unless recursive is true.

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • recursive – If true, will delete directory and all files residing in it. If false, directory must be empty for deletion. Allowed values are:

    • true

    • false

    The default value is ‘false’.

  • no_error_if_not_exists – If true, no error is returned if specified directory does not exist. Allowed values are:

    • true

    • false

    The default value is ‘false’.

The default value is an empty dict ( ).

Returns

A dict with the following entries–

directory_name (str) –

Value of input parameter directory_name.

info (dict of str to str) –

Additional information.