BaseController does not check for python attribute name clashes

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#437 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
78/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
backend

Hướng nghiên cứu

Bắt đầu bằng cách tìm BaseController và _check_for_name_clash, sau đó đọc các bài kiểm tra hiện có về xung đột tên. Mở rộng bước kiểm tra để phát hiện các tên thuộc tính dành riêng của Python, đồng thời giữ nguyên các bước kiểm tra namespace hiện có. Công việc hoàn tất khi xung đột như description gây ra ValueError rõ ràng hơn; hãy chạy các bài kiểm tra controller liên quan.

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

Mô tả

We have _check_for_name_clash, which does:

def _check_for_name_clash(self, name: str):
    namespaces = {
        "attribute": self.__attributes,
        "sub controller": self.__sub_controllers,
        "scan method": self.__scan_methods,
        "command method": self.__command_methods,
    }

    for kind, namespace in namespaces.items():
        if name in namespace:
            raise ValueError(
                f"Controller {self} has existing {kind} {name}: {namespace[name]}"
            )

However, this fastcs-eiger issue https://github.com/DiamondLightSource/fastcs-eiger/issues/107 reported an obscure error message when the python attribute "description" was shadowed by an attribute. _check_for_name_clash should be extended to check for these kinds of name clashed doing something like:

if hasattr(self, name) and not any(name in ns for ns in namespaces.values()):
    raise ValueError(
        f"Controller {self} has existing Python attribute {name!r}: "
        f"{getattr(self, name)!r}"
    )

Acceptance Criteria

  • Python attribute reserved names are caught, and their error reporting improved.
Ngôn ngữ chính
Python
Star
6
Fork
8
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

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.

Issue khác của DiamondLightSource/fastcs

Tất cả issue của DiamondLightSource/fastcs

Issue tương tự

Thêm issue về Python

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.