Hướng dẫn how to create log file in python - cách tạo tệp nhật ký trong python

Khi nào nên sử dụng Logging¶

Ghi nhật ký cung cấp một tập hợp các chức năng tiện lợi để sử dụng ghi nhật ký đơn giản. Đây là

import logging
logging.basicConfig(filename='example.log', encoding='utf-8', level=logging.DEBUG)
logging.debug('This message should go to the log file')
logging.info('So should this')
logging.warning('And this, too')
logging.error('And non-ASCII stuff, too, like Øresund and Malmö')

import logging
logging.basicConfig(filename='example.log', encoding='utf-8', level=logging.DEBUG)
logging.debug('This message should go to the log file')
logging.info('So should this')
logging.warning('And this, too')
logging.error('And non-ASCII stuff, too, like Øresund and Malmö')

import logging
logging.basicConfig(filename='example.log', encoding='utf-8', level=logging.DEBUG)
logging.debug('This message should go to the log file')
logging.info('So should this')
logging.warning('And this, too')
logging.error('And non-ASCII stuff, too, like Øresund and Malmö')

import logging
logging.basicConfig(filename='example.log', encoding='utf-8', level=logging.DEBUG)
logging.debug('This message should go to the log file')
logging.info('So should this')
logging.warning('And this, too')
logging.error('And non-ASCII stuff, too, like Øresund and Malmö')

import logging
logging.basicConfig(filename='example.log', encoding='utf-8', level=logging.DEBUG)
logging.debug('This message should go to the log file')
logging.info('So should this')
logging.warning('And this, too')
logging.error('And non-ASCII stuff, too, like Øresund and Malmö')

import logging
logging.basicConfig(filename='example.log', encoding='utf-8', level=logging.DEBUG)
logging.debug('This message should go to the log file')
logging.info('So should this')
logging.warning('And this, too')
logging.error('And non-ASCII stuff, too, like Øresund and Malmö')

import logging
logging.basicConfig(filename='example.log', encoding='utf-8', level=logging.DEBUG)
logging.debug('This message should go to the log file')
logging.info('So should this')
logging.warning('And this, too')
logging.error('And non-ASCII stuff, too, like Øresund and Malmö')

import logging
logging.basicConfig(filename='example.log', encoding='utf-8', level=logging.DEBUG)
logging.debug('This message should go to the log file')
logging.info('So should this')
logging.warning('And this, too')
logging.error('And non-ASCII stuff, too, like Øresund and Malmö')

import logging
logging.basicConfig(filename='example.log', encoding='utf-8', level=logging.DEBUG)
logging.debug('This message should go to the log file')
logging.info('So should this')
logging.warning('And this, too')
logging.error('And non-ASCII stuff, too, like Øresund and Malmö')

import logging
logging.basicConfig(filename='example.log', encoding='utf-8', level=logging.DEBUG)
logging.debug('This message should go to the log file')
logging.info('So should this')
logging.warning('And this, too')
logging.error('And non-ASCII stuff, too, like Øresund and Malmö')

DEBUG:root:This message should go to the log file
INFO:root:So should this
WARNING:root:And this, too
ERROR:root:And non-ASCII stuff, too, like Øresund and Malmö

DEBUG:root:This message should go to the log file
INFO:root:So should this
WARNING:root:And this, too
ERROR:root:And non-ASCII stuff, too, like Øresund and Malmö

DEBUG:root:This message should go to the log file
INFO:root:So should this
WARNING:root:And this, too
ERROR:root:And non-ASCII stuff, too, like Øresund and Malmö

Các chức năng ghi nhật ký được đặt tên theo mức độ hoặc mức độ nghiêm trọng của các sự kiện mà chúng được sử dụng để theo dõi. Các mức tiêu chuẩn và khả năng ứng dụng của chúng được mô tả dưới đây (theo thứ tự ngày càng tăng của mức độ nghiêm trọng):

DEBUG:root:This message should go to the log file
INFO:root:So should this
WARNING:root:And this, too
ERROR:root:And non-ASCII stuff, too, like Øresund and Malmö

DEBUG:root:This message should go to the log file
INFO:root:So should this
WARNING:root:And this, too
ERROR:root:And non-ASCII stuff, too, like Øresund and Malmö

DEBUG:root:This message should go to the log file
INFO:root:So should this
WARNING:root:And this, too
ERROR:root:And non-ASCII stuff, too, like Øresund and Malmö

DEBUG:root:This message should go to the log file
INFO:root:So should this
WARNING:root:And this, too
ERROR:root:And non-ASCII stuff, too, like Øresund and Malmö

DEBUG:root:This message should go to the log file
INFO:root:So should this
WARNING:root:And this, too
ERROR:root:And non-ASCII stuff, too, like Øresund and Malmö

Mức mặc định là

DEBUG:root:This message should go to the log file
INFO:root:So should this
WARNING:root:And this, too
ERROR:root:And non-ASCII stuff, too, like Øresund and Malmö

