Force Overwrite in Os.Rename

Python

Python Problem Overview


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");

Python Solutions


Solution 1 - Python

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.

Solution 2 - Python

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')

Solution 3 - Python

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.

Solution 4 - Python

> 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

Solution 5 - Python

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.

Solution 6 - Python

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.

Solution 7 - Python

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

Solution 8 - Python

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")

Solution 9 - Python

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

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

( Documentation: os.replace )

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionSplashlinView Question on Stackoverflow
Solution 1 - PythonatzzView Answer on Stackoverflow
Solution 2 - PythonBlenderView Answer on Stackoverflow
Solution 3 - Python6502View Answer on Stackoverflow
Solution 4 - PythonBenView Answer on Stackoverflow
Solution 5 - PythonJohn ZwinckView Answer on Stackoverflow
Solution 6 - PythonBrandon RhodesView Answer on Stackoverflow
Solution 7 - PythonDeepakView Answer on Stackoverflow
Solution 8 - PythonSL-PirateView Answer on Stackoverflow
Solution 9 - PythonellockieView Answer on Stackoverflow