tkinter – интерфейс Python к Tcl/Tk¶tkinter – Python interface to Tcl/Tk

Программа Hello World¶A Hello World Program

Начнём с разбора приложения «Hello World» на 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. Она также создаёт главное окно, известное как корневое окно, которое служит основным окном приложения.

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

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

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

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

Важные концепции Tk¶Important Tk Concepts

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

виджеты

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

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

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

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

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

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

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

цикл событий

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

Понимание того, как Tkinter оборачивает Tcl/Tk¶Understanding How Tkinter Wraps 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.

Как сделать…? Какой параметр…?¶How do I…? What option does…?

Если вы не уверены, как сделать что-то в 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¶Navigating the Tcl/Tk Reference Manual

Как уже отмечалось, официальное справочное руководство команд 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).

Многие общие параметры и методы можно найти на man-страницах options или ttk::widget, тогда как остальные находятся на man-странице конкретного класса виджета.

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

Установка опций¶Setting Options

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

При создании объекта – с помощью именованных аргументов

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

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

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

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

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

Полное объяснение конкретного параметра и его поведения можно найти на man-страницах Tk для соответствующего виджета.

Обратите внимание, что man-страницы перечисляют «СТАНДАРТНЫЕ ПАРАМЕТРЫ» и «ПАРАМЕТРЫ, СПЕЦИФИЧНЫЕ ДЛЯ ВИДЖЕТА» для каждого виджета. Первое – список параметров, общих для многих виджетов, второе – параметры, свойственные конкретному виджету. Стандартные параметры задокументированы на man-странице 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')}

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

Упаковщик¶The Packer

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

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

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

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

fred.pack()                     # по умолчанию side = "top"
fred.pack(side="left")
fred.pack(expand=1)

Опции упаковщика¶Packer Options

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

привязка

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

расширение

Логическое значение, 0 или 1.

заполнение

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

ipadx и ipady

Расстояние – задает внутренний отступ с каждой стороны дочернего виджета.

padx и pady

Расстояние – задает внешний отступ с каждой стороны дочернего виджета.

сторона

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

Привязка переменных виджетов¶Coupling Widget Variables

Текущее значение некоторых виджетов (например, виджетов ввода текста) может быть напрямую связано с переменными приложения с помощью специальных опций. Эти опции: 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()

        # Создайте переменную приложения.
        self.contents = tk.StringVar()
        # Установите её в некоторое значение.
        self.contents.set("this is a variable")
        # Укажите виджету ввода отслеживать эту переменную.
        self.entrythingy["textvariable"] = self.contents

        # Определите колбэк для события нажатия Return.
        # Он выводит текущее значение переменной.
        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()

Менеджер окон¶The Window Manager

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

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

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

import tkinter as tk

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

# создайте приложение
myapp = App()

#
# здесь вызовы методов класса оконного менеджера
#
myapp.master.title("My Do-Nothing Application")
myapp.master.maxsize(1000, 400)

# запустите программу
myapp.mainloop()

Типы данных опций Tk¶Tk Option Data Types

привязка

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

битовая карта

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

булевый

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

колбэк

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

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

цвет

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

курсор

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

расстояние

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

шрифт

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

геометрия

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

выравнивание

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

регион

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

рельеф

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

команда прокрутки

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

перенос

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

Привязки и события¶Bindings and Events

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

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

где:

последовательность

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

функция

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

добавить

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

Например:

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

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

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

Параметр index¶The index Parameter

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

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

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

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

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

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

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

• целое число, которое указывает на числовую позицию пункта в виджете, считая сверху, начиная с 0;

• строку "active", которая указывает на позицию меню, находящуюся в данный момент под курсором;

• строку "last", которая указывает на последний пункт меню;

• Целое число, перед которым стоит @, например @6, где целое число интерпретируется как координата y в пикселях в системе координат меню;

• строку "none", которая указывает на отсутствие какого-либо пункта меню, чаще всего используется с menu.activate() для деактивации всех пунктов, и наконец,

• текстовую строку, которая сопоставляется с образцом с меткой пункта меню при сканировании сверху вниз. Обратите внимание, что этот тип индекса рассматривается после всех остальных, что означает, что совпадения для пунктов меню с метками last, active или none могут быть интерпретированы как указанные выше литералы.

Изображения¶Images

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

• BitmapImage для изображений в формате XBM.

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

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

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