Các sự kiện được theo dõi có thể được xử lý theo những cách khác nhau. Cách đơn giản nhất để xử lý các sự kiện theo dõi là in chúng vào bảng điều khiển. Một cách phổ biến khác là viết chúng vào một tệp đĩa.

Một ví dụ đơn giản

Một ví dụ rất đơn giản là:

import logging
logging.warning('Watch out!')  # will print a message to the console
logging.info('I told you so')  # will not print anything

Nếu bạn nhập các dòng này vào một tập lệnh và chạy nó, bạn sẽ thấy:

in ra trên bảng điều khiển. Thông báo

DEBUG:root:This message should go to the log file
INFO:root:So should this
WARNING:root:And this, too
ERROR:root:And non-ASCII stuff, too, like Øresund and Malmö

DEBUG:root:This message should go to the log file
INFO:root:So should this
WARNING:root:And this, too
ERROR:root:And non-ASCII stuff, too, like Øresund and Malmö

Đăng nhập vào một tập tin

Một tình huống rất phổ biến là ghi lại các sự kiện ghi nhật ký trong một tệp, vì vậy hãy để Lôi nhìn vào đó tiếp theo. Hãy chắc chắn thử những điều sau đây trong một phiên dịch viên Python mới bắt đầu và don lồng chỉ tiếp tục từ phiên được mô tả ở trên:

import logging
logging.basicConfig(filename='example.log', encoding='utf-8', level=logging.DEBUG)
logging.debug('This message should go to the log file')
logging.info('So should this')
logging.warning('And this, too')
logging.error('And non-ASCII stuff, too, like Øresund and Malmö')

Thay đổi trong phiên bản 3.9: Đối số mã hóa đã được thêm vào. Trong các phiên bản Python trước đó hoặc nếu không được chỉ định, mã hóa được sử dụng là giá trị mặc định được sử dụng bởi

getattr(logging, loglevel.upper())

getattr(logging, loglevel.upper())

getattr(logging, loglevel.upper())

getattr(logging, loglevel.upper())

Và bây giờ nếu chúng ta mở tệp và xem xét những gì chúng ta có, chúng ta nên tìm các thông báo nhật ký:

DEBUG:root:This message should go to the log file
INFO:root:So should this
WARNING:root:And this, too
ERROR:root:And non-ASCII stuff, too, like Øresund and Malmö

Ví dụ này cũng cho thấy cách bạn có thể đặt mức ghi nhật ký đóng vai trò là ngưỡng để theo dõi. Trong trường hợp này, vì chúng tôi đặt ngưỡng thành

DEBUG:root:This message should go to the log file
INFO:root:So should this
WARNING:root:And this, too
ERROR:root:And non-ASCII stuff, too, like Øresund and Malmö

Nếu bạn muốn đặt mức ghi nhật ký từ tùy chọn dòng lệnh như:

Và bạn có giá trị của tham số được truyền cho

getattr(logging, loglevel.upper())

getattr(logging, loglevel.upper())

Để có được giá trị mà bạn sẽ chuyển sang

getattr(logging, loglevel.upper())

# assuming loglevel is bound to the string value obtained from the
# command line argument. Convert to upper case to allow the user to
# specify --log=DEBUG or --log=debug
numeric_level = getattr(logging, loglevel.upper(), None)
if not isinstance(numeric_level, int):
    raise ValueError('Invalid log level: %s' % loglevel)
logging.basicConfig(level=numeric_level, ...)

Cuộc gọi đến

getattr(logging, loglevel.upper())

import logging
logging.basicConfig(filename='example.log', encoding='utf-8', level=logging.DEBUG)
logging.debug('This message should go to the log file')
logging.info('So should this')
logging.warning('And this, too')
logging.error('And non-ASCII stuff, too, like Øresund and Malmö')

import logging
logging.basicConfig(filename='example.log', encoding='utf-8', level=logging.DEBUG)
logging.debug('This message should go to the log file')
logging.info('So should this')
logging.warning('And this, too')
logging.error('And non-ASCII stuff, too, like Øresund and Malmö')

getattr(logging, loglevel.upper())

Nếu bạn chạy tập lệnh trên nhiều lần, các tin nhắn từ các lần chạy liên tiếp sẽ được thêm vào ví dụ tệp.log. Nếu bạn muốn mỗi lần chạy bắt đầu một lần nữa, không nhớ các tin nhắn từ các lần chạy trước đó, bạn có thể chỉ định đối số FILEMODE, bằng cách thay đổi cuộc gọi trong ví dụ trên thành:

logging.basicConfig(filename='example.log', filemode='w', level=logging.DEBUG)

Đầu ra sẽ giống như trước đây, nhưng tệp nhật ký không còn được thêm vào, vì vậy các tin nhắn từ các lần chạy trước đó bị mất.

Đăng nhập từ nhiều mô -đun

