Penghias Python: Panduan Komprehensif

Apabila saya memulakan pengaturcaraan dengan Python, jika tidak silap saya, versinya ialah 3.3. Oleh itu, apabila saya memulakan pengaturcaraan, penghias telah tersedia untuk komuniti Python untuk masa yang lama.

Penghias fungsi datang ke Python dengan versi 2.2 dan penghias Kelas datang ke Python dengan versi 2.6.

Secara peribadi, saya melihat ciri Penghias Python sebagai ciri bahasa yang sangat berkuasa.

Sebenarnya, matlamat saya adalah untuk membuat satu siri artikel tentang topik yang paling sukar difahami dalam Python. Saya bercadang untuk membincangkan topik ini, yang lebih sedikit daripada sepuluh, satu persatu.

Dalam artikel ini, saya akan cuba menyentuh setiap bahagian topik Penghias sejauh yang saya boleh.

1. Konteks Sejarah

• Hari Awal (Pra-Python 2.2): Sebelum penghias, mengubah suai fungsi atau kelas selalunya melibatkan pembalut manual atau tampalan monyet, yang menyusahkan dan kurang boleh dibaca.
• Metaclasses (Python 2.2): Metaclasses menyediakan cara untuk mengawal penciptaan kelas, menawarkan beberapa fungsi yang penghias kemudiannya akan sediakan, tetapi ia adalah kompleks untuk pengubahsuaian mudah.
• PEP 318 (Python 2.4): Penghias secara rasmi diperkenalkan dalam Python 2.4 melalui PEP 318. Cadangan ini diilhamkan oleh anotasi dalam Java dan bertujuan untuk menyediakan cara yang lebih bersih dan lebih deklaratif untuk mengubah suai fungsi dan kaedah .
• Penghias Kelas (Python 2.6): Python 2.6 melanjutkan sokongan penghias kepada kelas, meningkatkan lagi kepelbagaian mereka.
• Penggunaan Meluas: Penghias dengan cepat menjadi ciri popular, digunakan secara meluas dalam rangka kerja seperti Flask dan Django untuk penghalaan, pengesahan dan banyak lagi.

2. Apakah itu Penghias?

Pada dasarnya, penghias ialah corak reka bentuk dalam Python yang membolehkan anda mengubah suai gelagat fungsi atau kelas tanpa mengubah struktur terasnya. Penghias ialah satu bentuk pengaturcaraan meta, di mana anda pada asasnya menulis kod yang memanipulasi kod lain.

Anda tahu Python menyelesaikan nama menggunakan skop yang diberikan mengikut urutan di bawah:

1. Tempatan
2. Melampirkan
3. Global
4. Terbina dalam

Penghias adalah skop Melampirkan duduk, yang berkait rapat dengan konsep Penutupan.

Idea Utama: Seorang penghias mengambil fungsi sebagai input, menambah beberapa fungsi padanya dan mengembalikan fungsi yang diubah suai.

Analogi: Fikirkan penghias sebagai pembalut hadiah. Anda mempunyai hadiah (fungsi asal), dan anda membungkusnya dengan kertas hiasan (penghias) untuk menjadikannya kelihatan lebih menarik atau menambah ciri tambahan (seperti haluan atau kad). Hadiah di dalamnya tetap sama, tetapi persembahannya atau tindakan yang berkaitan dipertingkatkan.

A) Variasi Penghias: Berasaskan fungsi vs. Berasaskan Kelas

Kebanyakan penghias dalam Python dilaksanakan menggunakan fungsi, tetapi anda juga boleh mencipta penghias menggunakan kelas.
Penghias berasaskan fungsi adalah lebih biasa dan lebih ringkas, manakala penghias berasaskan kelas menawarkan fleksibiliti tambahan.

Sintaks Penghias Asas berasaskan fungsi

def my_decorator(func):
    def wrapper(*args, **kwargs):
        # Do something before calling the decorated function
        print("Before function call")
        result = func(*args, **kwargs)
        # Do something after calling the decorated function
        print("After function call")
        return result
    return wrapper

