Untuk apa pernyataan python “with” dirancang?

Saya menemukan withpernyataan Python untuk pertama kalinya hari ini. Saya telah menggunakan Python ringan selama beberapa bulan dan bahkan tidak tahu keberadaannya! Mengingat statusnya yang agak tidak jelas, saya pikir patut bertanya:

1. Untuk apa withpernyataan Python dirancang untuk digunakan?
2. Untuk apa Anda menggunakannya?
3. Apakah ada gotcha yang perlu saya ketahui, atau anti-pola umum yang terkait dengan penggunaannya? Adakah kasus yang lebih baik digunakan try..finallydaripada with?
4. Mengapa tidak digunakan lebih luas?
5. Kelas perpustakaan standar apa yang kompatibel dengannya?

1. Saya percaya ini sudah dijawab oleh pengguna lain sebelum saya, jadi saya hanya menambahkannya demi kelengkapan: withpernyataan tersebut menyederhanakan penanganan pengecualian dengan merangkum persiapan umum dan tugas pembersihan dalam apa yang disebut manajer konteks . Rincian lebih lanjut dapat ditemukan di PEP 343 . Misalnya, openpernyataan itu sendiri adalah manajer konteks, yang memungkinkan Anda membuka file, tetap membuka selama eksekusi dalam konteks withpernyataan di mana Anda menggunakannya, dan tutup segera setelah Anda meninggalkan konteks, tidak peduli apakah Anda telah meninggalkannya karena pengecualian atau selama aliran kontrol reguler. The withpernyataan demikian dapat digunakan dengan cara yang mirip dengan pola RAII di C ++: beberapa sumber daya diperoleh olehwithpernyataan dan dirilis ketika Anda meninggalkan withkonteks.

2. Beberapa contoh adalah: membuka file menggunakan with open(filename) as fp:, memperoleh kunci menggunakan with lock:(di mana lockmerupakan instance dari threading.Lock). Anda juga dapat membuat manajer konteks sendiri menggunakan contextmanagerdekorator contextlib. Misalnya, saya sering menggunakan ini ketika saya harus mengubah direktori saat ini sementara dan kemudian kembali ke tempat saya sebelumnya:

   from contextlib import contextmanager
   import os
   
   @contextmanager
   def working_directory(path):
       current_dir = os.getcwd()
       os.chdir(path)
       try:
           yield
       finally:
           os.chdir(current_dir)
   
   with working_directory("data/stuff"):
       # do something within data/stuff
   # here I am back again in the original working directory

   Berikut adalah contoh lain yang sementara dialihkan sys.stdin, sys.stdoutdan sys.stderrke beberapa file lain menangani dan mengembalikannya nanti:

   from contextlib import contextmanager
   import sys
   
   @contextmanager
   def redirected(**kwds):
       stream_names = ["stdin", "stdout", "stderr"]
       old_streams = {}
       try:
           for sname in stream_names:
               stream = kwds.get(sname, None)
               if stream is not None and stream != getattr(sys, sname):
                   old_streams[sname] = getattr(sys, sname)
                   setattr(sys, sname, stream)
           yield
       finally:
           for sname, stream in old_streams.iteritems():
               setattr(sys, sname, stream)
   
   with redirected(stdout=open("/tmp/log.txt", "w")):
        # these print statements will go to /tmp/log.txt
        print "Test entry 1"
        print "Test entry 2"
   # back to the normal stdout
   print "Back to normal stdout again"

   Dan akhirnya, contoh lain yang membuat folder sementara dan membersihkannya ketika meninggalkan konteks:

   from tempfile import mkdtemp
   from shutil import rmtree
   
   @contextmanager
   def temporary_dir(*args, **kwds):
       name = mkdtemp(*args, **kwds)
       try:
           yield name
       finally:
           shutil.rmtree(name)
   
   with temporary_dir() as dirname:
       # do whatever you want

Saya akan menyarankan dua kuliah yang menarik:

• PEP 343 Pernyataan "dengan"
• Effbot Memahami pernyataan "dengan" Python

1. The withpernyataan digunakan untuk membungkus eksekusi blok dengan metode yang didefinisikan oleh manajer konteks. Ini memungkinkan try...except...finallypola penggunaan umum untuk dienkapsulasi agar nyaman digunakan kembali.

2. Anda dapat melakukan sesuatu seperti:

with open("foo.txt") as foo_file:
    data = foo_file.read()

ATAU

from contextlib import nested
with nested(A(), B(), C()) as (X, Y, Z):
   do_something()

ATAU (Python 3.1)

with open('data') as input_file, open('result', 'w') as output_file:
   for line in input_file:
     output_file.write(parse(line))

ATAU

lock = threading.Lock()
with lock:
    # Critical section of code

3. Saya tidak melihat Antipattern di sini.
Mengutip Menyelam ke Python :

coba .. akhirnya baik. dengan lebih baik.

4. Saya kira itu terkait dengan kebiasaan programmer untuk menggunakan try..catch..finallypernyataan dari bahasa lain.

withPernyataan Python adalah dukungan bahasa bawaan dari Resource Acquisition Is Initializationidiom yang biasa digunakan dalam C ++. Hal ini dimaksudkan untuk memungkinkan akuisisi dan pelepasan sumber daya sistem operasi yang aman.