Nếu chương trình của bạn bao gồm nhiều mô -đun, thì đây là một ví dụ về cách bạn có thể sắp xếp đăng nhập vào đó:

# myapp.py
import logging
import mylib

def main():
    logging.basicConfig(filename='myapp.log', level=logging.INFO)
    logging.info('Started')
    mylib.do_something()
    logging.info('Finished')

if __name__ == '__main__':
    main()

# mylib.py
import logging

def do_something():
    logging.info('Doing something')

Nếu bạn chạy myApp.py, bạn sẽ thấy điều này trong myApp.log:

from logger_settings import api_logger

api_logger.info('hello world')

Đó là hy vọng những gì bạn đã mong đợi để xem. Bạn có thể khái quát điều này thành nhiều mô -đun, sử dụng mẫu trong mylib.py. Lưu ý rằng đối với mẫu sử dụng đơn giản này, bạn đã giành chiến thắng, bằng cách xem trong tệp nhật ký, trong đó trong ứng dụng của bạn, tin nhắn của bạn đến, ngoài việc xem xét mô tả sự kiện. Nếu bạn muốn theo dõi vị trí của các tin nhắn của mình, bạn sẽ cần phải tham khảo tài liệu vượt quá cấp độ hướng dẫn - xem hướng dẫn đăng nhập nâng cao.Advanced Logging Tutorial.

Dữ liệu biến ghi nhật ký

Để nhật ký dữ liệu biến, hãy sử dụng chuỗi định dạng cho thông báo Mô tả sự kiện và nối dữ liệu biến làm đối số. Ví dụ:

from logger_settings import api_logger

api_logger.info('hello world')

sẽ hiển thị:

from logger_settings import api_logger

api_logger.info('hello world')

Như bạn có thể thấy, việc hợp nhất dữ liệu biến vào thông báo Mô tả sự kiện sử dụng kiểu cũ, kiểu %của định dạng chuỗi. Đây là để tương thích ngược: Gói ghi nhật ký trước các tùy chọn định dạng mới hơn như

# assuming loglevel is bound to the string value obtained from the
# command line argument. Convert to upper case to allow the user to
# specify --log=DEBUG or --log=debug
numeric_level = getattr(logging, loglevel.upper(), None)
if not isinstance(numeric_level, int):
    raise ValueError('Invalid log level: %s' % loglevel)
logging.basicConfig(level=numeric_level, ...)

# assuming loglevel is bound to the string value obtained from the
# command line argument. Convert to upper case to allow the user to
# specify --log=DEBUG or --log=debug
numeric_level = getattr(logging, loglevel.upper(), None)
if not isinstance(numeric_level, int):
    raise ValueError('Invalid log level: %s' % loglevel)
logging.basicConfig(level=numeric_level, ...)

Thay đổi định dạng của các tin nhắn được hiển thị lor

Để thay đổi định dạng được sử dụng để hiển thị tin nhắn, bạn cần chỉ định định dạng bạn muốn sử dụng:

from logger_settings import api_logger

api_logger.info('hello world')

cái nào sẽ in:

from logger_settings import api_logger

api_logger.info('hello world')

Lưu ý rằng ‘root, xuất hiện trong các ví dụ trước đó đã biến mất. Đối với một tập hợp đầy đủ các thứ có thể xuất hiện trong các chuỗi định dạng, bạn có thể tham khảo tài liệu cho các thuộc tính logrecord, nhưng để sử dụng đơn giản, bạn chỉ cần tên mức độ (mức độ nghiêm trọng), tin nhắn (mô tả sự kiện, bao gồm dữ liệu biến) và có lẽ để hiển thị Khi sự kiện xảy ra. Nó được mô tả trong phần sau.LogRecord attributes, but for simple usage, you just need the levelname (severity), message (event description, including variable data) and perhaps to display when the event occurred. This is described in the next section.

Hiển thị ngày/giờ trong Tin nhắn

Để hiển thị ngày và thời gian của một sự kiện, bạn sẽ đặt ‘%(ASCTIME) S trong chuỗi định dạng của bạn:

from logger_settings import api_logger

api_logger.info('hello world')

Mà sẽ in một cái gì đó như thế này:

from logger_settings import api_logger

api_logger.info('hello world')

Định dạng mặc định cho hiển thị ngày/thời gian (hiển thị ở trên) giống như ISO8601 hoặc RFC 3339. Nếu bạn cần kiểm soát thêm định dạng ngày/giờ, hãy cung cấp đối số DATEFMT cho

# assuming loglevel is bound to the string value obtained from the
# command line argument. Convert to upper case to allow the user to
# specify --log=DEBUG or --log=debug
numeric_level = getattr(logging, loglevel.upper(), None)
if not isinstance(numeric_level, int):
    raise ValueError('Invalid log level: %s' % loglevel)
logging.basicConfig(level=numeric_level, ...)

