Документация к модулю логирования

Модуль pyloggering предоставляет функции для логирования действий в Python. Он позволяет создавать файл логов и записывать в него сообщения различных уровней, а также выводить эти сообщения в консоль.

Подключение

Прежде чем использовать модуль, убедитесь, что у вас установлен Python версии 3.10.9 и выше.

import pyloggering

Функции модуля

1. Создание файла для логирования:

Создает файл логов с указанным именем. Если файл уже существует, он будет дописыватся Убедитесь, что у вас имеются права на запись в директорию, где вы хотите создать файл логов.(Если при использовании функций логирования writing = False, то файл создавать не обязятельно)

pyloggering.create_file(name,location,type)

Параметры:

name -> Имя файла для логирования

location -> путь до директории файла логов

type -> тип выходного файла. txt либо log

Пример 1:

import pyloggering

pyloggering.create_file("log","./assets","log")

Вывод:

2. Уровень логирования INFO и его функция:

Выводит в консоль лог с уровнем INFO и записывает его в файл.

pyloggering.log.info(text,writing)

Параметры:

text -> Текст который будет выведен в консоль и записан в файл

writing -> Записывать ли в файл логи(дефолт True(при false создавать файл не обязательно))

Пример 1:

import pyloggering

pyloggering.create_file("log", "./assets", ".log")
pyloggering.log.info("Test, check file and console")

Вывод:

Пример 2:

import pyloggering

pyloggering.log.info("Test, check console",False)

Вывод:

3. Уровень логирования WARN и его функция:

Выводит в консоль лог с уровнем warning и записывает его в файл.

pyloggering.log.warning(text,writing)

Параметры:

text -> Текст который будет выведен в консоль и записан в файл

writing -> Записывать ли в файл логи(дефолт True(при false создавать файл не обязательно))

Пример 1:

import pyloggering

pyloggering.create_file("log", "./assets", ".log")
pyloggering.log.warn("Test, check file and console")

Вывод:

Пример 2:

import pyloggering

pyloggering.log.warn("Test, check console",False)

Вывод:

4. Уровень логирования SUCCESS и его функция:

Выводит в консоль лог с уровнем success и записывает его в файл.

pyloggering.log.success(text,writing)

Параметры:

text -> Текст который будет выведен в консоль и записан в файл

writing -> Записывать ли в файл логи(дефолт True(при false создавать файл не обязательно))

Пример 1:

import pyloggering

pyloggering.create_file("log", "./assets", ".log")
pyloggering.log.success("Test, check file and console")

Вывод:

Пример 2:

import pyloggering


pyloggering.log.success("Test, console", False)

Вывод:

5. Уровень логирования CRIT и его функция:

Выводит в консоль лог с уровнем critical и записывает его в файл.

pyloggering.log.critical(text,writing)

Параметры:

text -> Текст который будет выведен в консоль и записан в файл

writing -> Записывать ли в файл логи(дефолт True(при false создавать файл не обязательно))

Пример 1:

import pyloggering

pyloggering.create_file("log", "./assets", ".log")
logger.log.critical("Test, check file and console")

Вывод:

Пример 2:

import pyloggering


logger.log.critical("Test, console", False)

Вывод:

6. Уровень логирования DEBUG и его функция:

Выводит в консоль лог с уровнем debug и записывает его в файл.

pyloggering.log.debug(text,writing)

Параметры:

text -> Текст который будет выведен в консоль и записан в файл

writing -> Записывать ли в файл логи(дефолт True(при false создавать файл не обязательно))

Пример 1:

import pyloggering

logger.create_file("log", "./assets", ".log")
logger.log.debug("Test, check file and console")

Вывод:

Пример 2:

import pyloggering

logger.log.debug("Test, console",False)

Вывод:

Заключение

Эта документация охватывает основные функции модуля логирования и даёт вам возможность начать с ним работать без особых трудностей.