tkinter — Python-интерфейс к Tcl/Tk

Программа «Привет, мир»

Мы начнем с рассмотрения приложения «Привет, мир» в Tkinter. Это не самая маленькая программа, которую мы могли бы написать, но она содержит достаточно элементов, чтобы проиллюстрировать некоторые ключевые понятия, которые вам нужно знать.

from tkinter import *
from tkinter import ttk
root = Tk()
frm = ttk.Frame(root, padding=10)
frm.grid()
ttk.Label(frm, text="Hello World!").grid(column=0, row=0)
ttk.Button(frm, text="Quit", command=root.destroy).grid(column=1, row=0)
root.mainloop()

После импортов следующая строка создает экземпляр класса Tk, который инициализирует Tk и создает связанный с ним интерпретатор Tcl. Он также создает окно верхнего уровня, известное как корневое окно, которое служит основным окном приложения.

Следующая строка создает виджет-фрейм, который в данном случае будет содержать метку и кнопку, которые мы создадим далее. Фрейм помещается внутри корневого окна.

Следующая строка создает виджет-метку, содержащую статическую строку текста. Метод grid() используется для указания относительной компоновки (позиции) метки внутри содержащего её фрейма, аналогично тому, как работают таблицы в HTML.

Затем создается виджет-кнопка и размещается справа от метки. При нажатии она вызовет метод destroy() корневого окна.

Наконец, метод mainloop() выводит всё на экран и реагирует на ввод пользователя до завершения программы.

Важные понятия Tk

Даже эта простая программа иллюстрирует следующие ключевые понятия Tk:

виджеты

Интерфейс пользователя Tkinter состоит из отдельных виджетов. Каждый виджет представлен объектом Python, созданным из классов, таких как ttk.Frame, ttk.Label, и ttk.Button.

иерархия виджетов

Виджеты организованы в иерархию. Метка и кнопка были помещены во фрейм, который, в свою очередь, был помещён в корневое окно. При создании каждого дочернего виджета его родительский виджет передаётся в качестве первого аргумента конструктору виджета.

параметры конфигурации

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

управление геометрией

Виджеты не добавляются автоматически в пользовательский интерфейс при их создании. Управляющий геометрией, такой как grid, контролирует, где они будут размещены в пользовательском интерфейсе.

цикл обработки событий

Tkinter реагирует на ввод пользователя, изменения от вашей программы и даже обновляет отображение только при активном выполнении цикла обработки событий. Если ваша программа не выполняет цикл обработки событий, ваш пользовательский интерфейс не будет обновляться.

Понимание того, как Tkinter оборачивает Tcl/Tk

Когда ваше приложение использует классы и методы Tkinter, внутри Tkinter собираются строки, представляющие команды Tcl/Tk, и эти команды выполняются в интерпретаторе Tcl, прикреплённом к экземпляру вашего приложения Tk.

Независимо от того, пытаетесь ли вы изучить справочную документацию, найти нужный метод или параметр, адаптировать существующий код или отладить ваше приложение Tkinter, иногда бывает полезно понять, как выглядят эти базовые команды Tcl/Tk.

В качестве иллюстрации ниже представлен эквивалент Tcl/Tk основной части скрипта Tkinter, приведённого выше.

ttk::frame .frm -padding 10
grid .frm
grid [ttk::label .frm.lbl -text "Hello World!"] -column 0 -row 0
grid [ttk::button .frm.btn -text "Quit" -command "destroy ."] -column 1 -row 0

Синтаксис Tcl похож на многие языки оболочек, где первое слово — это команда для выполнения, а аргументы к этой команде следуют за ней, разделённые пробелами. Не углубляясь в подробности, обратите внимание на следующее:

• Команды, используемые для создания виджетов (например, ttk::frame), соответствуют классам виджетов в Tkinter.
• Параметры виджетов Tcl (например, -text) соответствуют ключевым аргументам в Tkinter.
• Виджеты в Tcl обозначаются путем (например, .frm.btn), в то время как Tkinter не использует имена, а использует ссылки на объекты.
• Местоположение виджета в иерархии виджетов закодировано в его (иерархическом) пути, который использует . (точку) в качестве разделителя пути. Путь к корневому окну — просто . (точка). В Tkinter иерархия определяется не путём, а указанием родительского виджета при создании каждого дочернего виджета.
• Операции, которые реализуются как отдельные команды в Tcl (например, grid или destroy), представлены как методы объектов виджетов Tkinter. Как вы увидите вскоре, в других случаях Tcl использует то, что кажется вызовами методов на объектах виджетов, которые более точно отражают то, что используется в Tkinter.