@my_decorator
def say_hello(name):
    print(f"Hello, {name}!")

say_hello("World")

Penjelasan:

• my_decorator ialah fungsi penghias. Ia memerlukan fungsi fungsi untuk dihias sebagai input.
• wrapper ialah fungsi dalaman yang membalut panggilan fungsi asal. Ia boleh melaksanakan kod sebelum dan selepas fungsi asal.
• @my_decorator ialah sintaks penghias. Ia sama dengan say_hello = my_decorator(say_hello).

Sintaks Penghias Asas berasaskan kelas

Ini menggunakan kelas dan bukannya fungsi untuk menentukan penghias.

class MyDecorator:
    def __init__(self, func):
        self.func = func

    def __call__(self, *args, **kwargs):
        # Do something before calling the decorated function
        print("Before function call")
        result = self.func(*args, **kwargs)
        # Do something after calling the decorated function
        print("After function call")
        return result

@MyDecorator
def say_hello(name):
    print(f"Hello, {name}!")

say_hello("World")

Penjelasan:

• MyDecorator ialah kelas yang bertindak sebagai penghias.
• Kaedah __init__ menyimpan fungsi untuk dihias.
• Kaedah __call__ menjadikan contoh kelas boleh dipanggil, membenarkannya digunakan seperti fungsi.

B) Melaksanakan Penghias Mudah

Konsep asas penghias ialah fungsi yang mengambil fungsi lain sebagai hujah dan memanjangkan tingkah lakunya tanpa mengubahnya secara eksplisit.
Berikut ialah bentuk paling mudah:

def my_decorator(func):
    def wrapper():
        print("Something is happening before the function is called.")
        func()
        print("Something is happening after the function is called.")
    return wrapper

# Using the decorator with @ syntax
@my_decorator
def say_hello():
    print("Hello!")

# When we call say_hello()
say_hello()

# This is equivalent to:
# say_hello = my_decorator(say_hello)

C) Melaksanakan Penghias dengan Hujah

Mari kita buat penghias yang merekodkan masa pelaksanaan fungsi:

def decorator_with_args(func):
    def wrapper(*args, **kwargs):    # Accept any number of arguments
        print(f"Arguments received: {args}, {kwargs}")
        return func(*args, **kwargs)  # Pass arguments to the original function
    return wrapper

@decorator_with_args
def greet(name, greeting="Hello"):
    print(f"{greeting}, {name}!")

greet("Alice", greeting="Hi")  # Prints arguments then "Hi, Alice!"

D) Melaksanakan Penghias Berparameter

Ini adalah penghias yang boleh menerima parameter mereka sendiri:

def repeat(times):
    def decorator(func):
        def wrapper(*args, **kwargs):
            for _ in range(times):
                result = func(*args, **kwargs)
            return result
        return wrapper
    return decorator

@repeat(times=3)
def greet(name):
    print(f"Hello {name}")
    return "Done"

greet("Bob")  # Prints "Hello Bob" three times

E) Melaksanakan Penghias Kelas

def singleton(cls):
    instances = {}
    def get_instance(*args, **kwargs):
        if cls not in instances:
            instances[cls] = cls(*args, **kwargs)
        return instances[cls]
    return get_instance

@singleton
class DatabaseConnection:
    def __init__(self):
        print("Initializing database connection")

# Creating multiple instances actually returns the same instance
db1 = DatabaseConnection()  # Prints initialization
db2 = DatabaseConnection()  # No initialization printed
print(db1 is db2)  # True

F) Melaksanakan Penghias Kaedah

Ini direka khusus untuk kaedah kelas:

def debug_method(func):
    def wrapper(self, *args, **kwargs):
        print(f"Calling method {func.__name__} of {self.__class__.__name__}")
        return func(self, *args, **kwargs)
    return wrapper

class MyClass:
    @debug_method
    def my_method(self, x, y):
        return x + y

obj = MyClass()
print(obj.my_method(5, 3))

