Dzienniki, raporty, konfiguracja, eksporty: prędzej czy później każdy skrypt dotyka systemu plików. Obsługa plików w Pythonie jest prosta na początek, ale kilka szczegółów decyduje o tym, czy Twój kod jest niezawodny, czy też cicho niszczy dane.

Ten przewodnik omawia pliki tekstowe, CSV, JSON, dane binarne i ścieżki, ze szczególnym uwzględnieniem bezpiecznych nawyków. Uruchomiliśmy te przykłady w Pythonie 3.13 w folderze tymczasowym, a pokazane dane wyjściowe pochodzą z tego uruchomienia.

Otwórz pliki za pomocą open() i with

Wbudowana funkcja open() zwraca obiekt pliku. Użyj go wewnątrz bloku with:

with open("notes.txt", "w", encoding="utf-8") as file:
    file.write("first line\n")
    file.write("second line\n")

print(file.closed)

# True

Po zakończeniu bloku Python zamyka plik, nawet jeśli wystąpił w nim błąd. Bez with musisz sam wywołać close(), a wyjątek może pominąć tę linię. Użycie pliku po jego zamknięciu powoduje błąd:

file.read()

# ValueError: I/O operation on closed file.

Tryby plików

Drugi argument open() mówi, co planujesz zrobić:

Dodaj b dla danych binarnych, jak w "rb" lub "wb". Tekst jest domyślny i można go również zapisać jawnie jako t.

Napisz i dołącz

write() nie dodaje podziału wiersza, więc dołącz \n siebie. Dołączanie zachowuje to, co już istnieje:

with open("notes.txt", "a", encoding="utf-8") as file:
    file.write("third line\n")

Porównaj to z trybem "w", który zastąpił nasze trzy linie jedną, bez żadnego ostrzeżenia:

with open("notes.txt", "w", encoding="utf-8") as file:
    file.write("replaced\n")

# notes.txt now contains only: replaced

Jeśli nie możesz czegoś nadpisać, użyj "x". W naszym teście podniosło FileExistsError, ponieważ notes.txt już istniało.

Przeczytaj plik

Sposobów czytania jest kilka, a właściwy wybór zależy od rozmiaru pliku:

with open("notes.txt", encoding="utf-8") as file:
    print(repr(file.read()))

# 'first line\nsecond line\n'

with open("notes.txt", encoding="utf-8") as file:
    for line in file:
        print(line.strip())

# first line
# second line
# third line

Zwróć uwagę na znaki \n przechowywane w surowym ciągu znaków. strip() usuwa je. Obiekt pliku również pamięta swoją pozycję, więc czytanie jest kontynuowane od miejsca, w którym zostało przerwane:

with open("notes.txt", encoding="utf-8") as file:
    print(file.readline().strip())
    print(file.readlines())

# first line
# ['second line\n', 'third line\n']

Zapętlanie pliku jest kluczową techniką w przypadku dużych dzienników i eksportów. Czyta wiersz po wierszu, więc wielogigabajtowy plik nie musi mieścić się w pamięci.

Obsługuj błędy plików

Plików może brakować, być zablokowane lub nieczytelne, więc zaplanuj to:

try:
    with open("missing.txt", encoding="utf-8") as file:
        data = file.read()
except FileNotFoundError as error:
    print(error)

# [Errno 2] No such file or directory: 'missing.txt'

Spróbuj otworzyć plik i wychwycić błąd, zamiast sprawdzać najpierw za pomocą exists(), ponieważ plik może zniknąć pomiędzy sprawdzeniem a otwarciem. Nasz przewodnik po obsłudze wyjątków w Pythonie omawia to podejście.

Pliki CSV

Nie dziel samodzielnie wierszy CSV przecinkami, ponieważ cytowane wartości mogą zawierać przecinki. Standardowy moduł csv obsługuje te reguły. DictWriter i DictReader to najbardziej czytelne opcje:

import csv

with open("orders.csv", "w", newline="", encoding="utf-8") as file:
    writer = csv.DictWriter(file, fieldnames=["id", "customer", "total"])
    writer.writeheader()
    writer.writerow({"id": 1, "customer": "Asha", "total": 1200})
    writer.writerow({"id": 2, "customer": "Ben", "total": 300})

with open("orders.csv", newline="", encoding="utf-8") as file:
    rows = list(csv.DictReader(file))

print(rows[0])
print(sum(int(r["total"]) for r in rows))

# {'id': '1', 'customer': 'Asha', 'total': '1200'}
# 1500

Liczą się dwa szczegóły. Przekaż newline="" podczas otwierania plików CSV, zgodnie z zaleceniami dokumentacji, aby zapobiec pustym wierszom w systemie Windows. Każda wartość zwracana jest jako ciąg znaków, parzyste liczby, dlatego potrzebowaliśmy int() w sumie. W przypadku dużych ilości danych lepiej sprawdzi się biblioteka taka jak pandas.

pliki JSON

