console-debugger 0.1.7.6

Это подключаемая библиотека, для удобного вывода отладочной информации.

Что это?

Это подключаемая библиотека, для удобного вывода отладочной информации.

---

Как использовать ?

1 Сначала нужно создать экземпляры класса Debugger

Можно вручную указать параметры экземпляра

• Debug_Name = Debugger(active: bool,,title_name: str, consoleOutput: bool = True, fileConfig: Optional[Dict] = None style_text: Optional[dstyle] = None)

  • active = on/off жизни экземпляра, Если False экземпляр будет игнорировать вызов, а также будет добавлен в массив Debugger.AllCountSleepInstance.

  • title_name = Уникальное имя экземпляра которое будет отображаться в выводе.

  • consoleOutput = on/off отображения в консоль или другие визуальные выходы, не влияет на запись в файл!.

  • fileConfig = Конфигурация записи в файл, входные параметры такие же как и у стандартной функции open()
    передавать в формате Dict{"file":"test.log", ... }. Для удобного формирования параметров можно
    пользоваться функцией dopen().

  • style_text = Стиль отображения текста. Для удобного формирования параметров можно
    пользоваться функцией dstyle.

Или использовать готовые параметры

• Debug_Name = Debugger(**dDEBUG)
  • dDEBUG
  • dINFO
  • dWARNING
  • dEXCEPTION

2 Установить глобальный стиль для всех экземпляров

Эта команда влияет на все экземпляры Debugger

• Debugger.GlobalManager(global_status=None, typePrint: Optional[str] = "grid"):

  • global_status = Вы можете on/off все экземпляры разом

  • typePrint= = Глобальный стиль отображения данных

    • "grid" = Стиль таблица

    

    • "socket" = Данные будут отправляться по сокету, в данный момент есть два варианта прослушивания сокета. Через GUI Tkinter console_debugger/main.py gui или через TUI Urwid console_debugger/main.py tui. Настройки для сокетов хранится в console_debugger/setting_socket.json в них можно изменить хост и порт приема|отправки. Если в процессе отправки данных через сокет возникнут ошибки, данные будут сохранены в файл.

    • None = Без стиля

    

3 Использовать в коде

Вызывать экземпляр напрямую

• Debug_Name(text,*args, sep=' ', end='\n')
  • Debug_Name = Имя экземпляра Debugger
  • text = Строка
  • *args, sep=' ', end='\n' = такие же, как и у встроенной функции print()

Либо использовать функцию printD для однородности

• printD(Debug_Name, text, *args, sep=' ', end='\n')
  • Debug_Name = Имя экземпляра Debugger
  • text = Строка
  • *args, sep=' ', end='\n' = такие же, как и у встроенной функции print()

---

Примеры

Использовать свои стили, вызывать экземпляры напрямую

Для наглядности создадим функцию для генерации случайного слово

import random
import string             
# Сгенерировать случайное слово
random_word = lambda: "".join(random.choice(string.ascii_letters) for j in range(random.randint(1, 40)))

from console_debugger import *

Debug = Debugger(True,title_name="[DEBUG]",

                 fileConfig=dopen(file="debug.log",
                                  mode="a",
                                  encoding="utf-8"),

                 style_text=dstyle(bg_color="bg_blue",
                                   len_word=21)
                 )
Info = Debugger(True,title_name="[INFO]",

                fileConfig={"file": "info.log",
                            "mode": "a", "encoding": "utf-8"},
                style_text=dstyle(len_word=25),

                consoleOutput=False
                )
Warning = Debugger(True,"[WARNING]", style_text=dstyle(len_word=25))

Debugger.GlobalManager(typePrint="grid")

if __name__ == '__main__':
    for i in range(10):
        Warning(random_word())
        Debug(random_word())
        Info(random_word())

Использовать готовые стили, вызывать printD

from console_debugger import *

Debug = Debugger(**dDEBUG)
Info = Debugger(**dINFO)
Warning = Debugger(**dWARNING)

Debugger.GlobalManager(typePrint="grid")

if __name__ == '__main__':
    for i in range(10):
        printD(Debug, random_word())
        printD(Warning, random_word())
        printD(Info, random_word())

Использовать soket

from console_debugger import *


Debug = Debugger(**dDEBUG)
Info = Debugger(**dINFO)
Warning = Debugger(**dWARNING)
TEST = Debugger(True,"TEST")

Debugger.GlobalManager(typePrint="socket")


for i in range(10):
    printD(Debug, random_word())
    printD(Info, random_word())
    printD(Warning, random_word())
    printD(TEST, random_word())

Использование Глобального режима on/off

Создать два режима запуска Debug/Release

main.pyw

import sys
from console_debugger import Debugger
from app.viwe import Windows # При импорте должны быть созданы все экземпляры

