57 lines
2.2 KiB
Raw Normal View History

2010-04-07 03:43:36 -05:00
Send2Trash -- Send files to trash on all platforms
Send2Trash is a small package that sends files to the Trash (or Recycle Bin) *natively* and on
*all platforms*. On OS X, it uses native ``FSMoveObjectToTrashSync`` Cocoa calls or can use pyobjc
with NSFileManager. On Windows, it uses native ``IFileOperation`` call if on Vista or newer and
pywin32 is installed or falls back to ``SHFileOperation`` calls. On other platforms, if `PyGObject`_
and `GIO`_ are available, it will use this. Otherwise, it will fallback to its own implementation of
the `trash specifications from`_.
2010-04-07 03:43:36 -05:00
2010-10-18 05:13:37 -05:00
``ctypes`` is used to access native libraries, so no compilation is necessary.
Send2Trash supports Python 2.7 and up (Python 3 is supported).
2020-06-18 21:49:42 -05:00
Status: Additional Help Welcome
2019-01-04 09:27:27 -06:00
2020-06-18 21:49:42 -05:00
Additional help is welcome for supporting this package. Specifically help with the OSX and Linux
issues and fixes would be most appreciated.
2019-01-04 09:27:27 -06:00
2010-04-07 03:43:36 -05:00
You can download it with pip:
2020-12-01 01:36:59 -06:00
python -m pip install -U send2trash
To install with pywin32 or pyobjc required specify the extra `nativeLib`:
python -m pip install -U send2trash[nativeLib]
2020-06-18 21:49:42 -05:00
or you can download the source from and install it with::
2010-04-07 03:43:36 -05:00
>>> python install
2010-04-07 03:43:36 -05:00
>>> from send2trash import send2trash
>>> send2trash('some_file')
2020-06-18 21:49:42 -05:00
>>> send2trash(['some_file1', 'some_file2'])
2010-04-07 03:43:36 -05:00
2018-02-06 16:28:47 -06:00
On Freedesktop platforms (Linux, BSD, etc.), you may not be able to efficiently
trash some files. In these cases, an exception ``send2trash.TrashPermissionError``
is raised, so that the application can handle this case. This inherits from
``PermissionError`` (``OSError`` on Python 2). Specifically, this affects
files on a different device to the user's home directory, where the root of the
device does not have a ``.Trash`` directory, and we don't have permission to
create a ``.Trash-$UID`` directory.
For any other problem, ``OSError`` is raised.
2013-07-19 18:26:34 -05:00
.. _PyGObject:
.. _GIO:
.. _trash specifications from