Как сделать…? Какой параметр…?

Если вы не уверены, как сделать что-то в Tkinter, и не можете сразу найти это в используемом вами учебнике или справочной документации, есть несколько полезных стратегий.

Во-первых, помните, что подробности работы отдельных виджетов могут варьироваться в разных версиях как Tkinter, так и Tcl/Tk. Если вы ищете документацию, убедитесь, что она соответствует версиям Python и Tcl/Tk, установленным на вашей системе.

При поиске использования API полезно знать точное имя класса, параметра или метода, который вы используете. Интроспекция, либо в интерактивной оболочке Python, либо с помощью print(), может помочь вам определить, что вам нужно.

Чтобы узнать, какие параметры конфигурации доступны для любого виджета, вызовите его метод configure(), который возвращает словарь, содержащий различную информацию об объекте, включая его значения по умолчанию и текущие значения. Используйте keys() для получения только имён каждого параметра.

btn = ttk.Button(frm, ...)
print(btn.configure().keys())

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

print(set(btn.configure().keys()) - set(frm.configure().keys()))

Аналогично, вы можете найти доступные методы для объекта виджета, используя стандартную функцию dir(). Если вы попробуете, то увидите, что существует более 200 общих методов виджетов, поэтому снова определение тех, которые специфичны для класса виджетов, является полезным.

print(dir(btn))
print(set(dir(btn)) - set(dir(frm)))

Навигация по справочному руководству Tcl/Tk

Как уже отмечалось, официальное справочное руководство по командам Tk (справочные страницы) часто является наиболее точным описанием того, что делают конкретные операции с виджетами. Даже когда вы знаете имя параметра или метода, вам всё равно могут потребоваться некоторые дополнительные шаги.

Хотя все операции в Tkinter реализованы как вызовы методов на объектах виджетов, вы видели, что многие операции Tcl/Tk выглядят как команды, которые принимают путь к виджету в качестве первого параметра, за которым следуют необязательные параметры, например:

destroy .
grid .frm.btn -column 0 -row 0

Однако другие выглядят как вызовы методов на объекте виджета (на самом деле, когда вы создаёте виджет в Tcl/Tk, он создаёт Tcl-команду с именем пути к виджету, а первым параметром этой команды является имя вызываемого метода).

.frm.btn invoke
.frm.lbl configure -text "Goodbye"

В официальной документации Tcl/Tk вы найдёте большинство операций, которые выглядят как вызовы методов на справочной странице конкретного виджета (например, вы найдёте метод invoke() на странице руководства ttk::button), в то время как функции, которые принимают виджет в качестве параметра, часто имеют собственную справочную страницу (например, grid).

Многие общие параметры и методы вы найдёте на страницах руководства по параметрам или ttk::widget, а другие — на странице руководства конкретного класса виджетов.

Вы также обнаружите, что многие методы Tkinter имеют составные имена, например, winfo_x(), winfo_height(), winfo_viewable(). Документацию по всем этим методам вы найдёте на странице руководства winfo.

Параметры настроек

Параметры контролируют такие вещи, как цвет и ширину границы виджета. Параметры можно установить тремя способами:

При создании объекта, используя ключевые аргументы

fred = Button(self, fg="red", bg="blue")

После создания объекта, используя имя параметра как индекс словаря

fred["fg"] = "red"
fred["bg"] = "blue"

Используйте метод config() для обновления нескольких атрибутов после создания объекта

fred.config(fg="red", bg="blue")

Для полного объяснения заданного параметра и его поведения, см. страницы справки Tk для соответствующего виджета.

Обратите внимание, что страницы справки перечисляют «СТАНДАРТНЫЕ ПАРАМЕТРЫ» и «ПАРАМЕТРЫ, СПЕЦИФИЧНЫЕ ДЛЯ ВИДЖЕТА», для каждого виджета. Первое — это список параметров, общих для многих виджетов, а второе — параметры, специфичные для данного виджета. Стандартные параметры описаны на странице справки options(3).

