Minor code quality updates

This commit is contained in:
Andrew Senetar 2021-08-21 15:19:32 -05:00
parent 2aa834be94
commit 78a536abba
Signed by: arsenetar
GPG Key ID: C63300DCE48AB2F1
3 changed files with 58 additions and 98 deletions

View File

@ -37,54 +37,10 @@ class FileOperationProgressSink(DesignatedWrapPolicy):
# but that may need some additional considerations before implementing. # but that may need some additional considerations before implementing.
return 0 if flags & shellcon.TSF_DELETE_RECYCLE_IF_POSSIBLE else 0x80004005 # S_OK, or E_FAIL return 0 if flags & shellcon.TSF_DELETE_RECYCLE_IF_POSSIBLE else 0x80004005 # S_OK, or E_FAIL
def PostDeleteItem(self, flags, item, hrDelete, newlyCreated): def PostDeleteItem(self, flags, item, hr_delete, newly_created):
if newlyCreated: if newly_created:
self.newItem = newlyCreated.GetDisplayName(shellcon.SHGDN_FORPARSING) self.newItem = newly_created.GetDisplayName(shellcon.SHGDN_FORPARSING)
def StartOperations(self):
pass
def FinishOperations(self, Result):
pass
def PreRenameItem(self, Flags, Item, NewName):
pass
def PostRenameItem(self, Flags, Item, NewName, hrRename, NewlyCreated):
pass
def PreMoveItem(self, Flags, Item, DestinationFolder, NewName):
pass
def PostMoveItem(self, Flags, Item, DestinationFolder, NewName, hrMove, NewlyCreated):
pass
def PreCopyItem(self, Flags, Item, DestinationFolder, NewName):
pass
def PostCopyItem(self, Flags, Item, DestinationFolder, NewName, hrCopy, NewlyCreated):
pass
def PreNewItem(self, Flags, DestinationFolder, NewName):
pass
def PostNewItem(
self, Flags, DestinationFolder, NewName, TemplateName, FileAttributes, hrNew, NewItem,
):
pass
def UpdateProgress(self, WorkTotal, WorkSoFar):
pass
def ResetTimer(self):
pass
def PauseTimer(self):
pass
def ResumeTimer(self):
pass
def CreateSink(): def create_sink():
return pythoncom.WrapObject(FileOperationProgressSink(), shell.IID_IFileOperationProgressSink) return pythoncom.WrapObject(FileOperationProgressSink(), shell.IID_IFileOperationProgressSink)

View File

@ -12,7 +12,7 @@ from platform import version
import pythoncom import pythoncom
import pywintypes import pywintypes
from win32com.shell import shell, shellcon from win32com.shell import shell, shellcon
from .IFileOperationProgressSink import CreateSink from .IFileOperationProgressSink import create_sink
def send2trash(paths): def send2trash(paths):
@ -42,7 +42,7 @@ def send2trash(paths):
# actually try to perform the operation, this section may throw a # actually try to perform the operation, this section may throw a
# pywintypes.com_error which does not seem to create as nice of an # pywintypes.com_error which does not seem to create as nice of an
# error as OSError so wrapping with try to convert # error as OSError so wrapping with try to convert
sink = CreateSink() sink = create_sink()
try: try:
for path in paths: for path in paths:
item = shell.SHCreateItemFromParsingName(path, None, shell.IID_IShellItem) item = shell.SHCreateItemFromParsingName(path, None, shell.IID_IShellItem)

View File

