Python 3 - os.renames() Method


Description

The method renames() is recursive directory or file renaming function. It does the same functioning as os.rename(), but it also moves a file to a directory, or a whole tree of directories, that do not exist.

Syntax

Following is the syntax for renames() method −

os.renames(old, new)

Parameters

  • old − This is the actual name of the file or directory to be renamed.

  • new − This is the new name of the file or directory.It can even include a file to a directory, or a whole tree of directories, that do not exist.

Return Value

This method does not return any value.

Example

The following example shows the usage of renames() method.

# !/usr/bin/python3
import os, sys
os.chdir("d:\\tmp")
print ("Current directory is: %s" %os.getcwd())

# listing directories
print ("The dir is: %s"%os.listdir(os.getcwd()))

# renaming file "aa1.txt"
os.renames("foo.txt","newdir/foonew.txt")

print ("Successfully renamed.")

# listing directories after renaming and moving "foo.txt"
print ("The dir is: %s" %os.listdir(os.getcwd()))
os.chdir("newdir")
print ("The dir is: %s" %os.listdir(os.getcwd()))

Result

When we run the above program, it produces the following result −

Current directory is: d:\tmp

The dir is: [
   'Applicationdocs.docx', 'book.zip', 'foo.txt', 
   'Java Multiple Inheritance.htm', 'Java Multiple Inheritance_files', 
   'java.ppt', 'python2'
]

Successfully renamed.

The dir is: [
   'Applicationdocs.docx', 'book.zip', 
   'Java Multiple Inheritance.htm', 'Java Multiple Inheritance_files', 
   'java.ppt', 'newdir', 'python2'
]

Result

The file foo.txt is not visible here, as it is been moved to newdir and renamed as foonew.txt. The directory newdir and its contents are shown below:

The dir is: ['foonew.txt']
python_files_io.htm
Advertisements