pysyncrosim.library.Library.delete

Library.delete(project=None, scenario=None, folder=None, datasheet=None, pid=None, sid=None, force=False, remove_backup=False, remove_publish=False, remove_custom_folders=False)

Deletes a SyncroSim class instance.

Parameters:

  • project (Project, String, or Int, optional) – If called from a Library class instance, specify the Project to delete. The default is None.

  • scenario (Scenario, String, or Int, optional) – If called from a Project class instance, specify the Scenario to delete. The default is None.

  • folder (Folder, or Int, optional) – If called from a Library class instance, specify the folder to delete. The default is None.

  • datasheet (String, optional) – Name of the datasheet to delete data from. The default is None.

  • pid (Int, optional) – Project ID. Only used when a datasheet name is provided. The default is None.

  • sid (Int, optional) – Scenario ID. Only used when a datasheet name is provided. The default is None.

  • force (Logical, optional) – If set to True, does not ask user before deleting SyncroSim class instance. The default is False.

  • remove_backup (Logical, optional) – If True, will remove the backup folder when deleting a Library. Default is False.

  • remove_publish (Logical, optional) – If True, will remove the publish folder when deleting a Library. Default is False.

  • remove_custom_folders (Logical, optional) – If True and custom folders have been configured for a Library, then will remove the custom publish and/or backup folders when deleting a Library. Note that the remove_publish and remove_backup arguments must also be set to True to remove the respective custom folders. Default is False.

Return type:

None.