1
0
mirror of https://github.com/arsenetar/send2trash.git synced 2026-01-25 16:11:39 +00:00

45 Commits

Author SHA1 Message Date
5c4e6a81cd Merge pull request #103 from arsenetar/as/ci-lang-updates
feat: CI, Lanugage, lint, and misc cleanups
2025-12-30 22:06:40 -06:00
4e8d6c7e11 chore: Set version 2025-12-31 04:01:56 +00:00
2d07f76209 doc: Update CHANGES.rst for 2.0.0 2025-12-31 03:33:22 +00:00
a6539d146b fix: Update gio implementation to use GLib.Error instead of deprecated GObject.GError 2025-12-31 03:32:50 +00:00
2b20d606e2 doc: Update README to reflect python version support 2025-12-31 03:01:13 +00:00
06a9d37805 chore: More pylint cleanups, and python2 removals 2025-12-31 02:57:06 +00:00
8d96aa29df tests: Cleanup some pylint errors and share common fixture
- Cleanup some of the pylint erros in the tests
- Reorganize some of the tests functions and fixtures
- Move the one common fixture to conftest.py for sharing
2025-12-31 02:30:38 +00:00
0a4473d954 ci: Test python 3.9 on macOS instead of 3.8 as min version
PyObjC needs at least 3.9 now.
2025-12-31 01:34:12 +00:00
b23cba1ae2 chore: Fix lint error in test_plat_other.py 2025-12-31 01:32:01 +00:00
9465587899 chore: Update CI workflow versions add python 3.14
- Add Python 3.14
- Update GitHub Actions to latest versions
- Enable macOS in CI
2025-12-31 01:29:34 +00:00
b00bf8f8e0 Merge pull request #102 from gunSlaveUnit/fix/102-install-source-via-pip 2025-12-30 18:38:27 -06:00
gunSlaveUnit
fa9fee0442 Remove '>>>' from shell commands. 2025-12-27 15:39:46 +03:00
gunSlaveUnit
c91f2559da Fix source installation instructions.
- Replace outdated 'python setup.py install' with 'python -m pip install -e .'.
- Add virtual environment instructions for PEP 668 compatibility.
- Update the GitHub URL to HTTPS.
2025-12-27 15:23:33 +03:00
3f6c5b3088 Merge pull request #100 from denini08/mac-fix 2025-10-23 20:17:16 -05:00
denini08
1781b16fa8 test: Update trash topdir test for cross-platform compatibility 2025-09-24 15:26:49 -03:00
9a2c5bc690 chore: Update project configuration and ci for python version changes
- Drop support for Python 2
- Drop support for Python 3.7, 3.8 is new minimum
- Update tox to include newer python version and drop old ones
- Update GitHub action for python version changes, use standard python
  setup action
- Update GitHub action to use pinned action versions
- Update version to 2.0.0-dev
2025-08-06 05:27:33 +00:00
65bda6c7ca feat: Drop support for Python 2 and remove compatibility code
This removes support for Python 2, and drops most of the compatibility
code that was used to support both Python 2 and Python 3.
2025-08-06 05:27:32 +00:00
91d0698967 Merge pull request #91 from arsenetar/as/misc-fixes
chore: Upgrade version to 1.8.3, bump CI
2024-04-06 18:53:45 -05:00
5c47eb063c fix(ci): Use alternative setup-python to allow 2.7
The setup python action has removed 2.7, we want to keep it for the
moment.  Using an alternative action that supports 2.7.
2024-04-06 16:51:34 -07:00
c7a23884a9 chore: Upgrade version to 1.8.3, bump CI
- Upgrade version to 1.8.3, add changelog entry
- Fix minor flake8 error that can be ignored
- Update CI workflow to use newer actions and python versions
2024-04-06 16:36:23 -07:00
78fa300cac Merge pull request #90 from yogeshiitm/master
Fix bug when source and destination directories are on different file systems
2024-03-28 01:17:37 -05:00
Yogesh Agarwala
baeb9e59f9 Fix bug in send2trash: Use os.fsdecode() in shutil.move()
`shutil.move()` function expects string paths, not byte paths. This bug is leading to failure when src and dst are on on the different file system.
2024-03-23 05:37:21 +05:30
0a48c26f68 Merge pull request #88 from PalmtopTiger/iterable-types
Support for any iterable type as input data
2024-02-19 09:08:53 -06:00
Andrey Efremov
ed039dc892 Support for any iterable type as input data 2024-01-11 14:25:22 +07:00
e59ddcae98 Merge pull request #79 from mgorny/wheel
Remove redundant wheel dep from pyproject.toml
2023-05-03 02:41:22 -05:00
Michał Górny
19cf5d941a Remove redundant wheel dep from pyproject.toml
Remove the redundant `wheel` dependency, as it is added by the backend
automatically.  Listing it explicitly in the documentation was
a historical mistake and has been fixed since, see:
f7d30a9529
2023-04-27 18:12:32 +02:00
0244f53e2e fix(build): Fix syntax in setup.cfg, add python 3.11 2023-04-27 00:28:59 -05:00
1625d56345 Update version & changelog for 1.8.2 2023-04-27 00:22:55 -05:00
63e770d29e Merge pull request #78 from arsenetar/as/fix-ci
fix(ci): Update to latest actions, fix python versions
2023-04-27 00:03:55 -05:00
bfd3e08661 fix(ci): Update to latest actions, fix python versions
- Update to latest actions
- Change OS for older python 3.6, 3.5 to run
2023-04-26 23:54:52 -05:00
490fe02245 Merge pull request #73 from sobolevn/patch-1
TravisCI is not used anymore
2023-04-26 23:54:24 -05:00
d6d904c774 Merge pull request #77 from BoboTiG/patch-1
win/legacy: tiny logic simplification
2023-04-26 23:36:39 -05:00
Mickaël Schoentgen
0a36688a4b win/legacy: tiny logic simplification 2023-04-02 17:08:25 +02:00
Nikita Sobolev
955f8091da TravisCI is not used anymore 2022-10-11 23:57:46 +03:00
0ef9b3294a fix(tests): Correct windows tests to run on python <3.6 2022-07-26 22:51:16 -05:00
4b9bc4bc31 fix(win): Prevent exception on empty list
Add check for when an empty list remains after preprocessing and do
not continue for both legacy and modern windows implementations.

Fix #71
2022-07-26 22:42:30 -05:00
be402728fb Update setup.cfg for changes in d37197c, fix #68. 2022-06-01 02:06:14 -05:00
448224954b Replace relative imports with absolute 2022-06-01 00:22:46 -05:00
d37197c4f7 Move mac/win to subpackages & fix #64
- Move macOS and Windows implementations to sub packagese to improve organization
- Fix #64 in legacy windows implementation by mapping results to standard error codes
2022-04-30 19:52:09 -05:00
2a88b82104 Fix test_plat_other from previous change 2021-08-24 01:21:12 -05:00
18e51c0b5a Minor cleanup in plat_other
- Add OSError code values
- Use INFO_SUFFIX constant in tests
- Remove old PathLike conversions
2021-08-24 01:00:02 -05:00
7686647389 Fix flake8 error 2021-08-21 16:04:05 -05:00
696aed558b Change method for test symlink path generation 2021-08-21 16:00:50 -05:00
007d84361a Fix items missed in test_plat_other in last commit 2021-08-21 15:22:59 -05:00
78a536abba Minor code quality updates 2021-08-21 15:19:32 -05:00
26 changed files with 541 additions and 590 deletions

