Pengelogan Python Mudah - dan penyimpangan pada kebergantungan, kepercayaan dan Salin/menampal kod

Imej Pengepala (C) Tai Kedzierski

Goto Snippet

Siaran ini adalah pendapat.

Persediaan log lalai Python tidak membantu; ia berfungsi menentang pendekatan "termasuk bateri" yang kami jangkakan.

Daripada mesej log yang berguna, saya ingin tahu bila, tahap dan maklumat apa. Saya mungkin mahukannya pada konsol, saya mungkin mahukannya dalam fail.

Ini sepatutnya mudah - tetapi dalam Python saya akhirnya perlu mencari cara untuk mencipta utiliti pengelogan penuh dengan pengendalian fail tersuai dan pemformatan rentetan.

Ia seharusnya semudah logger = getLogger(), tetapi gelagat lalai atas sebab yang tidak diketahui adalah untuk menyediakan pemformatan yang tidak berguna sama sekali dan tiada trengkas untuk lalai yang wajar.

Itu atau saya perlu memuat turun beberapa pakej pip asal-usul yang tidak diketahui, percaya bahawa ia tidak dirampas nama atau melakukan beberapa pengelupasan yang keliru. Insiden pad kiri dari 2016 terlintas di fikiran, serta serangan rampasan Revival dari 2024 yang pada asasnya adalah masalah yang sama dalam sistem repo yang berbeza.

Malah, mana-mana repo pengguna tanpa jarak nama terdedah kepada perkara ini: npm Node, pip Python, Arch's AUR, Canonical's snap ... untuk menamakan segelintir yang membenarkan pengguna memuat naik apa sahaja. Malah jarak nama bukanlah jaminan kepercayaan - saya telah menjumpai projek yang mengedarkan perisian mereka melalui saluran ini bukan melalui nama projek, tetapi melalui beberapa nama pengembang sewenang-wenangnya, menimbulkan keraguan tentang keaslian pakej tersebut. Saya memberikan proses pemikiran saya tentang cara memutuskan sama ada untuk mempercayai sumber dalam siaran sebelumnya tentang menggunakan penyegerakan dalam persekitaran kerja.

Kebergantungan luaran dalam repo dikawal pengguna adalah syaitan, dan hanya perlu dipertimbangkan apabila penyelesaian kepada masalah adalah rumit. Dan secara amnya, penyelesaian mudah hanya perlu wujud secara langsung dalam pangkalan kod - idealnya ditulis sendiri, tetapi kadangkala masalahnya hanya meresap ke dalam ruang yang "cukup menyusahkan" untuk menjadikan pergantungan itu berasa munasabah dan menjijikkan.

Jawapannya: tulis sekali, simpan dalam intipati Github atau dalam repo "coretan berguna" anda sendiri. Salin dan tampal.

Salin Tampal? Ew!

"Salin dan tampal" kod mungkin menghantar loceng penggera berdering untuk mana-mana pengekod berpengalaman. "Jangan ulangi diri sendiri," "gunakan pengurus pakej," "tulis sekali, kemas kini di mana-mana." Ini adalah naluri yang baik untuk dimiliki, tetapi kes demi kes, ia juga baik untuk mengetahui bila salin-tampal adalah lebih baik.

Dalam kes ini, keperluannya ialah mengelakkan kebergantungan luaran yang tidak perlu untuk penyelesaian ringkas kepada keperluan mudah . Dalam pad kiri seperti mini-logger ini, coretan kod yang diperlukan ialah pendek dan mudah difahami ; tidak rugi untuk melaksanakan semula jika diperlukan. Ia juga dilesenkan dengan sewajarnya (ya, ia mungkin hanya coretan; ia tetap disyorkan untuk memastikan bahawa apa yang anda salin adalah benar-benar dibenarkan. Berhati-hati dengan menyalin gumpalan kod rawak.)

Coretan Logger Mini

Saya sertakan di bawah coretan kod untuk utiliti logger mini yang membenarkan satu panggilan dengan konfigurasi minimum:

from minilog import SimpleLogger

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

LOG.info("this is useful")

Yang dicetak untuk konsol:

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

Kod mini-logger

Salin ini ke dalam fail minilogger.py dalam projek anda. Tada - tiada pergantungan luar diperlukan. Jika tidak disentuh, ia akan kekal selama-lamanya. Tiada rampasan nama. Tiada suntikan rantaian bekalan.

# 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)

Lesen MIT pada asasnya membolehkan anda "melakukan apa sahaja yang anda mahu dengan ini." Tiada rentetan terikat.

Di sana kami berada. Log ringkas ?

Atas ialah kandungan terperinci Pengelogan Python Mudah - dan penyimpangan pada kebergantungan, kepercayaan dan Salin/menampal kod. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!