python / python/mypy

Allow a base class to restrict the type of subclass's inner class

Đang mở
#14,767 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

feature
Ngôn ngữ chính
Python
Star
20.6k
Fork
3.3k
Chỉ số merge pull request
Chỉ số pull request đang chờ

Mô tả

Feature

For regular classvars, attributes and methods, mypy already checks that the types in a subclass match those declared in the superclass. However, this checking does not extend to inner classes in the subclass. It seems inner classes are ignored by mypy entirely.

For example, a framework could define an abstract class Model whose inner class Meta must implement a certain protocol:

# Defined in the framework
class InnerMetaProtocol(Protocol):
    example_attr: str

class Model:
    Meta: type[InnerMetaProtocol]


# An application developer using framework
class Widget(Model):
    class Meta:
        example_attr = 123  # This should be an error: int is not str

Class Widget implements Model, whose attribute Meta should conform to type[InnerMetaProtocol], meaning it requires attribute example_attr: str. But currently mypy ignores this constraint: Playground.

It's probably useful to support this with not just protocols, but also concrete classes (e.g. Meta: type[ConcreteClass]).

Pitch

This pattern of inner Meta classes is used quite extensively in the Django ecosystem, including for Django models, forms, Django REST Framework serializers, djangorestframework-dataclasses, etc. I'm sure there are other use cases as well, but I don't know off the top of my head.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu với ví dụ Playground của issue và so sánh kiểu được khai báo của Model.Meta với lớp Meta bên trong của lớp con. Công việc hoàn tất khi mypy báo cáo ví dụ int không tương thích và hỗ trợ các trường hợp protocol và lớp cụ thể đã nêu.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
devtools
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.