# assuming loglevel is bound to the string value obtained from the
# command line argument. Convert to upper case to allow the user to
# specify --log=DEBUG or --log=debug
numeric_level = getattr(logging, loglevel.upper(), None)
if not isinstance(numeric_level, int):
    raise ValueError('Invalid log level: %s' % loglevel)
logging.basicConfig(level=numeric_level, ...)

from logger_settings import api_logger

api_logger.info('hello world')

Mà sẽ hiển thị một cái gì đó như thế này:

from logger_settings import api_logger

api_logger.info('hello world')

Định dạng của đối số DATEFMT giống như được hỗ trợ bởi

# assuming loglevel is bound to the string value obtained from the
# command line argument. Convert to upper case to allow the user to
# specify --log=DEBUG or --log=debug
numeric_level = getattr(logging, loglevel.upper(), None)
if not isinstance(numeric_level, int):
    raise ValueError('Invalid log level: %s' % loglevel)
logging.basicConfig(level=numeric_level, ...)

Bước tiếp theo¶

Điều đó kết thúc hướng dẫn cơ bản. Nó là đủ để giúp bạn đứng dậy và chạy với ghi nhật ký. Có rất nhiều điều mà gói ghi nhật ký cung cấp, nhưng để tận dụng tốt nhất, bạn sẽ cần phải đầu tư thêm một chút thời gian để đọc các phần sau. Nếu bạn đã sẵn sàng cho điều đó, hãy lấy một số đồ uống yêu thích của bạn và tiếp tục.

