67 lines
2.7 KiB
ReStructuredText
67 lines
2.7 KiB
ReStructuredText
==================================================
|
|
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, on Windows, it
|
|
uses native (and ugly) ``SHFileOperation`` win32 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 freedesktop.org`_.
|
|
|
|
``ctypes`` is used to access native libraries, so no compilation is necessary.
|
|
|
|
Send2Trash supports Python 2.7 and up (Python 3 is supported).
|
|
|
|
Status: Maintainer needed
|
|
-------------------------
|
|
|
|
I haven't had access to a Windows or MacOS environment for years now. I don't
|
|
care for those platforms as much as I used to. I also don't use this library
|
|
any more.
|
|
|
|
This is the most popular library I've authored and many people and projects
|
|
rely on it. I don't intend on letting it go broken. I am, however, wanting to
|
|
get rid of its maintainership burden.
|
|
|
|
It's not a big burden, but without access to Windows or MacOS, it can make
|
|
reviewing PRs a but tricky: I have to blind-merge them. That makes me a rather
|
|
bad maintainer for this library. So, for the good of the project, it should be
|
|
someone else.
|
|
|
|
However, being a relatively popular library makes this task a little tricky.
|
|
As we've seen in the NPM world recently, it has security implications.
|
|
Therefore, I don't intend on passing this to anyone. If you have some clout or
|
|
if I can otherwise have confidence that you'll handle the library responsibly,
|
|
then please contact me and I'll gladly pass this on.
|
|
|
|
Installation
|
|
------------
|
|
|
|
You can download it with pip::
|
|
|
|
pip install Send2Trash
|
|
|
|
or you can download the source from http://github.com/hsoft/send2trash and install it with::
|
|
|
|
>>> python setup.py install
|
|
|
|
Usage
|
|
-----
|
|
|
|
>>> from send2trash import send2trash
|
|
>>> send2trash('some_file')
|
|
|
|
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.
|
|
|
|
.. _PyGObject: https://wiki.gnome.org/PyGObject
|
|
.. _GIO: https://developer.gnome.org/gio/
|
|
.. _trash specifications from freedesktop.org: http://freedesktop.org/wiki/Specifications/trash-spec/
|