Với PEP 557, các lớp dữ liệu được đưa vào thư viện tiêu chuẩn python.

Họ sử dụng trình @dataclasstrang trí và chúng được cho là "các cặp tên có thể thay đổi với mặc định" nhưng tôi không thực sự chắc chắn rằng tôi hiểu điều này thực sự có nghĩa là gì và chúng khác với các lớp thông thường như thế nào.

Chính xác thì các lớp dữ liệu python là gì và khi nào thì tốt nhất để sử dụng chúng?

Các lớp dữ liệu chỉ là các lớp thông thường hướng tới trạng thái lưu trữ, nhiều hơn là chứa rất nhiều logic. Mỗi khi bạn tạo một lớp chủ yếu bao gồm các thuộc tính, bạn đã tạo một lớp dữ liệu.

Những gì dataclassesmô-đun làm là giúp tạo các lớp dữ liệu dễ dàng hơn . Nó sẽ chăm sóc rất nhiều tấm nồi hơi cho bạn.

Điều này đặc biệt quan trọng khi lớp dữ liệu của bạn phải có thể băm được; điều này đòi hỏi một __hash__phương pháp cũng như một __eq__phương pháp. Nếu bạn thêm một __repr__phương thức tùy chỉnh để dễ gỡ lỗi, điều đó có thể trở nên khá dài dòng:

