send2trash-1.3.0/000077500000000000000000000000001304147651500135765ustar00rootroot00000000000000send2trash-1.3.0/CHANGES.rst000066400000000000000000000013341304147651500154010ustar00rootroot00000000000000Changes ======= Version 1.3.0 -- 2013/07/19 --------------------------- * Added support for Gnome's GIO. * Merged Python 3 and Python 2 vesion in a single codebase. Version 1.2.0 -- 2011/03/16 --------------------------- * Improved ``plat_other`` to follow freedesktop.org trash specification. Version 1.1.0 -- 2010/10/18 --------------------------- * Converted compiled modules to ctypes so that cross-platform compilation isn't necessary anymore. Version 1.0.2 -- 2010/07/10 --------------------------- * Fixed bugs with external volumes in plat_other. Version 1.0.1 -- 2010/04/19 --------------------------- * Fixed memory leak in OS X module. Version 1.0.0 -- 2010/04/07 --------------------------- * Initial Releasesend2trash-1.3.0/MANIFEST.in000066400000000000000000000000231304147651500153270ustar00rootroot00000000000000include CHANGES.rstsend2trash-1.3.0/PKG-INFO000066400000000000000000000063371304147651500147040ustar00rootroot00000000000000Metadata-Version: 1.1 Name: Send2Trash Version: 1.3.0 Summary: Send file to trash natively under Mac OS X, Windows and Linux. Home-page: http://github.com/hsoft/send2trash Author: Hardcoded Software Author-email: hsoft@hardcoded.net License: BSD License Description: ================================================== 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). 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') When there's a 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/ Changes ======= Version 1.3.0 -- 2013/07/19 --------------------------- * Added support for Gnome's GIO. * Merged Python 3 and Python 2 vesion in a single codebase. Version 1.2.0 -- 2011/03/16 --------------------------- * Improved ``plat_other`` to follow freedesktop.org trash specification. Version 1.1.0 -- 2010/10/18 --------------------------- * Converted compiled modules to ctypes so that cross-platform compilation isn't necessary anymore. Version 1.0.2 -- 2010/07/10 --------------------------- * Fixed bugs with external volumes in plat_other. Version 1.0.1 -- 2010/04/19 --------------------------- * Fixed memory leak in OS X module. Version 1.0.0 -- 2010/04/07 --------------------------- * Initial Release Platform: UNKNOWN Classifier: Development Status :: 5 - Production/Stable Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: BSD License Classifier: Operating System :: MacOS :: MacOS X Classifier: Operating System :: Microsoft :: Windows Classifier: Operating System :: POSIX Classifier: Programming Language :: Python :: 2.7 Classifier: Programming Language :: Python :: 3 Classifier: Topic :: Desktop Environment :: File Managers send2trash-1.3.0/README.rst000066400000000000000000000023641304147651500152720ustar00rootroot00000000000000================================================== 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). 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') When there's a 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/ send2trash-1.3.0/Send2Trash.egg-info/000077500000000000000000000000001304147651500172455ustar00rootroot00000000000000send2trash-1.3.0/Send2Trash.egg-info/PKG-INFO000066400000000000000000000063371304147651500203530ustar00rootroot00000000000000Metadata-Version: 1.1 Name: Send2Trash Version: 1.3.0 Summary: Send file to trash natively under Mac OS X, Windows and Linux. Home-page: http://github.com/hsoft/send2trash Author: Hardcoded Software Author-email: hsoft@hardcoded.net License: BSD License Description: ================================================== 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). 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') When there's a 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/ Changes ======= Version 1.3.0 -- 2013/07/19 --------------------------- * Added support for Gnome's GIO. * Merged Python 3 and Python 2 vesion in a single codebase. Version 1.2.0 -- 2011/03/16 --------------------------- * Improved ``plat_other`` to follow freedesktop.org trash specification. Version 1.1.0 -- 2010/10/18 --------------------------- * Converted compiled modules to ctypes so that cross-platform compilation isn't necessary anymore. Version 1.0.2 -- 2010/07/10 --------------------------- * Fixed bugs with external volumes in plat_other. Version 1.0.1 -- 2010/04/19 --------------------------- * Fixed memory leak in OS X module. Version 1.0.0 -- 2010/04/07 --------------------------- * Initial Release Platform: UNKNOWN Classifier: Development Status :: 5 - Production/Stable Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: BSD License Classifier: Operating System :: MacOS :: MacOS X Classifier: Operating System :: Microsoft :: Windows Classifier: Operating System :: POSIX Classifier: Programming Language :: Python :: 2.7 Classifier: Programming Language :: Python :: 3 Classifier: Topic :: Desktop Environment :: File Managers send2trash-1.3.0/Send2Trash.egg-info/SOURCES.txt000066400000000000000000000004751304147651500211370ustar00rootroot00000000000000CHANGES.rst MANIFEST.in README.rst setup.py Send2Trash.egg-info/PKG-INFO Send2Trash.egg-info/SOURCES.txt Send2Trash.egg-info/dependency_links.txt Send2Trash.egg-info/top_level.txt send2trash/__init__.py send2trash/compat.py send2trash/plat_gio.py send2trash/plat_osx.py send2trash/plat_other.py send2trash/plat_win.pysend2trash-1.3.0/Send2Trash.egg-info/dependency_links.txt000066400000000000000000000000011304147651500233130ustar00rootroot00000000000000 send2trash-1.3.0/Send2Trash.egg-info/top_level.txt000066400000000000000000000000131304147651500217710ustar00rootroot00000000000000send2trash send2trash-1.3.0/send2trash/000077500000000000000000000000001304147651500156535ustar00rootroot00000000000000send2trash-1.3.0/send2trash/__init__.py000066400000000000000000000012351304147651500177650ustar00rootroot00000000000000# Copyright 2013 Hardcoded Software (http://www.hardcoded.net) # This software is licensed under the "BSD" License as described in the "LICENSE" file, # which should be included with this package. The terms are also available at # http://www.hardcoded.net/licenses/bsd_license import sys if sys.platform == 'darwin': from .plat_osx import send2trash elif sys.platform == 'win32': from .plat_win import send2trash else: try: # If we can use gio, let's use it from .plat_gio import send2trash except ImportError: # Oh well, let's fallback to our own Freedesktop trash implementation from .plat_other import send2trash send2trash-1.3.0/send2trash/compat.py000066400000000000000000000006321304147651500175110ustar00rootroot00000000000000# Copyright 2013 Hardcoded Software (http://www.hardcoded.net) # This software is licensed under the "BSD" License as described in the "LICENSE" file, # which should be included with this package. The terms are also available at # http://www.hardcoded.net/licenses/bsd_license import sys if sys.version < '3': text_type = unicode binary_type = str else: text_type = str binary_type = bytes send2trash-1.3.0/send2trash/plat_gio.py000066400000000000000000000007531304147651500200300ustar00rootroot00000000000000# Copyright 2013 Hardcoded Software (http://www.hardcoded.net) # This software is licensed under the "BSD" License as described in the "LICENSE" file, # which should be included with this package. The terms are also available at # http://www.hardcoded.net/licenses/bsd_license from gi.repository import GObject, Gio def send2trash(path): try: f = Gio.File.new_for_path(path) f.trash(cancellable=None) except GObject.GError as e: raise OSError(e.message) send2trash-1.3.0/send2trash/plat_osx.py000066400000000000000000000032621304147651500200610ustar00rootroot00000000000000# Copyright 2013 Hardcoded Software (http://www.hardcoded.net) # This software is licensed under the "BSD" License as described in the "LICENSE" file, # which should be included with this package. The terms are also available at # http://www.hardcoded.net/licenses/bsd_license from __future__ import unicode_literals from ctypes import cdll, byref, Structure, c_char, c_char_p from ctypes.util import find_library from .compat import binary_type Foundation = cdll.LoadLibrary(find_library('Foundation')) CoreServices = cdll.LoadLibrary(find_library('CoreServices')) GetMacOSStatusCommentString = Foundation.GetMacOSStatusCommentString GetMacOSStatusCommentString.restype = c_char_p FSPathMakeRefWithOptions = CoreServices.FSPathMakeRefWithOptions FSMoveObjectToTrashSync = CoreServices.FSMoveObjectToTrashSync kFSPathMakeRefDefaultOptions = 0 kFSPathMakeRefDoNotFollowLeafSymlink = 0x01 kFSFileOperationDefaultOptions = 0 kFSFileOperationOverwrite = 0x01 kFSFileOperationSkipSourcePermissionErrors = 0x02 kFSFileOperationDoNotMoveAcrossVolumes = 0x04 kFSFileOperationSkipPreflight = 0x08 class FSRef(Structure): _fields_ = [('hidden', c_char * 80)] def check_op_result(op_result): if op_result: msg = GetMacOSStatusCommentString(op_result).decode('utf-8') raise OSError(msg) def send2trash(path): if not isinstance(path, binary_type): path = path.encode('utf-8') fp = FSRef() opts = kFSPathMakeRefDoNotFollowLeafSymlink op_result = FSPathMakeRefWithOptions(path, opts, byref(fp), None) check_op_result(op_result) opts = kFSFileOperationDefaultOptions op_result = FSMoveObjectToTrashSync(byref(fp), None, opts) check_op_result(op_result) send2trash-1.3.0/send2trash/plat_other.py000066400000000000000000000124311304147651500203670ustar00rootroot00000000000000# Copyright 2013 Hardcoded Software (http://www.hardcoded.net) # This software is licensed under the "BSD" License as described in the "LICENSE" file, # which should be included with this package. The terms are also available at # http://www.hardcoded.net/licenses/bsd_license # This is a reimplementation of plat_other.py with reference to the # freedesktop.org trash specification: # [1] http://www.freedesktop.org/wiki/Specifications/trash-spec # [2] http://www.ramendik.ru/docs/trashspec.html # See also: # [3] http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html # # For external volumes this implementation will raise an exception if it can't # find or create the user's trash directory. from __future__ import unicode_literals import sys import os import os.path as op from datetime import datetime import stat try: from urllib.parse import quote except ImportError: # Python 2 from urllib import quote FILES_DIR = 'files' INFO_DIR = 'info' INFO_SUFFIX = '.trashinfo' # Default of ~/.local/share [3] XDG_DATA_HOME = op.expanduser(os.environ.get('XDG_DATA_HOME', '~/.local/share')) HOMETRASH = op.join(XDG_DATA_HOME, 'Trash') uid = os.getuid() TOPDIR_TRASH = '.Trash' TOPDIR_FALLBACK = '.Trash-' + str(uid) def is_parent(parent, path): path = op.realpath(path) # In case it's a symlink parent = op.realpath(parent) return path.startswith(parent) def format_date(date): return date.strftime("%Y-%m-%dT%H:%M:%S") def info_for(src, topdir): # ...it MUST not include a ".."" directory, and for files not "under" that # directory, absolute pathnames must be used. [2] if topdir is None or not is_parent(topdir, src): src = op.abspath(src) else: src = op.relpath(src, topdir) info = "[Trash Info]\n" info += "Path=" + quote(src) + "\n" info += "DeletionDate=" + format_date(datetime.now()) + "\n" return info def check_create(dir): # use 0700 for paths [3] if not op.exists(dir): os.makedirs(dir, 0o700) def trash_move(src, dst, topdir=None): filename = op.basename(src) filespath = op.join(dst, FILES_DIR) infopath = op.join(dst, INFO_DIR) base_name, ext = op.splitext(filename) counter = 0 destname = filename while op.exists(op.join(filespath, destname)) or op.exists(op.join(infopath, destname + INFO_SUFFIX)): counter += 1 destname = '%s %s%s' % (base_name, counter, ext) check_create(filespath) check_create(infopath) os.rename(src, op.join(filespath, destname)) f = open(op.join(infopath, destname + INFO_SUFFIX), 'w') f.write(info_for(src, topdir)) f.close() def find_mount_point(path): # Even if something's wrong, "/" is a mount point, so the loop will exit. # Use realpath in case it's a symlink path = op.realpath(path) # Required to avoid infinite loop while not op.ismount(path): path = op.split(path)[0] return path def find_ext_volume_global_trash(volume_root): # from [2] Trash directories (1) check for a .Trash dir with the right # permissions set. trash_dir = op.join(volume_root, TOPDIR_TRASH) if not op.exists(trash_dir): return None mode = os.lstat(trash_dir).st_mode # vol/.Trash must be a directory, cannot be a symlink, and must have the # sticky bit set. if not op.isdir(trash_dir) or op.islink(trash_dir) or not (mode & stat.S_ISVTX): return None trash_dir = op.join(trash_dir, str(uid)) try: check_create(trash_dir) except OSError: return None return trash_dir def find_ext_volume_fallback_trash(volume_root): # from [2] Trash directories (1) create a .Trash-$uid dir. trash_dir = op.join(volume_root, TOPDIR_FALLBACK) # Try to make the directory, if we can't the OSError exception will escape # be thrown out of send2trash. check_create(trash_dir) return trash_dir def find_ext_volume_trash(volume_root): trash_dir = find_ext_volume_global_trash(volume_root) if trash_dir is None: trash_dir = find_ext_volume_fallback_trash(volume_root) return trash_dir # Pull this out so it's easy to stub (to avoid stubbing lstat itself) def get_dev(path): return os.lstat(path).st_dev def send2trash(path): if not isinstance(path, str): path = str(path, sys.getfilesystemencoding()) if not op.exists(path): raise OSError("File not found: %s" % path) # ...should check whether the user has the necessary permissions to delete # it, before starting the trashing operation itself. [2] if not os.access(path, os.W_OK): raise OSError("Permission denied: %s" % path) # if the file to be trashed is on the same device as HOMETRASH we # want to move it there. path_dev = get_dev(path) # If XDG_DATA_HOME or HOMETRASH do not yet exist we need to stat the # home directory, and these paths will be created further on if needed. trash_dev = get_dev(op.expanduser('~')) if path_dev == trash_dev: topdir = XDG_DATA_HOME dest_trash = HOMETRASH else: topdir = find_mount_point(path) trash_dev = get_dev(topdir) if trash_dev != path_dev: raise OSError("Couldn't find mount point for %s" % path) dest_trash = find_ext_volume_trash(topdir) trash_move(path, dest_trash, topdir) send2trash-1.3.0/send2trash/plat_win.py000066400000000000000000000031741304147651500200470ustar00rootroot00000000000000# Copyright 2013 Hardcoded Software (http://www.hardcoded.net) # This software is licensed under the "BSD" License as described in the "LICENSE" file, # which should be included with this package. The terms are also available at # http://www.hardcoded.net/licenses/bsd_license from __future__ import unicode_literals from ctypes import windll, Structure, byref, c_uint from ctypes.wintypes import HWND, UINT, LPCWSTR, BOOL import os.path as op from .compat import text_type shell32 = windll.shell32 SHFileOperationW = shell32.SHFileOperationW class SHFILEOPSTRUCTW(Structure): _fields_ = [ ("hwnd", HWND), ("wFunc", UINT), ("pFrom", LPCWSTR), ("pTo", LPCWSTR), ("fFlags", c_uint), ("fAnyOperationsAborted", BOOL), ("hNameMappings", c_uint), ("lpszProgressTitle", LPCWSTR), ] FO_MOVE = 1 FO_COPY = 2 FO_DELETE = 3 FO_RENAME = 4 FOF_MULTIDESTFILES = 1 FOF_SILENT = 4 FOF_NOCONFIRMATION = 16 FOF_ALLOWUNDO = 64 FOF_NOERRORUI = 1024 def send2trash(path): if not isinstance(path, text_type): path = text_type(path, 'mbcs') if not op.isabs(path): path = op.abspath(path) fileop = SHFILEOPSTRUCTW() fileop.hwnd = 0 fileop.wFunc = FO_DELETE fileop.pFrom = LPCWSTR(path + '\0') fileop.pTo = None fileop.fFlags = FOF_ALLOWUNDO | FOF_NOCONFIRMATION | FOF_NOERRORUI | FOF_SILENT fileop.fAnyOperationsAborted = 0 fileop.hNameMappings = 0 fileop.lpszProgressTitle = None result = SHFileOperationW(byref(fileop)) if result: msg = "Couldn't perform operation. Error code: %d" % result raise OSError(msg) send2trash-1.3.0/setup.cfg000066400000000000000000000000731304147651500154170ustar00rootroot00000000000000[egg_info] tag_build = tag_date = 0 tag_svn_revision = 0 send2trash-1.3.0/setup.py000066400000000000000000000017151304147651500153140ustar00rootroot00000000000000import sys import os.path as op from setuptools import setup CLASSIFIERS = [ 'Development Status :: 5 - Production/Stable', 'Intended Audience :: Developers', 'License :: OSI Approved :: BSD License', 'Operating System :: MacOS :: MacOS X', 'Operating System :: Microsoft :: Windows', 'Operating System :: POSIX', 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3', 'Topic :: Desktop Environment :: File Managers', ] LONG_DESCRIPTION = open('README.rst', 'rt').read() + '\n\n' + open('CHANGES.rst', 'rt').read() setup( name='Send2Trash', version='1.3.0', author='Hardcoded Software', author_email='hsoft@hardcoded.net', packages=['send2trash'], scripts=[], url='http://github.com/hsoft/send2trash', license='BSD License', description='Send file to trash natively under Mac OS X, Windows and Linux.', long_description=LONG_DESCRIPTION, classifiers=CLASSIFIERS, )