beast-logger 0.0.4

A package for atomic evaluation tools and utilities

Core features

Log data as tables, and then render them as entries in web log viewer with extremely simple functions !

from best_logger import *

# === log nested dictionaries as table ===
print_dictofdict({
    'sample-1':{
        "a": 1,
        "b": 2,
        "c": 3,
    },
    'sample-2':{
        "a": 4,
        "b": 5,
        "c": 6,
    }
}, narrow=True, header="this is a header", mod="", attach="create a copy button in web log viewer, when clicked, copy this message into clipboard")

# ╭─────────────── this is a header ───────────────╮
# │ ┏━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━┳━━━━━━┳━━━━━━┓ │
# │ ┃                      ┃ a     ┃ b    ┃ c    ┃ │
# │ ┡━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━╇━━━━━━╇━━━━━━┩ │
# │ │ sample-1             │ 1     │ 2    │ 3    │ │
# │ ├──────────────────────┼───────┼──────┼──────┤ │
# │ │ sample-2             │ 4     │ 5    │ 6    │ │
# │ └──────────────────────┴───────┴──────┴──────┘ │
# ╰────────────────────────────────────────────────╯

# === log a list of dictionaries as table ===
print_listofdict(
    [{
        "a": 1,
        "b": 2,
        "c": 3,
    },
    {
        "a": 4,
        "b": 5,
        "c": 6,
    }], narrow=True)

# ╭────────────────────────────────────────────────╮
# │ ┏━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┓ │
# │ ┃           ┃ a        ┃ b        ┃ c        ┃ │
# │ ┡━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━┩ │
# │ │ 0         │ 1        │ 2        │ 3        │ │
# │ ├───────────┼──────────┼──────────┼──────────┤ │
# │ │ 1         │ 4        │ 5        │ 6        │ │
# │ └───────────┴──────────┴──────────┴──────────┘ │
# ╰────────────────────────────────────────────────╯

# === log dictionary as table ===
print_dict({
    "a": 1,
    "b": 2,
    "c": 3,
}, mod="abc")

# ╭────────────────────────────────────────────────╮
# │ ┌──────────────────────┬─────────────────────┐ │
# │ │ a                    │ 1                   │ │
# │ ├──────────────────────┼─────────────────────┤ │
# │ │ b                    │ 2                   │ │
# │ ├──────────────────────┼─────────────────────┤ │
# │ │ c                    │ 3                   │ │
# │ └──────────────────────┴─────────────────────┘ │
# ╰────────────────────────────────────────────────╯

Quick Start

• install: pip install beast-logger -i https://pypi.org/simple

• import

  from best_logger import *
  

• register file handler

  def register_logger(mods=[], non_console_mods=[], base_log_path="logs", auto_clean_mods=[]):
      """ mods: 需要注册的模块名列表，同时向终端和文件输出
          non_console_mods: 需要注册的模块名列表，只向文件输出
          base_log_path: 日志文件存放的根目录
          auto_clean_mods: 需要自动删除旧日志的模块名列表
  """
  

• begin logging

  from best_logger import *
  register_logger(mods=["abc"])
  print_dict({
      "a": 1,
      "b": 2,
      "c": 3,
  }, mod="abc")
  

• install nvm

  wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash

• launch web display on port 8181 (first time)

  python -m web_display.install 8181

• launch web display on port 8181 (skip npm install)

  python -m web_display.go 8181

• open in browser

  http://localhost:8181

• test program and enter log dir (absolute path) into web log viewer.

  from best_logger import *
  register_logger(mods=["abc"])
  print_dict({
      "a": 1,
      "b": 2,
      "c": 3,
  }, mod="abc")