G) Melaksanakan Dekorator Chaining

Berbilang penghias boleh digunakan untuk satu fungsi:

def bold(func):
    def wrapper():
        return "<b>" + func() + "</b>"
    return wrapper

def italic(func):
    def wrapper():
        return "<i>" + func() + "</i>"
    return wrapper

@bold
@italic
def greet():
    return "Hello!"

print(greet())  # Outputs: <b><i>Hello!</i></b>

Penjelasan:

• Penghias digunakan dari bawah ke atas.
• Ia lebih seperti apa yang kita lakukan dalam matematik: f(g(x)).
• condong digunakan dahulu, kemudian tebal.

H) Apakah yang berlaku jika kita tidak menggunakan @functools.wraps ?

Penghias functools.wraps, Lihat dokumen, ialah fungsi pembantu yang mengekalkan metadata fungsi asal (seperti namanya, docstring dan tandatangan) apabila anda membalutnya dengan penghias. Jika anda tidak menggunakannya, anda akan kehilangan maklumat penting ini.

Contoh:

def my_decorator(func):
    def wrapper(*args, **kwargs):
        """Wrapper docstring"""
        return func(*args, **kwargs)
    return wrapper

@my_decorator
def my_function():
    """My function docstring"""
    pass

print(my_function.__name__)
print(my_function.__doc__)

Output:

wrapper
Wrapper docstring

Masalah:

• Nama fungsi asal (my_function) dan docstring ("My function docstring") hilang.
• Ini boleh menyukarkan penyahpepijatan dan introspeksi.

Penyelesaian: Gunakan functools.wraps):

def my_decorator(func):
    def wrapper(*args, **kwargs):
        # Do something before calling the decorated function
        print("Before function call")
        result = func(*args, **kwargs)
        # Do something after calling the decorated function
        print("After function call")
        return result
    return wrapper

@my_decorator
def say_hello(name):
    print(f"Hello, {name}!")

say_hello("World")

Output:

class MyDecorator:
    def __init__(self, func):
        self.func = func

    def __call__(self, *args, **kwargs):
        # Do something before calling the decorated function
        print("Before function call")
        result = self.func(*args, **kwargs)
        # Do something after calling the decorated function
        print("After function call")
        return result

@MyDecorator
def say_hello(name):
    print(f"Hello, {name}!")

say_hello("World")

Kebaikan functools.wraps:

• Mengekalkan metadata fungsi.
• Meningkatkan kebolehbacaan dan kebolehselenggaraan kod.
• Menjadikan penyahpepijatan lebih mudah.
• Membantu dengan alat introspeksi dan penjana dokumentasi.

I) Penghias dengan Negeri

Penghias juga boleh mengekalkan keadaan antara panggilan fungsi. Ini amat berguna untuk senario seperti caching atau mengira panggilan fungsi.

def my_decorator(func):
    def wrapper():
        print("Something is happening before the function is called.")
        func()
        print("Something is happening after the function is called.")
    return wrapper

# Using the decorator with @ syntax
@my_decorator
def say_hello():
    print("Hello!")

# When we call say_hello()
say_hello()

# This is equivalent to:
# say_hello = my_decorator(say_hello)

Output:

def decorator_with_args(func):
    def wrapper(*args, **kwargs):    # Accept any number of arguments
        print(f"Arguments received: {args}, {kwargs}")
        return func(*args, **kwargs)  # Pass arguments to the original function
    return wrapper

@decorator_with_args
def greet(name, greeting="Hello"):
    print(f"{greeting}, {name}!")

greet("Alice", greeting="Hi")  # Prints arguments then "Hi, Alice!"

Penjelasan:

Fungsi pembalut mengekalkan pembilang (panggilan) yang bertambah setiap kali fungsi yang dihias dipanggil.
Ini ialah contoh mudah cara penghias boleh digunakan untuk mengekalkan keadaan.

J) Amalan Terbaik untuk Penghias Python

