Replace word in file python

In this article, we will learn how we can replace text in a file using python.

Method 1: Searching and replacing text without using any external module

Let see how we can search and replace text in a text file. First, we create a text file in which we want to search and replace text. Let this file be SampleFile.txt with the following contents:

To replace text in a file we are going to open the file in read-only using the open() function. Then we will t=read and replace the content in the text file using the read() and replace() functions.

Syntax: open(file, mode=’r’)

Parameters:

• file : Location of the file
• mode : Mode in which you want toopen the file.

Then we will open the same file in write mode to write the replaced content.

Output:

Text replaced

Method 2: Searching and replacing text using the pathlib2 module

Let see how we can search and replace text using the pathlib2 module. First, we create a Text file in which we want to search and replace text. Let this file be SampleFile.txt with the following contents:

Install pathlib2 module using the below command:

pip install pathlib2

This module offers classes representing filesystem paths with semantics appropriate for different operating systems. To replace the text using pathlib2 module we will use the Path method of pathlib2 module.

Syntax: Path(file)

Parameters:

• file: Location of the file you want to open

In the below code we are replacing “dummy” with “replaced” in our text file. using the pathlib2 module. 

Code:

Output:

Text replaced

Method 3: Searching and replacing text using the regex module

Let see how we can search and replace text using the regex module. We are going to use the re.sub( ) method to replace the text.

Syntax: re.sub(pattern, repl, string, count=0, flags=0)

Parameters:

• repl : Text you want to add
• string : Text you want to replace

Code:

Output:

Text replaced

Method 4: Using fileinput

Let see how we can search and replace text using the fileinput module. For this, we will use FileInput() method to iterate over the data of the file and replace the text.

Syntax: FileInput(files=None, inplace=False, backup=”, *, mode=’r’)

Parameters:

• files : Location of the text file
• mode : Mode in which you want toopen the file
• inplace : If value is True then the file is moved to a backup file and
• standard output is directed to the input file
• backup : Extension for the backup file

Code:

Output:

Text replaced

1. Используйте функцию replace(), когда входные и выходные файлы различаются
2. Используйте функцию replace(), когда для ввода и вывода используется только один файл

Работа с файлами — важный аспект любого веб-приложения. Python, как и другие языки программирования, поддерживает обработку файлов. Это позволяет программистам иметь дело с файлами и, по сути, выполнять некоторые базовые операции, такие как чтение, запись и некоторые другие параметры обработки файлов для работы с файлами.

Функцию open() можно использовать для открытия файла в программе Python. Файл можно открыть в текстовом или двоичном режиме, который выбирает пользователь. Функция open() имеет несколько режимов, каждый из которых обеспечивает различные варианты доступа к открываемому файлу.

Термин String в Python можно описать как набор символов Unicode, заключенных в одинарные или двойные кавычки. Строки могут содержаться внутри текстовых файлов, которые должны открываться в коде Python.

В этом руководстве будут рассмотрены различные методы замены строки в файле на Python.

Используйте функцию replace(), когда входные и выходные файлы различаются

Метод replace() в Python используется для поиска подстроки и замены ее другой подстрокой.

Функция replace() имеет три параметра, а именно newvalue, oldvalue и count. И oldvalue, и newvalue являются обязательными значениями, и предоставление функции с параметром count необязательно.

В следующем коде используется функция replace() для замены строки в Python, когда входные и выходные файлы различаются.

# the input file
fin = open("f1.txt", "rt")
# the output file which stores result
fout = open("f2.txt", "wt")
# iteration for each line in the input file
for line in fin:
	# replacing the string and write to output file
	fout.write(line.replace('gode', 'God'))
#closing the input and output files
fin.close()
fout.close()

В выводе приведенного выше кода строка gode в файле будет заменена словом God.

В приведенном выше коде мы одновременно работаем с двумя разными файлами: f1.txt и f2.txt. f1.txt открывается в режиме чтения текста rt и ссылается на end. f2.txt открывается в режиме записи текста wt и ссылается на fout. Затем цикл for повторяется, и при каждом появлении в файле строки gode она заменяется словом God. Затем оба файла закрываются после необходимых операций с помощью функции close().

Используйте функцию replace(), когда для ввода и вывода используется только один файл

В этом методе один и тот же файл используется как для ввода, так и для вывода.

Здесь мы используем оператор with вместе с функцией replace(). Менеджер контекста with выполняет фундаментальную функцию: делает программу короче и читабельнее.

Когда мы используем оператор with с обработкой файлов, файл, который мы открыли в коде Python, не нужно закрывать вручную; он автоматически закрывается после завершения блока with.

Следующий код использует функцию replace() для замены строки в Python, когда входной и выходной файл совпадают.

with open("file1.txt", "rt") as file:
	x = file.read()
	
with open("file1.txt", "wt") as file:
    x = x.replace("gode","God")
	fin.write(x)

Следующий код принимает file1 как входной и выходной файл. Сначала файл открывается в режиме чтения текста rt, а содержимое файла считывается и сохраняется в переменной. Затем файл закрывается и открывается снова, но уже в режиме записи текста wt. Строка заменяется, и данные записываются в этом режиме, а затем файл закрывается.

Preface

I’m a Network Engineer learning Python, and these are purely my notes. I’m not an expert by any means. Feel free to use any of these examples and improve upon them. Feel free to call me out where things can be done better.

Onward

A common task I need to do is replace words in a file with something else. For example:

hostname $hostname
interface Gig0/1
 ip address $ip 255.255.255.252

