Browse Source

Merge branch 'unicode-trash' of https://github.com/takluyver/send2trash into takluyver-unicode-trash

tags/1.4.0
Virgil Dupras 3 years ago
parent
commit
f3231ef857
2 changed files with 87 additions and 23 deletions
  1. +43
    -18
      send2trash/plat_other.py
  2. +44
    -5
      tests/test_plat_other.py

+ 43
- 18
send2trash/plat_other.py View File

@@ -29,22 +29,39 @@ except ImportError:

# PY2-PY3 compatibilty
text_type = str if sys.version_info[0] == 3 else unicode
environb = os.environb if sys.version_info[0] >= 3 else os.environ

FILES_DIR = 'files'
INFO_DIR = 'info'
INFO_SUFFIX = '.trashinfo'
try:
fsencode = os.fsencode # Python 3
fsdecode = os.fsdecode
except AttributeError:
def fsencode(u): # Python 2
return u.encode(sys.getfilesystemencoding())
def fsdecode(b):
return b.decode(sys.getfilesystemencoding())
# The Python 3 versions are a bit smarter, handling surrogate escapes,
# but these should work in most cases.

FILES_DIR = b'files'
INFO_DIR = b'info'
INFO_SUFFIX = b'.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')
XDG_DATA_HOME = op.expanduser(environb.get(b'XDG_DATA_HOME', b'~/.local/share'))
HOMETRASH_B = op.join(XDG_DATA_HOME, b'Trash')
HOMETRASH = fsdecode(HOMETRASH_B)

uid = os.getuid()
TOPDIR_TRASH = '.Trash'
TOPDIR_FALLBACK = '.Trash-' + text_type(uid)
TOPDIR_TRASH = b'.Trash'
TOPDIR_FALLBACK = b'.Trash-' + text_type(uid).encode('ascii')

def is_parent(parent, path):
path = op.realpath(path) # In case it's a symlink
if isinstance(path, text_type):
path = fsencode(path)
parent = op.realpath(parent)
if isinstance(parent, text_type):
parent = fsencode(parent)
return path.startswith(parent)

def format_date(date):
@@ -78,7 +95,7 @@ def trash_move(src, dst, topdir=None):
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)
destname = base_name + b' ' + text_type(counter).encode('ascii') + ext
check_create(filespath)
check_create(infopath)
@@ -109,7 +126,7 @@ def find_ext_volume_global_trash(volume_root):
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, text_type(uid))
trash_dir = op.join(trash_dir, text_type(uid).encode('ascii'))
try:
check_create(trash_dir)
except OSError:
@@ -135,29 +152,37 @@ def get_dev(path):
return os.lstat(path).st_dev

def send2trash(path):
if not isinstance(path, text_type):
path = text_type(path, sys.getfilesystemencoding())
if not op.exists(path):
if isinstance(path, text_type):
path_b = fsencode(path)
elif isinstance(path, bytes):
path_b = path
elif hasattr(path, '__fspath__'):
# Python 3.6 PathLike protocol
return send2trash(path.__fspath__())
else:
raise TypeError('str, bytes or PathLike expected, not %r' % type(path))

if not op.exists(path_b):
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):
if not os.access(path_b, 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)
path_dev = get_dev(path_b)
# 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('~'))
trash_dev = get_dev(op.expanduser(b'~'))

if path_dev == trash_dev:
topdir = XDG_DATA_HOME
dest_trash = HOMETRASH
dest_trash = HOMETRASH_B
else:
topdir = find_mount_point(path)
topdir = find_mount_point(path_b)
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)
trash_move(path_b, dest_trash, topdir)

+ 44
- 5
tests/test_plat_other.py View File

@@ -1,3 +1,5 @@
# encoding: utf-8
import codecs
import unittest
import os
from os import path as op
@@ -7,8 +9,12 @@ from configparser import ConfigParser
from tempfile import mkdtemp, NamedTemporaryFile, mktemp
import shutil
import stat
import sys
# Could still use cleaning up. But no longer relies on ramfs.

HOMETRASH = send2trash.plat_other.HOMETRASH
PY3 = sys.version_info[0] >= 3

def touch(path):
with open(path, 'a'):
os.utime(path, None)
@@ -23,10 +29,38 @@ class TestHomeTrash(unittest.TestCase):
self.assertFalse(op.exists(self.file.name))

def tearDown(self):
hometrash = send2trash.plat_other.HOMETRASH
name = op.basename(self.file.name)
os.remove(op.join(hometrash, 'files', name))
os.remove(op.join(hometrash, 'info', name+'.trashinfo'))
os.remove(op.join(HOMETRASH, 'files', name))
os.remove(op.join(HOMETRASH, 'info', name+'.trashinfo'))

def _filesys_enc():
enc = sys.getfilesystemencoding()
# Get canonical name of codec
return codecs.lookup(enc).name

@unittest.skipIf(_filesys_enc() == 'ascii', 'ASCII filesystem')
class TestUnicodeTrash(unittest.TestCase):
def setUp(self):
self.name = u'send2trash_tést1'
self.file = op.join(op.expanduser(b'~'), self.name.encode('utf-8'))
touch(self.file)

def test_trash_bytes(self):
s2t(self.file)
assert not op.exists(self.file)

def test_trash_unicode(self):
s2t(self.file.decode(sys.getfilesystemencoding()))
assert not op.exists(self.file)

def tearDown(self):
if op.exists(self.file):
os.remove(self.file)

trash_file = op.join(HOMETRASH, 'files', self.name)
if op.exists(trash_file):
os.remove(trash_file)
os.remove(op.join(HOMETRASH, 'info', self.name+'.trashinfo'))

#
# Tests for files on some other volume than the user's home directory.
@@ -38,6 +72,10 @@ class TestHomeTrash(unittest.TestCase):
class TestExtVol(unittest.TestCase):
def setUp(self):
self.trashTopdir = mkdtemp(prefix='s2t')
if PY3:
trashTopdir_b = os.fsencode(self.trashTopdir)
else:
trashTopdir_b = self.trashTopdir
self.fileName = 'test.txt'
self.filePath = op.join(self.trashTopdir, self.fileName)
touch(self.filePath)
@@ -49,9 +87,10 @@ class TestExtVol(unittest.TestCase):
st = os.lstat(path)
if is_parent(self.trashTopdir, path):
return 'dev'
return st
return st.st_dev
def s_ismount(path):
if op.realpath(path) == op.realpath(self.trashTopdir):
if op.realpath(path) in \
(op.realpath(self.trashTopdir), op.realpath(trashTopdir_b)):
return True
return old_ismount(path)



Loading…
Cancel
Save