간단한 Python 로깅 - 종속성, 신뢰 및 코드 복사/붙여넣기에 대한 여담

헤더 이미지(C) Tai Kedzierski

고토 스니펫

이 게시물은 자기 주장이 강한 게시물입니다.

Python의 기본 로그 설정은 도움이 되지 않습니다. 이는 우리가 기대하는 "배터리 포함" 접근 방식에 반대됩니다.

유용한 로그 메시지를 통해 언제, 어떤 레벨, 어떤 정보가 있는지 알고 싶습니다. 콘솔에서 원할 수도 있고 파일로 원할 수도 있습니다.

간단해야 합니다. 하지만 Python에서는 사용자 정의 파일 처리 및 문자열 형식 지정을 사용하여 전체 로깅 유틸리티를 만드는 방법을 매번 찾아야 합니다.

logger = getLogger()처럼 간단 해야 합니다. 그러나 알 수 없는 이유로 기본 동작은 전혀 쓸모 없는 형식을 제공하고 합리적인 기본값을 단축하지 않는 것입니다.

출처를 알 수 없는 pip 패키지를 다운로드해야 하며 이름이 도용되지 않았거나 난독화된 추출을 수행하지 않았는지 확인해야 합니다. 2016년의 leftpad 사건과 다른 repo 시스템에서 본질적으로 동일한 문제였던 2024년의 Revival hijack 공격이 떠오릅니다.

사실 네임스페이스가 없는 모든 사용자 저장소는 이에 취약합니다. Node의 npm, Python의 pip, Arch의 AUR, Canonical의 snap ... 사용자가 무엇이든 업로드하도록 허용하는 소수의 이름을 지정합니다. 네임스페이스 지정조차도 신뢰를 보장하지 않습니다. 프로젝트 이름이 아닌 임의의 개발자 이름을 통해 이러한 채널을 통해 소프트웨어를 배포하는 프로젝트를 본 적이 있는데, 이는 패키지의 신뢰성에 대한 의심을 불러일으킵니다. 업무 환경에서 동기화를 사용하는 것에 대한 이전 게시물에서 출처를 신뢰할지 여부를 결정하는 방법에 대한 생각 과정을 설명했습니다.

사용자 제어 저장소의 외부 종속성은 악마이므로 문제에 대한 해결책이 복잡한 경우에만 고려해야 합니다. 그리고 일반적으로 간단한 솔루션은 코드 베이스에 직접 존재해야 합니다. 이상적으로는 자체 작성되었지만 때로는 문제가 단지 "충분히 번거로운" 공간으로 흘러들어 종속성이 합리적이면서 엉뚱하게 느껴지기도 합니다.

답변: 한 번 작성하고 Github Gist나 자신만의 "유용한 스니펫" 저장소에 숨겨두세요. 복사해서 붙여넣으세요.

복사 붙여넣기? 에!

코드의 "복사하여 붙여넣기"는 노련한 코더에게 경종을 울릴 수도 있습니다. "반복하지 마세요", "패키지 관리자를 사용하세요", "한 번만 작성하면 모든 곳에서 업데이트됩니다." 이것은 좋은 본능이지만, 경우에 따라 복사하여 붙여넣기가 바람직한 시기를 아는 것도 좋습니다.

이 경우 간단한 요구에 대한 간단한 솔루션을 위해 불필요한 외부 종속성을 피하는 것이 요구됩니다. 이 미니 로거와 마찬가지로 왼쪽 패드에서도 필수 코드 조각은 짧고 이해하기 쉽습니다. 필요한 경우 다시 구현해도 손실이 없습니다. 또한 적절한 라이센스가 부여되어 있습니다(예, 단지 일부분일 수 있습니다. 하지만 복사하는 내용이 실제로 허용되는지 확인하는 것이 좋습니다. 임의의 코드 덩어리를 복사하는 것을 주의하세요.)

미니 로거 스니펫

아래에는 최소한의 구성으로 단일 호출을 허용하는 미니 로거 유틸리티용 코드 조각이 포함되어 있습니다.

from minilog import SimpleLogger

LOG = SimpleLogger(name="mylog", level=SimpleLogger.INFO)

LOG.info("this is useful")

위로할 인쇄:

2024-11-20 10:43:44,567 | INFO | mylog : this is useful

미니 로거 코드

이를 프로젝트의 minilogger.py 파일에 복사하세요. Tada - 외부 종속성이 필요하지 않습니다. 손대지 않은 채로 놔두면 영원히 동일하게 유지됩니다. 이름 도용이 없습니다. 공급망 주입이 없습니다.

# For completeness:
# (C) Tai Kedzierski - Provided under MIT license. Go wild.

import logging

class SimpleLogger(logging.Logger):
    FORMAT_STRING = '%(asctime)s | %(levelname)s | %(name)s : %(message)s'
    ERROR = logging.ERROR
    WARN = logging.WARN
    INFO = logging.INFO
    DEBUG = logging.DEBUG

    def __init__(self, name="main", fmt_string=FORMAT_STRING, level=logging.WARNING, console=True, files=None):
        logging.Logger.__init__(self, name, level)
        formatter_obj = logging.Formatter(fmt_string)

        if files is None:
            files = []
        elif isinstance(files, str):
            files = [files]

        def _add_stream(handler:logging.Handler, **kwargs):
            handler = handler(**kwargs)
            handler.setLevel(level)
            handler.setFormatter(formatter_obj)
            self.addHandler(handler)

        if console is True:
            _add_stream(logging.StreamHandler, stream=sys.stdout)

        for filepath in files:
            _add_stream(logging.FileHandler, filename=filepath)

MIT 라이선스를 사용하면 기본적으로 "이것으로 원하는 것은 무엇이든 할 수 있습니다." 아무런 조건도 붙지 않았습니다.

여기 있습니다. 간단한 로그 ?

위 내용은 간단한 Python 로깅 - 종속성, 신뢰 및 코드 복사/붙여넣기에 대한 여담의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!