if __name__ == '__main__':
    for param in set(sys.argv):
        if param == "--d":
            Debugger.GlobalManager(typePrint="grid") # Задать глобальный стиль всем экземпляром
            break
    else:
        Debugger.GlobalManager(global_status=False) # Если нет параметров отключаем все экземпляры 
    Windows()

В других модулях создаем необходимые экземпляры

from console_debugger import *
HotKeyD = Debugger(True, "[HotKey]")
PressKeyD = Debugger(True, "[PressKey]")
InfoD = Debugger(**dINFO)
ResD = Debugger(True, "[Result]", style_text=dstyle(len_word=25, height=4))

printD(HotKeyD,"Crtl+c")

Использование во Flask

Поместить Debugger.GlobalManager в @app.before_first_request

from console_debugger import *
from flask import * 

SECRET_KEY = "123_very_hard_password"
app = Flask(__name__)

 # Экземпляры в глобальной области видимости
cookDeb = Debugger(True, "[Cook]")
sessionDeb = Debugger(True, "[Session]")

@app.before_first_request
def deb():
    # Tkinter будет перезапускаться при каждом обновление сервера
    Debugger.GlobalManager(typePrint="socket")

@app.route("/login", methods=['POST', 'GET'])
def login():
    global data, cookDeb, sessionDeb
    cook = "no"
    ses = "no"

    # Получить куки если есть
    if request.cookies.get("logged"):
        cook = request.cookies.get("logged")

    # Получить данные из сессии если есть
    if "SessioN" in session:
        ses = session.get("SessioN")

    printD(cookDeb, cook)
    printD(sessionDeb, ses)

    res = make_response(render_template("login.html", cook=cook, session=ses))
    res.set_cookie(key="logged", value="yes", max_age=3)
    session["SessioN"] = "yes"
    return res

if __name__ == '__main__':
    app.run(debug=True)

"login.html"

<script>
    document.cookie = "ex=1;";
    if (!document.cookie) {
        alert("Этот сайт требует включение cookie");
    }
</script>
Cook: {{ cook }}
<p></p>
Session: {{ session }}
<form action="/login" method="post" class="form-contact">
    <p><label>Name </label><input type="text" name="username" value="" required/>
    <p><label>Passwortitled </label><input type="text" name="password" value="" required/>
    <p><input type="submit" value="Send"/>
</form>

Советы

Вы можете использовать шаблон для комментирования printD

Так как входные параметры функции являются не изменяемыми обметками, то они копируются в функцию printD, чтобы н тратить лишении наносекунды на эту операцию, вы можете закомментировать все вызовы этой функции.

\s{4}printD+ 
#none: printD

А потом раскомментировать

#none: printD 
   printD

Про режим отображения Tkinter

• Если нажать на заголовок консоли, то они выполнят команду из нижней консоли
• Если нажать нижнею кнопку save geometry то вы сохраните положение окна для следующих запусках, размеры сохранять в console_debugger/gui/static/config.txt
• Если закрыть окно Tkinter, до завершения главного потока, то данные будут отправляться в консоль typePrint=None"
• Можно сохранить весь текст из консоли в файл. Для этого нужно ввести в нижнею консоль save <NAME_FILE> <PATH> и нажать Enter
• Можно получить глобальную информацию о сокете написав в любую нижнею консоль g info и нажать Enter
• Можно отчистить консоль вывода если написать в нижнею консоль clear и нажать Enter

Установка Tkinter на Linux

ArchLinux

sudo pacman -S tk

xrdb -load /dev/null  
xrdb -query 

Про режим отображения Urwid

Работает также в терминале Pycharm

Этот режим поддерживается в терминалах Linux. Программа находиться в console_debugger/tui/main.py.

• Можно сохранить весь текст из консоли в файл. Для этого нужно ввести save <NAME_FILE> <PATH>

• Горячие клавиши

  • f1 = Влево
  • f3 = Верх
  • f2 = Вниз
  • f4 = Вправо
  • Tab= Вправо
  • shif + ЛКМ = Выделить текст
  • shif + ctrl + C = Копировать выделенный текст
  • shif + ctrl + V = Вставить текст

• Можно отчистить консоль вывода если написать в нижнею консоль clear и нажать Enter

Про доступную информации об экземпляре Debugger

• public set:

  • consoleOutput = Переключить on/off вывод в консоль
  • style_text = Задать другой стиль текста
  • active() = Включить дебагер
  • deactivate() = Отключить дебагер

• public get:

  • title_name = Уникальное имя дебагера
  • fileConfig = Конфигурация для файла
  • AllCountActiveInstance() = Все активные дебагеры
  • AllCountSleepInstance() = Все приостановленный дебагиры
  • AllUseFileName() = Все используемые имена файлов
  • AllInstance() = Все экземпляры дебагеров