В данном документе различия между стандартными и специфичными для виджета параметрами не делаются. Некоторые параметры не применяются к некоторым видам виджетов. То, отвечает ли данный виджет на определенный параметр, зависит от класса виджета; кнопки имеют параметр command, метки — нет.

Поддерживаемые виджетом параметры перечислены в справке для этого виджета, или могут быть запрошены во время выполнения, вызвав метод config() без аргументов, или вызвав метод keys() на этом виджете. Результатом этих вызовов является словарь, ключ которого — имя параметра как строка (например, 'relief') а значения — 5-кортежи.

Некоторые параметры, такие как bg, являются синонимами общих параметров с длинными именами (bg — сокращение от «background»). Передача методу config() имени синонима параметра вернет 2-кортеж, а не 5-кортеж. 2-кортеж, который возвращается, будет содержать имя синонима и «настоящий» параметр (например, ('bg', 'background')).

Пример:

>>> print(fred.config())
{'relief': ('relief', 'relief', 'Relief', 'raised', 'groove')}

Конечно, напечатанный словарь будет включать все доступные параметры и их значения. Это лишь пример.

Упаковщик

Упаковщик — один из механизмов управления геометрией Tk. Менеджеры геометрии используются для указания относительного расположения виджетов в их контейнере — их общем мастере. В отличие от более громоздкого размещателя (который используется реже и не рассматривается здесь), упаковщик принимает указания на качественные отношения — над, слева от, заполнять и т. д. — и рассчитывает точные координаты размещения за вас.

Размер любого мастер виджета определяется размером «вложенных виджетов» внутри. Упаковщик используется для управления тем, где вложенные виджеты появляются внутри мастера, в который они упаковываются. Вы можете упаковывать виджеты в фреймы, а фреймы в другие фреймы, чтобы получить желаемое расположение. Кроме того, расположение динамически корректируется для учета постепенных изменений конфигурации после упаковки.

Обратите внимание, что виджеты не отображаются, пока их геометрия не задана с помощью менеджера геометрии. Это распространённая ошибка на ранних этапах, когда спецификацию геометрии пропускают, а затем удивляются, почему виджет создан, но ничего не отображается. Виджет будет отображаться только после того, как, например, к нему будет применено свойство упаковщика pack().

Метод pack() можно вызывать с парами «ключевой параметр/значение», которые управляют тем, где виджет будет отображаться в контейнере и как он будет себя вести при изменении размера основного окна приложения. Вот несколько примеров:

fred.pack()                     # defaults to side = "top"
fred.pack(side="left")
fred.pack(expand=1)

Параметры Упаковщика

Для получения более подробной информации об упаковщике и параметрах, которые он может принимать, см. страницы справки и страницу 183 книги Джона Остерхаута.

anchor

Тип якоря. Обозначает, где упаковщик помещает каждый подчиненный виджет в его область.

expand

Булево значение, 0 или 1.

fill

Допустимые значения: 'x', 'y', 'both', 'none'.

ipadx и ipady

Расстояние — определяющее внутренний отступ с каждой стороны виджета.

padx и pady

Расстояние — определяющее внешний отступ с каждой стороны виджета.

side

Допустимые значения: 'left', 'right', 'top', 'bottom'.

Связывание переменных виджета

Текущее значение некоторых виджетов (например, текстовых виджетов ввода) можно напрямую связать с переменными приложения, используя специальные параметры. Эти параметры — variable, textvariable, onvalue, offvalue, и value. Это связывание работает в обоих направлениях: если переменная изменяется по какой-либо причине, связанный с ней виджет будет обновлён, чтобы отразить новое значение.

К сожалению, в текущей реализации tkinter невозможно передать произвольную переменную Python виджету через параметр variable или textvariable. Это работает только для переменных, которые являются подклассами класса Variable, определённого в tkinter.

Уже определено множество полезных подклассов Variable: StringVar, IntVar, DoubleVar, и BooleanVar. Чтобы прочитать текущее значение такой переменной, вызовите метод get() на ней, а чтобы изменить её значение, вызовите метод set(). Если вы следуете этому протоколу, виджет всегда будет отслеживать значение переменной без дополнительных вмешательств с вашей стороны.