View File

@@ -1,14 +1,3 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"
on:
@@ -18,7 +7,7 @@ on:
# The branches below must be a subset of the branches above
branches: [master]
schedule:
- cron: '25 5 * * 4'
- cron: "25 5 * * 4"
jobs:
analyze:
@@ -32,40 +21,15 @@ jobs:
strategy:
fail-fast: false
matrix:
language: [ 'python' ]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
# Learn more:
# https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
language: ["python"]
steps:
- name: Checkout repository
uses: actions/checkout@v2
# Initializes the CodeQL tools for scanning.
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
uses: github/codeql-action/init@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # v4.31.9
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v1
# Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language
#- run: |
# make bootstrap
# make release
uses: github/codeql-action/autobuild@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # v4.31.9
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1
uses: github/codeql-action/analyze@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # v4.31.9

View File

@@ -2,19 +2,15 @@
name: Default CI/CD
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
on: push
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
- name: Set up Python 3.x
uses: actions/setup-python@v2
uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0
with:
python-version: 3.x
- name: Install dependencies
@@ -31,36 +27,32 @@ jobs:
matrix:
include:
- os: ubuntu-latest
python-version: 3.10.0-alpha - 3.10.0
python-version: 3.14
- os: ubuntu-latest
python-version: 3.13
- os: ubuntu-latest
python-version: 3.12
- os: ubuntu-latest
python-version: 3.11
- os: ubuntu-latest
python-version: "3.10"
- os: ubuntu-latest
python-version: 3.9
- os: ubuntu-latest
python-version: 3.8
- os: ubuntu-latest
python-version: 3.7
- os: ubuntu-latest
python-version: 3.6
- os: ubuntu-latest
python-version: 3.5
- os: ubuntu-latest
python-version: 2.7
# - os: macos-latest
# python-version: 3.9
# - os: macos-latest
# python-version: 3.8
# - os: macos-latest
# python-version: 2.7
- os: windows-latest
- os: macos-latest
python-version: 3.14
- os: macos-latest
python-version: 3.9
- os: windows-latest
python-version: 3.8
python-version: 3.14
- os: windows-latest
python-version: 2.7
python-version: 3.8
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies

View File

@@ -1,19 +0,0 @@
language: python
matrix:
include:
- python: "2.7"
arch: ppc64le
- python: "3.6"
arch: ppc64le
- python: "3.7"
arch: ppc64le
- python: "3.8"
arch: ppc64le
- python: "3.9"
arch: ppc64le
install:
- python -m pip install tox
before_script:
- export TOXENV=$(echo py$TRAVIS_PYTHON_VERSION | tr -d .)
script:
- python -m tox

View File

