Skip to content

log_viewer

A python editor window

LogViewerWidget

Editable textbox with numbers at side and key bindings for Python

Source code in mmg_toolbox/tkguis/widgets/log_viewer.py 
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
class LogViewerWidget:
    """
    Editable textbox with numbers at side and key bindings for Python
    """

    def __init__(self, root: tk.Misc, log_tabs: dict[str, list[str]]):

        self.root = root
        self.search_box = tk.StringVar(self.root, '')
        self.search_matchcase = tk.BooleanVar(self.root, False)
        self.search_all_dates = tk.BooleanVar(self.root, True)
        self.search_number = tk.StringVar(self.root, '')

        main = ttk.Frame(root)
        main.pack(side=tk.TOP, expand=tk.YES, fill=tk.BOTH)

        self.ini_search(main)

        frm = ttk.Frame(main)
        frm.pack(side=tk.TOP, expand=tk.YES, fill=tk.BOTH)

        # Tabs
        self.view_tabs = ttk.Notebook(frm)
        self.tab_texts = []
        for title, log in log_tabs.items():
            tab = ttk.Frame(self.view_tabs)
            self.view_tabs.add(tab, text=title)
            self.tab_texts.append(log_tab(tab, '\n'.join(log)))
        self.view_tabs.pack(side=tk.TOP, fill=tk.BOTH, expand=tk.YES)

    def ini_search(self, frame: tk.Misc):
        frm = ttk.Frame(frame)
        frm.pack(side=tk.TOP, anchor=tk.E)

        var = ttk.Entry(frm, textvariable=self.search_box, width=40)
        var.pack(side=tk.LEFT)
        # var.bind('<KeyRelease>', self.fun_search)
        var.bind('<Return>', self.fun_search)
        var.bind('<KP_Enter>', self.fun_search)
        var = ttk.Button(frm, text='Search', command=self.fun_search, width=10)
        var.pack(side=tk.LEFT)

        ttk.Checkbutton(frm, variable=self.search_matchcase, text='Case').pack(side=tk.LEFT)
        ttk.Checkbutton(frm, variable=self.search_all_dates, text='All Dates').pack(side=tk.LEFT)
        ttk.Label(frm, textvariable=self.search_number).pack(side=tk.LEFT)


    def fun_search(self, event=None):
        """Search currently active tab"""
        found = 0
        if self.search_all_dates.get():
            # search all tabs
            first_tab = False
            for tab_index, tab_text in enumerate(self.tab_texts):
                found += search_text(tab_text, self.search_box.get(), self.search_matchcase.get(), Colours.highlight)
                if not first_tab and found > 0:
                    self.view_tabs.select(tab_index)
                    first_tab = True
        else:
            tab_index = self.view_tabs.index(self.view_tabs.select())
            tab_text = self.tab_texts[tab_index]
            found += search_text(tab_text, self.search_box.get(), self.search_matchcase.get(), Colours.highlight)
        self.search_number.set(f"{found} found")

Search currently active tab

Source code in mmg_toolbox/tkguis/widgets/log_viewer.py 
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
def fun_search(self, event=None):
    """Search currently active tab"""
    found = 0
    if self.search_all_dates.get():
        # search all tabs
        first_tab = False
        for tab_index, tab_text in enumerate(self.tab_texts):
            found += search_text(tab_text, self.search_box.get(), self.search_matchcase.get(), Colours.highlight)
            if not first_tab and found > 0:
                self.view_tabs.select(tab_index)
                first_tab = True
    else:
        tab_index = self.view_tabs.index(self.view_tabs.select())
        tab_text = self.tab_texts[tab_index]
        found += search_text(tab_text, self.search_box.get(), self.search_matchcase.get(), Colours.highlight)
    self.search_number.set(f"{found} found")

log_tab(root, log_string)

Create log textbox

Source code in mmg_toolbox/tkguis/widgets/log_viewer.py 
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
def log_tab(root: tk.Misc, log_string: str):
    """Create log textbox"""

    "----------- Textbox -----------"

    txt = ttk.Frame(root)
    txt.pack(side=tk.TOP, expand=tk.YES, fill=tk.BOTH)

    # Scrollbars
    scroll_x = ttk.Scrollbar(txt, orient=tk.HORIZONTAL)
    scroll_x.pack(side=tk.BOTTOM, fill=tk.X)
    scroll_y = ttk.Scrollbar(txt, orient=tk.VERTICAL)
    scroll_y.pack(side=tk.RIGHT, fill=tk.Y)

    # TEXT box
    text = tk.Text(
        txt,
        background=Colours.background,
        foreground=Colours.normal,
        insertbackground=Colours.normal,
        exportselection=True,
        relief=tk.FLAT,
        font=FONT,
        wrap=tk.NONE
    )
    text.pack(side=tk.LEFT, fill=tk.BOTH, expand=tk.YES)
    text.insert('1.0', log_string)
    text.config(state=tk.DISABLED)

    # make scrollbars work
    text.config(xscrollcommand=scroll_x.set, yscrollcommand=scroll_y.set)
    scroll_x.config(command=text.xview)
    scroll_y.config(command=text.yview)

    update_tags(text)
    return text

search_re(pattern, text)

Search text for regex pattern

Source code in mmg_toolbox/tkguis/widgets/log_viewer.py 
42
43
44
45
46
47
48
49
50
51
52
def search_re(pattern, text):
    """Search text for regex pattern"""
    matches = []
    regex = re.compile(pattern)
    for i, line in enumerate(text.splitlines()):
        for match in regex.finditer(line):
            if match.groups():
                matches.append((f"{i + 1}.{match.span(1)[0]}", f"{i + 1}.{match.span(1)[1]}"))
            else:
                matches.append((f"{i + 1}.{match.start()}", f"{i + 1}.{match.end()}"))
    return matches

update_tags(text)

apply tags to textbox

Source code in mmg_toolbox/tkguis/widgets/log_viewer.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
def update_tags(text: tk.Text):
    """ apply tags to textbox """

    # Remove all tags so they can be redrawn
    for tag in text.tag_names():
        text.tag_remove(tag, "1.0", tk.END)

    # Add tags where the search_re function found the pattern
    i = 0
    for pattern, color in REPL:
        for start, end in search_re(pattern, text.get('1.0', tk.END)):
            text.tag_add(f'{i}', start, end)
            text.tag_config(f'{i}', foreground=color)
            i += 1

    # Add tags to multiline comments
    start = None
    for n, line in enumerate(text.get('1.0', tk.END).splitlines()):
        for match in re.finditer('\'{3}|\"{3}', line):
            if start:
                text.tag_add(f'{i}', start, f"{n + 1}.{match.end()}")
                text.tag_config(f'{i}', foreground=Colours.comments)
                i += 1
                start = None
            else:
                start = f"{n + 1}.{match.start()}"