Bug in `databricks.sql.exc.Error` base class

Đang mở Phù hợp với người mới

#437 mở ngày 10/9/2024 5 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: 68/100

Loại issue: Lỗi
Độ rõ ràng: Khá rõ ràng
Mức độ hoạt động: Ít trao đổi
Công nghệ: python
Lĩnh vực: databases

Hướng nghiên cứu

Tìm kiếm trong connector lớp databricks.sql.exc.Error và kiểm tra các phương thức str và message_with_context của lớp này. Tái hiện một Error không có thông báo, sau đó xác minh rằng việc chuyển đổi thành chuỗi và message_with_context không còn thất bại, đồng thời hành vi lỗi hiện có vẫn được giữ nguyên.

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

Mô tả

engineer-bot

Problem: When try except catching errors and logging them I occasionally get this TypeError

...
    try:
        with connection.cursor() as cursor:
            cursor.execute(query)
            ...
    except databricks.sql.Error as e:
        logger.debug(f"{str(e)}: failed to execute query {query}")
        ...

__str__ returned non-string (type NoneType)

Explanation:

String representations of a class must be of type string

the message attribute can be None therefore there needs to be a check/cast prior to returning.

Note: message_with_context will also fail when a message is None since you can't use the operand type + for NoneType and a str

class Error(Exception):
    """Base class for DB-API2.0 exceptions.
    `message`: An optional user-friendly error message. It should be short, actionable and stable
    `context`: Optional extra context about the error. MUST be JSON serializable
    """

    def __init__(self, message=None, context=None, *args, **kwargs):
        super().__init__(message, *args, **kwargs)
        self.message = message
        self.context = context or {}

    def __str__(self):
        return self.message

    def message_with_context(self):
        return self.message + ": " + json.dumps(self.context, default=str)

Ngôn ngữ chính: Python
Star: 233
Fork: 152
Merge trung bình: 21 giờ 5 phút
Pull request đã merge (30 ngày): 10