class InventoryItem:
    '''Class for keeping track of an item in inventory.'''
    name: str
    unit_price: float
    quantity_on_hand: int = 0

    def __init__(
            self, 
            name: str, 
            unit_price: float,
            quantity_on_hand: int = 0
        ) -> None:
        self.name = name
        self.unit_price = unit_price
        self.quantity_on_hand = quantity_on_hand

    def total_cost(self) -> float:
        return self.unit_price * self.quantity_on_hand

    def __repr__(self) -> str:
        return (
            'InventoryItem('
            f'name={self.name!r}, unit_price={self.unit_price!r}, '
            f'quantity_on_hand={self.quantity_on_hand!r})'

    def __hash__(self) -> int:
        return hash((self.name, self.unit_price, self.quantity_on_hand))

    def __eq__(self, other) -> bool:
        if not isinstance(other, InventoryItem):
            return NotImplemented
        return (
            (self.name, self.unit_price, self.quantity_on_hand) == 
            (other.name, other.unit_price, other.quantity_on_hand))

Với dataclassesbạn có thể giảm nó thành:

from dataclasses import dataclass

@dataclass(unsafe_hash=True)
class InventoryItem:
    '''Class for keeping track of an item in inventory.'''
    name: str
    unit_price: float
    quantity_on_hand: int = 0

    def total_cost(self) -> float:
        return self.unit_price * self.quantity_on_hand

Lớp trang trí tương tự cũng có thể tạo ra các phương pháp so sánh ( __lt__, __gt__, vv) và xử lý bất biến.

namedtuplecác lớp cũng là các lớp dữ liệu, nhưng không thay đổi theo mặc định (cũng như là các chuỗi). dataclasseslinh hoạt hơn nhiều trong vấn đề này và có thể dễ dàng được cấu trúc để chúng có thể thực hiện cùng một vai trò như một namedtuplelớp .

PEP được lấy cảm hứng từ attrsdự án , có thể làm được nhiều hơn thế (bao gồm vị trí, trình xác thực, trình chuyển đổi, siêu dữ liệu, v.v.).

Nếu bạn muốn xem một số ví dụ, gần đây tôi đã sử dụng dataclassesmột số giải pháp Advent of Code của mình , hãy xem các giải pháp cho ngày 7 , ngày 8 , ngày 11 và ngày 20 .

Nếu bạn muốn sử dụng dataclassesmô-đun trong các phiên bản Python <3.7, thì bạn có thể cài đặt mô-đun được báo cáo ngược (yêu cầu 3.6) hoặc sử dụng attrsdự án được đề cập ở trên.

Tổng quat

Câu hỏi đã được giải quyết. Tuy nhiên, câu trả lời này bổ sung thêm một số ví dụ thực tế để hỗ trợ hiểu biết cơ bản về kính dữ liệu.

Chính xác thì các lớp dữ liệu python là gì và khi nào thì tốt nhất để sử dụng chúng?

1. bộ tạo mã : tạo mã chương trình; bạn có thể chọn triển khai các phương thức đặc biệt trong một lớp thông thường hoặc để một kính dữ liệu tự động triển khai chúng.
2. vùng chứa dữ liệu : các cấu trúc lưu giữ dữ liệu (ví dụ: bộ giá trị và bộ số), thường có quyền truy cập thuộc tính, có dấu chấm, chẳng hạn như các lớp namedtuplevà các cấu trúc khác .

"các cặp có tên có thể thay đổi với [s] mặc định"

Đây là ý nghĩa của cụm từ sau:

• có thể thay đổi : theo mặc định, các thuộc tính dataclass có thể được gán lại. Bạn có thể tùy ý biến chúng thành bất biến (xem Ví dụ bên dưới).
• Nametuple : bạn có quyền truy cập thuộc tính dạng chấm, giống như một namedtuplehoặc một lớp thông thường.
• default : bạn có thể gán giá trị mặc định cho các thuộc tính.

So với các lớp thông thường, bạn chủ yếu tiết kiệm khi nhập mã soạn sẵn.

Đặc trưng

Đây là tổng quan về các tính năng của dataclass (TL; DR? Xem Bảng Tóm tắt trong phần tiếp theo).

Những gì bạn nhận được

Đây là các tính năng bạn nhận được theo mặc định từ dataclasses.

Thuộc tính + Đại diện + So sánh

import dataclasses


@dataclasses.dataclass
#@dataclasses.dataclass()                                       # alternative
class Color:
    r : int = 0
    g : int = 0
    b : int = 0

Các giá trị mặc định này được cung cấp bằng cách tự động đặt các từ khóa sau thành True:

@dataclasses.dataclass(init=True, repr=True, eq=True)

Những gì bạn có thể bật

Các tính năng bổ sung có sẵn nếu các từ khóa thích hợp được đặt thành True.

Đặt hàng

@dataclasses.dataclass(order=True)
class Color:
    r : int = 0
    g : int = 0
    b : int = 0

Các phương thức sắp xếp hiện được thực hiện (nạp chồng toán tử < > <= >=:), tương tự như functools.total_orderingvới các bài kiểm tra bình đẳng mạnh hơn.

Có thể thay đổi, có thể thay đổi

@dataclasses.dataclass(unsafe_hash=True)                        # override base `__hash__`
class Color:
    ...

Mặc dù đối tượng có khả năng thay đổi (có thể không mong muốn), một hàm băm được thực hiện.

Có thể thay đổi, bất biến

@dataclasses.dataclass(frozen=True)                             # `eq=True` (default) to be immutable 
class Color:
    ...

Hàm băm hiện đã được triển khai và việc thay đổi đối tượng hoặc gán cho các thuộc tính là không được phép.

Nhìn chung, đối tượng có thể được băm nếu một trong hai unsafe_hash=Truehoặc frozen=True.

Xem thêm bảng logic băm ban đầu với nhiều chi tiết hơn.

Những gì bạn không nhận được

Để có được các tính năng sau, các phương pháp đặc biệt phải được triển khai thủ công:

Mở gói

@dataclasses.dataclass
class Color:
    r : int = 0
    g : int = 0
    b : int = 0

    def __iter__(self):
        yield from dataclasses.astuple(self)

Tối ưu hóa

@dataclasses.dataclass
class SlottedColor:
    __slots__ = ["r", "b", "g"]
    r : int
    g : int
    b : int

Kích thước đối tượng hiện đã giảm:

>>> imp sys
>>> sys.getsizeof(Color)
1056
>>> sys.getsizeof(SlottedColor)
888

Trong một số trường hợp, __slots__cũng cải thiện tốc độ tạo phiên bản và truy cập thuộc tính. Ngoài ra, các vị trí không cho phép các nhiệm vụ mặc định; nếu không, a ValueErrorđược nâng lên.

Xem thêm về các vị trí trong bài đăng blog này .

Bảng tóm tắt

+----------------------+----------------------+----------------------------------------------------+-----------------------------------------+
|       Feature        |       Keyword        |                      Example                       |           Implement in a Class          |
+----------------------+----------------------+----------------------------------------------------+-----------------------------------------+
| Attributes           |  init                |  Color().r -> 0                                    |  __init__                               |
| Representation       |  repr                |  Color() -> Color(r=0, g=0, b=0)                   |  __repr__                               |
| Comparision*         |  eq                  |  Color() == Color(0, 0, 0) -> True                 |  __eq__                                 |
|                      |                      |                                                    |                                         |
| Order                |  order               |  sorted([Color(0, 50, 0), Color()]) -> ...         |  __lt__, __le__, __gt__, __ge__         |
| Hashable             |  unsafe_hash/frozen  |  {Color(), {Color()}} -> {Color(r=0, g=0, b=0)}    |  __hash__                               |
| Immutable            |  frozen + eq         |  Color().r = 10 -> TypeError                       |  __setattr__, __delattr__               |
|                      |                      |                                                    |                                         |
| Unpacking+           |  -                   |  r, g, b = Color()                                 |   __iter__                              |
| Optimization+        |  -                   |  sys.getsizeof(SlottedColor) -> 888                |  __slots__                              |
+----------------------+----------------------+----------------------------------------------------+-----------------------------------------+

_{⁺ Các phương thức này không được tạo tự động và yêu cầu thực hiện thủ công trong một dataclass.}

_{^* __ne__ không cần thiết và do đó không được thực hiện .}

Tính năng bổ sung

Hậu khởi tạo

@dataclasses.dataclass
class RGBA:
    r : int = 0
    g : int = 0
    b : int = 0
    a : float = 1.0

    def __post_init__(self):
        self.a : int =  int(self.a * 255)


RGBA(127, 0, 255, 0.5)
# RGBA(r=127, g=0, b=255, a=127)

Di sản

@dataclasses.dataclass
class RGBA(Color):
    a : int = 0

Chuyển đổi

Chuyển đổi một kính dữ liệu thành một bộ hoặc một chính tả, một cách đệ quy :

>>> dataclasses.astuple(Color(128, 0, 255))
(128, 0, 255)
>>> dataclasses.asdict(Color(128, 0, 255))
{'r': 128, 'g': 0, 'b': 255}

Hạn chế

• Thiếu cơ chế để xử lý các đối số được gắn dấu sao
• Làm việc với các kính dữ liệu lồng nhau có thể phức tạp

Người giới thiệu

• Bài nói chuyện của R. Hettinger trên Dataclasses: Trình tạo mã để kết thúc tất cả các trình tạo mã
• Bài nói chuyện của T. Hunner về Lớp học dễ dàng hơn: Lớp học Python không có tất cả những gì nguy hiểm
• Tài liệu của Python về chi tiết băm
• Hướng dẫn của Real Python về Hướng dẫn cơ bản về lớp dữ liệu trong Python 3.7
• Bài đăng trên blog của A. Shaw về Chuyến tham quan ngắn gọn về các lớp dữ liệu Python 3.7
• Kho lưu trữ github của E. Smith trên dataclasses

Hãy xem xét lớp học đơn giản này Foo

from dataclasses import dataclass
@dataclass
class Foo:    
    def bar():
        pass  

Đây là dir()so sánh được tích hợp sẵn. Ở bên trái là Fookhông có trình trang trí @dataclass và ở bên phải là không có trình trang trí @dataclass.

Đây là một khác biệt khác, sau khi sử dụng inspectmô-đun để so sánh.

Từ thông số kỹ thuật PEP :

Một trình trang trí lớp được cung cấp để kiểm tra định nghĩa lớp cho các biến có chú thích kiểu như được định nghĩa trong PEP 526, "Cú pháp cho chú thích biến". Trong tài liệu này, các biến như vậy được gọi là trường. Sử dụng các trường này, trình trang trí thêm các định nghĩa phương thức đã tạo vào lớp để hỗ trợ khởi tạo phiên bản, đại diện, các phương thức so sánh và các phương thức tùy chọn khác như được mô tả trong phần Đặc tả. Một lớp như vậy được gọi là Lớp Dữ liệu, nhưng thực sự không có gì đặc biệt về lớp: trình trang trí thêm các phương thức đã tạo vào lớp và trả về cùng một lớp mà nó đã được cấp.

Các @dataclassmáy phát điện bổ sung thêm phương thức cho lớp mà bạn muốn bằng cách khác xác định mình như __repr__, __init__, __lt__, và __gt__.