Att läsa filer som listor i Python

För att kunna spara data mellan två exekveringar av våra program kan filer användas.

Vi ska i denna övning läsa från filer och använda datan som finns i filen. Övningen avslutas med att vi skriver till en fil.

Läsa från fil

Skapa “items.txt” i practice mappen och lägg i följande text i den.

cookie
cake
tea

Vi börjar med att öppna filen items.txt med hjälp av konstruktionen with, där definierar vi variabeln filehandle som innehåller kopplingen till filen. Med filehandle kan vi läsa hela filen genom att använda read().

# the name of the file
filename = "items.txt"

# with - as for reading a file automatically closes it after reading is done
with open(filename) as filehandle:
    lines = filehandle.read()

# print the line read from the file
print(lines)

# skriver ut:
# cookie
# cake
# tea
#

Notera en tom rad på slutet.

Vi har i övningen “Kom igång med datatypen lista i Python” tittat på hur vi kan använda listor och här ser vi ett ypperligt tillfälle att använda oss av en lista. Vi har en sträng separerad med ny-rad. Vi vill dela upp den så varje delsträng blir ett element i en lista, detta kan göras med sträng-funktionen split().

# split the line into a list on the comma ","
items_as_list = lines.split("\n")
# print what the list looks like
print(items_as_list)

# skriver ut: ['cookie', 'cake', 'tea', '']

Vi har nu en lista som innehåller fyra element som vi har läst in från filen items.txt. Notera "" i sista elementet, den får vi med för att sista raden har en \n, radbrytning, och egentligen inget vi vill ha med i listan. Så vi kan använda funktionen strip() för att ta bort så kallat whitespace (mellanrum, radbrytning osv.) från ändarna av strängen.

# the name of the file
filename = "items.txt"

# with - as for reading a file automatically closes it after reading is done
with open(filename) as filehandle:
    lines = filehandle.read().strip()

# split the line into a list on the comma "\n"
items_as_list = lines.split("\n")
# print what the list looks like
print(items_as_list)

Vi får nu utskriften ['cookie', 'cake', 'tea'] som vi hade förväntat från första början.

readlines()

Istället för att själva dela upp strängen och ta bort sista tomma raden kan vi använda den inbyggda funktionen readlines(). Denna läser upp hela filens innehåll och returnerar den som en lista där alla rader blir ett eget element.

# the name of the file
filename = "items.txt"

# with - as for reading a file automatically closes it after reading is done
with open(filename) as filehandle:
    items_as_list = filehandle.readlines()

# print what the list looks like
print(items_as_list)

Vi får igen utskriften ['cookie\n', 'cake\n', 'tea\n'] med färre rader kod. Men nu får vi med \n i slutet av varje sträng. Detta är en av de stora skillnaderna om vi väljer att använda read() och själva gör om det till en lista eller om vi använder readlines(). För tillfället nöjer vi oss med att ha med \n. Men i vanliga fall hade vi troligen inte velat ha med dem.

Vi ska nu titta på hur vi kan lägga till flera element i listan och hur vi skriver listan till fil.

Skriva till fil

Vi vill lägga till ett element i slutet av listan och vet sen tidigare att då använder vi list funktionen append(). Då vi inte vill skriva listan direkt till fil gör vi om den med motsatsen till split() som heter join(). Precis som split() är join() en strängfunktion så vi anger först strängen som vi vill använda som ‘lim’ och sen anger vi listan som vi vill sätta ihop till en sträng. Precis som när vi läste från fil använder vi with när vi vill skriva till en fil. Dock måste vi öppna filen med skrivrättigheter och det gör vi genom att använda flaggan w.

# add item to the list
items_as_list.append("cup")
# print what the list looks like after change
print(items_as_list)

# join the list into a string with nothing between every item
# this is because we already have \n in the string values
list_as_str = "".join(items_as_list)
# show what the string looks like after join
print(list_as_str)

# write the line to the file
with open(filename, "w") as filehandle:
    filehandle.write(list_as_str)

Nu innehåller filen fyra föremål med en sak per rad. Vi noterar dock att förut fanns det en tom rad i slutet av filen vilket det inte gör längre.

Avslutningsvis

Vi har nu sett hur vi kan läsa raderna från en fil via en sträng till en lista, hur vi lägger till element i listan och hur vi skriver den ändrade listan till fil. Filhantering är ett viktigt verktyg för att spara undan data som kan återanvändas vid nästa exekvering av programmet och vi har i denna övning fått en introduktion till hur man gör detta i Python.