Force Overwrite in Os.Rename

Question

Is it possible to force a rename os.rename to overwrite another file if it already exists? For example in the code below if the file Tests.csv already exists it would be replaced by the Tests.txt file (that was also renamed to Tests.csv).

os.rename("C:\Users\Test.txt","C:\Users\Tests.csv");

Answer 1

Since Python 3.3, there is now a standard cross-platform solution, os.replace:

Rename the file or directory src to dst. If dst is a directory, OSError will be raised. If dst exists and is a file, it will be replaced silently if the user has permission. The operation may fail if src and dst are on different filesystems. If successful, the renaming will be an atomic operation (this is a POSIX requirement).

Availability: Unix, Windows.

New in version 3.3.

However, contrary to the documentation, on Windows it's not guaranteed to be atomic (in Python 3.4.4). That's because internally it uses MoveFileEx on Windows, which doesn't make such a guarantee.

Answer 2

You could try shutil.move():

from shutil import move

move('C:\\Users\\Test.txt', 'C:\\Users\\Tests.csv')

Or os.remove and then shutil.move:

from os import remove
from shutil import move

remove('C:\\Users\\Tests.csv')
move('C:\\Users\\Test.txt', 'C:\\Users\\Tests.csv')

Answer 3

As the documentation says it's impossible to guarantee an atomic renaming operation on Windows if the file exists so what Python does is asking to do the double step os.remove + os.rename yourself, handling potential errors.

On unix systems rename overwrites the destination if exists (because the operation is guaranteed to be atomic).

Note that on windows it's also possible that deleting the destination file will fail even if you have permission because the file may be in use. This is another essential limitation of the windows file system and you have to handle it yourself in the code.

Answer 4

On Unix, if dst exists and is a file, it will be replaced silently if the user has permission. The operation may fail on some Unix flavors if src and dst are on different filesystems. If successful, the renaming will be an atomic operation (this is a POSIX requirement). On Windows, if dst already exists, OSError will be raised even if it is a file; there may be no way to implement an atomic rename when dst names an existing file. http://docs.python.org/library/os.html#os.rename

Answer 5

The syntax for the accepted answer (for Python >= 3.3):

os.replace("src/file/path", "dst/file/path")

( Documentation: os.replace )

Answer 6

import os
try:
  os.rename("/path/input file", "/path/output file")
except FileExistsError:
  os.remove("/path/output file")
  os.rename("/path/input file", "/path/output file")

Answer 7

Funny enough, the documentation for os.rename() says it does replace the target on Unix systems, but on Windows it does not. They mention something vague about it being impossible to implement atomic renaming if the destination exists on Windows, which IMO is hardly enough reason not to support it.

You should catch OSError (destination exists on Windows) and remove the destination and try again, I suppose.

Answer 8

How about use of replace() and shutil.move() ? example:

import os
from shutil import move

filename=r'C:\Users\Test.txt'
move(filename,filename.replace('.txt','.csv')

also you can make it more general for all the files. Thanks

Answer 9

Try something like this:

import os

def rename_downloaded_files(download_dir):
    """Renames downloaded files to (file name).

    Args:
        download_dir (str): The path to the download directory.
    """
    for file in os.listdir(download_dir):
        if file.endswith(".yourExtension"):
            continue
        new_file_name = "enter file + extension"
        os.rename(os.path.join(download_dir, file), os.path.join(download_dir, new_file_name), overwrite=True)

if __name__ == "__main__":
    download_dir = "/path/to/download/directory"
    rename_downloaded_files(download_dir)

This code will rename all downloaded files in the download_dir directory to a file of your choosing, overwriting any existing files with the same name. You can change the path to the directory to match your own system.

Answer 10

From the Standard Library documentation, “On Windows, if dst already exists, OSError will be raised even if it is a file; there may be no way to implement an atomic rename when dst names an existing file.”

http://docs.python.org/library/os.html#os.rename

So the only solution, unfortunately, would be to change operating systems; Windows simply disallows a rename() atop an existing file.