• Gunakan functools.wraps: Sentiasa gunakan @functools.wraps dalam penghias anda untuk mengekalkan metadata fungsi asal.
• Pastikan Penghias Mudah: Penghias sepatutnya melakukan satu perkara khusus dan melakukannya dengan baik. Ini menjadikan mereka lebih boleh digunakan semula dan lebih mudah difahami.
• Dokumenkan Penghias Anda: Terangkan perkara yang dilakukan oleh penghias anda, hujah yang diperlukan dan perkara yang dikembalikan.
• Uji Penghias Anda: Tulis ujian unit untuk memastikan penghias anda berfungsi seperti yang diharapkan dalam pelbagai senario.
• Pertimbangkan Susunan Rantaian: Berhati-hati dengan susunan apabila merantai berbilang penghias, kerana ia mempengaruhi aliran pelaksanaan.

K) Pelaksanaan Buruk (Anti-Corak)

• Penghias Terlalu Kompleks: Elakkan mencipta penghias yang terlalu kompleks atau cuba melakukan terlalu banyak perkara. Ini menjadikan mereka sukar untuk difahami, diselenggara dan nyahpepijat.
• Mengabaikan functools.wraps: Terlupa menggunakan @functools.wraps membawa kepada kehilangan metadata fungsi, yang boleh menyebabkan masalah dengan introspeksi dan penyahpepijatan.
• Kesan Sampingan: Penghias sepatutnya tidak mempunyai kesan sampingan yang tidak diingini di luar mengubah suai fungsi yang dihias.
• Nilai Pengekodan Keras: Elakkan nilai pengekodan keras dalam penghias. Sebaliknya, gunakan kilang penghias untuk menjadikannya boleh dikonfigurasikan.
• Tidak Mengendalikan Hujah dengan Betul: Pastikan fungsi pembalut anda boleh mengendalikan sebarang bilangan hujah kedudukan dan kata kunci menggunakan *args dan **kwargs jika penghias dimaksudkan untuk digunakan dengan pelbagai fungsi.

L) 10. Kes Penggunaan Dunia Sebenar

• Log: Merakam panggilan fungsi, hujah dan nilai pulangan untuk penyahpepijatan atau pengauditan.
• Masa: Mengukur masa pelaksanaan fungsi untuk analisis prestasi.
• Caching: Menyimpan hasil panggilan fungsi yang mahal untuk mengelakkan pengiraan berlebihan (memoisasi).
• Pengesahan dan Keizinan: Mengesahkan kelayakan atau kebenaran pengguna sebelum melaksanakan fungsi.
• Pengesahan Input: Menyemak sama ada hujah yang dihantar ke fungsi memenuhi kriteria tertentu.
• Penghadan Kadar: Mengawal bilangan kali fungsi boleh dipanggil dalam tempoh masa tertentu.
• Cuba Semula Logik: Mencuba semula panggilan fungsi secara automatik jika ia gagal disebabkan ralat sementara.
• Tugas Khusus Rangka Kerja: Rangka kerja seperti Flask dan Django menggunakan penghias untuk penghalaan (memetakan URL ke fungsi), mendaftarkan pemalam dan banyak lagi.

M) Senarai Pilihan Penghias Python

Anda boleh menemui senarai susun atur penghias Python di bawah:

• Penghias Ular Ular yang Hebat
• Perpustakaan Penghias Python

N) 11. Kesimpulan

Penghias ialah ciri yang berkuasa dan elegan dalam Python yang membolehkan anda mempertingkatkan fungsi dan kelas dengan cara yang bersih dan deklaratif.
Dengan memahami prinsip, amalan terbaik dan kemungkinan perangkap, anda boleh memanfaatkan penghias dengan berkesan untuk menulis kod yang lebih modular, boleh diselenggara dan ekspresif.
Ia adalah alat yang berharga dalam mana-mana senjata pengaturcara Python, terutamanya apabila bekerja dengan rangka kerja atau membina komponen yang boleh digunakan semula.

Atas ialah kandungan terperinci Penghias Python: Panduan Komprehensif. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!