@@ -1,9 +1,26 @@
Changes
=======
Version 2.0.0 -- 2025/12/30
---------------------------
* Drop suport for Python 2
* Fix `test_trash_topdir` failing on macOS by @denini08 in https://github.com/arsenetar/send2trash/pull/100
* Update source installation instructions by @gunSlaveUnit in https://github.com/arsenetar/send2trash/pull/102
* Update gio implemenation, should fix #5 by no longer using deprecated GObject.GError
Version 1.8.3 -- 2024/04/06
---------------------------
* Add support for any iterable type as input by @PalmtopTiger in https://github.com/arsenetar/send2trash/pull/88
* fix: Use os.fsdecode() for arguments to shutil.move() by @yogeshiitm in https://github.com/arsenetar/send2trash/pull/90
Version 1.8.2 -- 2023/04/27
---------------------------
* win/legacy: tiny logic simplification by @BoboTiG in https://github.com/arsenetar/send2trash/pull/77
* TravisCI is not used anymore by @sobolevn in https://github.com/arsenetar/send2trash/pull/73
* fix(ci): Update to latest actions, fix python versions by @arsenetar in https://github.com/arsenetar/send2trash/pull/78
Version 1.8.1b0 -- 2021/09/20
-----------------------------
* Add fallback to HOMETRASH when cross device errors happen in plat_other (#26, $41, #63)
* Add fallback to HOMETRASH when cross device errors happen in plat_other (#26, #41, #63)
Version 1.8.0 -- 2021/08/08
---------------------------

View File

@@ -11,7 +11,7 @@ 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).
Send2Trash supports Python 3 (versions before 2.x support Python 2).
Status: Additional Help Welcome
-------------------------------
@@ -30,9 +30,23 @@ To install with pywin32 or pyobjc required specify the extra `nativeLib`:
python -m pip install -U send2trash[nativeLib]
or you can download the source from http://github.com/arsenetar/send2trash and install it with::
or download the source from https://github.com/arsenetar/send2trash and install it with:
>>> python setup.py install
python -m pip install -e .
On systems where Python enforces PEP 668 (e.g., recent Linux distributions),
installing packages into the system Python may be restricted.
Use a virtual environment:
python -m venv .venv
GNU/Linux / macOS:
source .venv/bin/activate
Windows:
.venv\Scripts\activate
Usage
-----
@@ -44,7 +58,7 @@ Usage
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
``PermissionError``. 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.

View File

@@ -1,5 +1,5 @@
[build-system]
requires = ["setuptools >= 40.6.0", "wheel"]
requires = ["setuptools >= 75.3.1"]
build-backend = "setuptools.build_meta"
[tool.black]

View File

@@ -6,16 +6,19 @@
import sys
from .exceptions import TrashPermissionError # noqa: F401
from send2trash.exceptions import TrashPermissionError # noqa: F401
if sys.version_info[0] < 3:
raise RuntimeError("send2trash is only compatible with Python 3 and above (use versions <= 1.8.3 for python 2).")
if sys.platform == "darwin":
from .plat_osx import send2trash
from send2trash.mac import send2trash
elif sys.platform == "win32":
from .plat_win import send2trash
from send2trash.win import send2trash
else:
try:
# If we can use gio, let's use it
from .plat_gio import send2trash
from send2trash.plat_gio import send2trash
except ImportError:
# Oh well, let's fallback to our own Freedesktop trash implementation
from .plat_other import send2trash # noqa: F401
from send2trash.plat_other import send2trash # noqa: F401

View File

@@ -12,6 +12,9 @@ import sys
from argparse import ArgumentParser
from send2trash import send2trash
if sys.version_info[0] < 3:
raise RuntimeError("send2trash is only compatible with Python 3 and above (use versions <= 1.8.3 for python 2).")
def main(args=None):
parser = ArgumentParser(description="Tool to send files to trash")

View File

@@ -1,20 +0,0 @@
# Copyright 2017 Virgil Dupras
# 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
import os
PY3 = sys.version_info[0] >= 3
if PY3:
text_type = str
binary_type = bytes
if os.supports_bytes_environ:
# environb will be unset under Windows, but then again we're not supposed to use it.
environb = os.environb
else:
text_type = unicode # noqa: F821
binary_type = str
environb = os.environ

View File

@@ -1,13 +1,7 @@
import errno
from .compat import PY3
if PY3:
_permission_error = PermissionError # noqa: F821
else:
_permission_error = OSError
class TrashPermissionError(_permission_error):
class TrashPermissionError(PermissionError):
"""A permission error specific to a trash directory.
Raising this error indicates that permissions prevent us efficiently
@@ -23,4 +17,4 @@ class TrashPermissionError(_permission_error):
"""
def __init__(self, filename):
_permission_error.__init__(self, errno.EACCES, "Permission denied", filename)
PermissionError.__init__(self, errno.EACCES, "Permission denied", filename)

View File

@@ -11,10 +11,10 @@ from sys import version_info
macos_ver = tuple(int(part) for part in mac_ver()[0].split("."))
if version_info >= (3, 6) and macos_ver >= (10, 9):
try:
from .plat_osx_pyobjc import send2trash
from send2trash.mac.modern import send2trash
except ImportError:
# Try to fall back to ctypes version, although likely problematic still
from .plat_osx_ctypes import send2trash
from send2trash.mac.legacy import send2trash
else:
# Just use the old version otherwise
from .plat_osx_ctypes import send2trash # noqa: F401
from send2trash.mac.legacy import send2trash # noqa: F401

View File

@@ -9,8 +9,7 @@ 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
from .util import preprocess_paths
from send2trash.util import preprocess_paths
Foundation = cdll.LoadLibrary(find_library("Foundation"))
CoreServices = cdll.LoadLibrary(find_library("CoreServices"))
@@ -42,7 +41,7 @@ def check_op_result(op_result):
def send2trash(paths):
paths = preprocess_paths(paths)
paths = [path.encode("utf-8") if not isinstance(path, binary_type) else path for path in paths]
paths = [path.encode("utf-8") if not isinstance(path, bytes) else path for path in paths]
for path in paths:
fp = FSRef()
opts = kFSPathMakeRefDoNotFollowLeafSymlink

View File

@@ -5,8 +5,7 @@
# http://www.hardcoded.net/licenses/bsd_license
from Foundation import NSFileManager, NSURL
from .compat import text_type
from .util import preprocess_paths
from send2trash.util import preprocess_paths
def check_op_result(op_result):
@@ -18,7 +17,7 @@ def check_op_result(op_result):
def send2trash(paths):
paths = preprocess_paths(paths)
paths = [path.decode("utf-8") if not isinstance(path, text_type) else path for path in paths]
paths = [path.decode("utf-8") if not isinstance(path, str) else path for path in paths]
for path in paths:
file_url = NSURL.fileURLWithPath_(path)
fm = NSFileManager.defaultManager()

View File

@@ -4,9 +4,9 @@
# 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
from .exceptions import TrashPermissionError
from .util import preprocess_paths
from gi.repository import Gio, GLib
from send2trash.exceptions import TrashPermissionError
from send2trash.util import preprocess_paths
def send2trash(paths):
@@ -15,9 +15,9 @@ def send2trash(paths):
try:
f = Gio.File.new_for_path(path)
f.trash(cancellable=None)
except GObject.GError as e:
except GLib.Error as e:
if e.code == Gio.IOErrorEnum.NOT_SUPPORTED:
# We get here if we can't create a trash directory on the same
# device. I don't know if other errors can result in NOT_SUPPORTED.
raise TrashPermissionError("")
raise OSError(e.message)
raise TrashPermissionError("") from e
raise OSError(e.message) from e

View File

@@ -17,58 +17,36 @@
from __future__ import unicode_literals
import errno
import sys
import os
import shutil
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
from .compat import text_type, environb
from .util import preprocess_paths
from .exceptions import TrashPermissionError
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.
from send2trash.util import preprocess_paths
from send2trash.exceptions import TrashPermissionError
FILES_DIR = b"files"
INFO_DIR = b"info"
INFO_SUFFIX = b".trashinfo"
# Default of ~/.local/share [3]
XDG_DATA_HOME = op.expanduser(environb.get(b"XDG_DATA_HOME", b"~/.local/share"))
XDG_DATA_HOME = op.expanduser(os.environb.get(b"XDG_DATA_HOME", b"~/.local/share"))
HOMETRASH_B = op.join(XDG_DATA_HOME, b"Trash")
HOMETRASH = fsdecode(HOMETRASH_B)
HOMETRASH = os.fsdecode(HOMETRASH_B)
uid = os.getuid()
TOPDIR_TRASH = b".Trash"
TOPDIR_FALLBACK = b".Trash-" + text_type(uid).encode("ascii")
TOPDIR_FALLBACK = b".Trash-" + str(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)
if isinstance(path, str):
path = os.fsencode(path)
parent = op.realpath(parent)
if isinstance(parent, text_type):
parent = fsencode(parent)
if isinstance(parent, str):
parent = os.fsencode(parent)
return path.startswith(parent)
@@ -90,34 +68,34 @@ def info_for(src, topdir):
return info
def check_create(dir):
def check_create(folder):
# use 0700 for paths [3]
if not op.exists(dir):
os.makedirs(dir, 0o700)
if not op.exists(folder):
os.makedirs(folder, 0o700)
def trash_move(src, dst, topdir=None, cross_dev=False):
filename = op.basename(src)
filespath = op.join(dst, FILES_DIR)
infopath = op.join(dst, INFO_DIR)
base_name, ext = op.splitext(filename)
file_name = op.basename(src)
files_path = op.join(dst, FILES_DIR)
info_path = op.join(dst, INFO_DIR)
base_name, ext = op.splitext(file_name)
counter = 0
destname = filename
while op.exists(op.join(filespath, destname)) or op.exists(op.join(infopath, destname + INFO_SUFFIX)):
dest_name = file_name
while op.exists(op.join(files_path, dest_name)) or op.exists(op.join(info_path, dest_name + INFO_SUFFIX)):
counter += 1
destname = base_name + b" " + text_type(counter).encode("ascii") + ext
dest_name = base_name + b" " + str(counter).encode("ascii") + ext
check_create(filespath)
check_create(infopath)
check_create(files_path)
check_create(info_path)
with open(op.join(infopath, destname + INFO_SUFFIX), "w") as f:
with open(op.join(info_path, dest_name + INFO_SUFFIX), "w") as f:
f.write(info_for(src, topdir))
destpath = op.join(filespath, destname)
dest_path = op.join(files_path, dest_name)
if cross_dev:
shutil.move(src, destpath)
shutil.move(os.fsdecode(src), os.fsdecode(dest_path))
else:
os.rename(src, destpath)
os.rename(src, dest_path)
def find_mount_point(path):
@@ -139,10 +117,10 @@ def find_ext_volume_global_trash(volume_root):
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):
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).encode("ascii"))
trash_dir = op.join(trash_dir, str(uid).encode("ascii"))
try:
check_create(trash_dir)
except OSError:
@@ -158,7 +136,7 @@ def find_ext_volume_fallback_trash(volume_root):
check_create(trash_dir)
except OSError as e:
if e.errno == errno.EACCES:
raise TrashPermissionError(e.filename)
raise TrashPermissionError(e.filename) from e
raise
return trash_dir
@@ -178,30 +156,27 @@ def get_dev(path):
def send2trash(paths):
paths = preprocess_paths(paths)
for path in paths:
if isinstance(path, text_type):
path_b = fsencode(path)
if isinstance(path, str):
path_b = os.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))
raise TypeError(f"str, bytes or PathLike expected, not {type(path)}")
if not op.exists(path_b):
raise OSError("File not found: %s" % path)
raise OSError(errno.ENOENT, f"File not found: {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_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_b)
raise OSError(errno.EACCES, f"Permission denied: {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(b"~"))
# if the file to be trashed is on the same device as HOMETRASH we
# want to move it there.
if path_dev == trash_dev:
topdir = XDG_DATA_HOME
dest_trash = HOMETRASH_B
@@ -209,7 +184,7 @@ def send2trash(paths):
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)
raise OSError(f"Couldn't find mount point for {path}")
dest_trash = find_ext_volume_trash(topdir)
try:
trash_move(path_b, dest_trash, topdir)

View File

@@ -5,10 +5,14 @@
# which should be included with this package. The terms are also available at
# http://www.hardcoded.net/licenses/bsd_license
import os
import collections.abc
def preprocess_paths(paths):
if not isinstance(paths, list):
if isinstance(paths, collections.abc.Iterable) and not isinstance(paths, (str, bytes)):
paths = list(paths)
elif not isinstance(paths, list):
paths = [paths]
# Convert items such as pathlib paths to strings
paths = [path.__fspath__() if hasattr(path, "__fspath__") else path for path in paths]
return paths
return [os.fspath(path) for path in paths]

View File

@@ -37,54 +37,10 @@ class FileOperationProgressSink(DesignatedWrapPolicy):
# 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
def PostDeleteItem(self, flags, item, hrDelete, newlyCreated):
if newlyCreated:
self.newItem = newlyCreated.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 PostDeleteItem(self, flags, item, hr_delete, newly_created):
if newly_created:
self.newItem = newly_created.GetDisplayName(shellcon.SHGDN_FORPARSING)
def CreateSink():
def create_sink():
return pythoncom.WrapObject(FileOperationProgressSink(), shell.IID_IFileOperationProgressSink)

View File

@@ -11,10 +11,10 @@ from platform import version
if int(version().split(".", 1)[0]) >= 6:
try:
# Attempt to use pywin32 to use IFileOperation
from .plat_win_modern import send2trash
from send2trash.win.modern import send2trash
except ImportError:
# use SHFileOperation as fallback
from .plat_win_legacy import send2trash
from send2trash.win.legacy import send2trash
else:
# use SHFileOperation as fallback
from .plat_win_legacy import send2trash # noqa: F401
from send2trash.win.legacy import send2trash # noqa: F401

View File

@@ -6,9 +6,6 @@
from __future__ import unicode_literals
import os.path as op
from .compat import text_type
from .util import preprocess_paths
from ctypes import (
windll,
Structure,
@@ -21,6 +18,8 @@ from ctypes import (
)
from ctypes.wintypes import HWND, UINT, LPCWSTR, BOOL
from send2trash.util import preprocess_paths
kernel32 = windll.kernel32
GetShortPathNameW = kernel32.GetShortPathNameW
@@ -53,6 +52,41 @@ FOF_ALLOWUNDO = 64
FOF_NOERRORUI = 1024
def convert_sh_file_opt_result(result):
# map overlapping values from SHFileOpterationW to approximate standard windows errors
# ref https://docs.microsoft.com/en-us/windows/win32/api/shellapi/nf-shellapi-shfileoperationw#return-value
# ref https://docs.microsoft.com/en-us/windows/win32/debug/system-error-codes--0-499-
results = {
0x71: 0x50, # DE_SAMEFILE -> ERROR_FILE_EXISTS
0x72: 0x57, # DE_MANYSRC1DEST -> ERROR_INVALID_PARAMETER
0x73: 0x57, # DE_DIFFDIR -> ERROR_INVALID_PARAMETER
0x74: 0x57, # DE_ROOTDIR -> ERROR_INVALID_PARAMETER
0x75: 0x4C7, # DE_OPCANCELLED -> ERROR_CANCELLED
0x76: 0x57, # DE_DESTSUBTREE -> ERROR_INVALID_PARAMETER
0x78: 0x05, # DE_ACCESSDENIEDSRC -> ERROR_ACCESS_DENIED
0x79: 0x6F, # DE_PATHTOODEEP -> ERROR_BUFFER_OVERFLOW
0x7A: 0x57, # DE_MANYDEST -> ERROR_INVALID_PARAMETER
0x7C: 0xA1, # DE_INVALIDFILES -> ERROR_BAD_PATHNAME
0x7D: 0x57, # DE_DESTSAMETREE -> ERROR_INVALID_PARAMETER
0x7E: 0xB7, # DE_FLDDESTISFILE -> ERROR_ALREADY_EXISTS
0x80: 0xB7, # DE_FILEDESTISFLD -> ERROR_ALREADY_EXISTS
0x81: 0x6F, # DE_FILENAMETOOLONG -> ERROR_BUFFER_OVERFLOW
0x82: 0x13, # DE_DEST_IS_CDROM -> ERROR_WRITE_PROTECT
0x83: 0x13, # DE_DEST_IS_DVD -> ERROR_WRITE_PROTECT
0x84: 0x6F9, # DE_DEST_IS_CDRECORD -> ERROR_UNRECOGNIZED_MEDIA
0x85: 0xDF, # DE_FILE_TOO_LARGE -> ERROR_FILE_TOO_LARGE
0x86: 0x13, # DE_SRC_IS_CDROM -> ERROR_WRITE_PROTECT
0x87: 0x13, # DE_SRC_IS_DVD -> ERROR_WRITE_PROTECT
0x88: 0x6F9, # DE_SRC_IS_CDRECORD -> ERROR_UNRECOGNIZED_MEDIA
0xB7: 0x6F, # DE_ERROR_MAX -> ERROR_BUFFER_OVERFLOW
0x402: 0xA1, # UNKNOWN -> ERROR_BAD_PATHNAME
0x10000: 0x1D, # ERRORONDEST -> ERROR_WRITE_FAULT
0x10074: 0x57, # DE_ROOTDIR | ERRORONDEST -> ERROR_INVALID_PARAMETER
}
return results.get(result, result)
def prefix_and_path(path):
r"""Guess the long-path prefix based on the kind of *path*.
Local paths (C:\folder\file.ext) and UNC names (\\server\folder\file.ext)
@@ -104,8 +138,10 @@ def get_short_path_name(long_name):
def send2trash(paths):
paths = preprocess_paths(paths)
if not paths:
return
# convert data type
paths = [text_type(path, "mbcs") if not isinstance(path, text_type) else path for path in paths]
paths = [str(path, "mbcs") if not isinstance(path, str) else path for path in paths]
# convert to full paths
paths = [op.abspath(path) if not op.isabs(path) else path for path in paths]
# get short path to handle path length issues
@@ -141,4 +177,5 @@ def send2trash(paths):
fileop.lpszProgressTitle = None
result = SHFileOperationW(byref(fileop))
if result:
raise WindowsError(result, FormatError(result), paths)
error = convert_sh_file_opt_result(result)
raise WindowsError(None, FormatError(error), paths, error)

View File

@@ -6,19 +6,20 @@
from __future__ import unicode_literals
import os.path as op
from .compat import text_type
from .util import preprocess_paths
from platform import version
import pythoncom
import pywintypes
from win32com.shell import shell, shellcon
from .IFileOperationProgressSink import CreateSink
from send2trash.util import preprocess_paths
from send2trash.win.IFileOperationProgressSink import create_sink
def send2trash(paths):
paths = preprocess_paths(paths)
if not paths:
return
# convert data type
paths = [text_type(path, "mbcs") if not isinstance(path, text_type) else path for path in paths]
paths = [str(path, "mbcs") if not isinstance(path, str) else path for path in paths]
# convert to full paths
paths = [op.abspath(path) if not op.isabs(path) else path for path in paths]
# remove the leading \\?\ if present
@@ -27,7 +28,10 @@ def send2trash(paths):
pythoncom.CoInitialize()
# create instance of file operation object
fileop = pythoncom.CoCreateInstance(
shell.CLSID_FileOperation, None, pythoncom.CLSCTX_ALL, shell.IID_IFileOperation,
shell.CLSID_FileOperation,
None,
pythoncom.CLSCTX_ALL,
shell.IID_IFileOperation,
)
# default flags to use
flags = shellcon.FOF_NOCONFIRMATION | shellcon.FOF_NOERRORUI | shellcon.FOF_SILENT | shellcon.FOFX_EARLYFAILURE
@@ -42,7 +46,7 @@ def send2trash(paths):
# actually try to perform the operation, this section may throw a
# pywintypes.com_error which does not seem to create as nice of an
# error as OSError so wrapping with try to convert
sink = CreateSink()
sink = create_sink()
try:
for path in paths:
item = shell.SHCreateItemFromParsingName(path, None, shell.IID_IShellItem)
@@ -55,7 +59,7 @@ def send2trash(paths):
except pywintypes.com_error as error:
# convert to standard OS error, allows other code to get a
# normal errno
raise OSError(None, error.strerror, path, error.hresult)
raise OSError(None, error.strerror, path, error.hresult) from error
finally:
# Need to make sure we call this once fore every init
pythoncom.CoUninitialize()

View File

@@ -1,6 +1,6 @@
[metadata]
name = Send2Trash
version = 1.8.1b0
version = 2.0.0
url = https://github.com/arsenetar/send2trash
project_urls =
Bug Reports = https://github.com/arsenetar/send2trash/issues
@@ -18,24 +18,30 @@ classifiers =
Operating System :: MacOS :: MacOS X
Operating System :: Microsoft :: Windows
Operating System :: POSIX
Programming Language :: Python :: 2.7
Programming Language :: Python :: 3
Programming Language :: Python :: 3.5
Programming Language :: Python :: 3.6
Programming Language :: Python :: 3.7
Programming Language :: Python :: 3.8
Programming Language :: Python :: 3.9
Programming Language :: Python :: 3.10
Programming Language :: Python :: 3.11
Programming Language :: Python :: 3.12
Programming Language :: Python :: 3.13
Programming Language :: Python :: 3.14
Topic :: Desktop Environment :: File Managers
[options]
packages = send2trash
packages = find:
tests_require = pytest
python_requires = >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
python_requires = !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*
[options.packages.find]
include=
send2trash*
[options.extras_require]
win32 = pywin32; sys_platform == "win32"
objc = pyobjc-framework-Cocoa; sys_platform == "darwin"
win32 =
pywin32; sys_platform == "win32"
objc =
pyobjc-framework-Cocoa; sys_platform == "darwin"
nativeLib =
pywin32; sys_platform == "win32"
pyobjc-framework-Cocoa; sys_platform == "darwin"

27
tests/conftest.py Normal file
View File

@@ -0,0 +1,27 @@
# encoding: utf-8
import sys
import os
from tempfile import NamedTemporaryFile
import pytest
# Only import HOMETRASH on supported platforms
if sys.platform != "win32":
from send2trash.plat_other import HOMETRASH
@pytest.fixture(name="test_file")
def fixture_test_file():
file = NamedTemporaryFile(dir=os.path.expanduser("~"), prefix="send2trash_test", delete=False)
file.close()
# Verify file was actually created
assert os.path.exists(file.name) is True
yield file.name
# Cleanup trash files on supported platforms
if sys.platform != "win32":
name = os.path.basename(file.name)
# Remove trash files if they exist
if os.path.exists(os.path.join(HOMETRASH, "files", name)):
os.remove(os.path.join(HOMETRASH, "files", name))
os.remove(os.path.join(HOMETRASH, "info", name + ".trashinfo"))
if os.path.exists(file.name):
os.remove(file.name)

View File

@@ -1,79 +1,62 @@
# encoding: utf-8
import pytest
import codecs
import os
import sys
from os import path as op
from send2trash.compat import PY3
from send2trash import TrashPermissionError
try:
from configparser import ConfigParser
except ImportError:
# py2
from ConfigParser import ConfigParser # noqa: F401
from tempfile import mkdtemp, NamedTemporaryFile, mktemp
from tempfile import mkdtemp, NamedTemporaryFile
import shutil
import stat
import uuid
from configparser import ConfigParser
import pytest
from send2trash import TrashPermissionError
if sys.platform != "win32":
if sys.platform == "win32":
pytest.skip("Skipping non-windows tests", allow_module_level=True)
else:
import send2trash.plat_other
from send2trash.plat_other import send2trash as s2t
from send2trash.plat_other import is_parent
INFO_SUFFIX = send2trash.plat_other.INFO_SUFFIX.decode()
HOMETRASH = send2trash.plat_other.HOMETRASH
else:
pytest.skip("Skipping non-windows tests", allow_module_level=True)
@pytest.fixture
def testfile():
file = NamedTemporaryFile(dir=op.expanduser("~"), prefix="send2trash_test", delete=False)
file.close()
assert op.exists(file.name) is True
yield file
# Cleanup trash files on supported platforms
if sys.platform != "win32":
name = op.basename(file.name)
# Remove trash files if they exist
if op.exists(op.join(HOMETRASH, "files", name)):
os.remove(op.join(HOMETRASH, "files", name))
os.remove(op.join(HOMETRASH, "info", name + ".trashinfo"))
if op.exists(file.name):
os.remove(file.name)
@pytest.fixture
def testfiles():
@pytest.fixture(name="test_files")
def fixture_test_files():
files = list(
map(
lambda index: NamedTemporaryFile(
dir=op.expanduser("~"), prefix="send2trash_test{}".format(index), delete=False,
dir=op.expanduser("~"),
prefix=f"send2trash_test{index}",
delete=False,
),
range(10),
)
)
[file.close() for file in files]
assert all([op.exists(file.name) for file in files]) is True
for file in files:
file.close()
assert all(op.exists(file.name) for file in files) is True
yield files
filenames = [op.basename(file.name) for file in files]
[os.remove(op.join(HOMETRASH, "files", filename)) for filename in filenames]
[os.remove(op.join(HOMETRASH, "info", filename + ".trashinfo")) for filename in filenames]
for filename in filenames:
os.remove(op.join(HOMETRASH, "files", filename))
os.remove(op.join(HOMETRASH, "info", filename + INFO_SUFFIX))
def test_trash(testfile):
s2t(testfile.name)
assert op.exists(testfile.name) is False
def test_trash(test_file):
s2t(test_file)
assert op.exists(test_file) is False
def test_multitrash(testfiles):
filenames = [file.name for file in testfiles]
s2t(filenames)
assert any([op.exists(filename) for filename in filenames]) is False
def test_multitrash(test_files):
file_names = [file.name for file in test_files]
s2t(file_names)
assert any(op.exists(filename) for filename in file_names) is False
def touch(path):
with open(path, "a"):
with open(path, "a", encoding="utf-8"):
os.utime(path, None)
@@ -83,53 +66,49 @@ def _filesys_enc():
return codecs.lookup(enc).name
@pytest.fixture
def testUnicodefile():
name = u"send2trash_tést1"
@pytest.fixture(name="gen_unicode_file")
def fixture_gen_unicode_file():
name = "send2trash_tést1"
file = op.join(op.expanduser(b"~"), name.encode("utf-8"))
touch(file)
assert op.exists(file) is True
yield file
# Cleanup trash files on supported platforms
if sys.platform != "win32":
# Remove trash files if they exist
if op.exists(op.join(HOMETRASH, "files", name)):
if sys.platform != "win32" and op.exists(op.join(HOMETRASH, "files", name)):
os.remove(op.join(HOMETRASH, "files", name))
os.remove(op.join(HOMETRASH, "info", name + ".trashinfo"))
os.remove(op.join(HOMETRASH, "info", name + INFO_SUFFIX))
if op.exists(file):
os.remove(file)
@pytest.mark.skipif(_filesys_enc() == "ascii", reason="Requires Unicode filesystem")
def test_trash_bytes(testUnicodefile):
s2t(testUnicodefile)
assert not op.exists(testUnicodefile)
def test_trash_bytes(gen_unicode_file):
s2t(gen_unicode_file)
assert not op.exists(gen_unicode_file)
@pytest.mark.skipif(_filesys_enc() == "ascii", reason="Requires Unicode filesystem")
def test_trash_unicode(testUnicodefile):
s2t(testUnicodefile.decode(sys.getfilesystemencoding()))
assert not op.exists(testUnicodefile)
def test_trash_unicode(gen_unicode_file):
s2t(gen_unicode_file.decode(sys.getfilesystemencoding()))
assert not op.exists(gen_unicode_file)
class ExtVol:
def __init__(self, path):
self.trashTopdir = path
if PY3:
self.trashTopdir_b = os.fsencode(self.trashTopdir)
else:
self.trashTopdir_b = self.trashTopdir
self.trash_topdir = path
self.trash_topdir_b = os.fsencode(self.trash_topdir)
def s_getdev(path):
from send2trash.plat_other import is_parent
st = os.lstat(path)
if is_parent(self.trashTopdir, path):
if is_parent(self.trash_topdir, path):
return "dev"
return st.st_dev
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 old_ismount(path)
@@ -141,58 +120,91 @@ class ExtVol:
def cleanup(self):
send2trash.plat_other.get_dev = self.old_getdev
send2trash.plat_other.os.path.ismount = self.old_ismount
shutil.rmtree(self.trashTopdir)
shutil.rmtree(self.trash_topdir)
@pytest.fixture
def testExtVol():
trashTopdir = mkdtemp(prefix="s2t")
volume = ExtVol(trashTopdir)
fileName = "test.txt"
filePath = op.join(volume.trashTopdir, fileName)
touch(filePath)
assert op.exists(filePath) is True
yield volume, fileName, filePath
@pytest.fixture(name="gen_ext_vol")
def fixture_gen_ext_vol():
trash_topdir = mkdtemp(prefix="s2t")
volume = ExtVol(trash_topdir)
file_name = "test.txt"
file_path = op.join(volume.trash_topdir, file_name)
touch(file_path)
assert op.exists(file_path) is True
yield volume, file_name, file_path
volume.cleanup()
def test_trash_topdir(testExtVol):
trashDir = op.join(testExtVol[0].trashTopdir, ".Trash")
os.mkdir(trashDir, 0o777 | stat.S_ISVTX)
def test_trash_topdir(gen_ext_vol):
trash_dir = op.join(gen_ext_vol[0].trash_topdir, ".Trash")
os.mkdir(trash_dir, 0o777 | stat.S_ISVTX)
s2t(gen_ext_vol[2])
assert op.exists(gen_ext_vol[2]) is False
if sys.platform == "darwin":
# On macOS, we can only verify the file was removed from original location
pass
else:
# Others platforms we can test
assert op.exists(op.join(trash_dir, str(os.getuid()), "files", gen_ext_vol[1])) is True
assert (
op.exists(
op.join(
trash_dir,
str(os.getuid()),
"info",
gen_ext_vol[1] + INFO_SUFFIX,
)
)
is True
)
s2t(testExtVol[2])
assert op.exists(testExtVol[2]) is False
assert op.exists(op.join(trashDir, str(os.getuid()), "files", testExtVol[1])) is True
assert op.exists(op.join(trashDir, str(os.getuid()), "info", testExtVol[1] + ".trashinfo",)) is True
# info relative path (if another test is added, with the same fileName/Path,
# then it gets renamed etc.)
cfg = ConfigParser()
cfg.read(op.join(trashDir, str(os.getuid()), "info", testExtVol[1] + ".trashinfo"))
assert (testExtVol[1] == cfg.get("Trash Info", "Path", raw=True)) is True
cfg.read(op.join(trash_dir, str(os.getuid()), "info", gen_ext_vol[1] + INFO_SUFFIX))
assert (gen_ext_vol[1] == cfg.get("Trash Info", "Path", raw=True)) is True
def test_trash_topdir_fallback(testExtVol):
s2t(testExtVol[2])
assert op.exists(testExtVol[2]) is False
assert op.exists(op.join(testExtVol[0].trashTopdir, ".Trash-" + str(os.getuid()), "files", testExtVol[1],)) is True
def test_trash_topdir_fallback(gen_ext_vol):
s2t(gen_ext_vol[2])
assert op.exists(gen_ext_vol[2]) is False
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):
os.chmod(testExtVol[0].trashTopdir, 0o500) # not writable to induce the exception
pytest.raises(TrashPermissionError, s2t, [testExtVol[2]])
os.chmod(testExtVol[0].trashTopdir, 0o700) # writable to allow deletion
def test_trash_topdir_failure(gen_ext_vol):
os.chmod(gen_ext_vol[0].trash_topdir, 0o500) # not writable to induce the exception
pytest.raises(TrashPermissionError, s2t, [gen_ext_vol[2]])
os.chmod(gen_ext_vol[0].trash_topdir, 0o700) # writable to allow deletion
def test_trash_symlink(testExtVol):
# Use mktemp (race conditioney but no symlink equivalent)
# Since is_parent uses realpath(), and our getdev uses is_parent,
# this should work
slDir = mktemp(prefix="s2t", dir=op.expanduser("~"))
os.mkdir(op.join(testExtVol[0].trashTopdir, "subdir"), 0o700)
filePath = op.join(testExtVol[0].trashTopdir, "subdir", testExtVol[1])
touch(filePath)
os.symlink(op.join(testExtVol[0].trashTopdir, "subdir"), slDir)
s2t(op.join(slDir, testExtVol[1]))
assert op.exists(filePath) is False
assert op.exists(op.join(testExtVol[0].trashTopdir, ".Trash-" + str(os.getuid()), "files", testExtVol[1],)) is True
os.remove(slDir)
def test_trash_symlink(gen_ext_vol):
# Generating a random uuid named path for symlink
sl_dir = op.join(op.expanduser("~"), "s2t_" + str(uuid.uuid4()))
os.mkdir(op.join(gen_ext_vol[0].trash_topdir, "subdir"), 0o700)
file_path = op.join(gen_ext_vol[0].trash_topdir, "subdir", gen_ext_vol[1])
touch(file_path)
os.symlink(op.join(gen_ext_vol[0].trash_topdir, "subdir"), sl_dir)
s2t(op.join(sl_dir, gen_ext_vol[1]))
assert op.exists(file_path) is False
assert (
op.exists(
op.join(
gen_ext_vol[0].trash_topdir,
".Trash-" + str(os.getuid()),
"files",
gen_ext_vol[1],
)
)
is True
)
os.remove(sl_dir)

View File

@@ -2,56 +2,98 @@
import os
import shutil
import sys
import pytest
from os import path as op
import pytest
from send2trash import send2trash as s2t
# import the two versions as well as the "automatic" version
if sys.platform == "win32":
from send2trash.plat_win_modern import send2trash as s2t_modern
from send2trash.plat_win_legacy import send2trash as s2t_legacy
else:
s2t_modern = None
s2t_legacy = None
if sys.platform != "win32":
pytest.skip("Skipping windows-only tests", allow_module_level=True)
else:
# import the two versions as well as the "automatic" version
from send2trash.win.modern import send2trash as s2t_modern
from send2trash.win.legacy import send2trash as s2t_legacy
if s2t_modern is None:
pytest.fail("Modern send2trash not available")
if s2t_legacy is None:
pytest.fail("Legacy send2trash not available")
def _create_tree(path):
dirname = op.dirname(path)
if not op.isdir(dirname):
os.makedirs(dirname)
with open(path, "w") as writer:
dir_name = op.dirname(path)
if not op.isdir(dir_name):
os.makedirs(dir_name)
with open(path, "w", encoding="utf-8") as writer:
writer.write("send2trash test")
@pytest.fixture
def testdir(tmp_path):
dirname = "\\\\?\\" + str(tmp_path)
assert op.exists(dirname) is True
yield dirname
shutil.rmtree(dirname, ignore_errors=True)
@pytest.fixture(name="test_dir")
def fixture_test_dir(tmp_path):
dir_name = "\\\\?\\" + str(tmp_path)
assert op.exists(dir_name) is True
yield dir_name
shutil.rmtree(dir_name, ignore_errors=True)
@pytest.fixture
def testfile(testdir):
file = op.join(testdir, "testfile.txt")
@pytest.fixture(name="test_file")
def fixture_test_file(test_dir):
file = op.join(test_dir, "testfile.txt")
_create_tree(file)
assert op.exists(file) is True
yield file
# Note dir will cleanup the file
@pytest.fixture
def testfiles(testdir):
files = [op.join(testdir, "testfile{}.txt".format(index)) for index in range(10)]
[_create_tree(file) for file in files]
assert all([op.exists(file) for file in files]) is True
@pytest.fixture(name="test_files")
def fixture_test_files(test_dir):
files = [op.join(test_dir, f"testfile{index}.txt") for index in range(10)]
for file in files:
_create_tree(file)
assert all(op.exists(file) for file in files) is True
yield files
# Note dir will cleanup the files
def _trash_folder(dir, fcn):
fcn(dir)
assert op.exists(dir) is False
# Long path tests
@pytest.fixture(name="long_dir")
def fixture_long_dir(tmp_path):
dir_name = "\\\\?\\" + str(tmp_path)
name = "A" * 100
yield op.join(dir_name, name, name, name)
try:
shutil.rmtree(dir_name, ignore_errors=True)
except TypeError:
pass
@pytest.fixture(name="long_file")
def fixture_long_file(long_dir):
name = "A" * 100
path = op.join(long_dir, name + "{}.txt")
file = path.format("")
_create_tree(file)
assert op.exists(file) is True
yield file
@pytest.fixture(name="long_files")
def fixture_long_files(long_dir):
name = "A" * 100
path = op.join(long_dir, name + "{}.txt")
files = [path.format(index) for index in range(10)]
for file in files:
_create_tree(file)
assert all(op.exists(file) for file in files) is True
yield files
def _trash_folder(folder, fcn):
fcn(folder)
assert op.exists(folder) is False
def _trash_file(file, fcn):
@@ -61,146 +103,113 @@ def _trash_file(file, fcn):
def _trash_multifile(files, fcn):
fcn(files)
assert any([op.exists(file) for file in files]) is False
assert any(op.exists(file) for file in files) is False
def _file_not_found(dir, fcn):
file = op.join(dir, "otherfile.txt")
def _file_not_found(folder, fcn):
file = op.join(folder, "otherfile.txt")
pytest.raises(OSError, fcn, file)
def _multi_byte_unicode(dir, fcn):
single_file = op.join(dir, "😇.txt")
def _multi_byte_unicode(folder, fcn):
single_file = op.join(folder, "😇.txt")
_create_tree(single_file)
assert op.exists(single_file) is True
fcn(single_file)
assert op.exists(single_file) is False
files = [op.join(dir, "😇{}.txt".format(index)) for index in range(10)]
[_create_tree(file) for file in files]
assert all([op.exists(file) for file in files]) is True
fcn(files)
assert any([op.exists(file) for file in files]) is False
def test_trash_folder(testdir):
_trash_folder(testdir, s2t)
def test_trash_file(testfile):
_trash_file(testfile, s2t)
def test_trash_multifile(testfiles):
_trash_multifile(testfiles, s2t)
def test_file_not_found(testdir):
_file_not_found(testdir, s2t)
def test_trash_folder_modern(testdir):
_trash_folder(testdir, s2t_modern)
def test_trash_file_modern(testfile):
_trash_file(testfile, s2t_modern)
def test_trash_multifile_modern(testfiles):
_trash_multifile(testfiles, s2t_modern)
def test_file_not_found_modern(testdir):
_file_not_found(testdir, s2t_modern)
def test_multi_byte_unicode_modern(testdir):
_multi_byte_unicode(testdir, s2t_modern)
def test_trash_folder_legacy(testdir):
_trash_folder(testdir, s2t_legacy)
def test_trash_file_legacy(testfile):
_trash_file(testfile, s2t_legacy)
def test_trash_multifile_legacy(testfiles):
_trash_multifile(testfiles, s2t_legacy)
def test_file_not_found_legacy(testdir):
_file_not_found(testdir, s2t_legacy)
def test_multi_byte_unicode_legacy(testdir):
_multi_byte_unicode(testdir, s2t_legacy)
# Long path tests
@pytest.fixture
def longdir(tmp_path):
dirname = "\\\\?\\" + str(tmp_path)
name = "A" * 100
yield op.join(dirname, name, name, name)
try:
shutil.rmtree(dirname, ignore_errors=True)
except TypeError:
pass
@pytest.fixture
def longfile(longdir):
name = "A" * 100
path = op.join(longdir, name + "{}.txt")
file = path.format("")
files = [op.join(folder, f"😇{index}.txt") for index in range(10)]
for file in files:
_create_tree(file)
assert op.exists(file) is True
yield file
assert all(op.exists(file) for file in files) is True
fcn(files)
assert any(op.exists(file) for file in files) is False
@pytest.fixture
def longfiles(longdir):
name = "A" * 100
path = op.join(longdir, name + "{}.txt")
files = [path.format(index) for index in range(10)]
[_create_tree(file) for file in files]
assert all([op.exists(file) for file in files]) is True
yield files
def test_trash_folder(test_dir):
_trash_folder(test_dir, s2t)
def test_trash_file(test_file):
_trash_file(test_file, s2t)
def test_trash_multifile(test_files):
_trash_multifile(test_files, s2t)
def test_file_not_found(test_dir):
_file_not_found(test_dir, s2t)
def test_trash_folder_modern(test_dir):
_trash_folder(test_dir, s2t_modern)
def test_trash_file_modern(test_file):
_trash_file(test_file, s2t_modern)
def test_trash_multifile_modern(test_files):
_trash_multifile(test_files, s2t_modern)
def test_file_not_found_modern(test_dir):
_file_not_found(test_dir, s2t_modern)
def test_multi_byte_unicode_modern(test_dir):
_multi_byte_unicode(test_dir, s2t_modern)
# NOTE: both legacy and modern test "pass" on windows, however sometimes with the same path
# they do not actually recycle files but delete them. Noticed this when testing with the
# recycle bin open, noticed later tests actually worked, modern version can actually detect
# when this happens but not stop it at this moment, and we need a way to verify it when testing.
def test_trash_long_file_modern(longfile):
_trash_file(longfile, s2t_modern)
def test_trash_long_file_modern(long_file):
_trash_file(long_file, s2t_modern)
def test_trash_long_multifile_modern(longfiles):
_trash_multifile(longfiles, s2t_modern)
def test_trash_long_multifile_modern(long_files):
_trash_multifile(long_files, s2t_modern)
# @pytest.skipif(
# op.splitdrive(os.getcwd())[0] != op.splitdrive(gettempdir())[0],
# "Cannot trash long path from other drive",
# )
# def test_trash_long_folder_modern(self):
# self._trash_folder(s2t_modern)
def test_trash_nothing_modern():
try:
s2t_modern([])
except Exception as ex:
assert False, f"Exception thrown when trashing nothing: {ex}"
def test_trash_long_file_legacy(longfile):
_trash_file(longfile, s2t_legacy)
def test_trash_folder_legacy(test_dir):
_trash_folder(test_dir, s2t_legacy)
def test_trash_long_multifile_legacy(longfiles):
_trash_multifile(longfiles, s2t_legacy)
def test_trash_file_legacy(test_file):
_trash_file(test_file, s2t_legacy)
# @pytest.skipif(
# op.splitdrive(os.getcwd())[0] != op.splitdrive(gettempdir())[0],
# "Cannot trash long path from other drive",
# )
# def test_trash_long_folder_legacy(self):
# self._trash_folder(s2t_legacy)
def test_trash_multifile_legacy(test_files):
_trash_multifile(test_files, s2t_legacy)
def test_file_not_found_legacy(test_dir):
_file_not_found(test_dir, s2t_legacy)
def test_multi_byte_unicode_legacy(test_dir):
_multi_byte_unicode(test_dir, s2t_legacy)
def test_trash_long_file_legacy(long_file):
_trash_file(long_file, s2t_legacy)
def test_trash_long_multifile_legacy(long_files):
_trash_multifile(long_files, s2t_legacy)
def test_trash_nothing_legacy():
try:
s2t_legacy([])
except Exception as ex:
assert False, f"Exception thrown when trashing nothing: {ex}"

View File

@@ -1,41 +1,16 @@
# encoding: utf-8
import os
import sys
import pytest
from tempfile import NamedTemporaryFile
from os import path as op
import pytest
from send2trash.__main__ import main as trash_main
# Only import HOMETRASH on supported platforms
if sys.platform != "win32":
from send2trash.plat_other import HOMETRASH
def test_trash(test_file):
trash_main(["-v", test_file])
assert op.exists(test_file) is False
@pytest.fixture
def file():
file = NamedTemporaryFile(dir=op.expanduser("~"), prefix="send2trash_test", delete=False)
file.close()
# Verify file was actually created
assert op.exists(file.name) is True
yield file.name
# Cleanup trash files on supported platforms
if sys.platform != "win32":
name = op.basename(file.name)
# Remove trash files if they exist
if op.exists(op.join(HOMETRASH, "files", name)):
os.remove(op.join(HOMETRASH, "files", name))
os.remove(op.join(HOMETRASH, "info", name + ".trashinfo"))
if op.exists(file.name):
os.remove(file.name)
def test_trash(file):
trash_main(["-v", file])
assert op.exists(file) is False
def test_no_args(file):
def test_no_args(test_file):
pytest.raises(SystemExit, trash_main, [])
pytest.raises(SystemExit, trash_main, ["-v"])
assert op.exists(file) is True
assert op.exists(test_file) is True

View File

@@ -1,5 +1,5 @@
[tox]
envlist = py{27,34,35,36,37,38,39,310}
envlist = py{38,39,310,311,312,313,314}
skip_missing_interpreters = True
isolated_build = True