Tại sao tên của lớp chứa không được nhận dạng là chú thích hàm trả về giá trị?

Question

Tôi sẽ sử dụng Python function annotations để chỉ định loại giá trị trả về của một phương pháp nhà máy tĩnh. Tôi hiểu điều này là one of the desired use cases cho chú thích.

class Trie: 
    @staticmethod 
    def from_mapping(mapping) -> Trie: 
     # docstrings and initialization ommitted 
     trie = Trie() 
     return trie 

PEP 3107 khẳng định rằng:

Chức năng chú thích là gì khác hơn là một cách để kết hợp biểu Python tùy ý với các bộ phận khác nhau của một hàm tại thời gian biên dịch.

Trie là một biểu thức hợp lệ trong Python, phải không? Python không đồng ý hay đúng hơn, không thể tìm thấy tên:

def from_mapping(mapping) -> Trie:
NameError: name 'Trie' is not defined

Nó đáng chú ý rằng lỗi này không xảy ra nếu một loại cơ bản (như object hoặc int) hoặc loại thư viện chuẩn (chẳng hạn như collections.deque) được chỉ định.

Điều gì gây ra lỗi này và cách khắc phục?

Answer 1

PEP 484 cung cấp giải pháp chính thức cho điều này dưới dạng forward references.

Khi gợi ý loại chứa tên chưa được xác định, định nghĩa đó có thể được biểu thị dưới dạng chuỗi ký tự, được giải quyết sau.

Trong trường hợp của mã câu hỏi:

class Trie: 
    @staticmethod 
    def from_mapping(mapping) -> Trie: 
     # docstrings and initialization ommitted 
     trie = Trie() 
     return trie 

trở thành:

class Trie: 
    @staticmethod 
    def from_mapping(mapping) -> 'Trie': 
     # docstrings and initialization ommitted 
     trie = Trie() 
     return trie 

Answer 2

Trie là biểu thức hợp lệ và đánh giá thành giá trị hiện tại được liên kết với tên tên Trie. Nhưng tên đó chưa được xác định - một đối tượng lớp chỉ bị ràng buộc với tên của nó là sau khi nội dung lớp đã chạy để hoàn thành. Bạn sẽ lưu ý hành vi tương tự trong ví dụ đơn giản hơn nhiều này:

class C: 
    myself = C 
    # or even just 
    C 

Thông thường, cách giải quyết sẽ đặt thuộc tính lớp sau khi lớp được xác định, bên ngoài lớp học. Đây không phải là một lựa chọn thực sự tốt ở đây, mặc dù nó hoạt động. Ngoài ra, bạn có thể sử dụng bất kỳ giá trị giữ chỗ trong định nghĩa ban đầu, sau đó thay thế nó trong __annotations__ (mà là hợp pháp vì nó là một cuốn từ điển thường xuyên):

class C: 
    def f() -> ...: pass 
print(C.f.__annotations__) 
C.f.__annotations__['return'] = C 
print(C.f.__annotations__) 

Nó không cảm thấy khá hacky mặc dù. Tùy thuộc vào trường hợp sử dụng của bạn, thay vào đó, bạn có thể sử dụng đối tượng sentinel (ví dụ: CONTAINING_CLASS = object()) và để giải thích cho bất kỳ điều gì thực sự xử lý chú thích.