@ -84,7 +84,7 @@ def _filesys_enc():
@pytest.fixture @pytest.fixture
def testUnicodefile(): def gen_unicode_file():
name = u"send2trash_tést1" name = u"send2trash_tést1"
file = op.join(op.expanduser(b"~"), name.encode("utf-8")) file = op.join(op.expanduser(b"~"), name.encode("utf-8"))
touch(file) touch(file)
@ -101,35 +101,35 @@ def testUnicodefile():
@pytest.mark.skipif(_filesys_enc() == "ascii", reason="Requires Unicode filesystem") @pytest.mark.skipif(_filesys_enc() == "ascii", reason="Requires Unicode filesystem")
def test_trash_bytes(testUnicodefile): def test_trash_bytes(gen_unicode_file):
s2t(testUnicodefile) s2t(gen_unicode_file)
assert not op.exists(testUnicodefile) assert not op.exists(gen_unicode_file)
@pytest.mark.skipif(_filesys_enc() == "ascii", reason="Requires Unicode filesystem") @pytest.mark.skipif(_filesys_enc() == "ascii", reason="Requires Unicode filesystem")
def test_trash_unicode(testUnicodefile): def test_trash_unicode(gen_unicode_file):
s2t(testUnicodefile.decode(sys.getfilesystemencoding())) s2t(gen_unicode_file.decode(sys.getfilesystemencoding()))
assert not op.exists(testUnicodefile) assert not op.exists(gen_unicode_file)
class ExtVol: class ExtVol:
def __init__(self, path): def __init__(self, path):
self.trashTopdir = path self.trash_topdir = path
if PY3: if PY3:
self.trashTopdir_b = os.fsencode(self.trashTopdir) self.trash_topdir_b = os.fsencode(self.trash_topdir)
else: else:
self.trashTopdir_b = self.trashTopdir self.trash_topdir_b = self.trash_topdir
def s_getdev(path): def s_getdev(path):
from send2trash.plat_other import is_parent from send2trash.plat_other import is_parent
st = os.lstat(path) st = os.lstat(path)
if is_parent(self.trashTopdir, path): if is_parent(self.trash_topdir, path):
return "dev" return "dev"
return st.st_dev return st.st_dev
def s_ismount(path): def s_ismount(path):
if op.realpath(path) in (op.realpath(self.trashTopdir), op.realpath(self.trashTopdir_b),): if op.realpath(path) in (op.realpath(self.trash_topdir), op.realpath(self.trash_topdir_b),):
return True return True
return old_ismount(path) return old_ismount(path)
@ -141,58 +141,62 @@ class ExtVol:
def cleanup(self): def cleanup(self):
send2trash.plat_other.get_dev = self.old_getdev send2trash.plat_other.get_dev = self.old_getdev
send2trash.plat_other.os.path.ismount = self.old_ismount send2trash.plat_other.os.path.ismount = self.old_ismount
shutil.rmtree(self.trashTopdir) shutil.rmtree(self.trash_topdir)
@pytest.fixture @pytest.fixture
def testExtVol(): def gen_ext_vol():
trashTopdir = mkdtemp(prefix="s2t") trash_topdir = mkdtemp(prefix="s2t")
volume = ExtVol(trashTopdir) volume = ExtVol(trash_topdir)
fileName = "test.txt" file_name = "test.txt"
filePath = op.join(volume.trashTopdir, fileName) file_path = op.join(volume.trash_topdir, file_name)
touch(filePath) touch(file_path)
assert op.exists(filePath) is True assert op.exists(file_path) is True
yield volume, fileName, filePath yield volume, file_name, file_path
volume.cleanup() volume.cleanup()
def test_trash_topdir(testExtVol): def test_trash_topdir(gen_ext_vol):
trashDir = op.join(testExtVol[0].trashTopdir, ".Trash") trash_dir = op.join(gen_ext_vol[0].trash_topdir, ".Trash")
os.mkdir(trashDir, 0o777 | stat.S_ISVTX) os.mkdir(trash_dir, 0o777 | stat.S_ISVTX)
s2t(testExtVol[2]) s2t(gen_ext_vol[2])
assert op.exists(testExtVol[2]) is False assert op.exists(gen_ext_vol[2]) is False
assert op.exists(op.join(trashDir, str(os.getuid()), "files", testExtVol[1])) is True assert op.exists(op.join(trash_dir, str(os.getuid()), "files", gen_ext_vol[1])) is True
assert op.exists(op.join(trashDir, str(os.getuid()), "info", testExtVol[1] + ".trashinfo",)) is True assert op.exists(op.join(trash_dir, str(os.getuid()), "info", gen_ext_vol[1] + ".trashinfo",)) is True
# info relative path (if another test is added, with the same fileName/Path, # info relative path (if another test is added, with the same fileName/Path,
# then it gets renamed etc.) # then it gets renamed etc.)
cfg = ConfigParser() cfg = ConfigParser()
cfg.read(op.join(trashDir, str(os.getuid()), "info", testExtVol[1] + ".trashinfo")) cfg.read(op.join(trash_dir, str(os.getuid()), "info", gen_ext_vol[1] + ".trashinfo"))
assert (testExtVol[1] == cfg.get("Trash Info", "Path", raw=True)) is True assert (gen_ext_vol[1] == cfg.get("Trash Info", "Path", raw=True)) is True
def test_trash_topdir_fallback(testExtVol): def test_trash_topdir_fallback(gen_ext_vol):
s2t(testExtVol[2]) s2t(gen_ext_vol[2])
assert op.exists(testExtVol[2]) is False assert op.exists(gen_ext_vol[2]) is False
assert op.exists(op.join(testExtVol[0].trashTopdir, ".Trash-" + str(os.getuid()), "files", testExtVol[1],)) is True assert (
op.exists(op.join(gen_ext_vol[0].trash_topdir, ".Trash-" + str(os.getuid()), "files", gen_ext_vol[1],)) is True
)
def test_trash_topdir_failure(testExtVol): def test_trash_topdir_failure(gen_ext_vol):
os.chmod(testExtVol[0].trashTopdir, 0o500) # not writable to induce the exception os.chmod(gen_ext_vol[0].trash_topdir, 0o500) # not writable to induce the exception
pytest.raises(TrashPermissionError, s2t, [testExtVol[2]]) pytest.raises(TrashPermissionError, s2t, [gen_ext_vol[2]])
os.chmod(testExtVol[0].trashTopdir, 0o700) # writable to allow deletion os.chmod(gen_ext_vol[0].trash_topdir, 0o700) # writable to allow deletion
def test_trash_symlink(testExtVol): def test_trash_symlink(gen_ext_vol):
# Use mktemp (race conditioney but no symlink equivalent) # Use mktemp (race conditioney but no symlink equivalent)
# Since is_parent uses realpath(), and our getdev uses is_parent, # Since is_parent uses realpath(), and our getdev uses is_parent,
# this should work # this should work
slDir = mktemp(prefix="s2t", dir=op.expanduser("~")) sl_dir = mktemp(prefix="s2t", dir=op.expanduser("~"))
os.mkdir(op.join(testExtVol[0].trashTopdir, "subdir"), 0o700) os.mkdir(op.join(gen_ext_vol[0].trashTopdir, "subdir"), 0o700)
filePath = op.join(testExtVol[0].trashTopdir, "subdir", testExtVol[1]) file_path = op.join(gen_ext_vol[0].trashTopdir, "subdir", gen_ext_vol[1])
touch(filePath) touch(file_path)
os.symlink(op.join(testExtVol[0].trashTopdir, "subdir"), slDir) os.symlink(op.join(gen_ext_vol[0].trashTopdir, "subdir"), sl_dir)
s2t(op.join(slDir, testExtVol[1])) s2t(op.join(sl_dir, gen_ext_vol[1]))
assert op.exists(filePath) is False assert op.exists(file_path) is False
assert op.exists(op.join(testExtVol[0].trashTopdir, ".Trash-" + str(os.getuid()), "files", testExtVol[1],)) is True assert (
os.remove(slDir) op.exists(op.join(gen_ext_vol[0].trashTopdir, ".Trash-" + str(os.getuid()), "files", gen_ext_vol[1],)) is True
)
os.remove(sl_dir)