The withPernyataan menciptakan sumber daya dalam lingkup / blok. Anda menulis kode menggunakan sumber daya di dalam blok. Ketika blok keluar sumber daya dilepaskan dengan bersih terlepas dari hasil kode dalam blok (yaitu apakah blok keluar secara normal atau karena pengecualian).

Banyak sumber daya di pustaka Python yang mematuhi protokol yang diperlukan oleh withpernyataan dan dapat digunakan dengan itu out-of-the-box. Namun siapa pun dapat membuat sumber daya yang dapat digunakan dalam pernyataan with dengan mengimplementasikan protokol yang terdokumentasi dengan baik: PEP 0343

Gunakan setiap kali Anda memperoleh sumber daya dalam aplikasi Anda yang harus dilepaskan secara eksplisit seperti file, koneksi jaringan, kunci dan sejenisnya.

Sekali lagi untuk kelengkapan, saya akan menambahkan kasus penggunaan saya yang paling berguna untuk withpernyataan.

Saya melakukan banyak komputasi ilmiah dan untuk beberapa kegiatan saya membutuhkan Decimalperpustakaan untuk perhitungan presisi yang sewenang-wenang. Beberapa bagian dari kode saya, saya perlu presisi tinggi dan untuk sebagian besar bagian lain saya perlu kurang presisi.

Saya mengatur presisi default saya ke angka rendah dan kemudian gunakan withuntuk mendapatkan jawaban yang lebih tepat untuk beberapa bagian:

from decimal import localcontext

with localcontext() as ctx:
    ctx.prec = 42   # Perform a high precision calculation
    s = calculate_something()
s = +s  # Round the final result back to the default precision

Saya sering menggunakan ini dengan Uji Hypergeometrik yang membutuhkan pembagian angka besar yang menghasilkan faktorial. Ketika Anda melakukan perhitungan skala genom, Anda harus berhati-hati terhadap kesalahan pembulatan dan luapan.

Contoh dari antipattern mungkin menggunakan withloop dalam ketika akan lebih efisien untuk memiliki withloop luar

sebagai contoh

for row in lines:
    with open("outfile","a") as f:
        f.write(row)

vs.

with open("outfile","a") as f:
    for row in lines:
        f.write(row)

Cara pertama adalah membuka dan menutup file untuk masing-masing rowyang dapat menyebabkan masalah kinerja dibandingkan dengan cara kedua dengan membuka dan menutup file hanya sekali.

Lihat PEP 343 - Pernyataan 'dengan' , ada bagian contoh di akhir.

... pernyataan baru "with" ke bahasa Python untuk memungkinkan untuk memperhitungkan penggunaan standar dari pernyataan try / akhirnya.

poin 1, 2, dan 3 dicakup dengan cukup baik:

4: ini relatif baru, hanya tersedia di python2.6 + (atau python2.5 menggunakan from __future__ import with_statement)

Pernyataan with bekerja dengan apa yang disebut manajer konteks:

http://docs.python.org/release/2.5.2/lib/typecontextmanager.html

Idenya adalah untuk menyederhanakan penanganan pengecualian dengan melakukan pembersihan yang diperlukan setelah meninggalkan blok 'with'. Beberapa built-in python sudah berfungsi sebagai manajer konteks.

Contoh lain untuk dukungan out-of-the-box, dan yang mungkin agak membingungkan pada awalnya ketika Anda terbiasa dengan cara open()berperilaku built-in , adalah connectionobjek modul database populer seperti:

• sqlite3
• psycopg2
• cx_oracle

The connectionobjek adalah manajer konteks dan dengan demikian dapat digunakan out-of-the-box dalam with-statement, namun ketika menggunakan catatan di atas bahwa:

Ketika with-blockselesai, baik dengan pengecualian atau tanpa, koneksi tidak ditutup . Dalam hal with-blockselesai dengan pengecualian, transaksi dibatalkan, jika tidak, transaksi dilakukan.

Ini berarti bahwa programmer harus berhati-hati untuk menutup koneksi sendiri, tetapi memungkinkan untuk memperoleh koneksi, dan menggunakannya secara berganda with-statements, seperti yang ditunjukkan dalam dokumen psycopg2 :

conn = psycopg2.connect(DSN)

with conn:
    with conn.cursor() as curs:
        curs.execute(SQL1)

with conn:
    with conn.cursor() as curs:
        curs.execute(SQL2)

conn.close()

Dalam contoh di atas, Anda akan mencatat bahwa cursorobjek psycopg2juga adalah manajer konteks. Dari dokumentasi yang relevan tentang perilaku:

Ketika cursorkeluar with-blockitu ditutup, melepaskan sumber daya apa pun yang akhirnya dikaitkan dengannya. Keadaan transaksi tidak terpengaruh.

Dalam python umumnya pernyataan " with " digunakan untuk membuka file, memproses data yang ada dalam file, dan juga untuk menutup file tanpa memanggil metode close (). Pernyataan "dengan" membuat pengecualian penanganan lebih sederhana dengan menyediakan kegiatan pembersihan.

Bentuk umum dengan:

with open(“file name”, “mode”) as file-var:
    processing statements

catatan: tidak perlu menutup file dengan memanggil close () setelah file-var.close ()