JSON to typowy format danych konfiguracyjnych i API. Odwzorowuje się starannie na słownikach Pythona i wyświetla listę:

import json

config = {"debug": True, "retries": 3, "hosts": ["a", "b"]}

with open("config.json", "w", encoding="utf-8") as file:
    json.dump(config, file, indent=2)

with open("config.json", encoding="utf-8") as file:
    print(json.load(file)["retries"])

# 3

Zapamiętaj nazewnictwo: dump i load działają z plikami, podczas gdy dumps i loads działają z ciągami znaków. Typów takich jak daty nie można przechowywać bezpośrednio, dlatego należy je najpierw przekonwertować na ciągi znaków.

Pracuj ze ścieżkami za pomocą pathlib

Sklejanie ścieżek za pomocą ciągów powoduje przerwanie pracy w różnych systemach operacyjnych. Standardowy moduł pathlib obsługuje za Ciebie separatory i oferuje przydatne skróty:

from pathlib import Path

path = Path("data") / "reports" / "summary.txt"
path.parent.mkdir(parents=True, exist_ok=True)
path.write_text("all good\n", encoding="utf-8")

print(path.read_text(encoding="utf-8").strip())   # all good
print(path.suffix, path.stem, path.exists())      # .txt summary True
print(sorted(p.name for p in Path(".").glob("*.csv")))
# ['orders.csv']

To ostatnie rozwiązuje powszechny ból głowy. Ścieżki względne są wyznaczane z miejsca, w którym uruchomono skrypt, a nie z miejsca, w którym znajduje się skrypt, więc budowanie ścieżek z Path(__file__).parent pozwala uniknąć wielu niespodzianek związanych z „nie odnalezieniem pliku”.

Pliki binarne

Obrazy, pliki PDF i ZIP nie są tekstem. Otwórz je za pomocą b, a będziesz czytać i pisać bytes, bez użycia kodowania:

with open("pixel.bin", "wb") as file:
    file.write(bytes([255, 0, 128]))

with open("pixel.bin", "rb") as file:
    print(file.read())

# b'\xff\x00\x80'

Bezpieczniej pisze

Jeśli program ulegnie awarii w połowie zapisywania ważnego pliku, może to spowodować uszkodzenie wyniku. Typowym rozwiązaniem jest najpierw zapisanie pliku tymczasowego, a następnie zamiana go na miejsce:

temp = Path("settings.tmp")
temp.write_text("new", encoding="utf-8")
temp.replace("settings.txt")

print(Path("settings.txt").read_text(), temp.exists())

# new False

replace() zastępuje miejsce docelowe. W tym samym systemie plików zmiana nazwy jest zazwyczaj atomowa, więc czytelnicy widzą albo stary plik, albo nowy, a nie na wpół napisany miks.

Praktyczny przykład: podsumowanie dziennika

Ten krótki scenariusz łączy w sobie kilka pomysłów. Odczytuje dziennik po linii, więc jego rozmiar nie ma znaczenia, liczy każdy poziom za pomocą Counter i zapisuje podsumowanie do nowego pliku:

from collections import Counter

counts = Counter()
with open("app.log", encoding="utf-8") as file:
    for line in file:
        counts[line.split()[0]] += 1

with open("summary.txt", "w", encoding="utf-8") as out:
    for level, total in counts.most_common():
        out.write(f"{level}: {total}\n")

# summary.txt
# ERROR: 2
# INFO: 2
# WARN: 1

Nasz przykładowy dziennik miał pięć linii. Pusta linia zostanie przerwana line.split()[0], więc prawdziwe skrypty powinny najpierw pominąć puste linie.

Typowe błędy

• Użyłeś "w", gdy miałeś na myśli "a". Twoje istniejące dane zostaną natychmiast otwarte, nawet jeśli nigdy nic nie napiszesz.
• Pomijanie kodowania. Wartość domyślna różni się w zależności od systemu, więc skrypt działający w systemie Linux może nie działać w systemie Windows z tekstem akcentowanym lub emoji.
• Wywoływanie read() w przypadku dużych plików. Może to wyczerpać pamięć, więc zamiast tego pętluj linie.
• Zapomnienie int() o wartościach CSV. "10" + "20" daje "1020".
• Pomijam newline="" w przypadku pliku CSV. W systemie Windows mogą pojawić się nieoczekiwane puste wiersze.
• Nie testuję kodu pliku. Użyj urządzenia pytest tmp_path, aby testy nigdy nie dotykały prawdziwych plików. Zobacz nasz samouczek dotyczący testów Pythona.

Podsumowanie

Kilka nawyków obejmuje tutaj prawie wszystko: użyj with, ustaw kodowanie, zastanów się dwa razy nad "w" i pozwól, aby csv, json i pathlib wykonały najtrudniejsze części. Aby poćwiczyć, napisz mały skrypt, który odczytuje plik CSV, sumuje jedną kolumnę i zapisuje podsumowanie JSON w nowym folderze.

Najczęstsze pytania

Ucz się dalej