Where $hostname and $ip should be variables that needs replacing. This post looks at how to accomplish this on the Python interpretor, and via a script file using a Python function.

To keep things relatively simple, I’m only going to perform the replacement on a single file, using a single set of attributes.

Interpretor

Hop into Python

$ python
Python 2.7.9 (default, Dec 15 2014, 10:01:34) 
[GCC 4.2.1 Compatible Apple LLVM 6.0 (clang-600.0.56)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> 

First, I’ll open a text file as ‘t‘ and read it into a string called ‘tempstr‘

>>> t = open('example_template.txt', 'r')
>>> tempstr = t.read()
>>> t.close()

Let’s take a look at this string:

>>> print tempstr
Your hostname is:     $hostname
Your IP address is:   $ip
Did this work?        $answer

The goal is to replace the words starting with a dollar sign ($) with something else. Note that I’m using dollar signs because it makes it easy when doing a find replace. This is not required.

Next I’ll create a dictionary of key/value pairs to be used when replacing variables.  We’ll call this dictionary “device_values“

>>> device_values = {
...     '$hostname': 'overlaid-router',
...     '$ip': '169.254.66.6',
...     '$answer': 'yes',
... }

You can see the keys are specified with a dollar sign ($) in front of them. Remember, this has nothing to do with Python, this is simply how I chose to name these keys so they line up with the words I’ll be replacing in my template file.

Now we need to search our string ‘tempstr‘ for the keys found in device_values and replace them with the corresponding values. To accomplish this, we’ll iterate through our dictionary and use the .replace method.

Our current string:

>>> print tempstr
Your hostname is:     $hostname
Your IP address is:   $ip
Did this work?        $answer

Look at each key/value pair in the dictionary and update the tempstr string with the matching key/values

>>> for key,val in device_values.items():
...     tempstr = tempstr.replace(key,val)
... 

Our new string:

>>> print tempstr
Your hostname is:     overlaid-router
Your IP address is:   169.254.66.6
Did this work?        yes

Perfect!

What is .items?

In case you’re curious, the .items method above returns a list of the dictionaries key/value pairs.  Actually, they’re tuples, not dictionaries, but in this case serve the same purpose.  Tuples cannot be changed, unlike dictionaries, but we’re not doing any changing here, just reading.  

This is required when iterating through a dictionary. You can see the difference here between a simple print of the dictionary and a print of the dictionary items.  Notice {} for the dictionary and [()] for the list [] of tuples ().

>>> device_values
{'$ip': '169.254.66.6', '$answer': 'yes', '$hostname': 'overlaid-router'}
>>> device_values.items()
[('$ip', '169.254.66.6'), ('$answer', 'yes'), ('$hostname', 'overlaid-router')]

Python Function to Replace Words

This function will take in two variables: base_text string and device_values dictionary. It will iterate through the dictionary just like the example above and replace words (keys) found in the base_text with corresponding words (values) from the dictionary.

def replace_words(base_text, device_values):
	for key, val in device_values.items():
		base_text = base_text.replace(key, val)
	return base_text

The dictionary and string are derived via the same means as the first example.

t = open('example_template.txt', 'r')
tempstr = t.read()
t.close()

device_values = {
    '$hostname': 'overlaid-router',
    '$ip': '169.254.66.6',
    '$answer': 'yes',
}

The only difference is how we send these to our function for processing. tempstr will go in as the base_text argument and device will go in as the device_values argument.

>>> output = replace_words(tempstr, device)

>>> print output
Your hostname is:     overlaid-router
Your IP address is:   169.254.66.6
Did this work?        yes

As a Python script

The .py script below will ask you for three variables. It will open a template file and perform a find and replace, saving a new file called output.txt to your directory.

#!/usr/bin/env python
# This is a simple Python function that will open a text file and perform a find/replace, and save to a new text file.

def replace_words(base_text, device_values):
	for key, val in device_values.items():
		base_text = base_text.replace(key, val)
	return base_text

# Here I'll create an empty dictionary, and prompt the user to enter in the values

device = {}

device["$hostname"] = raw_input("nHostname: ")
device["$ip"] = raw_input("nIP Address: ")
device["$answer"] = raw_input("nDo you like Python? ")

# Open your desired file as 't' and read the lines into string 'tempstr'

t = open('example_template.txt', 'r')
tempstr = t.read()
t.close()


# Using the "replace_words" function, we'll pass in our tempstr to be used as the base, 
# and our device_values to be used as replacement.  

output = replace_words(tempstr, device)

# Write out the new config file

fout = open('output.txt', 'w')
fout.write(output)
fout.close()

Let’s try it out. Notice I only have 2 files in this directory – my script and the example template

$ ls -l
total 16
-rw-r--r--@ 1 vosx  staff    87B Jan 28 17:28 example_template.txt
-rw-r--r--@ 1 vosx  staff   958B Jan 28 19:04 replace_words.py

Run the replace_words script

$ python replace_words.py

Hostname: overlaid-router

IP Address: 1.1.1.1

Do you like Python? yep

I now have a new file

$ ls -l
total 24
-rw-r--r--@ 1 vosx  staff    87B Jan 28 17:28 example_template.txt
-rw-r--r--@ 1 vosx  staff    93B Jan 28 19:06 output.txt
-rw-r--r--@ 1 vosx  staff   958B Jan 28 19:04 replace_words.py

Let’s take a look

$ more output.txt
Your hostname is:     overlaid-router
Your IP address is:   1.1.1.1
Did this work?        yep