Например:

import tkinter as tk

class App(tk.Frame):
    def __init__(self, master):
        super().__init__(master)
        self.pack()

        self.entrythingy = tk.Entry()
        self.entrythingy.pack()

        # Create the application variable.
        self.contents = tk.StringVar()
        # Set it to some value.
        self.contents.set("this is a variable")
        # Tell the entry widget to watch this variable.
        self.entrythingy["textvariable"] = self.contents

        # Define a callback for when the user hits return.
        # It prints the current value of the variable.
        self.entrythingy.bind('<Key-Return>',
                             self.print_contents)

    def print_contents(self, event):
        print("Hi. The current entry content is:",
              self.contents.get())

root = tk.Tk()
myapp = App(root)
myapp.mainloop()

Менеджер окон

В Tk есть служебная команда wm, для взаимодействия с менеджером окон. Параметры команды wm позволяют управлять такими вещами, как заголовки, расположение, значки и т. п. В tkinter, эти команды реализованы как методы класса Wm. Виджеты Toplevel являются подклассами класса Wm и поэтому могут напрямую вызывать методы Wm.

Чтобы получить окно toplevel, содержащее данный виджет, можно часто просто обратиться к мастеру виджета. Конечно, если виджет был упакован в фрейм, мастер не будет представлять окно toplevel. Чтобы получить окно toplevel, содержащее произвольный виджет, можно вызвать метод _root(). Этот метод начинается с символа подчеркивания, чтобы указать на то, что эта функция является частью реализации, а не интерфейсом к функциональности Tk.

Вот несколько примеров типичного использования:

import tkinter as tk

class App(tk.Frame):
    def __init__(self, master=None):
        super().__init__(master)
        self.pack()

# create the application
myapp = App()

#
# here are method calls to the window manager class
#
myapp.master.title("My Do-Nothing Application")
myapp.master.maxsize(1000, 400)

# start the program
myapp.mainloop()

Типы данных опций Tk

anchor

Допустимые значения — точки компаса: "n", "ne", "e", "se", "s", "sw", "w", "nw", а также "center".

bitmap

Существует восемь встроенных, именованных битовых изображений: 'error', 'gray25', 'gray50', 'hourglass', 'info', 'questhead', 'question', 'warning'. Для указания имени файла X Bitmap укажите полный путь к файлу, предварив его @, как в "@/usr/contrib/bitmap/gumby.bit".

boolean

Вы можете передать целые числа 0 или 1 или строки "yes" или "no".

callback

Это любая функция Python, которая не принимает аргументов. Например:

def print_it():
    print("hi there")
fred["command"] = print_it

color

Цвета могут быть заданы как имена X-цветов в файле rgb.txt или как строки, представляющие значения RGB в диапазонах 4 бита: "#RGB", 8 бит: "#RRGGBB", 12 бит: "#RRRGGGBBB", или 16 бит: "#RRRRGGGGBBBB", где R, G, B здесь представляют любые допустимые шестнадцатеричные цифры. Подробности см. на странице 160 книги Остерхауса.

cursor

Можно использовать стандартные имена курсоров X из cursorfont.h без префикса XC_. Например, чтобы получить курсор руки (XC_hand2), используйте строку "hand2". Также можно указать собственный файл битовой карты и маски. См. страницу 179 книги Остерхауса.

distance

Расстояния на экране можно задавать в пикселях или в абсолютных единицах. Пиксели задаются числами, а абсолютные расстояния — строками с обозначением единиц в конце: c для сантиметров, i для дюймов, m для миллиметров, p для типографских пунктов. Например, 3,5 дюйма записываются как "3.5i".

font

Tk использует список имён шрифтов, например {courier 10 bold}. Размеры шрифтов с положительными числами измеряются в пунктах; размеры с отрицательными числами измеряются в пикселях.

geometry

Это строка в формате widthxheight, где ширина и высота измеряются в пикселях для большинства виджетов (в символах для виджетов, отображающих текст). Например: fred["geometry"] = "200x100".

justify

Допустимые значения — строки: "left", "center", "right", и "fill".

