Python wrapper for using Win32's IFileOperation for manipulating the filesystem.
Project description
IFileOperation- a simple wrapper to use Windows shell file operations.
This is a very small wrapper around IFileOperation to expose methods to perform file opereration ( move, copy, rename, delete) on files using Windows shell operations. This means these operations can be undone, files can be recycled, and you can allow users to handle name conflicts: just like when you do any of these through Windows Explorer.
At the moment this is a very young and so only exposes the file operations:
- Move
- Copy
- Rename
- Delete
More features may be added in the future, feel free to open a feature request for something specific.
Installation:
pip install ifileoperation
At the moment the library is tested to run on Python 3.11, but other version might work if pywin32
and comtypes
are available.
Usage
All of the functionality is accessed via the FileOperator
class. This is a scheduling context
manager. If you're familiar with IFileOperation, you'll know that you queue a bunch of operations
you wish to be performed, then order them to be executed all at once:
from Pathlib import Path
from ifileoperation import FileOperator, FileOperationFlags
if __name__ == '__main__':
# Configure for recycling, showing a prompt if the file(s) can't be recyled
# and must be deleted instead.
recycle_flags = (
# ALLOW_UNDO: for versions < Win8, ADDUNDORECORD is preferred for Win8+
FileOperationFlags.ALLOW_UNDO | FileOperationFlags.ADDUNDORECORD |
# RECYCLEONDELETE: Perform deletes as recycles
FileOperationFlags.RECYCLEONDELETE |
# WANTNUKEWARNING: If a file is too big to be recyled, show a warning that
# it will be deleted instead
FileOperationFlags.WANTNUKEWARNING |
)
# Don't show any confirmation dialogs (except for WANTNUKEWARNING), or a UAC
# prompt if elevation is required (default behavior)
ui_flags = (
# NO_CONFIMATION: Don't show confirmation dialogs (ie, treat all dialogs
# as if 'Yes to All' was selected)
FileOperationFlags.NO_CONFIRMATION |
)
config = recycle_flags | ui_flags
with FileOperator(flags=config, commit_on_exit=True) as op:
op.delete_file('Q:/foo.txt')
op.delete_file(Path.cwd().join('bar.txt'))
FileOperator
A thin wrapper around IFileOperation, exposing the move, copy, rename, and
delete operations. All paths can be specified as anything implementing the
os.PathLike[str]
interface: strings, Path
objects, or your own custom
PathLike
class. The FileOperator
instance is a context manager: you queue
operations in the with
block, and then commit
them or have them committed
automatically.
NOTE: FileOperator
is not reentrant. Once you've entered the with
block and
exited, you should create a new instance to perform more operations.
Configuring:
Configuration is done via the constructor:
__init__(self, parent=None, flags=FileOperator.DEFAULT_FLAGS, commit_on_exit=False):
parent
: A optionalHANDLE
to the parent that should own any dialog boxes shown. You may also pass awx.Window
object, andFileOperator
will extract the handle for you.flags
: AFileOperationFlags
instance indicating the options you want when performing the operations. See the Microsoft documentation on these flags for more details on what each means. These are also in the docstrings forFileOperationFlags
, so you can read there them as well. Some common defaults are provided as well:FileOperator.DEFAULT_FLAGS
: This causes behavior as if the user had initiated the file operations from within Windows Exlorer with no modifier keys pressed (Shift, Ctrl, etc).FileOperator.UNDO_FLAGS
: This sets the flags needed to allow your operation to be undone withCtrl+Z
.FileOperator.SEMI_SILENT_FLAGS
: This hides the progress dialog, and only shows dialogs if user intervention is required. For example, if a name collision occurs, or when attempting to move a file that cannot be (temporarily) due to being open in another program, or if a file must be deleted instead of recycled.FileOperator.FULL_SILENT_FLAGS
: This performs the operations fully silently, responding to any prompts as if "Yes to All" or "Continue" was selected. Note this does not resolve other errors, and will fail if any error occurs. The only prompt that may be shown is a UAC prompt if elevation is required. You can further suppress the UAC prompt withFileOperationFlags.REQUIREELEVATION
.
commit_on_exit
: If set toTrue
, all the queued operations will be automatically commited as long as no exceptions occurred withing thewith
block before exiting. Exceptions might still occur during the committing itself though!
Operations supported:
The basic file operations can be scheduled. In these method signatures,
StrPath
is defined as str | os.PathLike[str]
.
move_file(source: StrPath, destination: StrPath, new_name: str | None = None)
: Moves the file atsource
to the destination directorydestination
. Ifnew_name
is supplied, the file will also be renamed to the new name.move_files(sources: Iterable[StrPath], destination: StrPath, new_name: str | None = None)
: Moves the specified filessources
to the destination directorydestination
. Ifnew_name
is supplied, the files will all be renamed to the new name. In this case, you probably also want to supplyFileOperationFlags.RENAMEONCOLLISION
.copy_file(source: StrPath, destination: StrPath, new_name: str | None = None)
: Like move, but performs a copy instead.copy_files(sources: Iterable[StrPath], destination: StrPath)
: Like move (without the rename), but performs a copy instead.rename_file(source: StrPath, new_name: str, allow_move: bool = True)
: Renames a file to a new name. Normally,new_name
should just be the name of the new file, without its directory. However, if you're used to other file APIs that let you "rename" a file into a different directory,rename_file
supports this as well. Whenallow_move
isTrue
, if it is detected thatnew_name
is actually a path resolving to a different directory, this will automatically be transformed into amove_file
operation instead.rename_files(sources: Iterable[StrPath], new_name: str)
: Renames the given files to have the new name. Unlikerename_file
, you cannot rename files into files in different directories.delete_file(source: StrPath)
: Deletes the target file.delete_files(sources: Iterable[StrPath])
: Deletes the target files.commit()
: Cause all the queue operations to be performed.
Post-commit attributes
After a commit
, additional attributes are available on the FileOperator
instance:
return_code
: TheHRESULT
return code from the overall operation. This is usually not required to be inspected.aborted
:True
if any of the operations were aborted / skipped.results
: A mapping of source filenames to destination filenames for successful operations. In the special case of deleted files, the destination will be'RECYCLED'
or'DELETED'
respectively.
Exceptions
This library may raise any of the following exceptions:
NotADirectoryError
: This can happen when trying to rename a folder if a file already exists with the same name, or attempting to move/copy to a directory that doesn't exist.IsADirectoryError
: This can happen when trying to rename a file if a folder already exists with the same name.PermissionError
: Can occur for various reasons, common examples are UAC elevation being required, or modifying a read-only file.FileExistsError
: Can occur when attempting to create a new file, when one of the same name already exists.FileNotFoundError
: Happens if the source file for an operation cannot be found.ifileoperation.IFileOperationError
: For all other errors that occur. These are a simple wrapper aroundpythoncom.com_error
, and expose an.hresult
attribute with theHRESULT
that triggered the error. In the future, moreHRESULT
s may be converted into standard libraryOSError
s.
Contributing
Pull requests are welcome! We use branch protection with some (minimal) tests
at the moment: just formatting really. To install the dependencies needed for
development, use:
pip install -r requirements-dev.txt
And before committing make sure to check against the tests and formatters:
pytest
: No tests at the momentblack ifileoperation
: Code formattingisort ifileoperation
: Code formattingflake8 ifileoperation
: Linting
IFileOperation uses semantic versioning, but if you're unsure if your changes need a version bump feel free to note that in your pull request and you'll get feedback!
If you're not into coding, you can open a Bug Report or Feature Request and I'll look into it.
Known Issues:
- Incompatible with WINE: see: https://github.com/lojack5/IFileOperation/issues/9
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ifileoperation-1.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5993a76d0b9a61b131bc614c8ccdb7e3e1e7943a3d0664efe33baa7d2ee76dce |
|
MD5 | 0e81a2c2b24d10054b8e859191cf41b9 |
|
BLAKE2b-256 | eff4ed00d4e1fa15f74b17d27fe1a7746a45ad3c7c2cb37499798e8f27c20083 |