Use __main__.py, 1.0.0, conflict checking optional

Author: hammy275

README.md

@@ -12,18 +12,21 @@ To import, use `import movefile_restart`
 
 From there, you have a couple functions at your disposal:
 
-`movefile_restart.DeleteFile(file_path)`: Queues `file_path` for deletion.
+`movefile_restart.DeleteFile(file_path, check_conflicts=True)`: Queues `file_path` for deletion.*
 
-`movefile_restart.MoveFile(from_path, to_path)` or `movefile_restart.RenameFile(from_path, to_path)`: Moves the file from `from_path` to `to_path`.
+`movefile_restart.MoveFile(from_path, to_path, check_conflicts=True)` or `movefile_restart.RenameFile(from_path, to_path)`: Moves the file from `from_path` to `to_path`.*
 
 `movefile_restart.GetFileOperations()`: Get a list of tuples containing the source and destination of all file movings queued.
 
 `movefile_restart.PrintFileOperations()`: Print a list of file operations that are scheduled to occur during reboot.
 
+`movefile_restart.RemoveFileOperation(file_op_index)`: Remove a file operation based on its index from `movefile_restart.GetFileOperations()`.
+
 `movefile_restart.CheckPermissions()`: Check for read/write permissions to the registry keys needed for this library.
 
+*: For both of these functions, the `check_conflicts` parameter determines whether or not to perform checks when moving/deleting to make sure if it can be performed successfully in the case of a conflict. It only checks if there is initially a problem (the file being deleted doesn't exist, the source of the file being moved doesn't exist, or the destination file of a move already exists). Setting `check_conflicts` to False when calling these functions will skip all of these checks.
+
 ## Current Limitations
 
-* Files cannot currently be un-queued.
-* Some weird cases such as: if you're moving `a.txt` to `b.txt`, you cannot queue a deletion for `b.txt` after your file move queue. You would have to restart the computer so `b.txt` exists before deleting it.
-* Due to using the Windows Registry for handling these kinds of operations, no other operating system is supported, nor is there planned support.
+* Due to using the Windows Registry for handling these kinds of operations, no other operating system is supported, nor is there planned support.
+* Some cases can occur where a move/delete can fail. For example, queueing a deletion of file A then queueing a move from file A to file B isn't currently checked for, and will result in the move not occuring (as file A will be deleted before it can be moved).

movefile_restart/__init__.py

@@ -1,3 +1,3 @@
 from .main import DeleteFile, MoveFile, RenameFile, GetFileOperations, PrintFileOperations, RemoveFileOperation, CheckPermissions
 
-__version__ = "0.6.0"
+__version__ = "1.0.0"

movefile_restart/__main__.py

@@ -0,0 +1,11 @@
+import sys
+
+from main import CheckPermissions, PrintFileOperations
+
+if CheckPermissions()[0]:
+    print("Currently pending file operations: ")
+    PrintFileOperations()
+    sys.exit(0)
+else:
+    print("No read permission on registry key!")
+    sys.exit(1)

movefile_restart/main.py

@@ -52,25 +52,26 @@ def __set_registry(values):
     winreg.SetValueEx(_write_key, "PendingFileRenameOperations", 0, winreg.REG_MULTI_SZ, values)
 
 
-def DeleteFile(file_path):
+def DeleteFile(file_path, check_conflicts=True):
     """Queue File for Deletion.
 
     Adds the Registry information to delete a file on reboot.
 
     Args:
         file_path (str): A path to the file to delete.
+        check_conflicts (bool): Checks file_path to make sure the Delete can happen as supplied. Defaults to True.
 
     Raises:
         FileNotFoundError: Raised if the file_path doesn't exist.
 
     """
     file_path = file_path.replace("/", "\\")
     values = __get_current_values()
-    if not (os.path.isfile(file_path)):
+    if check_conflicts and not (os.path.isfile(file_path)):
         values.reverse()
         try:
             file_path_index = values.index("\\??\\" + file_path)
-        except IndexError:
+        except ValueError:
             file_path_index = -1
         if file_path_index % 2 != 0 or file_path_index == -1:
             raise FileNotFoundError("Path {} does not exist and is not being created during a move operation!".format(file_path))
@@ -80,28 +81,29 @@ def DeleteFile(file_path):
     __set_registry(values)
 
 
-def MoveFile(from_path, to_path):
+def MoveFile(from_path, to_path, check_conflicts=True):
     """Queue File for Moving.
 
     Adds the Registry information to move a file on reboot.
 
     Args:
         from_path (str): The directory being moved from.
         to_path (str): The directory being moved to.
+        check_conflicts (bool): Check from_path and to_path to make sure the Move/Rename can be performed successfully.
 
     Raises:
         FileNotFoundError: Raised if the from_path doesn't exist or if the directory of to_path doesn't exist.
         FileExistsError: Raised if to_path already exists.
 
     """
     from_path = from_path.replace("/", "\\")
-    if not os.path.isfile(from_path):  # Don't move non-existant path
+    if check_conflicts and not os.path.isfile(from_path):  # Don't move non-existant path
         raise FileNotFoundError("Path {} does not exist!".format(from_path))
     to_path = to_path.replace("/", "\\")
-    if not os.path.isdir(os.path.dirname(to_path)):  # Don't move to non-existant dir
+    if check_conflicts and not os.path.isdir(os.path.dirname(to_path)):  # Don't move to non-existant dir
         raise FileNotFoundError("Path {} does not exist to move to!".format(os.path.dirname(to_path)))
     values = __get_current_values()
-    if os.path.isfile(to_path):  # Don't move to already-existing destination unless it will be deleted/moved
+    if check_conflicts and os.path.isfile(to_path):  # Don't move to already-existing destination unless it will be deleted/moved
         values.reverse()
         try:
             to_path_index = values.index("\\??\\" + to_path)
@@ -115,9 +117,9 @@ def MoveFile(from_path, to_path):
     __set_registry(values)
 
 
-def RenameFile(from_path, to_path):
+def RenameFile(from_path, to_path, check_conflicts=True):
     """MoveFile Alias."""
-    MoveFile(from_path, to_path)
+    MoveFile(from_path, to_path, check_conflicts)
 
 
 def GetFileOperations():
@@ -139,6 +141,9 @@ def GetFileOperations():
 def PrintFileOperations():
     """Prints Pending File Operations."""
     vals = GetFileOperations()
+    if not vals:
+        print("There are no currently pending file operations!")
+        return
     for i in vals:
         if i[1] == "":
             print("Deleting {}".format(i[0]))

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="movefile-restart",
-    version="0.6.0",
+    version="1.0.0",
     author="hammy3502",
     author_email="hammy275@gmail.com",
     description="A small library for Windows to queue files to be moved, deleted, or renamed on reboot.",