region

Это строка с четырьмя элементами, разделёнными пробелами, каждый из которых является допустимым расстоянием (см. выше). Например: "2 3 4 5" и "3i 2i 4.5i 2i" и "3c 2c 4c 10.43c" — все являются допустимыми областями.

relief

Определяет стиль границы виджета. Допустимые значения: "raised", "sunken", "flat", "groove", и "ridge".

scrollcommand

Это почти всегда метод set() некоторого виджета полосы прокрутки, но может быть любым методом виджета, принимающим один аргумент.

wrap

Должно быть одним из: "none", "char", или "word".

Связывания и события

Метод bind из команды виджета позволяет наблюдать за определёнными событиями и вызывать функцию обратного вызова, когда происходит событие указанного типа. Формат метода bind:

def bind(self, sequence, func, add=''):

где:

sequence

— строка, обозначающая целевой тип события. (См. страницу man bind(3tk) и страницу 201 книги Джона Остерхауса, Tcl and the Tk Toolkit (2nd edition), для получения подробной информации).

func

— функция Python, принимающая один аргумент, которая будет вызвана при возникновении события. В качестве аргумента будет передаваться объект Event. (Функции, развернутые таким образом, обычно называются обработчиками событий.)

add

— необязательно, либо '' или '+'. Передача пустой строки означает, что это связывание должно заменить все другие связывания, связанные с этим событием. Передача '+' означает, что эта функция должна быть добавлена в список функций, связанных с этим типом события.

Например:

def turn_red(self, event):
    event.widget["activeforeground"] = "red"

self.button.bind("<Enter>", self.turn_red)

Обратите внимание, как в функции обратного вызова turn_red() обращается к полю widget события. Это поле содержит виджет, поймавший событие X. В следующей таблице перечислены другие поля событий, к которым можно обратиться, и как они обозначаются в Tk, что может быть полезно при работе с страницами man Tk.

Параметр index

Для ряда виджетов требуются параметры «index». Они используются для указания определённого места в виджете Text или конкретных символов в виджете Entry или конкретных пунктов меню в виджете Menu.

Индексы виджетов Entry (index, view index и т. д.)

В виджетах Entry есть параметры, которые ссылаются на позиции символов в отображаемом тексте. Вы можете использовать эти функции tkinter, чтобы получить доступ к этим особым точкам в виджетах текста:

Индексы виджетов Text

Индексация для виджетов Text очень богата и лучше всего описывается в страницах man Tk.

Индексы меню (menu.invoke(), menu.entryconfig() и т. д.)

Некоторые параметры и методы для меню манипулируют конкретными пунктами меню. В любое время, когда требуется индекс меню для параметра или аргумента, можно передать:

• целое число, которое ссылается на числовую позицию элемента в виджете, считая сверху, начиная с 0;
• строку "active", которая относится к позиции меню, которая сейчас находится под курсором;
• строку "last" которая относится к последнему пункту меню;
• целое число, предваряемое @, как в @6, где целое число интерпретируется как координата y в пикселях в системе координат меню;
• строку "none", которая обозначает отсутствие элемента меню, чаще всего используемая с menu.activate() для деактивации всех элементов, и наконец,
• строку текста, которая сопоставляется по шаблону с меткой элемента меню, как сканируемая сверху вниз. Обратите внимание, что этот тип индекса рассматривается после всех остальных, что означает, что совпадения для элементов меню с метками last, active, или none могут быть интерпретированы как указанные выше литералы, вместо этого.

Изображения

Изображения различных форматов могут быть созданы с помощью соответствующего подкласса tkinter.Image:

• BitmapImage для изображений в формате XBM.
• PhotoImage для изображений в форматах PGM, PPM, GIF и PNG. Последний поддерживается, начиная с Tk 8.6.

Изображение любого типа создаётся с помощью параметра file или data (также доступны другие параметры).

Объект изображения затем можно использовать там, где поддерживается параметр image некоторым виджетом (например, метками, кнопками, меню). В этих случаях Tk не будет хранить ссылку на изображение. Когда последняя ссылка Python на объект изображения удаляется, данные изображения удаляются также, и Tk будет отображать пустую область там, где изображение использовалось.