Nếu nhu cầu ghi nhật ký của bạn rất đơn giản, thì hãy sử dụng các ví dụ trên để kết hợp ghi nhật ký vào các tập lệnh của riêng bạn và nếu bạn gặp vấn đề hoặc không hiểu điều gì đó, vui lòng đăng một câu hỏi trên nhóm comp.lang.python usenet (có sẵn tại https : //groups.google.com/forum/#! Diễn đàn/comp.lang.python) và bạn sẽ nhận được sự giúp đỡ trước khi quá lâu.

Vẫn ở đây? Bạn có thể tiếp tục đọc một vài phần tiếp theo, cung cấp một hướng dẫn nâng cao/chuyên sâu hơn một chút so với phần cơ bản ở trên. Sau đó, bạn có thể xem sách nấu ăn đăng nhập.Logging Cookbook.

Lưu lượng ghi nhật ký

Dòng thông tin sự kiện nhật ký trong loggers và trình xử lý được minh họa trong sơ đồ sau.

Người khai thác gỗ¶

# assuming loglevel is bound to the string value obtained from the
# command line argument. Convert to upper case to allow the user to
# specify --log=DEBUG or --log=debug
numeric_level = getattr(logging, loglevel.upper(), None)
if not isinstance(numeric_level, int):
    raise ValueError('Invalid log level: %s' % loglevel)
logging.basicConfig(level=numeric_level, ...)

Các phương thức được sử dụng rộng rãi nhất trên các đối tượng logger rơi vào hai loại: cấu hình và gửi tin nhắn.

Đây là những phương pháp cấu hình phổ biến nhất:

• # myapp.py
  import logging
  import mylib
  
  def main():
      logging.basicConfig(filename='myapp.log', level=logging.INFO)
      logging.info('Started')
      mylib.do_something()
      logging.info('Finished')
  
  if __name__ == '__main__':
      main()
  

  1 Chỉ định thông báo nhật ký mức độ nghiêm trọng thấp nhất mà logger sẽ xử lý, trong đó gỡ lỗi là mức độ nghiêm trọng tích hợp thấp nhất và quan trọng là mức độ nghiêm trọng tích hợp cao nhất. Ví dụ: nếu mức độ nghiêm trọng là thông tin, logger sẽ chỉ xử lý thông tin, cảnh báo, lỗi và tin nhắn quan trọng và sẽ bỏ qua các tin nhắn gỡ lỗi.

• # myapp.py
  import logging
  import mylib
  
  def main():
      logging.basicConfig(filename='myapp.log', level=logging.INFO)
      logging.info('Started')
      mylib.do_something()
      logging.info('Finished')
  
  if __name__ == '__main__':
      main()
  

  2 và

  # myapp.py
  import logging
  import mylib
  
  def main():
      logging.basicConfig(filename='myapp.log', level=logging.INFO)
      logging.info('Started')
      mylib.do_something()
      logging.info('Finished')
  
  if __name__ == '__main__':
      main()
  

  3 Thêm và xóa các đối tượng xử lý khỏi đối tượng logger. Người xử lý được đề cập chi tiết hơn trong người xử lý.Handlers.

• # myapp.py
  import logging
  import mylib
  
  def main():
      logging.basicConfig(filename='myapp.log', level=logging.INFO)
      logging.info('Started')
      mylib.do_something()
      logging.info('Finished')
  
  if __name__ == '__main__':
      main()
  

  4 và

  # myapp.py
  import logging
  import mylib
  
  def main():
      logging.basicConfig(filename='myapp.log', level=logging.INFO)
      logging.info('Started')
      mylib.do_something()
      logging.info('Finished')
  
  if __name__ == '__main__':
      main()
  

  5 Thêm và xóa các đối tượng bộ lọc khỏi đối tượng logger. Bộ lọc được đề cập chi tiết hơn trong các đối tượng bộ lọc.Filter Objects.

Bạn không cần phải luôn gọi các phương thức này trên mọi logger bạn tạo. Xem hai đoạn cuối cùng trong phần này.

Với đối tượng logger được định cấu hình, các phương thức sau tạo thông báo nhật ký:

• # myapp.py
  import logging
  import mylib
  
  def main():
      logging.basicConfig(filename='myapp.log', level=logging.INFO)
      logging.info('Started')
      mylib.do_something()
      logging.info('Finished')
  
  if __name__ == '__main__':
      main()
  

  6,

  # myapp.py
  import logging
  import mylib
  
  def main():
      logging.basicConfig(filename='myapp.log', level=logging.INFO)
      logging.info('Started')
      mylib.do_something()
      logging.info('Finished')
  
  if __name__ == '__main__':
      main()
  

  7,

  # myapp.py
  import logging
  import mylib
  
  def main():
      logging.basicConfig(filename='myapp.log', level=logging.INFO)
      logging.info('Started')
      mylib.do_something()
      logging.info('Finished')
  
  if __name__ == '__main__':
      main()
  

  8,

  # myapp.py
  import logging
  import mylib
  
  def main():
      logging.basicConfig(filename='myapp.log', level=logging.INFO)
      logging.info('Started')
      mylib.do_something()
      logging.info('Finished')
  
  if __name__ == '__main__':
      main()
  

  9 và

  # mylib.py
  import logging
  
  def do_something():
      logging.info('Doing something')
  

  0 đều tạo bản ghi nhật ký với một thông báo và cấp độ tương ứng với tên phương thức tương ứng của chúng. Thông báo thực sự là một chuỗi định dạng, có thể chứa cú pháp thay thế chuỗi tiêu chuẩn là

  # mylib.py
  import logging
  
  def do_something():
      logging.info('Doing something')
  

  1,

  # mylib.py
  import logging
  
  def do_something():
      logging.info('Doing something')
  

  2,

  # mylib.py
  import logging
  
  def do_something():
      logging.info('Doing something')
  

  3, v.v. Phần còn lại của các đối số của họ là một danh sách các đối tượng tương ứng với các trường thay thế trong tin nhắn. Liên quan đến

  # mylib.py
  import logging
  
  def do_something():
      logging.info('Doing something')
  

  4, các phương thức khai thác chỉ quan tâm đến từ khóa của

  # mylib.py
  import logging
  
  def do_something():
      logging.info('Doing something')
  

  5 và sử dụng nó để xác định xem có đăng nhập thông tin ngoại lệ hay không.

• # mylib.py
  import logging
  
  def do_something():
      logging.info('Doing something')
  

  6 Tạo một thông báo nhật ký tương tự như

  # myapp.py
  import logging
  import mylib
  
  def main():
      logging.basicConfig(filename='myapp.log', level=logging.INFO)
      logging.info('Started')
      mylib.do_something()
      logging.info('Finished')
  
  if __name__ == '__main__':
      main()
  

  9. Sự khác biệt là

  # mylib.py
  import logging
  
  def do_something():
      logging.info('Doing something')
  

  6 bỏ một dấu vết ngăn xếp cùng với nó. Chỉ gọi phương thức này từ một người xử lý ngoại lệ.

• # mylib.py
  import logging
  
  def do_something():
      logging.info('Doing something')
  

  9 lấy một mức nhật ký làm đối số rõ ràng. Đây là một chút dài dòng cho các tin nhắn ghi nhật ký so với sử dụng các phương thức tiện lợi ở cấp độ nhật ký được liệt kê ở trên, nhưng đây là cách đăng nhập ở các cấp nhật ký tùy chỉnh.

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

Loggers có một khái niệm về mức độ hiệu quả. Nếu một cấp độ không được đặt rõ ràng trên logger, mức độ của cha mẹ được sử dụng thay vào đó làm mức hiệu quả. Nếu cha mẹ không có cấp cấp rõ ràng, cha mẹ của nó được kiểm tra, v.v. - tất cả các tổ tiên được tìm kiếm cho đến khi tìm thấy cấp độ được thiết lập rõ ràng. Logger gốc luôn có một mức cấp rõ ràng (

DEBUG:root:This message should go to the log file
INFO:root:So should this
WARNING:root:And this, too
ERROR:root:And non-ASCII stuff, too, like Øresund and Malmö

Những người đăng nhập trẻ em tuyên truyền các thông điệp lên đến những người xử lý liên quan đến loggers tổ tiên của họ. Bởi vì điều này, không cần thiết phải xác định và định cấu hình trình xử lý cho tất cả các loggers mà ứng dụng sử dụng. Nó là đủ để định cấu hình trình xử lý cho một bộ ghi cấp cấp cao nhất và tạo bộ ghi nhật ký con khi cần thiết. .

Người xử lý và

Các đối tượng

from logger_settings import api_logger

api_logger.info('hello world')

# assuming loglevel is bound to the string value obtained from the
# command line argument. Convert to upper case to allow the user to
# specify --log=DEBUG or --log=debug
numeric_level = getattr(logging, loglevel.upper(), None)
if not isinstance(numeric_level, int):
    raise ValueError('Invalid log level: %s' % loglevel)
logging.basicConfig(level=numeric_level, ...)

from logger_settings import api_logger

api_logger.info('hello world')

Thư viện tiêu chuẩn bao gồm khá nhiều loại xử lý (xem Trình xử lý hữu ích); Các hướng dẫn sử dụng chủ yếu là

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

Có rất ít phương pháp trong một người xử lý cho các nhà phát triển ứng dụng quan tâm đến bản thân. Các phương thức xử lý duy nhất có vẻ phù hợp với các nhà phát triển ứng dụng đang sử dụng các đối tượng xử lý tích hợp (nghĩa là không tạo trình xử lý tùy chỉnh) là các phương thức cấu hình sau:

• Phương pháp

  from logger_settings import api_logger
  
  api_logger.info('hello world')
  

  15, giống như trong các đối tượng logger, chỉ định mức độ nghiêm trọng thấp nhất sẽ được gửi đến đích thích hợp. Tại sao có hai phương pháp

  from logger_settings import api_logger
  
  api_logger.info('hello world')
  

  15? Mức được đặt trong logger xác định mức độ nghiêm trọng của tin nhắn mà nó sẽ chuyển cho người xử lý. Cấp độ được đặt trong mỗi người xử lý xác định tin nhắn mà Handler sẽ gửi.

• from logger_settings import api_logger
  
  api_logger.info('hello world')
  

  17 chọn một đối tượng định dạng cho người xử lý này sử dụng.

• from logger_settings import api_logger
  
  api_logger.info('hello world')
  

  18 và

  from logger_settings import api_logger
  
  api_logger.info('hello world')
  

  19 Cấu hình và cấu hình các đối tượng bộ lọc trên trình xử lý.

Mã ứng dụng không nên trực tiếp khởi tạo và sử dụng các trường hợp là

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

Định dạng

Các đối tượng Formatter định cấu hình thứ tự, cấu trúc và nội dung cuối cùng của thông báo nhật ký. Không giống như lớp cơ sở ____122, mã ứng dụng có thể khởi tạo các lớp định dạng, mặc dù bạn có thể phân lớp định dạng nếu ứng dụng của bạn cần hành vi đặc biệt. Trình xây dựng có ba đối số tùy chọn - chuỗi định dạng tin nhắn, chuỗi định dạng ngày và chỉ báo kiểu.

Nếu không có chuỗi định dạng tin nhắn, mặc định là sử dụng thông báo RAW. Nếu không có chuỗi định dạng ngày, định dạng ngày mặc định là:

với các mili giây đã được giải quyết vào cuối.

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

Nếu

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

# assuming loglevel is bound to the string value obtained from the
# command line argument. Convert to upper case to allow the user to
# specify --log=DEBUG or --log=debug
numeric_level = getattr(logging, loglevel.upper(), None)
if not isinstance(numeric_level, int):
    raise ValueError('Invalid log level: %s' % loglevel)
logging.basicConfig(level=numeric_level, ...)

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

# assuming loglevel is bound to the string value obtained from the
# command line argument. Convert to upper case to allow the user to
# specify --log=DEBUG or --log=debug
numeric_level = getattr(logging, loglevel.upper(), None)
if not isinstance(numeric_level, int):
    raise ValueError('Invalid log level: %s' % loglevel)
logging.basicConfig(level=numeric_level, ...)

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

Đã thay đổi trong phiên bản 3.2: Đã thêm tham số

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

Chuỗi định dạng thông báo sau đây sẽ ghi lại thời gian ở định dạng có thể đọc được của con người, mức độ nghiêm trọng của tin nhắn và nội dung của tin nhắn, theo thứ tự đó:

import logging
logging.warning('Watch out!')  # will print a message to the console
logging.info('I told you so')  # will not print anything

Formatters sử dụng chức năng có thể định cấu hình người dùng để chuyển đổi thời gian tạo của bản ghi thành một tuple. Theo mặc định,

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

Định cấu hình ghi nhật ký

Các lập trình viên có thể định cấu hình đăng nhập theo ba cách:

1. Tạo loggers, trình xử lý và định dạng rõ ràng bằng cách sử dụng mã Python gọi các phương thức cấu hình được liệt kê ở trên.

2. Tạo tệp cấu hình ghi nhật ký và đọc nó bằng hàm

   from logger_settings import api_logger
   
   api_logger.info('hello world')
   

   42.

3. Tạo một từ điển thông tin cấu hình và chuyển nó đến hàm

   from logger_settings import api_logger
   
   api_logger.info('hello world')
   

   43.

Đối với tài liệu tham khảo về hai tùy chọn cuối cùng, xem các chức năng cấu hình. Ví dụ sau đây định cấu hình một bộ ghi âm rất đơn giản, trình xử lý bảng điều khiển và một định dạng đơn giản bằng cách sử dụng mã Python:Configuration functions. The following example configures a very simple logger, a console handler, and a simple formatter using Python code:

import logging
logging.warning('Watch out!')  # will print a message to the console
logging.info('I told you so')  # will not print anything

Chạy mô -đun này từ dòng lệnh tạo ra đầu ra sau:

import logging
logging.warning('Watch out!')  # will print a message to the console
logging.info('I told you so')  # will not print anything

Mô -đun Python sau đây tạo ra một logger, người xử lý và định dạng gần giống với các mô -đun trong ví dụ được liệt kê ở trên, với sự khác biệt duy nhất là tên của các đối tượng:

import logging
logging.warning('Watch out!')  # will print a message to the console
logging.info('I told you so')  # will not print anything

Đây là tệp đăng nhập.conf:

import logging
logging.warning('Watch out!')  # will print a message to the console
logging.info('I told you so')  # will not print anything

Đầu ra gần giống với ví dụ không dựa trên tệp-file:

import logging
logging.warning('Watch out!')  # will print a message to the console
logging.info('I told you so')  # will not print anything

Bạn có thể thấy rằng cách tiếp cận tệp cấu hình có một vài lợi thế so với cách tiếp cận mã Python, chủ yếu phân tách cấu hình và mã và khả năng của những người không kiểm duyệt để dễ dàng sửa đổi các thuộc tính ghi nhật ký.

Cảnh báo

Hàm

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

Từ điển được chuyển đến

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

Lưu ý rằng các tên lớp được tham chiếu trong các tệp cấu hình cần phải liên quan đến mô -đun ghi nhật ký hoặc các giá trị tuyệt đối có thể được giải quyết bằng cách sử dụng các cơ chế nhập thông thường. Do đó, bạn có thể sử dụng

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

Trong Python 3.2, một phương tiện mới để định cấu hình ghi nhật ký đã được giới thiệu, sử dụng từ điển để giữ thông tin cấu hình. Điều này cung cấp một superset của chức năng của cách tiếp cận dựa trên tệp cấu hình được nêu ở trên và là phương thức cấu hình được đề xuất cho các ứng dụng và triển khai mới. Bởi vì một từ điển Python được sử dụng để chứa thông tin cấu hình và vì bạn có thể điền từ điển đó bằng các phương tiện khác nhau, bạn có nhiều tùy chọn hơn cho cấu hình. Ví dụ: bạn có thể sử dụng tệp cấu hình ở định dạng JSON hoặc, nếu bạn có quyền truy cập vào chức năng xử lý YAML, một tệp ở định dạng YAML, để điền vào Từ điển cấu hình. Hoặc, tất nhiên, bạn có thể xây dựng từ điển trong mã Python, nhận nó ở dạng ngâm trên một ổ cắm hoặc sử dụng bất kỳ cách tiếp cận nào có ý nghĩa cho ứng dụng của bạn.

Ở đây, một ví dụ về cấu hình tương tự như trên, ở định dạng YAML cho cách tiếp cận dựa trên từ điển mới:

import logging
logging.warning('Watch out!')  # will print a message to the console
logging.info('I told you so')  # will not print anything

Để biết thêm thông tin về việc đăng nhập bằng từ điển, hãy xem các chức năng cấu hình.Configuration functions.

Điều gì xảy ra nếu không có cấu hình nào được cung cấp Jo

Nếu không có cấu hình ghi nhật ký được cung cấp, có thể có một tình huống trong đó một sự kiện ghi nhật ký cần phải được đầu ra, nhưng không có người xử lý nào có thể được tìm thấy để xuất hiện sự kiện. Hành vi của gói ghi nhật ký trong những trường hợp này phụ thuộc vào phiên bản Python.

Đối với các phiên bản của Python trước 3.2, hành vi như sau:

• Nếu ghi nhật ký.RAISEEXEXTIES là

  from logger_settings import api_logger
  
  api_logger.info('hello world')
  

  09 (chế độ sản xuất), sự kiện này được giảm âm thầm.

• Nếu ghi nhật ký.raiseexceptions là

  from logger_settings import api_logger
  
  api_logger.info('hello world')
  

  46 (chế độ phát triển), một thông báo ‘không có người xử lý nào có thể được tìm thấy cho logger x.y.z, được in một lần.

Trong Python 3.2 trở lên, hành vi như sau:

• Sự kiện này là đầu ra bằng cách sử dụng một người xử lý cuối cùng, được lưu trữ trong

  from logger_settings import api_logger
  
  api_logger.info('hello world')
  

  60. Trình xử lý nội bộ này không được liên kết với bất kỳ logger nào và hoạt động như

  from logger_settings import api_logger
  
  api_logger.info('hello world')
  

  13 ghi thông báo mô tả sự kiện vào giá trị hiện tại của

  logging.basicConfig(filename='example.log', filemode='w', level=logging.DEBUG)
  

  7 (do đó tôn trọng bất kỳ chuyển hướng nào có thể có hiệu lực). Không có định dạng nào được thực hiện trên tin nhắn - chỉ là thông báo mô tả sự kiện trần được in. Cấp độ Handler được đặt thành

  DEBUG:root:This message should go to the log file
  INFO:root:So should this
  WARNING:root:And this, too
  ERROR:root:And non-ASCII stuff, too, like Øresund and Malmö
  

  5, vì vậy tất cả các sự kiện ở mức độ này và mức độ nghiêm trọng lớn hơn sẽ được đầu ra.

Để có được hành vi trước 3,2,

from logger_settings import api_logger

api_logger.info('hello world')

from logger_settings import api_logger

api_logger.info('hello world')

Định cấu hình ghi nhật ký cho thư viện

Khi phát triển một thư viện sử dụng ghi nhật ký, bạn nên cẩn thận để ghi lại cách thư viện sử dụng ghi nhật ký - ví dụ: tên của loggers được sử dụng. Một số xem xét cũng cần được cung cấp cho cấu hình ghi nhật ký của nó. Nếu ứng dụng sử dụng không sử dụng ghi nhật ký và mã thư viện thực hiện các cuộc gọi ghi nhật ký, thì (như được mô tả trong phần trước) Các sự kiện về mức độ nghiêm trọng

DEBUG:root:This message should go to the log file
INFO:root:So should this
WARNING:root:And this, too
ERROR:root:And non-ASCII stuff, too, like Øresund and Malmö

logging.basicConfig(filename='example.log', filemode='w', level=logging.DEBUG)

Nếu vì một lý do nào đó, bạn không muốn những tin nhắn này được in trong trường hợp không có bất kỳ cấu hình ghi nhật ký nào, bạn có thể đính kèm trình xử lý không làm gì vào bộ ghi cấp cao nhất cho thư viện của bạn. Điều này tránh được thông điệp được in, vì một trình xử lý sẽ luôn được tìm thấy cho các sự kiện thư viện: nó không tạo ra bất kỳ đầu ra nào. Nếu người dùng thư viện định cấu hình ghi nhật ký để sử dụng ứng dụng, có lẽ cấu hình đó sẽ thêm một số trình xử lý và nếu các cấp được cấu hình phù hợp thì các cuộc gọi đăng nhập được thực hiện trong mã thư viện sẽ gửi đầu ra cho những người xử lý đó là bình thường.

Một trình xử lý không có gì được bao gồm trong gói ghi nhật ký:

from logger_settings import api_logger

api_logger.info('hello world')

logging.basicConfig(filename='example.log', filemode='w', level=logging.DEBUG)

import logging
logging.warning('Watch out!')  # will print a message to the console
logging.info('I told you so')  # will not print anything

Nên có hiệu ứng mong muốn. Nếu một tổ chức tạo ra một số thư viện, thì tên logger được chỉ định có thể là ‘orgname.foo, chứ không chỉ là‘ foo.

Ghi chú

Chúng tôi khuyên bạn không nên đăng nhập vào logger gốc trong thư viện của mình. Thay vào đó, hãy sử dụng một logger có tên độc đáo và dễ nhận dạng, chẳng hạn như

from logger_settings import api_logger

api_logger.info('hello world')

Ghi chú

Chúng tôi khuyên bạn không nên đăng nhập vào logger gốc trong thư viện của mình. Thay vào đó, hãy sử dụng một logger có tên độc đáo và dễ nhận dạng, chẳng hạn như

from logger_settings import api_logger

api_logger.info('hello world')

Cấp độ tùy chỉnh

Xác định cấp độ của riêng bạn là có thể, nhưng không cần thiết, vì các cấp độ hiện tại đã được chọn trên cơ sở kinh nghiệm thực tế. Tuy nhiên, nếu bạn bị thuyết phục rằng bạn cần các cấp độ tùy chỉnh, nên được thực hiện cẩn thận khi làm điều này và có thể là một ý tưởng rất tồi để xác định các cấp tùy chỉnh nếu bạn đang phát triển thư viện. Đó là bởi vì nếu nhiều tác giả thư viện đều xác định các cấp tùy chỉnh của riêng họ, có khả năng đầu ra ghi nhật ký từ nhiều thư viện như vậy được sử dụng cùng nhau sẽ khó sử dụng nhà phát triển để kiểm soát và/hoặc giải thích cho các thư viện khác nhau.