Thông điệp PyLint: nội suy định dạng ghi nhật ký

Đối với mã sau:

logger.debug('message: {}'.format('test'))

pylint đưa ra cảnh báo sau:

đăng nhập định dạng-định dạng (W1202):

Sử dụng định dạng% trong các chức năng ghi nhật ký và truyền các tham số% làm đối số Được sử dụng khi câu lệnh ghi nhật ký có dạng cuộc gọi ghi nhật ký. (Format_opes.format (format_args ...)). Các cuộc gọi như vậy nên sử dụng định dạng% thay vào đó, nhưng để nội suy cho hàm ghi nhật ký bằng cách chuyển các tham số dưới dạng đối số.

Tôi biết tôi có thể tắt cảnh báo này, nhưng tôi muốn hiểu nó. Tôi giả sử sử dụng format()là cách ưa thích để in ra các câu lệnh trong Python 3. Tại sao điều này không đúng với các câu lệnh logger?

Điều này không đúng với câu lệnh logger vì nó dựa vào định dạng "%" trước đây như chuỗi để cung cấp phép nội suy lười biếng của chuỗi này bằng cách sử dụng các đối số bổ sung cho lệnh gọi logger. Ví dụ thay vì làm:

logger.error('oops caused by %s' % exc)

bạn nên làm

logger.error('oops caused by %s', exc)

vì vậy chuỗi sẽ chỉ được nội suy nếu thông điệp thực sự được phát ra.

Bạn không thể hưởng lợi của chức năng này khi sử dụng .format().

Theo phần Tối ưu hóa của loggingtài liệu:

Định dạng của các đối số tin nhắn được hoãn lại cho đến khi nó không thể tránh được. Tuy nhiên, tính toán các đối số được truyền cho phương thức ghi nhật ký cũng có thể tốn kém và bạn có thể muốn tránh làm điều đó nếu trình ghi nhật ký sẽ bỏ đi sự kiện của bạn.

Có lẽ sự khác biệt thời gian này có thể giúp bạn.

Mô tả sau đây không phải là câu trả lời cho câu hỏi của bạn, nhưng nó có thể giúp mọi người.

Đối với pylint 2.4: Có 3 lựa chọn để đăng nhập phong cách trong .pylintrcfile: old, new,fstr

fstrtùy chọn được thêm vào 2.4 và loại bỏ trong 2.5

Mô tả từ .pylintrctệp (v2.4):

[LOGGING]

# Format style used to check logging format string. `old` means using %
# formatting, `new` is for `{}` formatting,and `fstr` is for f-strings.
logging-format-style=old

cho cũ ( logging-format-style=old):

foo = "bar"
self.logger.info("foo: %s", foo)

cho mới ( logging-format-style=new):

foo = "bar"
self.logger.info("foo: {}", foo)
# OR
self.logger.info("foo: {foo}", foo=foo)

Lưu ý : bạn không thể sử dụng .format()ngay cả khi bạn chọn newtùy chọn.

pylint vẫn đưa ra cảnh báo tương tự cho mã này:

self.logger.info("foo: {}".format(foo))  # W1202
# OR
self.logger.info("foo: {foo}".format(foo=foo))  # W1202

cho fstr ( logging-format-style=fstr):

foo = "bar"
self.logger.info(f"foo: {foo}")

Cá nhân, tôi thích tùy chọn fstr vì PEP-0498 .

Theo kinh nghiệm của tôi, một lý do hấp dẫn hơn là tối ưu hóa (đối với hầu hết các trường hợp sử dụng) cho phép nội suy lười biếng là nó chơi độc đáo với các trình tổng hợp nhật ký như Sentry.

Hãy xem xét một thông điệp tường trình 'người dùng đăng nhập'. Nếu bạn nội suy người dùng thành chuỗi định dạng, bạn có nhiều thông điệp tường trình riêng biệt như có người dùng. Nếu bạn sử dụng phép nội suy lười biếng như thế này, trình tổng hợp nhật ký có thể diễn giải hợp lý hơn đây là cùng một thông điệp tường trình với một loạt các trường hợp khác nhau.