PyPI 官网下载 | custos-logger-1.0.2.tar.gz

# ===================== # Import PATH libraries # ===================== # ----------------- # Builtin libraries # ----------------- from os import _exit from typing import Optional, Any from sys import _getframe from datetime import datetime # --------------------- # Third-party libraries # --------------------- from termcolor import colored # ====================== # Import local libraries # ====================== from .blueprints import log, timestamp LOG_FORMAT = "{ts.day}-{ts.month}-{ts.year} {ts.hour}:{ts.minute}:{ts.second}:{ts.microsecond} {level} [{project}:{origin}]: {content}" ORIGIN_FORMAT = "{file_name}.{func_name}" class Custos: """This is a device used to easily print coloured text to the stdout without the need for messy code. It also allows for a more authentic printing method if an instance of this class is assigned to a "console" variable, examples of how this would look are: console.info(text="Successfully started up!") try: ... except: console.warn(text="Something failed!") Options and how to define them ============================== Several options can be provided to this class to change the way it works. To set options, simply pass the option name as a keyword argument along with the value you wish to set. For example: Custos(option=value) Log & Prompt Format ------------------- Sometimes, people may wish to change the format of the information that gets logged to the console. Luckily, this is pretty easy to do with Custos. Due to the way Python string interpolation (formatted strings) works, we can't use .strftime inside of format strings. This means that you can't change the datetime formatting listed below. Luckily, we can just use different variables for each of the time units of the datetime. You can change the log format by doing something similar to this: Custos(log_format="[{ts.day}-{ts.month}-{ts.year}] {level} [{project}.{origin}] >> {content}") To set the format of prompt calls, simply do something like this: Custos(prompt_format="[{ts.day}-{ts.month}-{ts.year}] {level} [{project}.{origin}]: {content} >>") The prompt format has the same available variables as the log format does. Below is a list of available variables that you can put into your format string: ts - the timestamp of the log containing these values: year - the year that the log was created month - the zero padded month that the log was created day - the zero padded day of the month that the log was created hour - the zero padded hour of the day that the log was created minute - the zero padded minute of the hour that the log was created second - the zero padded second of the minute that the log was created microsecond - the decimal value of the microsecond of the second that the log was created hour_12 - the 12-hour clock value of the hour of the day that the log was created am_pm - AM or PM depending on the time of day project - the optional name of the project (defaults to custos) id - the ID of the log level - the urgency level of the log, e.g: INFO origin - the provided or queried origin of the call content - the content of the log [Note]: The provided format should be a partially formatted string that uses the {} syntax. Origin Format ------------- You can also specify a format for the origin of the log. This works similarly to the log and prompt formats, except it's set using: Custos(origin_format="{file_name}.{func_name}#{line_no}") Here are the possible variables you can provide: file_name - the optional name of the file that the call came from (defaults to "module") func_name - the optional name of the function containing the call (defaults to "external") line_no - the line number at which the call was made Logging level ------------- This wouldn't be a proper logging handler without a logging level. In essence, the value of this option determines which type of logs are able to be printed to the console. Log levels run on a hierarchy system, if DEBUG logs can be printed, so can INFO, WARN, ERROR (etc.) logs. If the logging level is set to WARN, then INFO and DEBUG will not be printed etc. To set a log level, you can do something like this: Custos(log_level="WARN") The possible values for this option are as follows: DEBUG: every log is printed INFO: info logs and logs listed below are printed READY: ready logs and logs listed below are printed WARN: warning logs and logs listed below are printed ERROR: error logs and logs listed below are printed CRITICAL: critical logs and logs listed below are printed FATAL: only fatal logs are printed [Note]: Regardless of log level, every log will be available in the Custos.logs list, they just aren't printed to the stdout. Project name ------------ This logging system prints an origin with every log made. It looks like this: [custos:origin_function] However, you can swap custos for whatever word you want by passing the project_name value, below is an example: Custos(project_name="dominus") [Note]: As long as the value for this option can be turned into a string, the module doesn't care about what the type of the value is. Using multiple consoles ======================= Since this module allows you to choose project names for your logger, you could theoretically have different instances of this class with different project names. This would allow you to provide more clarity on the source of your logs. For example: master_console = Custos(project_name="master", log_level="DEBUG") slave_console = Custos(project_name="slave", log_level="ERROR")""" def __init__(self, **options: dict): self.log_level: Optional[str] = options.pop("log_level", "INFO") self.project_name: Optional[str] = options.pop("project_name", "custos") self.format: str = options.pop("log_format", LOG_FORMAT) self.prompt_format: str = options.pop("prompt_format", self.format + " >> ") self.origin_format: str = options.pop("origin_format", ORIGIN_FORMAT) self.logs = [] def get_origin(self, depth: Optional[int] = 2) -> str: """Returns the formatted version of the origin with an optional depth. The depth determines which function to get the frame for, a depth of two returns the origin if called from one of this class' functions. If called externally, you should pass depth as 1. Thanks to how Python works, it's not actually possible for the frame to be missing the f_code property, so there's no need to check for that.""" frame = _getframe(depth) return self.origin_format.format(file_name="module" if (file_name := frame.f_code.co_filename.split("/")[-1][:-3]) == "<module>" else file_name, func_name=func_name if (func_name := frame.f_code.co_name) else "external", line_no=frame.f_lineno) def fatal(self, text: str, origin: Optional[str] = None): """This creates a FATAL message and prints it to the stdout. This is designed to be used whenever the project has decided t