Log, laporan, konfigurasi, ekspor: cepat atau lambat, setiap skrip menyentuh sistem file. Penanganan file Python mudah untuk memulai, tetapi beberapa detail menentukan apakah kode Anda dapat diandalkan atau secara diam-diam menghancurkan data.

Panduan ini mencakup file teks, CSV, JSON, data biner, dan jalur, dengan fokus pada kebiasaan aman. Kami menjalankan contoh ini di Python 3.13 dalam folder sementara, dan output yang ditampilkan berasal dari proses tersebut.

Buka file dengan open() dan dengan

Fungsi open() bawaan mengembalikan objek file. Gunakan di dalam blok 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

Ketika blok berakhir, Python menutup file, meskipun terjadi kesalahan di dalamnya. Tanpa with, Anda harus memanggil close() sendiri, dan pengecualian dapat melewati baris itu. Menggunakan file setelah ditutup menimbulkan kesalahan:

file.read()

# ValueError: I/O operation on closed file.

Mode berkas

Argumen kedua pada open() mengatakan apa yang Anda rencanakan:

Tambahkan b untuk data biner, seperti pada "rb" atau "wb". Teks adalah defaultnya, dan juga dapat ditulis secara eksplisit sebagai t.

Tulis dan lampirkan

write() tidak menambahkan jeda baris, jadi sertakan \n diri Anda sendiri. Menambahkan mempertahankan apa yang sudah ada:

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

Bandingkan dengan mode "w", yang menggantikan tiga baris kita dengan satu, tanpa peringatan sama sekali:

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

# notes.txt now contains only: replaced

Jika Anda tidak boleh menimpa sesuatu, gunakan "x". Itu memunculkan FileExistsError dalam pengujian kami, karena notes.txt sudah ada.

Membaca file

Ada beberapa cara untuk membaca, dan pilihan yang tepat bergantung pada ukuran file:

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

Perhatikan karakter \n yang disimpan dalam string mentah. strip() menghapusnya. Objek file juga mengingat posisinya, jadi pembacaan dilanjutkan dari bagian terakhirnya:

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

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

Mengulangi file adalah teknik utama untuk log dan ekspor besar. Ia membaca baris demi baris, sehingga file multi-gigabyte tidak harus muat di memori.

Menangani kesalahan file

File mungkin hilang, terkunci, atau tidak dapat dibaca, jadi rencanakan hal tersebut:

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'

Coba buka file dan temukan kesalahannya, daripada memeriksa terlebih dahulu dengan exists(), karena file bisa hilang antara pemeriksaan dan pembukaan. Panduan kami untuk penanganan pengecualian Python mencakup pendekatan ini.

file CSV

Jangan pisahkan sendiri baris CSV dengan koma, karena nilai yang dikutip dapat berisi koma. Modul standar csv menangani aturan tersebut. DictWriter dan DictReader adalah opsi yang paling mudah dibaca:

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

Dua detail penting. Lewati newline="" saat membuka file CSV, seperti yang direkomendasikan dokumentasi, untuk mencegah baris kosong di Windows. Dan setiap nilai kembali sebagai string, bilangan genap, itulah sebabnya kami membutuhkan int() dalam jumlah tersebut. Untuk pekerjaan data yang berat, perpustakaan seperti pandas mungkin lebih cocok.

file JSON

JSON adalah format biasa untuk konfigurasi dan data API. Ini dipetakan dengan rapi ke kamus Python dan mencantumkan:

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

Ingat penamaannya: dump dan load berfungsi dengan file, sedangkan dumps dan loads berfungsi dengan string. Jenis seperti tanggal tidak dapat disimpan secara langsung, jadi Anda perlu mengonversinya menjadi string terlebih dahulu.

Bekerja dengan jalur menggunakan pathlib

Merekatkan jalur bersama-sama dengan string akan merusak sistem operasi. Modul pathlib standar menangani pemisah untuk Anda dan menawarkan pintasan praktis:

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

Yang terakhir ini mengatasi sakit kepala yang umum. Jalur relatif diselesaikan dari tempat Anda menjalankan skrip, bukan dari tempat skrip berada, sehingga membangun jalur dari Path(__file__).parent menghindari banyak kejutan “file tidak ditemukan”.

File biner

File gambar, PDF, dan ZIP bukan teks. Buka dengan b, dan Anda membaca dan menulis bytes, tanpa melibatkan pengkodean:

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'

Menulis lebih aman

Jika suatu program mogok di tengah proses penulisan file penting, Anda mungkin mendapatkan hasil yang rusak. Perbaikan yang umum adalah menulis ke file sementara terlebih dahulu, lalu menukarnya ke tempatnya:

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() menimpa tujuan. Pada sistem file yang sama, penggantian nama umumnya bersifat atomik, sehingga pembaca akan melihat file lama atau baru, bukan campuran setengah tertulis.

Contoh praktis: meringkas log

Naskah pendek ini menyatukan beberapa ide. Ia membaca log satu baris pada satu waktu, jadi ukurannya tidak menjadi masalah, menghitung setiap level menggunakan Counter, dan menulis ringkasan ke file baru:

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

Log sampel kami memiliki lima baris. Baris kosong akan merusak line.split()[0], jadi skrip sebenarnya harus melewati baris kosong terlebih dahulu.

Kesalahan umum

• Menggunakan "w" padahal yang Anda maksud adalah "a". Data Anda yang ada akan langsung hilang saat dibuka, meskipun Anda tidak pernah menulis apa pun.
• Menghilangkan pengkodean. Defaultnya berbeda-beda tergantung sistem, sehingga skrip yang berfungsi di Linux bisa gagal di Windows dengan teks beraksen atau emoji.
• Memanggil read() pada file berukuran besar. Hal ini dapat menghabiskan memori, jadi ulangi baris saja.
• Lupa int() pada nilai CSV. "10" + "20" menghasilkan "1020".
• Menghilangkan newline="" untuk CSV. Anda mungkin mendapatkan baris kosong yang tidak terduga di Windows.
• Tidak menguji kode file. Gunakan perlengkapan tmp_path pytest sehingga pengujian tidak pernah menyentuh file sebenarnya. Lihat tutorial pytest kami.

Penutup

Beberapa kebiasaan mencakup hampir semuanya di sini: gunakan with, atur pengkodeannya, pikirkan dua kali tentang "w", dan biarkan csv, json dan pathlib mengerjakan bagian yang sulit. Untuk berlatih, tulis skrip kecil yang membaca CSV, berjumlah satu kolom dan menyimpan ringkasan JSON ke folder baru.

Pertanyaan yang sering diajukan

Teruslah belajar